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
|
//=============================================================================
/**
* @file Thread_Pool_Test.cpp
*
* This test program illustrates how the <ACE_Task>
* synchronization mechanisms work in conjunction with the
* <ACE_Thread_Manager>. If the <manual> flag is set input comes
* from stdin until the user enters a return -- otherwise, the
* input is generated automatically. All worker threads shutdown
* when (1) they receive a message block of length 0 or (2) the
* queue is deactivated.
*
* @author Karlheinz Dorn <Karlheinz.Dorn@med.siemens.de>
* @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
* @author and Prashant Jain <pjain@cs.wustl.edu>
*/
//=============================================================================
#include "test_config.h"
#include "ace/Task.h"
#if defined (ACE_HAS_THREADS)
#include "ace/Lock_Adapter_T.h"
#include "ace/OS_NS_stdio.h"
#include "ace/OS_NS_string.h"
#include "ace/OS_NS_unistd.h"
// Number of iterations to run the test.
static size_t n_iterations = 100;
// Controls whether the input is generated "manually" or automatically.
static int manual = 0;
/**
* @class Thread_Pool
*
* @brief Defines a thread pool abstraction based on the <ACE_Task>.
*/
class Thread_Pool : public ACE_Task<ACE_MT_SYNCH>
{
public:
/// Create the thread pool containing <n_threads>.
Thread_Pool (int n_threads);
/// Destructor...
~Thread_Pool ();
/**
* Activate the task's thread pool, produce the messages that are
* consumed by the threads in the thread pool, and demonstate how to
* shutdown using the <ACE_Message_Queue::deactivate> method.
*/
int test_queue_deactivation_shutdown ();
/**
* Activate the task's thread pool, produce the messages that are,
* produce the messages that are consumed by the threads in the
* thread pool, and demonstrate how to shutdown by enqueueing
* "empty" messages into the queue.
*/
int test_empty_message_shutdown ();
/// Iterate <n_iterations> time printing off a message and "waiting"
/// for all other threads to complete this iteration.
virtual int svc ();
/// Allows the producer to pass messages to the <Thread_Pool>.
virtual int put (ACE_Message_Block *mb,
ACE_Time_Value *tv = 0);
private:
//FUZZ: disable check_for_lack_ACE_OS
/// Spawn the threads in the pool.
virtual int open (void * = 0);
//FUZZ: enable check_for_lack_ACE_OS
/// Close hook.
virtual int close (u_long);
/// Serialize access to <ACE_Message_Block> reference count, which
/// will be decremented by multiple threads.
ACE_Lock_Adapter<ACE_Thread_Mutex> lock_adapter_;
/// Number of threads to spawn.
int n_threads_;
};
Thread_Pool::~Thread_Pool ()
{
}
int
Thread_Pool::close (u_long)
{
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) worker thread closing down\n")));
return 0;
}
Thread_Pool::Thread_Pool (int n_threads)
: n_threads_ (n_threads)
{
}
// Simply enqueue the Message_Block into the end of the queue.
int
Thread_Pool::put (ACE_Message_Block *mb,
ACE_Time_Value *tv)
{
return this->putq (mb, tv);
}
// Iterate <n_iterations> printing off a message and "waiting" for all
// other threads to complete this iteration.
int
Thread_Pool::svc ()
{
// Keep looping, reading a message out of the queue, until we get a
// message with a length == 0, which signals us to quit.
for (int count = 1; ; count++)
{
ACE_Message_Block *mb = 0;
int result = this->getq (mb);
ACE_TEST_ASSERT (result != -1 || errno == ESHUTDOWN);
if (result == -1 && errno == ESHUTDOWN)
{
// The queue has been deactivated, so let's bail out.
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) in iteration %d, queue len = %d, ")
ACE_TEXT ("queue deactivated, exiting\n"),
count,
this->msg_queue ()->message_count ()));
break;
}
size_t length = mb->length ();
if (length > 0)
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) in iteration %d, queue len = %d, ")
ACE_TEXT ("length = %d, text = \"%*s\"\n"),
count,
this->msg_queue ()->message_count (),
length,
length - 1,
mb->rd_ptr ()));
// We're responsible for deallocating this.
mb->release ();
if (length == 0)
{
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) in iteration %d, queue len = %d, ")
ACE_TEXT ("got \"empty\" message, exiting\n"),
count,
this->msg_queue ()->message_count ()));
break;
}
}
// Note that the <ACE_Task::svc_run> method automatically removes us
// from the <ACE_Thread_Manager> when the thread exits.
return 0;
}
int
Thread_Pool::open (void *)
{
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) producer start, dumping the Thread_Pool\n")));
this->dump ();
// Create a pool of worker threads.
if (this->activate (THR_NEW_LWP,
this->n_threads_) == -1)
ACE_ERROR_RETURN ((LM_ERROR,
ACE_TEXT ("%p\n"),
ACE_TEXT ("activate failed")),
-1);
return 0;
}
// Activate the task's thread pool, produce the messages that are
// consumed by the threads in the thread pool, and demonstate how to
// shutdown using the <ACE_Message_Queue::deactivate> method.
int
Thread_Pool::test_queue_deactivation_shutdown ()
{
if (this->open () == -1)
return -1;
ACE_Message_Block *mb = 0;
// Run the main loop that generates messages and enqueues them into
// the pool of threads managed by <ACE_Task>.
for (size_t count = 0;
;
count++)
{
ssize_t n = 0;
// Allocate a new message.
ACE_NEW_RETURN (mb,
ACE_Message_Block (BUFSIZ,
ACE_Message_Block::MB_DATA,
0,
0,
0,
&this->lock_adapter_),
-1);
if (manual)
{
#if !defined (ACE_HAS_WINCE)
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) enter a new message for ")
ACE_TEXT ("the task pool...")));
n = ACE_OS::read (ACE_STDIN,
mb->wr_ptr (),
mb->size ());
#endif // ACE_HAS_WINCE
}
else
{
static size_t count = 0;
ACE_OS::snprintf (reinterpret_cast<ACE_TCHAR *> (mb->wr_ptr ()), BUFSIZ,
ACE_SIZE_T_FORMAT_SPECIFIER,
count);
n = ACE_OS::strlen (mb->rd_ptr ());
if (count == n_iterations)
n = 1; // Indicate that we need to shut down.
else
count++;
if (count == 0 || (count % 20 == 0))
ACE_OS::sleep (1);
}
if (n > 1)
{
// Send a normal message to the waiting threads and continue
// producing.
mb->wr_ptr (n * sizeof (ACE_TCHAR));
// Pass the message to the Thread_Pool.
if (this->put (mb) == -1)
ACE_ERROR ((LM_ERROR,
ACE_TEXT (" (%t) %p\n"),
ACE_TEXT ("put")));
}
else
{
// Release the <Message_Block> since we're shutting down and
// don't need it anymore.
mb->release ();
// Deactivate the message queue and return.
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("\n(%t) deactivating queue for %d threads, ")
ACE_TEXT ("dump of task:\n"),
this->thr_count ()));
this->dump ();
// Deactivate the queue.
return this->msg_queue ()->deactivate ();
}
}
}
// Activate the task's thread pool, produce the messages that are,
// produce the messages that are consumed by the threads in the thread
// pool, and demonstrate how to shutdown by enqueueing "empty"
// messages into the queue.
int
Thread_Pool::test_empty_message_shutdown ()
{
if (this->open () == -1)
return -1;
ACE_Message_Block *mb = 0;
// Run the main loop that generates messages and enqueues them into
// the pool of threads managed by <ACE_Task>.
for (size_t count = 0;
;
count++)
{
ssize_t n = 0;
// Allocate a new message.
ACE_NEW_RETURN (mb,
ACE_Message_Block (BUFSIZ,
ACE_Message_Block::MB_DATA,
0,
0,
0,
&this->lock_adapter_),
-1);
if (manual)
{
#if !defined (ACE_HAS_WINCE)
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) enter a new message for ")
ACE_TEXT ("the task pool...")));
n = ACE_OS::read (ACE_STDIN,
mb->wr_ptr (),
mb->size ());
#endif // ACE_HAS_WINCE
}
else
{
static size_t count = 0;
ACE_OS::snprintf (reinterpret_cast<ACE_TCHAR *> (mb->wr_ptr ()), BUFSIZ,
ACE_SIZE_T_FORMAT_SPECIFIER,
count);
n = ACE_OS::strlen (mb->rd_ptr ());
if (count == n_iterations)
n = 1; // Indicate that we need to shut down.
else
count++;
if (count == 0 || (count % 20 == 0))
ACE_OS::sleep (1);
}
if (n > 1)
{
// Send a normal message to the waiting threads and continue
// producing.
mb->wr_ptr (n * sizeof (ACE_TCHAR));
// Pass the message to the Thread_Pool.
if (this->put (mb) == -1)
ACE_ERROR ((LM_ERROR,
ACE_TEXT (" (%t) %p\n"),
ACE_TEXT ("put")));
}
else
{
// Send a shutdown message to the waiting threads and return.
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("\n(%t) sending shutdown message to %d threads, ")
ACE_TEXT ("dump of task:\n"),
this->thr_count ()));
this->dump ();
size_t i = 0;
// Enqueue an empty message to flag each consumer thread to
// inform it to shutdown.
for (i = this->thr_count ();
i > 0;
i--)
{
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) end of input, ")
ACE_TEXT ("enqueueing \"empty\" message %d\n"),
i));
// Note the use of reference counting to avoid copying
// the message contents.
ACE_Message_Block *dup = mb->duplicate ();
if (this->put (dup) == -1)
ACE_ERROR ((LM_ERROR,
ACE_TEXT (" (%t) %p\n"),
ACE_TEXT ("put")));
}
mb->release ();
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("\n(%t) end loop, dump of task:\n")));
this->dump ();
return 0;
}
}
}
#endif /* ACE_HAS_THREADS */
int
run_main (int, ACE_TCHAR *[])
{
ACE_START_TEST (ACE_TEXT ("Thread_Pool_Test"));
#if defined (ACE_HAS_THREADS)
int n_threads = ACE_MAX_THREADS;
// Create the worker tasks.
Thread_Pool thread_pool (n_threads);
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) running test with %d threads\n"),
n_threads));
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) starting empty message shutdown test\n")));
// Activate the task's thread pool, produce the messages that are,
// produce the messages that are consumed by the threads in the
// thread pool, and demonstrate how to shutdown by enqueueing
// "empty" messages into the queue.
if (thread_pool.test_empty_message_shutdown () == -1)
return 1;
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) waiting for worker tasks to finish...\n")));
// Wait for all the threads to reach their exit point, at which
// point the barrier in the destructor of the <ACE_Task> portion of
// <Thread_Pool> will return.
if (thread_pool.wait () == -1)
return 1;
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) starting queue deactivation shutdown test\n")));
// Activate the task's thread pool, produce the messages that are
// consumed by the threads in the thread pool, and demonstate how to
// shutdown using the <ACE_Message_Queue::deactivate> method.
if (thread_pool.test_queue_deactivation_shutdown () == -1)
return 1;
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) waiting for worker tasks to finish...\n")));
// Wait for all the threads to reach their exit point, at which
// point the barrier in the destructor of the <ACE_Task> portion of
// <Thread_Pool> will return.
if (thread_pool.wait () == -1)
return 1;
ACE_DEBUG ((LM_DEBUG,
ACE_TEXT ("(%t) all worker tasks destroyed, exiting test...\n")));
#else
ACE_ERROR ((LM_INFO,
ACE_TEXT ("threads not supported on this platform\n")));
#endif /* ACE_HAS_THREADS */
ACE_END_TEST;
return 0;
}
|