task.c 20.1 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1 2 3

#include <isc/assertions.h>

Bob Halley's avatar
Bob Halley committed
4
#include <isc/thread.h>
5 6
#include <isc/mutex.h>
#include <isc/condition.h>
7
#include <isc/error.h>
Bob Halley's avatar
Bob Halley committed
8
#include <isc/task.h>
Bob Halley's avatar
base  
Bob Halley committed
9

Bob Halley's avatar
Bob Halley committed
10 11 12 13

/***
 *** General Macros.
 ***/
Bob Halley's avatar
base  
Bob Halley committed
14

Bob Halley's avatar
update  
Bob Halley committed
15
/*
Bob Halley's avatar
Bob Halley committed
16
 * We use macros instead of calling the routines directly because
Bob Halley's avatar
update  
Bob Halley committed
17 18 19 20
 * the capital letters make the locking stand out.
 *
 * We INSIST that they succeed since there's no way for us to continue
 * if they fail.
Bob Halley's avatar
update  
Bob Halley committed
21
 */
Bob Halley's avatar
Bob Halley committed
22 23 24 25 26 27 28

#define LOCK(lp) \
	INSIST(isc_mutex_lock((lp)) == ISC_R_SUCCESS);
#define UNLOCK(lp) \
	INSIST(isc_mutex_unlock((lp)) == ISC_R_SUCCESS);
#define BROADCAST(cvp) \
	INSIST(isc_condition_broadcast((cvp)) == ISC_R_SUCCESS);
29 30
#define SIGNAL(cvp) \
	INSIST(isc_condition_signal((cvp)) == ISC_R_SUCCESS);
Bob Halley's avatar
Bob Halley committed
31 32 33 34 35
#define WAIT(cvp, lp) \
	INSIST(isc_condition_wait((cvp), (lp)) == ISC_R_SUCCESS);
#define WAITUNTIL(cvp, lp, tp, bp) \
	INSIST(isc_condition_waituntil((cvp), (lp), (tp), (bp)) == \
	ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
36

Bob Halley's avatar
Bob Halley committed
37
#ifdef ISC_TASK_TRACE
Bob Halley's avatar
update  
Bob Halley committed
38
#define XTRACE(m)		printf("%s task %p thread %lu\n", (m), \
Bob Halley's avatar
Bob Halley committed
39
				       task, isc_thread_self())
Bob Halley's avatar
Bob Halley committed
40 41 42
#else
#define XTRACE(m)
#endif
Bob Halley's avatar
base  
Bob Halley committed
43

Bob Halley's avatar
Bob Halley committed
44 45

/***
Bob Halley's avatar
Bob Halley committed
46
 *** Types.
Bob Halley's avatar
Bob Halley committed
47 48
 ***/

Bob Halley's avatar
Bob Halley committed
49 50 51 52 53 54 55 56 57
typedef enum {
	task_state_idle, task_state_ready, task_state_running,
	task_state_shutdown
} task_state_t;

#define TASK_MAGIC			0x5441534BU	/* TASK. */
#define VALID_TASK(t)			((t) != NULL && \
					 (t)->magic == TASK_MAGIC)

Bob Halley's avatar
Bob Halley committed
58
struct isc_task {
Bob Halley's avatar
Bob Halley committed
59 60
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
61
	isc_taskmgr_t			manager;
Bob Halley's avatar
Bob Halley committed
62
	isc_mutex_t			lock;
Bob Halley's avatar
Bob Halley committed
63 64 65
	/* Locked by task lock. */
	task_state_t			state;
	unsigned int			references;
Bob Halley's avatar
Bob Halley committed
66
	isc_eventlist_t			events;
Bob Halley's avatar
Bob Halley committed
67
	unsigned int			quantum;
Bob Halley's avatar
Bob Halley committed
68
	isc_boolean_t			enqueue_allowed;
Bob Halley's avatar
Bob Halley committed
69
	isc_event_t			shutdown_event;
Bob Halley's avatar
Bob Halley committed
70
	/* Locked by task manager lock. */
Bob Halley's avatar
Bob Halley committed
71 72
	LINK(struct isc_task)		link;
	LINK(struct isc_task)		ready_link;
Bob Halley's avatar
Bob Halley committed
73 74 75 76 77 78
};

#define TASK_MANAGER_MAGIC		0x54534B4DU	/* TSKM. */
#define VALID_MANAGER(m)		((m) != NULL && \
					 (m)->magic == TASK_MANAGER_MAGIC)

Bob Halley's avatar
Bob Halley committed
79
struct isc_taskmgr {
Bob Halley's avatar
Bob Halley committed
80 81
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
82
	isc_memctx_t			mctx;
Bob Halley's avatar
Bob Halley committed
83
	isc_mutex_t			lock;
84 85
	unsigned int			workers;
	isc_thread_t *			threads;
Bob Halley's avatar
Bob Halley committed
86 87
	/* Locked by task manager lock. */
	unsigned int			default_quantum;
Bob Halley's avatar
Bob Halley committed
88 89
	LIST(struct isc_task)		tasks;
	LIST(struct isc_task)		ready_tasks;
Bob Halley's avatar
Bob Halley committed
90
	isc_condition_t			work_available;
Bob Halley's avatar
Bob Halley committed
91
	isc_boolean_t			exiting;
Bob Halley's avatar
Bob Halley committed
92
};
Bob Halley's avatar
Bob Halley committed
93

