-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathlisting1.html
executable file
·508 lines (411 loc) · 19.6 KB
/
listing1.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>AESendThreadSafe - /AESendThreadSafe.c</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Carbon/index.html">Carbon</a> > <a href="../../samplecode/Carbon/idxInterapplicationCommunication-date.html">Interapplication Communication</a> > <A HREF="javascript:location.replace('index.html');">AESendThreadSafe</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">AESendThreadSafe</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/AESendThreadSafe.c</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/AESendThreadSafe.c</option>
<option value="listing2.html">/AESendThreadSafe.h</option>
<option value="listing3.html">/main.m</option>
<option value="listing4.html">/Read Me About AESendThreadSafe.txt</option>
<option value="listing5.html">/Test.m</option></select>
</p>
</form>
<p><strong><a href="AESendThreadSafe.zip">Download Sample</a></strong> (“AESendThreadSafe.zip”, 65.1K)<BR>
<strong><a href="AESendThreadSafe.dmg">Download Sample</a></strong> (“AESendThreadSafe.dmg”, 125.0K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: AESendThreadSafe.c
Contains: Code to send Apple events in a thread-safe manner.
Written by: DTS
Copyright: Copyright (c) 2007 Apple Inc. All Rights Reserved.
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc.
("Apple") in consideration of your agreement to the following
terms, and your use, installation, modification or
redistribution of this Apple software constitutes acceptance of
these terms. If you do not agree with these terms, please do
not use, install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following
terms, and subject to these terms, Apple grants you a personal,
non-exclusive license, under Apple's copyrights in this
original Apple software (the "Apple Software"), to use,
reproduce, modify and redistribute the Apple Software, with or
without modifications, in source and/or binary forms; provided
that if you redistribute the Apple Software in its entirety and
without modifications, you must retain this notice and the
following text and disclaimers in all such redistributions of
the Apple Software. Neither the name, trademarks, service marks
or logos of Apple Inc. may be used to endorse or promote
products derived from the Apple Software without specific prior
written permission from Apple. Except as expressly stated in
this notice, no other rights or licenses, express or implied,
are granted by Apple herein, including but not limited to any
patent rights that may be infringed by your derivative works or
by other works in which the Apple Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis.
APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING
THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT,
INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY
OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY
OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
Change History (most recent first):
$Log: AESendThreadSafe.c,v $
Revision 1.3 2007/02/27 10:45:15
In the destructor, add an assert that the thread-local storage has been set to NULL. Also fixed a comment typo.
Revision 1.2 2007/02/12 11:59:09
Added a type cast for the malloc result.
Revision 1.1 2007/02/09 10:55:24
First checked in.
*/
/////////////////////////////////////////////////////////////////
#include "AESendThreadSafe.h"
#include <pthread.h>
#include <mach/mach.h>
/////////////////////////////////////////////////////////////////
/*
How It Works
------------
The basic idea behind this module is that it uses per-thread storage to keep
track of an Apple event reply for any given thread. The first time that the
thread calls AESendMessageThreadSafeSynchronous, the per-thread storage will
not be initialised and the code will grab an Apple event reply port and
assign it to the per-thread storage. Subsequent calls to AESendMessageThreadSafeSynchronous
will continue to use that port. When the thread dies, pthreads will automatically
call the destructor for the per-thread storage, and that will clean up the port.
Because we can't dispose of the reply port (without triggering the Apple
Event Manager bug that's the reason we wrote this code in the first place),
the destructor doesn't actually dispose of the port. Rather, it adds the
port to a pool of ports that are available for reuse. The next time a thread
needs to allocate a port, it will grab it from the pool rather than allocating
it from scratch.
This technique means that the code still 'leaks' Apple event reply ports, but
the size of the leak is limited to the maximum number of threads that you run
simultaneously. This isn't a problem in practice.
*/
/////////////////////////////////////////////////////////////////
// The PerThreadStorage structure is a trivial wrapper around the Mach port.
// I added this because I need to attach this structure a thread using
// per-thread storage. The API for that (<x-man-page://3/pthread_setspecific>)
// is pointer based. I could've just cast the Mach port to a (void *), but
// that's ugly because of a) pointer size issues (are pointers always bigger than
// ints?), and b) because it implies an equivalent between NULL and MACH_PORT_NULL.
// Given this, I simply decided to create a structure to wrap the Mach port.
enum {
kPerThreadStorageMagic = 'PTSm'
};
struct PerThreadStorage {
OSType magic; // must be kPerThreadStorageMagic
mach_port_t port;
};
typedef struct PerThreadStorage PerThreadStorage;
// The following static variables manage the per-thread storage key
// (sPerThreadStorageKey) and the pool of Mach ports (wrapped in
// PerThreadStorage structures) that are not currently attached to a thread.
static pthread_once_t sInited = PTHREAD_ONCE_INIT; // covers initialisation of all of the
// following static variables
static OSStatus sPerThreadStorageKeyInitErrNum; // latches result of initialisation
static pthread_key_t sPerThreadStorageKey = 0; // key for our per-thread storage
static pthread_mutex_t sPoolMutex; // protects sPool
static CFMutableArrayRef sPool; // array of (PerThreadStorage *), holds
// the ports that aren't currently bound to
// a thread
static void PerThreadStorageDestructor(void *keyValue); // forward declaration
static void InitRoutine(void)
// Call once (via pthread_once) to initialise various static variables.
{
OSStatus err;
// Create the per-thread storage key. Note that we assign a destructor to this key;
// pthreads call the destructor to clean up that item of per-thread storage whenever
// a thread terminates.
err = (OSStatus) pthread_key_create(&sPerThreadStorageKey, PerThreadStorageDestructor);
// Create the pool of Mach ports that aren't bound to any thread, and its associated
// lock. The pool starts out empty.
if (err == noErr) {
err = (OSStatus) pthread_mutex_init(&sPoolMutex, NULL);
}
if (err == noErr) {
sPool = CFArrayCreateMutable(NULL, 0, NULL);
if (sPool == NULL) {
err = coreFoundationUnknownErr;
}
}
assert(err == 0);
sPerThreadStorageKeyInitErrNum = err;
}
static OSStatus AllocatePortFromPool(PerThreadStorage **storagePtr)
// Grab a Mach port from sPool; if sPool is empty, create one.
{
OSStatus err;
OSStatus junk;
PerThreadStorage * storage;
assert( storagePtr != NULL);
assert(*storagePtr == NULL);
storage = NULL;
// First try to get an entry from pool. We try to grab the last one because
// that minimises the amount of copying that CFArrayRemoveValueAtIndex has to
// do.
err = (OSStatus) pthread_mutex_lock(&sPoolMutex);
if (err == noErr) {
CFIndex poolCount;
poolCount = CFArrayGetCount(sPool);
if (poolCount > 0) {
storage = (PerThreadStorage *) CFArrayGetValueAtIndex(sPool, poolCount - 1);
CFArrayRemoveValueAtIndex(sPool, poolCount - 1);
}
junk = (OSStatus) pthread_mutex_unlock(&sPoolMutex);
assert(junk == noErr);
}
// If we failed to find an entry in the pool, create a new one.
if ( (err == noErr) && (storage == NULL) ) {
storage = (PerThreadStorage *) malloc(sizeof(*storage));
if (storage == NULL) {
err = memFullErr;
} else {
storage->magic = kPerThreadStorageMagic;
storage->port = MACH_PORT_NULL;
err = (OSStatus) mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &storage->port);
if (err != noErr) {
assert(storage->port == MACH_PORT_NULL);
free(storage);
storage = NULL;
}
}
}
if (err == noErr) {
*storagePtr = storage;
}
assert( (err == noErr) == (*storagePtr != NULL) );
assert( (*storagePtr == NULL) || ((*storagePtr)->magic == kPerThreadStorageMagic) );
assert( (*storagePtr == NULL) || ((*storagePtr)->port != MACH_PORT_NULL) );
return err;
}
static void ReturnPortToPool(PerThreadStorage * storage)
// Returns a port to sPool.
{
OSStatus err;
assert(storage != NULL);
assert(storage->magic == kPerThreadStorageMagic);
assert(storage->port != MACH_PORT_NULL);
err = (OSStatus) pthread_mutex_lock(&sPoolMutex);
if (err == noErr) {
CFArrayAppendValue(sPool, storage);
err = (OSStatus) pthread_mutex_unlock(&sPoolMutex);
}
assert(err == noErr);
}
// Main Thread Notes
// -----------------
// There are two reasons why we don't assign a reply port to the main thread.
// First, the main thread already has a reply port created for it by Apple
// Event Manager. Thus, we don't need a specific reply port. Also, the
// destructor for per-thread storage isn't called for the main thread, so
// we wouldn't get a chance to clean up (although that's not really a problem
// in practice).
static OSStatus BindReplyMachPortToThread(mach_port_t *replyPortPtr)
// Get a reply port for this thread, remembering that we've done this
// in per-thread storage.
//
// On success, *replyPortPtr is the port to use for this thread's reply
// port. It will be MACH_PORT_NULL if you call it from the main thread.
{
OSStatus err;
assert( replyPortPtr != NULL);
assert(*replyPortPtr == MACH_PORT_NULL);
// Initialise ourselves the first time that we're called.
err = (OSStatus) pthread_once(&sInited, InitRoutine);
// If something went wrong, return the latched error.
if ( (err == noErr) && (sPerThreadStorageKeyInitErrNum != noErr) ) {
err = sPerThreadStorageKeyInitErrNum;
}
// Now do the real work.
if (err == noErr) {
if ( pthread_main_np() ) {
// This is the main thread, so do nothing; leave *replyPortPtr set
// to MACH_PORT_NULL.
assert(*replyPortPtr == MACH_PORT_NULL);
} else {
PerThreadStorage * storage;
// Get the per-thread storage for this thread.
storage = (PerThreadStorage *) pthread_getspecific(sPerThreadStorageKey);
if (storage == NULL) {
// The per-thread storage hasn't been allocated yet for this specific
// thread. Let's go allocate it and attach it to this thread.
err = AllocatePortFromPool(&storage);
if (err == noErr) {
err = (OSStatus) pthread_setspecific(sPerThreadStorageKey, (void *) storage);
if (err != noErr) {
ReturnPortToPool(storage);
storage = NULL;
}
}
}
assert( (err == noErr) == (storage != NULL) );
// If all went well, copy the port out to our client.
if (err == noErr) {
assert(storage->magic == kPerThreadStorageMagic);
assert(storage->port != MACH_PORT_NULL);
*replyPortPtr = storage->port;
}
}
}
// no error + MACH_PORT_NULL is a valid response if we're on the main
// thread.
//
// assert( (err == noErr) == (*replyPortPtr != MACH_PORT_NULL) );
assert( (*replyPortPtr == MACH_PORT_NULL) || (err == noErr) );
return err;
}
static void PerThreadStorageDestructor(void *keyValue)
// Called by pthreads when a thread dies and it has a non-null value for our
// per-thread storage key. We use this callback to return the thread's
// Apple event reply port to the pool.
{
PerThreadStorage * storage;
storage = (PerThreadStorage *) keyValue;
assert(storage != NULL); // pthread won't call us if it's NULL
assert(storage->magic == kPerThreadStorageMagic);
assert(storage->port != MACH_PORT_NULL);
// Return the port associated with this thread to the pool.
ReturnPortToPool(storage);
// pthreads has already set this thread's per-thread storage for our key to
// NULL before calling us. So we don't need to do anything to remove it.
assert( pthread_getspecific(sPerThreadStorageKey) == NULL );
}
extern OSStatus AESendMessageThreadSafeSynchronous(
AppleEvent * eventPtr,
AppleEvent * replyPtr,
long timeOutInTicks
)
// See comment in header.
{
OSStatus err;
mach_port_t replyPort;
assert(eventPtr != NULL);
assert(replyPtr != NULL);
replyPort = MACH_PORT_NULL;
// Set up the reply port if necessary.
err = BindReplyMachPortToThread(&replyPort);
if ( (err == noErr) && (replyPort != MACH_PORT_NULL) ) {
err = AEPutAttributePtr(eventPtr, keyReplyPortAttr, typeMachPort, &replyPort, sizeof(replyPort));
}
// Call through to AESendMessage.
if (err == noErr) {
err = AESendMessage(eventPtr, replyPtr, kAEWaitReply, timeOutInTicks);
}
return err;
}
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/AESendThreadSafe/listing1.html%3Fid%3DDTS10004229-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/AESendThreadSafe/listing1.html%3Fid%3DDTS10004229-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/AESendThreadSafe/listing1.html%3Fid%3DDTS10004229-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>