forked from karelia/ConnectionKit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
InterThreadMessaging.m
623 lines (525 loc) · 18.6 KB
/
InterThreadMessaging.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
/*-*- Mode: ObjC; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-*/
/*
* InterThreadMessaging -- InterThreadMessaging.m
* Created by toby on Tue Jun 19 2001.
*
*/
#import <pthread.h>
#import "InterThreadMessaging.h"
#import "KTLog.h"
#import "CKAbstractConnection.h" //for threading domain
@interface NSInvocation ( Connection )
+ (NSInvocation *)invocationWithSelector:(SEL)aSelector target:(id)aTarget arguments:(NSArray *)anArgumentArray;
@end
/* There are four types of messages that can be posted between threads: a
notification to be posted to the default notification centre and selectors
to be performed with a varying number of arguments. (I was tempted to
implement all three in terms of performSelector:withObject:withObject:
and passing in nil for the empty arguments, but then it occurred to me
that perhaps the receiver has overridden performSelector: and
performSelector:withObject:. So I think I must disambiguate between
them all.) */
typedef enum ConnectionInterThreadMessageType ConnectionInterThreadMessageType;
enum ConnectionInterThreadMessageType
{
kITMPostNotification = 1,
kITMPerformSelector0Args,
kITMPerformSelector1Args,
kITMPerformSelector2Args
};
/* The message contents are carried between threads in this struct. The
struct is allocated in the sending thread and freed in the receiving thread.
It is carried between the threads in an NSPortMessage - the NSPortMessage
contains a single NSData argument, which is a wrapper around the pointer to
this struct. */
typedef struct ConnectionInterThreadMessage
{
ConnectionInterThreadMessageType type;
union {
NSNotification *notification;
struct {
SEL selector;
id receiver;
id arg1;
id arg2;
} sel;
} data;
} ConnectionInterThreadMessage;
@interface NSObject (PrivateConnectionStuff)
- (void)postDelayedMessage:(NSNumber *)type
thread:(NSThread *)thread
notification:(NSNotification *)notification
selector:(SEL)selector
receiver:(id)receiver
arg1:(id)arg1
arg2:(id)arg2;
@end
@interface NSThread (ConnectionSecretStuff)
- (NSRunLoop *) runLoop;
- (void)delayPostingMessage:(ConnectionInterThreadMessage *)msg thread:(NSThread *)thread;
@end
/* Each thread is associated with an NSPort. This port is used to deliver
messages to the target thread. */
static NSMapTable *pThreadMessagePorts = NULL;
static NSMapTable *pThreadMessageLocks = NULL;
static pthread_mutex_t pGate = { 0 };
@interface ConnectionInterThreadManager : NSObject
+ (void) threadDied:(NSNotification *)notification;
+ (void) handlePortMessage:(NSPortMessage *)msg;
@end
static void
ConnectionCreateMessagePortForThread (NSThread *thread, NSRunLoop *runLoop)
{
NSPort *port;
assert(nil != thread);
assert(nil != runLoop);
if (!pThreadMessagePorts)
{
[ConnectionInterThreadManager class];
}
assert(NULL != pThreadMessagePorts);
pthread_mutex_lock(&pGate);
port = NSMapGet(pThreadMessagePorts, thread);
if (nil == port) {
port = [[NSPort allocWithZone:NULL] init];
[port setDelegate:[ConnectionInterThreadManager class]];
[port scheduleInRunLoop:runLoop forMode:NSDefaultRunLoopMode];
[port scheduleInRunLoop:runLoop forMode:NSModalPanelRunLoopMode];
NSLock *lock = [[NSRecursiveLock alloc] init];
NSMapInsertKnownAbsent(pThreadMessagePorts, thread, port);
NSMapInsertKnownAbsent(pThreadMessageLocks, thread, lock);
/* Transfer ownership of this port to the map table. */
[port release];
[lock release];
}
pthread_mutex_unlock(&pGate);
}
static NSLock * ConnectionMessageLockForThread (NSThread *thread)
{
assert (thread != nil);
assert (pThreadMessageLocks != nil);
NSLock *lock = nil;
pthread_mutex_lock(&pGate);
lock = NSMapGet(pThreadMessageLocks, thread);
pthread_mutex_unlock(&pGate);
return lock;
}
static NSPort *
ConnectionMessagePortForThread (NSThread *thread)
{
NSPort *port = nil;
if (!pThreadMessagePorts)
{
[ConnectionInterThreadManager class];
}
assert(NULL != pThreadMessagePorts);
assert(nil != thread);
pthread_mutex_lock(&pGate);
port = NSMapGet(pThreadMessagePorts, thread);
pthread_mutex_unlock(&pGate);
if (nil == port)
{
ConnectionCreateMessagePortForThread(thread, [thread runLoop]);
pthread_mutex_lock(&pGate);
port = NSMapGet(pThreadMessagePorts, thread);
pthread_mutex_unlock(&pGate);
}
if (nil == port) {
[NSException raise:NSInvalidArgumentException
format:@"Thread %@ is not prepared to receive "
@"inter-thread messages. You must invoke "
@"+prepareForConnectionInterThreadMessages first.", thread];
}
return port;
}
static void
ConnectionRemoveMessagePortForThread (NSThread *thread, NSRunLoop *runLoop)
{
NSPort *port;
assert(nil != thread);
if (!pThreadMessagePorts)
{
[ConnectionInterThreadManager class];
}
assert(NULL != pThreadMessagePorts);
pthread_mutex_lock(&pGate);
port = (NSPort *) NSMapGet(pThreadMessagePorts, thread);
if (nil != port) {
[port removeFromRunLoop:runLoop forMode:NSDefaultRunLoopMode];
NSMapRemove(pThreadMessagePorts, thread);
}
NSMapRemove(pThreadMessageLocks, thread);
pthread_mutex_unlock(&pGate);
}
@implementation NSThread (ConnectionInterThreadMessaging)
+ (void) prepareForConnectionInterThreadMessages
{
/* Force the class initialization. */
[ConnectionInterThreadManager class];
ConnectionCreateMessagePortForThread([NSThread currentThread],
[NSRunLoop currentRunLoop]);
}
@end
@implementation ConnectionInterThreadManager
+ (void) initialize
{
/* Create the mutex - this should be invoked by the Objective-C runtime
(in a thread-safe manner) before any one can use this module, so I
don't think I need to worry about race conditions here. */
if (nil == pThreadMessagePorts) {
pthread_mutex_init(&pGate, NULL);
pThreadMessagePorts =
NSCreateMapTable(NSNonRetainedObjectMapKeyCallBacks,
NSObjectMapValueCallBacks, 0);
pThreadMessageLocks = NSCreateMapTable(NSNonRetainedObjectMapKeyCallBacks,
NSObjectMapValueCallBacks, 0);
[[NSNotificationCenter defaultCenter]
addObserver:[self class]
selector:@selector(threadDied:)
name:NSThreadWillExitNotification
object:nil];
}
}
+ (void) threadDied:(NSNotification *)notification
{
NSThread *thread;
NSRunLoop *runLoop;
thread = [notification object];
runLoop = [thread runLoop];
if (nil != runLoop) {
ConnectionRemoveMessagePortForThread(thread, [thread runLoop]);
}
}
+ (void) handlePortMessage:(NSPortMessage *)portMessage
{
ConnectionInterThreadMessage *msg;
NSArray *components;
NSData *data;
components = [portMessage components];
assert(1 == [components count]);
data = [components objectAtIndex:0];
msg = *((ConnectionInterThreadMessage **) [data bytes]);
switch (msg->type)
{
case kITMPostNotification:
[[NSNotificationCenter defaultCenter]
postNotification:msg->data.notification];
[msg->data.notification release];
break;
case kITMPerformSelector0Args:
[msg->data.sel.receiver performSelector:msg->data.sel.selector withObject:nil afterDelay:0.0];
[msg->data.sel.receiver release];
break;
case kITMPerformSelector1Args:
[msg->data.sel.receiver performSelector:msg->data.sel.selector
withObject:msg->data.sel.arg1
afterDelay:0.0];
[msg->data.sel.receiver release];
[msg->data.sel.arg1 release];
break;
case kITMPerformSelector2Args:
[msg->data.sel.receiver performSelector:msg->data.sel.selector
withObject:msg->data.sel.arg1
withObject:msg->data.sel.arg2];
[msg->data.sel.receiver release];
[msg->data.sel.arg1 release];
[msg->data.sel.arg2 release];
break;
default:
assert(0);
}
free(msg);
}
@end
static void
ConnectionPostMessage (ConnectionInterThreadMessage *message, NSThread *thread, NSDate *limitDate)
{
NSPortMessage *portMessage;
NSMutableArray *components;
NSPort *port, *replyPort;
NSData *data;
BOOL retval;
if (nil == thread) { thread = [NSThread currentThread]; }
port = ConnectionMessagePortForThread(thread);
replyPort = ConnectionMessagePortForThread([NSThread currentThread]);
assert(nil != port);
data = [[NSData alloc] initWithBytes:&message length:sizeof(void *)];
components = [[NSMutableArray alloc] initWithObjects:&data count:1];
portMessage = [[NSPortMessage alloc] initWithSendPort:port
receivePort:replyPort
components:components];
if (nil == limitDate || [limitDate timeIntervalSinceNow] > 0 ) { limitDate = [NSDate dateWithTimeIntervalSinceNow:1.5]; }
NSLock *ourLock = ConnectionMessageLockForThread([NSThread currentThread]);
NSLock *receiverLock = ConnectionMessageLockForThread(thread);
if (![ourLock tryLock])
{
[[NSThread currentThread] delayPostingMessage:message thread:thread];
[portMessage release];
[components release];
[data release];
return;
}
if (![receiverLock tryLock])
{
[ourLock unlock];
[[NSThread currentThread] delayPostingMessage:message thread:thread];
[portMessage release];
[components release];
[data release];
return;
}
@try {
retval = [portMessage sendBeforeDate:limitDate];
}
@catch (NSException *ex) {
}
@finally {
if (!retval)
{
[[NSThread currentThread] delayPostingMessage:message thread:thread];
}
[ourLock unlock];
[receiverLock unlock];
[portMessage release];
[components release];
[data release];
}
}
static void
ConnectionPerformSelector (ConnectionInterThreadMessageType type, SEL selector, id receiver,
id object1, id object2, NSThread *thread, NSDate *limitDate)
{
ConnectionInterThreadMessage *msg;
assert(NULL != selector);
if (nil != receiver) {
msg = (ConnectionInterThreadMessage *) malloc(sizeof(struct ConnectionInterThreadMessage));
bzero(msg, sizeof(struct ConnectionInterThreadMessage));
msg->type = type;
msg->data.sel.selector = selector;
msg->data.sel.receiver = [receiver retain];
msg->data.sel.arg1 = [object1 retain];
msg->data.sel.arg2 = [object2 retain];
ConnectionPostMessage(msg, thread, limitDate);
}
}
static void
ConnectionPostNotification (NSNotification *notification, NSThread *thread,
NSDate *limitDate)
{
ConnectionInterThreadMessage *msg;
assert(nil != notification);
msg = (ConnectionInterThreadMessage *) malloc(sizeof(struct ConnectionInterThreadMessage));
bzero(msg, sizeof(struct ConnectionInterThreadMessage));
msg->type = kITMPostNotification;
msg->data.notification = [notification retain];
ConnectionPostMessage(msg, thread, limitDate);
}
@implementation NSObject (ConnectionInterThreadMessaging)
- (void)postDelayedMessage:(NSNumber *)type
thread:(NSThread *)thread
notification:(NSNotification *)notification
selector:(SEL)selector
receiver:(id)receiver
arg1:(id)arg1
arg2:(id)arg2
{
KTLog(CKThreadingDomain, KTLogDebug, @"resending delayed message: %@ to %@", NSStringFromSelector(selector), receiver);
ConnectionInterThreadMessage *msg = (ConnectionInterThreadMessage *) malloc(sizeof(struct ConnectionInterThreadMessage));
bzero(msg, sizeof(struct ConnectionInterThreadMessage));
// we have already retained our args from the initial creation of the msg
switch([type unsignedIntValue])
{
case kITMPostNotification:
msg->type = kITMPostNotification;
msg->data.notification = notification;
break;
case kITMPerformSelector0Args:
msg->type = kITMPerformSelector0Args;
msg->data.sel.receiver = receiver;
msg->data.sel.selector = selector;
msg->data.sel.arg1 = nil;
msg->data.sel.arg2 = nil;
break;
case kITMPerformSelector1Args:
msg->type = kITMPerformSelector1Args;
msg->data.sel.receiver = receiver;
msg->data.sel.selector = selector;
msg->data.sel.arg1 = arg1;
msg->data.sel.arg2 = nil;
break;
case kITMPerformSelector2Args:
msg->type = kITMPerformSelector2Args;
msg->data.sel.receiver = receiver;
msg->data.sel.selector = selector;
msg->data.sel.arg1 = arg1;
msg->data.sel.arg2 = arg2;
break;
default:
assert(0);
}
ConnectionPostMessage(msg, thread, nil);
}
- (void)delayPostingMessage:(ConnectionInterThreadMessage *)msg thread:(NSThread *)thread
{
KTLog(CKThreadingDomain, KTLogDebug, @"delaying message: %@ to %@", NSStringFromSelector(msg->data.sel.selector), msg->data.sel.receiver);
NSInvocation *inv = [NSInvocation invocationWithSelector:@selector(postDelayedMessage:thread:notification:selector:receiver:arg1:arg2:)
target:self
arguments:[NSArray array]];
NSNumber *type = [NSNumber numberWithUnsignedInt:msg->type];
[inv setArgument:&type atIndex:2];
[inv setArgument:&thread atIndex:3];
if (msg->type == kITMPostNotification)
{
[inv setArgument:&msg->data.notification atIndex:4];
}
else
{
[inv setArgument:&msg->data.sel.selector atIndex:5];
[inv setArgument:&msg->data.sel.receiver atIndex:6];
if (msg->data.sel.arg1)
[inv setArgument:&msg->data.sel.arg1 atIndex:7];
if (msg->data.sel.arg2)
[inv setArgument:&msg->data.sel.arg2 atIndex:8];
}
[inv retainArguments];
[inv performSelector:@selector(invoke) withObject:nil afterDelay:0.0];
free(msg);
}
- (void) performSelector:(SEL)selector
inThread:(NSThread *)thread
{
ConnectionPerformSelector(kITMPerformSelector0Args, selector, self, nil, nil,
thread, nil);
}
- (void) performSelector:(SEL)selector
inThread:(NSThread *)thread
beforeDate:(NSDate *)limitDate
{
ConnectionPerformSelector(kITMPerformSelector0Args, selector, self, nil, nil,
thread, limitDate);
}
- (void) performSelector:(SEL)selector
withObject:(id)object
inThread:(NSThread *)thread
{
ConnectionPerformSelector(kITMPerformSelector1Args, selector, self, object, nil,
thread, nil);
}
- (void) performSelector:(SEL)selector
withObject:(id)object
inThread:(NSThread *)thread
beforeDate:(NSDate *)limitDate
{
ConnectionPerformSelector(kITMPerformSelector1Args, selector, self, object, nil,
thread, limitDate);
}
- (void) performSelector:(SEL)selector
withObject:(id)object1
withObject:(id)object2
inThread:(NSThread *)thread
{
ConnectionPerformSelector(kITMPerformSelector2Args, selector, self, object1, object2,
thread, nil);
}
- (void) performSelector:(SEL)selector
withObject:(id)object1
withObject:(id)object2
inThread:(NSThread *)thread
beforeDate:(NSDate *)limitDate
{
ConnectionPerformSelector(kITMPerformSelector2Args, selector, self, object1, object2,
thread, limitDate);
}
@end
@implementation NSNotificationCenter (ConnectionInterThreadMessaging)
- (void) postNotification:(NSNotification *)notification
inThread:(NSThread *)thread
{
ConnectionPostNotification(notification, thread, nil);
}
- (void) postNotification:(NSNotification *)notification
inThread:(NSThread *)thread
beforeDate:(NSDate *)limitDate
{
ConnectionPostNotification(notification, thread, limitDate);
}
- (void) postNotificationName:(NSString *)name
object:(id)object
inThread:(NSThread *)thread
{
NSNotification *notification;
notification = [NSNotification notificationWithName:name
object:object
userInfo:nil];
ConnectionPostNotification(notification, thread, nil);
}
- (void) postNotificationName:(NSString *)name
object:(id)object
inThread:(NSThread *)thread
beforeDate:(NSDate *)limitDate
{
NSNotification *notification;
notification = [NSNotification notificationWithName:name
object:object
userInfo:nil];
ConnectionPostNotification(notification, thread, limitDate);
}
- (void) postNotificationName:(NSString *)name
object:(id)object
userInfo:(NSDictionary *)userInfo
inThread:(NSThread *)thread
{
NSNotification *notification;
notification = [NSNotification notificationWithName:name
object:object
userInfo:userInfo];
ConnectionPostNotification(notification, thread, nil);
}
- (void) postNotificationName:(NSString *)name
object:(id)object
userInfo:(NSDictionary *)userInfo
inThread:(NSThread *)thread
beforeDate:(NSDate *)limitDate
{
NSNotification *notification;
notification = [NSNotification notificationWithName:name
object:object
userInfo:userInfo];
ConnectionPostNotification(notification, thread, limitDate);
}
@end
@implementation NSInvocation ( Connection )
+ (NSInvocation *)invocationWithSelector:(SEL)aSelector target:(id)aTarget arguments:(NSArray *)anArgumentArray
{
NSMethodSignature *methodSignature = [aTarget methodSignatureForSelector:aSelector];
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSignature];
if ( nil != invocation )
{
[invocation setSelector:aSelector];
if (nil != aTarget)
{
[invocation setTarget:aTarget];
}
if ( (nil != anArgumentArray) && ([anArgumentArray count] > 0) )
{
NSEnumerator *e = [anArgumentArray objectEnumerator];
id argument;
int argumentIndex = 2; // arguments start at index 2 per NSInvocation.h
while ( argument = [e nextObject] )
{
if ( [argument isMemberOfClass:[NSNull class]] )
{
[invocation setArgument:nil atIndex:argumentIndex];
}
else
{
[invocation setArgument:&argument atIndex:argumentIndex];
}
argumentIndex++;
}
[invocation retainArguments];
}
}
return invocation;
}
@end