Bob Halley's avatar
Bob Halley committed
94 95
#define DEFAULT_DEFAULT_QUANTUM		5
#define FINISHED(m)			((m)->exiting && EMPTY((m)->tasks))
Bob Halley's avatar
Bob Halley committed
96

Bob Halley's avatar
update  
Bob Halley committed
97 98 99 100 101

/***
 *** Events.
 ***/

Bob Halley's avatar
Bob Halley committed
102
static inline isc_event_t
Bob Halley's avatar
Bob Halley committed
103
event_allocate(isc_memctx_t mctx, void *sender, isc_eventtype_t type,
Bob Halley's avatar
Bob Halley committed
104
	       isc_taskaction_t action, void *arg, size_t size)
Bob Halley's avatar
update  
Bob Halley committed
105
{
Bob Halley's avatar
Bob Halley committed
106
	isc_event_t event;
Bob Halley's avatar
update  
Bob Halley committed
107

Bob Halley's avatar
Bob Halley committed
108
	event = isc_mem_get(mctx, size);
Bob Halley's avatar
update  
Bob Halley committed
109 110 111 112
	if (event == NULL)
		return (NULL);
	event->mctx = mctx;
	event->size = size;
Bob Halley's avatar
Bob Halley committed
113
	event->sender = sender;
Bob Halley's avatar
update  
Bob Halley committed
114 115 116 117 118 119 120
	event->type = type;
	event->action = action;
	event->arg = arg;

	return (event);
}

Bob Halley's avatar
Bob Halley committed
121
isc_event_t
Bob Halley's avatar
Bob Halley committed
122 123
isc_event_allocate(isc_memctx_t mctx, void *sender, isc_eventtype_t type,
		   isc_taskaction_t action, void *arg, size_t size)
Bob Halley's avatar
update  
Bob Halley committed
124
{
Bob Halley's avatar
Bob Halley committed
125
	if (size < sizeof (struct isc_event))
Bob Halley's avatar
update  
Bob Halley committed
126 127 128 129 130 131
		return (NULL);
	if (type < 0)
		return (NULL);
	if (action == NULL)
		return (NULL);

Bob Halley's avatar
Bob Halley committed
132
	return (event_allocate(mctx, sender, type, action, arg, size));
Bob Halley's avatar
update  
Bob Halley committed
133 134 135
}

void
Bob Halley's avatar
Bob Halley committed
136 137
isc_event_free(isc_event_t *eventp) {
	isc_event_t event;
Bob Halley's avatar
update  
Bob Halley committed
138 139 140 141 142
	
	REQUIRE(eventp != NULL);
	event = *eventp;
	REQUIRE(event != NULL);

Bob Halley's avatar
Bob Halley committed
143 144
	if (event->destroy != NULL)
		(event->destroy)(event);
Bob Halley's avatar
Bob Halley committed
145
	isc_mem_put(event->mctx, event, event->size);
Bob Halley's avatar
update  
Bob Halley committed
146 147 148 149

	*eventp = NULL;
}

Bob Halley's avatar
base  
Bob Halley committed
150 151 152 153 154
/***
 *** Tasks.
 ***/

static void
Bob Halley's avatar
Bob Halley committed
155 156
task_free(isc_task_t task) {
	isc_taskmgr_t manager = task->manager;
Bob Halley's avatar
base  
Bob Halley committed
157

Bob Halley's avatar
Bob Halley committed
158
	XTRACE("free task");
Bob Halley's avatar
base  
Bob Halley committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172
	REQUIRE(EMPTY(task->events));

	LOCK(&manager->lock);
	UNLINK(manager->tasks, task, link);
	if (FINISHED(manager)) {
		/*
		 * All tasks have completed and the
		 * task manager is exiting.  Wake up
		 * any idle worker threads so they
		 * can exit.
		 */
		BROADCAST(&manager->work_available);
	}
	UNLOCK(&manager->lock);
Bob Halley's avatar
Bob Halley committed
173
	(void)isc_mutex_destroy(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
174
	if (task->shutdown_event != NULL)
Bob Halley's avatar
Bob Halley committed
175
		isc_event_free(&task->shutdown_event);
Bob Halley's avatar
base  
Bob Halley committed
176
	task->magic = 0;
Bob Halley's avatar
Bob Halley committed
177
	isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
178 179
}

Bob Halley's avatar
Bob Halley committed
180
isc_result_t
Bob Halley's avatar
Bob Halley committed
181 182
isc_task_create(isc_taskmgr_t manager, isc_taskaction_t shutdown_action,
		void *shutdown_arg, unsigned int quantum, isc_task_t *taskp)
Bob Halley's avatar
Bob Halley committed
183
{
Bob Halley's avatar
Bob Halley committed
184
	isc_task_t task;
Bob Halley's avatar
base  
Bob Halley committed
185 186 187 188

	REQUIRE(VALID_MANAGER(manager));
	REQUIRE(taskp != NULL && *taskp == NULL);

Bob Halley's avatar
Bob Halley committed
189
	task = isc_mem_get(manager->mctx, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
190
	if (task == NULL)
Bob Halley's avatar
Bob Halley committed
191
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
192 193 194

	task->magic = TASK_MAGIC;
	task->manager = manager;
Bob Halley's avatar
Bob Halley committed
195
	if (isc_mutex_init(&task->lock) != ISC_R_SUCCESS) {
Bob Halley's avatar
Bob Halley committed
196
		isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
Bob Halley committed
197 198 199
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_mutex_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
200
	}
Bob Halley's avatar
base  
Bob Halley committed
201 202 203 204
	task->state = task_state_idle;
	task->references = 1;
	INIT_LIST(task->events);
	task->quantum = quantum;
Bob Halley's avatar
Bob Halley committed
205
	task->enqueue_allowed = ISC_TRUE;
Bob Halley's avatar
update  
Bob Halley committed
206
	task->shutdown_event = event_allocate(manager->mctx,
Bob Halley's avatar
Bob Halley committed
207
					      NULL,
Bob Halley's avatar
Bob Halley committed
208
					      ISC_TASKEVENT_SHUTDOWN,
Bob Halley's avatar
update  
Bob Halley committed
209 210 211 212
					      shutdown_action,
					      shutdown_arg,
					      sizeof *task->shutdown_event);
	if (task->shutdown_event == NULL) {
Bob Halley's avatar
Bob Halley committed
213
		(void)isc_mutex_destroy(&task->lock);
Bob Halley's avatar
Bob Halley committed
214
		isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
Bob Halley committed
215
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
update  
Bob Halley committed
216
	}
Bob Halley's avatar
base  
Bob Halley committed
217 218 219 220 221 222 223 224 225 226 227
	INIT_LINK(task, link);
	INIT_LINK(task, ready_link);

	LOCK(&manager->lock);
	if (task->quantum == 0)
		task->quantum = manager->default_quantum;
	APPEND(manager->tasks, task, link);
	UNLOCK(&manager->lock);

	*taskp = task;

Bob Halley's avatar
Bob Halley committed
228
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
229 230
}

Bob Halley's avatar
update  
Bob Halley committed
231
void
Bob Halley's avatar
Bob Halley committed
232
isc_task_attach(isc_task_t task, isc_task_t *taskp) {
Bob Halley's avatar
base  
Bob Halley committed
233 234 235 236 237 238 239 240 241 242 243

	REQUIRE(VALID_TASK(task));
	REQUIRE(taskp != NULL && *taskp == NULL);

	LOCK(&task->lock);
	task->references++;
	UNLOCK(&task->lock);

	*taskp = task;
}

Bob Halley's avatar
Bob Halley committed
244
void
Bob Halley's avatar
Bob Halley committed
245
isc_task_detach(isc_task_t *taskp) {
Bob Halley's avatar
Bob Halley committed
246
	isc_boolean_t free_task = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
247
	isc_task_t task;
Bob Halley's avatar
base  
Bob Halley committed
248

Bob Halley's avatar
Bob Halley committed
249
	XTRACE("isc_task_detach");
Bob Halley's avatar
base  
Bob Halley committed
250 251 252 253 254 255 256 257

	REQUIRE(taskp != NULL);
	task = *taskp;
	REQUIRE(VALID_TASK(task));

	LOCK(&task->lock);
	REQUIRE(task->references > 0);
	task->references--;
258
	if (task->state == task_state_shutdown && task->references == 0)
Bob Halley's avatar
Bob Halley committed
259
		free_task = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
260 261 262 263 264 265 266 267
	UNLOCK(&task->lock);

	if (free_task)
		task_free(task);

	*taskp = NULL;
}

268
isc_result_t
Bob Halley's avatar
Bob Halley committed
269
isc_task_send(isc_task_t task, isc_event_t *eventp) {
Bob Halley's avatar
Bob Halley committed
270 271
	isc_boolean_t was_idle = ISC_FALSE;
	isc_boolean_t discard = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
272
	isc_event_t event;
Bob Halley's avatar
base  
Bob Halley committed
273 274

	REQUIRE(VALID_TASK(task));
Bob Halley's avatar
update  
Bob Halley committed
275 276
	REQUIRE(eventp != NULL);
	event = *eventp;
Bob Halley's avatar
base  
Bob Halley committed
277
	REQUIRE(event != NULL);
Bob Halley's avatar
Bob Halley committed
278 279
	REQUIRE(event->sender != NULL);
	REQUIRE(event->type > 0);
Bob Halley's avatar
base  
Bob Halley committed
280

Bob Halley's avatar
Bob Halley committed
281
	XTRACE("sending");
Bob Halley's avatar
base  
Bob Halley committed
282 283 284 285 286 287
	/*
	 * We're trying hard to hold locks for as short a time as possible.
	 * We're also trying to hold as few locks as possible.  This is why
	 * some processing is deferred until after a lock is released.
	 */
	LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
288
	if (task->enqueue_allowed) {
Bob Halley's avatar
base  
Bob Halley committed
289
		if (task->state == task_state_idle) {
Bob Halley's avatar
Bob Halley committed
290
			was_idle = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
291 292 293 294 295 296 297
			INSIST(EMPTY(task->events));
			task->state = task_state_ready;
		}
		INSIST(task->state == task_state_ready ||
		       task->state == task_state_running);
		ENQUEUE(task->events, event, link);
	} else
Bob Halley's avatar
Bob Halley committed
298
		discard = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
299 300 301
	UNLOCK(&task->lock);

	if (discard) {
Bob Halley's avatar
Bob Halley committed
302
		isc_event_free(&event);
Bob Halley's avatar
update  
Bob Halley committed
303
		*eventp = NULL;
304
		return (ISC_R_TASKSHUTDOWN);
Bob Halley's avatar
base  
Bob Halley committed
305 306 307
	}

	if (was_idle) {
Bob Halley's avatar
Bob Halley committed
308
		isc_taskmgr_t manager;
Bob Halley's avatar
base  
Bob Halley committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332

		/*
		 * We need to add this task to the ready queue.
		 *
		 * We've waited until now to do it, rather than doing it
		 * while holding the task lock, because we don't want to
		 * block while holding the task lock.
		 *
		 * We've changed the state to ready, so no one else will
		 * be trying to add this task to the ready queue.  It
		 * thus doesn't matter if more events have been added to
		 * the queue after we gave up the task lock.
		 *
		 * Shutting down a task requires posting a shutdown event
		 * to the task's queue and then executing it, so there's
		 * no way the task can disappear.  A task is always on the
		 * task manager's 'tasks' list, so the task manager can
		 * always post a shutdown event to all tasks if it is
		 * requested to shutdown.
		 */
		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		ENQUEUE(manager->ready_tasks, task, ready_link);
333
		SIGNAL(&manager->work_available);
Bob Halley's avatar
base  
Bob Halley committed
334 335 336
		UNLOCK(&manager->lock);
	}

Bob Halley's avatar
update  
Bob Halley committed
337 338
	*eventp = NULL;

Bob Halley's avatar
Bob Halley committed
339
	XTRACE("sent");
340 341

	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
342 343
}

344
unsigned int
Bob Halley's avatar
Bob Halley committed
345 346 347
isc_task_purge(isc_task_t task, void *sender, isc_eventtype_t type) {
	isc_event_t event, next_event;
	isc_eventlist_t purgeable;
348
	unsigned int purge_count;
Bob Halley's avatar
Bob Halley committed
349 350 351 352 353 354 355 356 357 358 359

	REQUIRE(VALID_TASK(task));
	REQUIRE(type >= 0);

	/*
	 * Purge events matching 'sender' and 'type'.  sender == NULL means
	 * "any sender".  type == NULL means any type.  Task manager events
	 * cannot be purged.
	 */

	INIT_LIST(purgeable);
360
	purge_count = 0;
Bob Halley's avatar
Bob Halley committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

	LOCK(&task->lock);
	for (event = HEAD(task->events);
	     event != NULL;
	     event = next_event) {
		next_event = NEXT(event, link);
		if ((sender == NULL || event->sender == sender) &&
		    ((type == 0 && event->type > 0) || event->type == type)) {
			DEQUEUE(task->events, event, link);
			ENQUEUE(purgeable, event, link);
		}
	}
	UNLOCK(&task->lock);

	for (event = HEAD(purgeable);
	     event != NULL;
	     event = next_event) {
		next_event = NEXT(event, link);
Bob Halley's avatar
Bob Halley committed
379
		isc_event_free(&event);
380
		purge_count++;
Bob Halley's avatar
Bob Halley committed
381
	}
382 383

	return (purge_count);
Bob Halley's avatar
Bob Halley committed
384 385
}

Bob Halley's avatar
Bob Halley committed
386
void
Bob Halley's avatar
Bob Halley committed
387
isc_task_shutdown(isc_task_t task) {
Bob Halley's avatar
Bob Halley committed
388 389
	isc_boolean_t was_idle = ISC_FALSE;
	isc_boolean_t discard = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
390 391 392 393

	REQUIRE(VALID_TASK(task));

	/*
394
	 * This routine is very similar to isc_task_send() above.
Bob Halley's avatar
base  
Bob Halley committed
395 396 397
	 */

	LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
398
	if (task->enqueue_allowed) {
Bob Halley's avatar
base  
Bob Halley committed
399
		if (task->state == task_state_idle) {
Bob Halley's avatar
Bob Halley committed
400
			was_idle = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
401 402 403 404 405
			INSIST(EMPTY(task->events));
			task->state = task_state_ready;
		}
		INSIST(task->state == task_state_ready ||
		       task->state == task_state_running);
Bob Halley's avatar
update  
Bob Halley committed
406 407 408
		INSIST(task->shutdown_event != NULL);
		ENQUEUE(task->events, task->shutdown_event, link);
		task->shutdown_event = NULL;
Bob Halley's avatar
Bob Halley committed
409
		task->enqueue_allowed = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
410
	} else
Bob Halley's avatar
Bob Halley committed
411
		discard = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
412 413
	UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
414
	if (discard)
Bob Halley's avatar
Bob Halley committed
415
		return;
Bob Halley's avatar
base  
Bob Halley committed
416 417

	if (was_idle) {
Bob Halley's avatar
Bob Halley committed
418
		isc_taskmgr_t manager;
Bob Halley's avatar
base  
Bob Halley committed
419 420 421 422 423

		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		ENQUEUE(manager->ready_tasks, task, ready_link);
424
		SIGNAL(&manager->work_available);
Bob Halley's avatar
base  
Bob Halley committed
425 426
		UNLOCK(&manager->lock);
	}
Bob Halley's avatar
Bob Halley committed
427
}
Bob Halley's avatar
base  
Bob Halley committed
428

Bob Halley's avatar
Bob Halley committed
429
void
Bob Halley's avatar
Bob Halley committed
430
isc_task_destroy(isc_task_t *taskp) {
Bob Halley's avatar
Bob Halley committed
431 432 433

	REQUIRE(taskp != NULL);

Bob Halley's avatar
Bob Halley committed
434 435
	isc_task_shutdown(*taskp);
	isc_task_detach(taskp);
Bob Halley's avatar
base  
Bob Halley committed
436 437 438
}


Bob Halley's avatar
Bob Halley committed
439

Bob Halley's avatar
base  
Bob Halley committed
440 441 442 443
/***
 *** Task Manager.
 ***/

Bob Halley's avatar
update  
Bob Halley committed
444
static isc_threadresult_t
Bob Halley's avatar
Bob Halley committed
445 446 447
#ifdef _WIN32
WINAPI
#endif
Bob Halley's avatar
update  
Bob Halley committed
448
run(void *uap) {
Bob Halley's avatar
Bob Halley committed
449 450
	isc_taskmgr_t manager = uap;
	isc_task_t task;
Bob Halley's avatar
base  
Bob Halley committed
451

Bob Halley's avatar
Bob Halley committed
452
	XTRACE("start");
Bob Halley's avatar
base  
Bob Halley committed
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

	REQUIRE(VALID_MANAGER(manager));

	/*
	 * Again we're trying to hold the lock for as short a time as possible
	 * and to do as little locking and unlocking as possible.
	 * 
	 * In both while loops, the appropriate lock must be held before the
	 * while body starts.  Code which acquired the lock at the top of
	 * the loop would be more readable, but would result in a lot of
	 * extra locking.  Compare:
	 *
	 * Straightforward:
	 *
	 *	LOCK();
	 *	...
	 *	UNLOCK();
	 *	while (expression) {
	 *		LOCK();
	 *		...
	 *		UNLOCK();
	 *
	 *	       	Unlocked part here...
	 *
	 *		LOCK();
	 *		...
	 *		UNLOCK();
	 *	}
	 *
	 * Note how if the loop continues we unlock and then immediately lock.
	 * For N iterations of the loop, this code does 2N+1 locks and 2N+1
	 * unlocks.  Also note that the lock is not held when the while
	 * condition is tested, which may or may not be important, depending
	 * on the expression.
	 * 
	 * As written:
	 *
	 *	LOCK();
	 *	while (expression) {
	 *		...
	 *		UNLOCK();
	 *
	 *	       	Unlocked part here...
	 *
	 *		LOCK();
	 *		...
	 *	}
	 *	UNLOCK();
	 *
	 * For N iterations of the loop, this code does N+1 locks and N+1
	 * unlocks.  The while expression is always protected by the lock.
	 */

	LOCK(&manager->lock);
	while (!FINISHED(manager)) {
		/*
		 * For reasons similar to those given in the comment in
510
		 * isc_task_send() above, it is safe for us to dequeue
Bob Halley's avatar
base  
Bob Halley committed
511 512 513 514 515
		 * the task while only holding the manager lock, and then
		 * change the task to running state while only holding the
		 * task lock.
		 */
		while (EMPTY(manager->ready_tasks) && !FINISHED(manager)) {
Bob Halley's avatar
Bob Halley committed
516
			XTRACE("wait");
Bob Halley's avatar
base  
Bob Halley committed
517
			WAIT(&manager->work_available, &manager->lock);
Bob Halley's avatar
Bob Halley committed
518
			XTRACE("awake");
Bob Halley's avatar
base  
Bob Halley committed
519
		}
Bob Halley's avatar
Bob Halley committed
520
		XTRACE("working");
Bob Halley's avatar
base  
Bob Halley committed
521 522 523
		
		task = HEAD(manager->ready_tasks);
		if (task != NULL) {
Bob Halley's avatar
Bob Halley committed
524
			unsigned int dispatch_count = 0;
Bob Halley's avatar
Bob Halley committed
525 526 527 528 529
			isc_boolean_t done = ISC_FALSE;
			isc_boolean_t requeue = ISC_FALSE;
			isc_boolean_t wants_shutdown;
			isc_boolean_t is_shutdown;
			isc_boolean_t free_task = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
530 531
			isc_event_t event;
			isc_eventlist_t remaining_events;
Bob Halley's avatar
Bob Halley committed
532
			isc_boolean_t discard_remaining = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
533 534 535 536 537 538 539 540 541 542 543 544

			INSIST(VALID_TASK(task));

			/*
			 * Note we only unlock the manager lock if we actually
			 * have a task to do.  We must reacquire the manager 
			 * lock before exiting the 'if (task != NULL)' block.
			 */
			DEQUEUE(manager->ready_tasks, task, ready_link);
			UNLOCK(&manager->lock);

			LOCK(&task->lock);
Bob Halley's avatar
Bob Halley committed
545 546 547 548 549 550 551 552
			INSIST(task->state == task_state_ready);
			if (EMPTY(task->events)) {
				/*
				 * The task became runnable, but all events
				 * in the run queue were subsequently purged.
				 * Put the task to sleep.
				 */
				task->state = task_state_idle;
Bob Halley's avatar
Bob Halley committed
553
				done = ISC_TRUE;
Bob Halley's avatar
Bob Halley committed
554 555 556
				XTRACE("ready but empty");
			} else
				task->state = task_state_running;
Bob Halley's avatar
base  
Bob Halley committed
557
			while (!done) {
Bob Halley's avatar
update  
Bob Halley committed
558 559 560
				INSIST(!EMPTY(task->events));
				event = HEAD(task->events);
				DEQUEUE(task->events, event, link);
Bob Halley's avatar
base  
Bob Halley committed
561 562
				UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
563
				if (event->type == ISC_TASKEVENT_SHUTDOWN)
Bob Halley's avatar
Bob Halley committed
564
					is_shutdown = ISC_TRUE;
Bob Halley's avatar
update  
Bob Halley committed
565
				else
Bob Halley's avatar
Bob Halley committed
566
					is_shutdown = ISC_FALSE;
Bob Halley's avatar
update  
Bob Halley committed
567

Bob Halley's avatar
base  
Bob Halley committed
568 569 570
				/*
				 * Execute the event action.
				 */
Bob Halley's avatar
Bob Halley committed
571
				XTRACE("execute action");
Bob Halley's avatar
update  
Bob Halley committed
572 573 574
				if (event->action != NULL)
					wants_shutdown =
						(event->action)(task, event);
Bob Halley's avatar
base  
Bob Halley committed
575
				else
Bob Halley's avatar
Bob Halley committed
576
					wants_shutdown = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
577
				dispatch_count++;
Bob Halley's avatar
update  
Bob Halley committed
578
				
Bob Halley's avatar
base  
Bob Halley committed
579
				LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
580
				if (wants_shutdown || is_shutdown) {
Bob Halley's avatar
Bob Halley committed
581
					/*
Bob Halley's avatar
update  
Bob Halley committed
582 583 584 585
					 * The event action has either
					 * requested shutdown, or the event
					 * we just executed was the shutdown
					 * event.
Bob Halley's avatar
Bob Halley committed
586 587 588 589 590 591 592 593
					 *
					 * Since no more events can be
					 * delivered to the task, we purge
					 * any remaining events (but defer
					 * freeing them until we've released
					 * the lock).
					 */
					XTRACE("wants shutdown");
Bob Halley's avatar
base  
Bob Halley committed
594 595 596 597
					if (!EMPTY(task->events)) {
						remaining_events =
							task->events;
						INIT_LIST(task->events);
Bob Halley's avatar
Bob Halley committed
598
						discard_remaining = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
599 600
					}
					if (task->references == 0)
Bob Halley's avatar
Bob Halley committed
601
						free_task = ISC_TRUE;
Bob Halley's avatar
Bob Halley committed
602
					task->state = task_state_shutdown;
Bob Halley's avatar
Bob Halley committed
603 604
					task->enqueue_allowed = ISC_FALSE;
					done = ISC_TRUE;
Bob Halley's avatar
update  
Bob Halley committed
605
				} else if (EMPTY(task->events)) {
Bob Halley's avatar
Bob Halley committed
606 607 608
					/*
					 * Nothing else to do for this task.
					 * Put it to sleep.
Bob Halley's avatar
Bob Halley committed
609 610 611
					 *
					 * XXX detect tasks with 0 references
					 * and do something about them.
Bob Halley's avatar
Bob Halley committed
612
					 */
Bob Halley's avatar
Bob Halley committed
613
					XTRACE("empty");
Bob Halley's avatar
base  
Bob Halley committed
614
					task->state = task_state_idle;
Bob Halley's avatar
Bob Halley committed
615
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
616 617 618 619 620 621 622 623 624 625 626
				} else if (dispatch_count >= task->quantum) {
					/*
					 * Our quantum has expired, but
					 * there is more work to be done.
					 * We'll requeue it to the ready
					 * queue later.
					 *
					 * We don't check quantum until
					 * dispatching at least one event,
					 * so the minimum quantum is one.
					 */
Bob Halley's avatar
Bob Halley committed
627
					XTRACE("quantum");
Bob Halley's avatar
base  
Bob Halley committed
628
					task->state = task_state_ready;
Bob Halley's avatar
Bob Halley committed
629 630
					requeue = ISC_TRUE;
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
631 632 633 634 635
				}
			}
			UNLOCK(&task->lock);

			if (discard_remaining) {
Bob Halley's avatar
Bob Halley committed
636
				isc_event_t next_event;
Bob Halley's avatar
base  
Bob Halley committed
637 638 639 640 641

				for (event = HEAD(remaining_events);
				     event != NULL;
				     event = next_event) {
					next_event = NEXT(event, link);
Bob Halley's avatar
Bob Halley committed
642
					isc_event_free(&event);
Bob Halley's avatar
base  
Bob Halley committed
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
				}
			}

			if (free_task)
				task_free(task);

			LOCK(&manager->lock);
			if (requeue) {
				/*
				 * We know we're awake, so we don't have
				 * to wakeup any sleeping threads if the
				 * ready queue is empty before we requeue.
				 *
				 * A possible optimization if the queue is
				 * empty is to 'goto' the 'if (task != NULL)'
				 * block, avoiding the ENQUEUE of the task
				 * and the subsequent immediate DEQUEUE
				 * (since it is the only executable task).
				 * We don't do this because then we'd be
				 * skipping the exit_requested check.  The
				 * cost of ENQUEUE is low anyway, especially
				 * when you consider that we'd have to do
				 * an extra EMPTY check to see if we could
				 * do the optimization.  If the ready queue
				 * were usually nonempty, the 'optimization'
				 * might even hurt rather than help.
				 */
				ENQUEUE(manager->ready_tasks, task,
					ready_link);
			}
		}
	}
	UNLOCK(&manager->lock);

Bob Halley's avatar
Bob Halley committed
677
	XTRACE("exit");
Bob Halley's avatar
base  
Bob Halley committed
678

Bob Halley's avatar
update  
Bob Halley committed
679
	return ((isc_threadresult_t)0);
Bob Halley's avatar
base  
Bob Halley committed
680 681 682
}

static void
Bob Halley's avatar
Bob Halley committed
683
manager_free(isc_taskmgr_t manager) {
Bob Halley's avatar
Bob Halley committed
684 685
	(void)isc_condition_destroy(&manager->work_available);
	(void)isc_mutex_destroy(&manager->lock);
686 687
	isc_mem_put(manager->mctx, manager->threads,
		    manager->workers * sizeof (isc_thread_t));
Bob Halley's avatar
base  
Bob Halley committed
688
	manager->magic = 0;
Bob Halley's avatar
Bob Halley committed
689
	isc_mem_put(manager->mctx, manager, sizeof *manager);
Bob Halley's avatar
base  
Bob Halley committed
690 691
}

Bob Halley's avatar
Bob Halley committed
692
isc_result_t
Bob Halley's avatar
Bob Halley committed
693 694
isc_taskmgr_create(isc_memctx_t mctx, unsigned int workers, 
		   unsigned int default_quantum, isc_taskmgr_t *managerp)
Bob Halley's avatar
Bob Halley committed
695 696
{
	unsigned int i, started = 0;
Bob Halley's avatar
Bob Halley committed
697
	isc_taskmgr_t manager;
698
	isc_thread_t *threads;
Bob Halley's avatar
Bob Halley committed
699 700

	REQUIRE(workers > 0);
Bob Halley's avatar
base  
Bob Halley committed
701

Bob Halley's avatar
Bob Halley committed
702
	manager = isc_mem_get(mctx, sizeof *manager);
Bob Halley's avatar
base  
Bob Halley committed
703
	if (manager == NULL)
Bob Halley's avatar
Bob Halley committed
704
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
705 706
	manager->magic = TASK_MANAGER_MAGIC;
	manager->mctx = mctx;
707 708 709 710 711 712 713
	threads = isc_mem_get(mctx, workers * sizeof (isc_thread_t));
	if (threads == NULL) {
		isc_mem_put(mctx, manager, sizeof *manager);
		return (ISC_R_NOMEMORY);
	}
	manager->threads = threads;
	manager->workers = 0;
Bob Halley's avatar
Bob Halley committed
714
	if (isc_mutex_init(&manager->lock) != ISC_R_SUCCESS) {
715
		isc_mem_put(mctx, threads, workers * sizeof (isc_thread_t));
Bob Halley's avatar
Bob Halley committed
716
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
717 718 719
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_mutex_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
720
	}
Bob Halley's avatar
base  
Bob Halley committed
721 722 723 724 725
	if (default_quantum == 0)
		default_quantum = DEFAULT_DEFAULT_QUANTUM;
	manager->default_quantum = default_quantum;
	INIT_LIST(manager->tasks);
	INIT_LIST(manager->ready_tasks);
Bob Halley's avatar
Bob Halley committed
726 727
	if (isc_condition_init(&manager->work_available) != ISC_R_SUCCESS) {
		(void)isc_mutex_destroy(&manager->lock);
728
		isc_mem_put(mctx, threads, workers * sizeof (isc_thread_t));
Bob Halley's avatar
Bob Halley committed
729
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
730 731 732
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_condition_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
733
	}
Bob Halley's avatar
Bob Halley committed
734
	manager->exiting = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
735 736 737 738 739 740 741
	manager->workers = 0;

	LOCK(&manager->lock);
	/*
	 * Start workers.
	 */
	for (i = 0; i < workers; i++) {
742 743
		if (isc_thread_create(run, manager,
				      &manager->threads[manager->workers]) == 
Bob Halley's avatar
Bob Halley committed
744
		    ISC_R_SUCCESS) {
Bob Halley's avatar
base  
Bob Halley committed
745 746 747 748 749 750 751 752
			manager->workers++;
			started++;
		}
	}
	UNLOCK(&manager->lock);

	if (started == 0) {
		manager_free(manager);
Bob Halley's avatar
Bob Halley committed
753
		return (ISC_R_NOTHREADS);
Bob Halley's avatar
base  
Bob Halley committed
754 755 756 757
	}		

	*managerp = manager;

Bob Halley's avatar
Bob Halley committed
758
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
759 760
}

Bob Halley's avatar
update  
Bob Halley committed
761
void
Bob Halley's avatar
Bob Halley committed
762 763 764
isc_taskmgr_destroy(isc_taskmgr_t *managerp) {
	isc_taskmgr_t manager;
	isc_task_t task;
765
	unsigned int i;
Bob Halley's avatar
base  
Bob Halley committed
766 767 768 769 770

	REQUIRE(managerp != NULL);
	manager = *managerp;
	REQUIRE(VALID_MANAGER(manager));

Bob Halley's avatar
Bob Halley committed
771
	XTRACE("isc_taskmgr_destroy");
Bob Halley's avatar
base  
Bob Halley committed
772 773 774 775
	/*
	 * Only one non-worker thread may ever call this routine.
	 * If a worker thread wants to initiate shutdown of the
	 * task manager, it should ask some non-worker thread to call
Bob Halley's avatar
Bob Halley committed
776
	 * isc_taskmgr_destroy(), e.g. by signalling a condition variable
Bob Halley's avatar
base  
Bob Halley committed
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
	 * that the startup thread is sleeping on.
	 */

	/*
	 * Unlike elsewhere, we're going to hold this lock a long time.
	 * We need to do so, because otherwise the list of tasks could
	 * change while we were traversing it.
	 *
	 * This is also the only function where we will hold both the
	 * task manager lock and a task lock at the same time.
	 */

	LOCK(&manager->lock);

	/*
	 * Make sure we only get called once.
	 */
	INSIST(!manager->exiting);
Bob Halley's avatar
Bob Halley committed
795
	manager->exiting = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
796 797

	/*
Bob Halley's avatar
update  
Bob Halley committed
798 799
	 * Post the shutdown event to every task (if it hasn't already been
	 * posted).
Bob Halley's avatar
base  
Bob Halley committed
800 801 802 803 804
	 */
	for (task = HEAD(manager->tasks);
	     task != NULL;
	     task = NEXT(task, link)) {
		LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
805 806 807 808 809 810 811 812 813 814 815
		if (task->enqueue_allowed) {
			INSIST(task->shutdown_event != NULL);
			ENQUEUE(task->events, task->shutdown_event, link);
			task->shutdown_event = NULL;
			if (task->state == task_state_idle) {
				task->state = task_state_ready;
				ENQUEUE(manager->ready_tasks, task,
					ready_link);
			}
			INSIST(task->state == task_state_ready ||
			       task->state == task_state_running);
Bob Halley's avatar
Bob Halley committed
816
			task->enqueue_allowed = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
817 818 819 820 821 822 823 824 825 826
		}
		UNLOCK(&task->lock);
	}

	/*
	 * Wake up any sleeping workers.  This ensures we get work done if
	 * there's work left to do, and if there are already no tasks left
	 * it will cause the workers to see manager->exiting.
	 */
	BROADCAST(&manager->work_available);
827
	UNLOCK(&manager->lock);
Bob Halley's avatar
base  
Bob Halley committed
828 829 830 831

	/*
	 * Wait for all the worker threads to exit.
	 */
832 833
	for (i = 0; i < manager->workers; i++)
		(void)isc_thread_join(manager->threads[i], NULL);
Bob Halley's avatar
base  
Bob Halley committed
834 835 836 837 838

	manager_free(manager);

	*managerp = NULL;
}