task.c 18.2 KB
Newer Older
Bob Halley's avatar
base  
Bob Halley committed
1

Bob Halley's avatar
Bob Halley committed
2 3
#include "attribute.h"

Bob Halley's avatar
base  
Bob Halley committed
4 5
#include <isc/assertions.h>

Bob Halley's avatar
Bob Halley committed
6 7
#include <isc/thread.h>
#include <isc/task.h>
Bob Halley's avatar
base  
Bob Halley committed
8

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

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

Bob Halley's avatar
update  
Bob Halley committed
14
/*
Bob Halley's avatar
update  
Bob Halley committed
15 16 17 18 19
 * We use macros instead of calling the os_ routines directly because
 * 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
20
 */
Bob Halley's avatar
update  
Bob Halley committed
21 22 23 24
#define LOCK(lp)		INSIST(os_mutex_lock((lp)))
#define UNLOCK(lp)		INSIST(os_mutex_unlock((lp)))
#define WAIT(cvp, lp)		INSIST(os_condition_wait((cvp), (lp)))
#define BROADCAST(cvp)		INSIST(os_condition_broadcast((cvp)))
Bob Halley's avatar
base  
Bob Halley committed
25

Bob Halley's avatar
Bob Halley committed
26
#ifdef DEBUGTRACE
Bob Halley's avatar
Bob Halley committed
27
#define XTRACE(m)		printf("%s %p\n", (m), os_thread_self())
Bob Halley's avatar
Bob Halley committed
28 29 30
#else
#define XTRACE(m)
#endif
Bob Halley's avatar
base  
Bob Halley committed
31

Bob Halley's avatar
Bob Halley committed
32 33

/***
Bob Halley's avatar
Bob Halley committed
34
 *** Types.
Bob Halley's avatar
Bob Halley committed
35 36
 ***/

Bob Halley's avatar
Bob Halley committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
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)

struct task {
	/* Not locked. */
	unsigned int			magic;
	task_manager_t			manager;
	os_mutex_t			lock;
	/* Locked by task lock. */
	task_state_t			state;
	unsigned int			references;
Bob Halley's avatar
Bob Halley committed
54
	task_eventlist_t		events;
Bob Halley's avatar
Bob Halley committed
55
	unsigned int			quantum;
Bob Halley's avatar
update  
Bob Halley committed
56 57
	boolean_t			enqueue_allowed;
	task_event_t			shutdown_event;
Bob Halley's avatar
Bob Halley committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
	/* Locked by task manager lock. */
	LINK(struct task)		link;
	LINK(struct task)		ready_link;
};

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

struct task_manager {
	/* Not locked. */
	unsigned int			magic;
	mem_context_t			mctx;
	os_mutex_t			lock;
	/* Locked by task manager lock. */
	unsigned int			default_quantum;
	LIST(struct task)		tasks;
	LIST(struct task)		ready_tasks;
	os_condition_t			work_available;
	boolean_t			exiting;
	unsigned int			workers;
	os_condition_t			no_workers;
};
Bob Halley's avatar
Bob Halley committed
81

Bob Halley's avatar
Bob Halley committed
82 83
#define DEFAULT_DEFAULT_QUANTUM		5
#define FINISHED(m)			((m)->exiting && EMPTY((m)->tasks))
Bob Halley's avatar
Bob Halley committed
84

Bob Halley's avatar
update  
Bob Halley committed
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

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

static inline task_event_t
event_allocate(mem_context_t mctx, task_eventtype_t type,
	       task_action_t action, void *arg, size_t size)
{
	task_event_t event;

	event = mem_get(mctx, size);
	if (event == NULL)
		return (NULL);
	event->mctx = mctx;
	event->size = size;
	event->type = type;
	event->action = action;
	event->arg = arg;

	return (event);
}

task_event_t
task_event_allocate(mem_context_t mctx, task_eventtype_t type,
		    task_action_t action, void *arg, size_t size)
{
	if (size < sizeof (struct task_event))
		return (NULL);
	if (type < 0)
		return (NULL);
	if (action == NULL)
		return (NULL);

	return (event_allocate(mctx, type, action, arg, size));
}

void
task_event_free(task_event_t *eventp) {
	task_event_t event;
	
	REQUIRE(eventp != NULL);
	event = *eventp;
	REQUIRE(event != NULL);

	mem_put(event->mctx, event, event->size);

	*eventp = NULL;
}

Bob Halley's avatar
base  
Bob Halley committed
135 136 137 138 139 140 141 142
/***
 *** Tasks.
 ***/

static void
task_free(task_t task) {
	task_manager_t manager = task->manager;

Bob Halley's avatar
Bob Halley committed
143
	XTRACE("free task");
Bob Halley's avatar
base  
Bob Halley committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157
	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
update  
Bob Halley committed
158
	(void)os_mutex_destroy(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
159 160
	if (task->shutdown_event != NULL)
		task_event_free(&task->shutdown_event);
Bob Halley's avatar
base  
Bob Halley committed
161 162 163 164 165
	task->magic = 0;
	mem_put(manager->mctx, task, sizeof *task);
}

boolean_t
Bob Halley's avatar
update  
Bob Halley committed
166 167
task_create(task_manager_t manager, task_action_t shutdown_action,
	    void *shutdown_arg, unsigned int quantum, task_t *taskp)
Bob Halley's avatar
Bob Halley committed
168
{
Bob Halley's avatar
base  
Bob Halley committed
169 170 171 172 173 174 175 176 177 178 179
	task_t task;

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

	task = mem_get(manager->mctx, sizeof *task);
	if (task == NULL)
		return (FALSE);

	task->magic = TASK_MAGIC;
	task->manager = manager;
Bob Halley's avatar
update  
Bob Halley committed
180 181 182 183
	if (!os_mutex_init(&task->lock)) {
		mem_put(manager->mctx, task, sizeof *task);
		return (FALSE);
	}
Bob Halley's avatar
base  
Bob Halley committed
184 185 186 187
	task->state = task_state_idle;
	task->references = 1;
	INIT_LIST(task->events);
	task->quantum = quantum;
Bob Halley's avatar
update  
Bob Halley committed
188 189 190 191 192 193 194 195 196 197 198
	task->enqueue_allowed = TRUE;
	task->shutdown_event = event_allocate(manager->mctx,
					      TASK_EVENT_SHUTDOWN,
					      shutdown_action,
					      shutdown_arg,
					      sizeof *task->shutdown_event);
	if (task->shutdown_event == NULL) {
		(void)os_mutex_destroy(&task->lock);
		mem_put(manager->mctx, task, sizeof *task);
		return (FALSE);
	}
Bob Halley's avatar
base  
Bob Halley committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212
	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;

	return (TRUE);
}

Bob Halley's avatar
update  
Bob Halley committed
213
void
Bob Halley's avatar
base  
Bob Halley committed
214 215 216 217 218 219 220 221 222 223 224 225
task_attach(task_t task, task_t *taskp) {

	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
226
void
Bob Halley's avatar
base  
Bob Halley committed
227 228 229 230
task_detach(task_t *taskp) {
	boolean_t free_task = FALSE;
	task_t task;

Bob Halley's avatar
Bob Halley committed
231
	XTRACE("task_detach");
Bob Halley's avatar
base  
Bob Halley committed
232 233 234 235 236 237 238 239

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

	LOCK(&task->lock);
	REQUIRE(task->references > 0);
	task->references--;
240
	if (task->state == task_state_shutdown && task->references == 0)
Bob Halley's avatar
base  
Bob Halley committed
241 242 243 244 245 246 247 248 249 250
		free_task = TRUE;
	UNLOCK(&task->lock);

	if (free_task)
		task_free(task);

	*taskp = NULL;
}

boolean_t
Bob Halley's avatar
Bob Halley committed
251
task_send_event(task_t task, task_event_t *eventp) {
Bob Halley's avatar
base  
Bob Halley committed
252 253
	boolean_t was_idle = FALSE;
	boolean_t discard = FALSE;
Bob Halley's avatar
Bob Halley committed
254
	task_event_t event;
Bob Halley's avatar
base  
Bob Halley committed
255 256

	REQUIRE(VALID_TASK(task));
Bob Halley's avatar
update  
Bob Halley committed
257 258
	REQUIRE(eventp != NULL);
	event = *eventp;
Bob Halley's avatar
base  
Bob Halley committed
259
	REQUIRE(event != NULL);
Bob Halley's avatar
update  
Bob Halley committed
260
	REQUIRE(event->type >= 0);
Bob Halley's avatar
base  
Bob Halley committed
261

Bob Halley's avatar
Bob Halley committed
262
	XTRACE("sending");
Bob Halley's avatar
base  
Bob Halley committed
263 264 265 266 267 268
	/*
	 * 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
269
	if (task->enqueue_allowed) {
Bob Halley's avatar
base  
Bob Halley committed
270 271 272 273 274 275 276 277 278 279 280 281 282
		if (task->state == task_state_idle) {
			was_idle = TRUE;
			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
		discard = TRUE;
	UNLOCK(&task->lock);

	if (discard) {
Bob Halley's avatar
Bob Halley committed
283
		task_event_free(&event);
Bob Halley's avatar
update  
Bob Halley committed
284
		*eventp = NULL;
Bob Halley's avatar
base  
Bob Halley committed
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
		return (TRUE);
	}

	if (was_idle) {
		boolean_t need_wakeup = FALSE;
		task_manager_t manager;

		/*
		 * 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);
		if (EMPTY(manager->ready_tasks))
			need_wakeup = TRUE;
		ENQUEUE(manager->ready_tasks, task, ready_link);
		UNLOCK(&manager->lock);

		/*
		 * If the runnable queue is empty, the worker threads could
		 * either be executing tasks or waiting for something to do.
		 * We wakeup anyone who is sleeping.
		 */
		if (need_wakeup)
			BROADCAST(&manager->work_available);
	}

Bob Halley's avatar
update  
Bob Halley committed
328 329
	*eventp = NULL;

Bob Halley's avatar
Bob Halley committed
330
	XTRACE("sent");
Bob Halley's avatar
base  
Bob Halley committed
331 332 333
	return (TRUE);
}

Bob Halley's avatar
Bob Halley committed
334
void
Bob Halley's avatar
base  
Bob Halley committed
335 336
task_shutdown(task_t task) {
	boolean_t was_idle = FALSE;
Bob Halley's avatar
Bob Halley committed
337
	boolean_t discard = FALSE;
Bob Halley's avatar
base  
Bob Halley committed
338 339 340 341 342 343 344 345

	REQUIRE(VALID_TASK(task));

	/*
	 * This routine is very similar to task_send_event() above.
	 */

	LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
346
	if (task->enqueue_allowed) {
Bob Halley's avatar
base  
Bob Halley committed
347 348 349 350 351 352 353
		if (task->state == task_state_idle) {
			was_idle = TRUE;
			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
354 355 356 357
		INSIST(task->shutdown_event != NULL);
		ENQUEUE(task->events, task->shutdown_event, link);
		task->shutdown_event = NULL;
		task->enqueue_allowed = FALSE;
Bob Halley's avatar
base  
Bob Halley committed
358
	} else
Bob Halley's avatar
Bob Halley committed
359
		discard = TRUE;
Bob Halley's avatar
base  
Bob Halley committed
360 361
	UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
362
	if (discard)
Bob Halley's avatar
Bob Halley committed
363
		return;
Bob Halley's avatar
base  
Bob Halley committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379

	if (was_idle) {
		boolean_t need_wakeup = FALSE;
		task_manager_t manager;

		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		if (EMPTY(manager->ready_tasks))
			need_wakeup = TRUE;
		ENQUEUE(manager->ready_tasks, task, ready_link);
		UNLOCK(&manager->lock);

		if (need_wakeup)
			BROADCAST(&manager->work_available);
	}
Bob Halley's avatar
Bob Halley committed
380
}
Bob Halley's avatar
base  
Bob Halley committed
381

Bob Halley's avatar
Bob Halley committed
382 383 384 385 386 387 388
void
task_destroy(task_t *taskp) {

	REQUIRE(taskp != NULL);

	task_shutdown(*taskp);
	task_detach(taskp);
Bob Halley's avatar
base  
Bob Halley committed
389 390 391
}


Bob Halley's avatar
Bob Halley committed
392

Bob Halley's avatar
base  
Bob Halley committed
393 394 395 396 397 398 399 400 401 402
/***
 *** Task Manager.
 ***/

static
void *task_manager_run(void *uap) {
	task_manager_t manager = uap;
	task_t task;
	boolean_t no_workers = FALSE;

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

	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
		 * task_send_event() above, it is safe for us to dequeue
		 * 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
467
			XTRACE("wait");
Bob Halley's avatar
base  
Bob Halley committed
468
			WAIT(&manager->work_available, &manager->lock);
Bob Halley's avatar
Bob Halley committed
469
			XTRACE("awake");
Bob Halley's avatar
base  
Bob Halley committed
470
		}
Bob Halley's avatar
Bob Halley committed
471
		XTRACE("working");
Bob Halley's avatar
base  
Bob Halley committed
472 473 474
		
		task = HEAD(manager->ready_tasks);
		if (task != NULL) {
Bob Halley's avatar
Bob Halley committed
475
			unsigned int dispatch_count = 0;
Bob Halley's avatar
base  
Bob Halley committed
476 477 478
			boolean_t done = FALSE;
			boolean_t requeue = FALSE;
			boolean_t wants_shutdown;
Bob Halley's avatar
update  
Bob Halley committed
479
			boolean_t is_shutdown;
Bob Halley's avatar
base  
Bob Halley committed
480
			boolean_t free_task = FALSE;
Bob Halley's avatar
update  
Bob Halley committed
481
			task_event_t event;
Bob Halley's avatar
Bob Halley committed
482
			task_eventlist_t remaining_events;
Bob Halley's avatar
base  
Bob Halley committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
			boolean_t discard_remaining = FALSE;

			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);
			task->state = task_state_running;
			while (!done) {
Bob Halley's avatar
update  
Bob Halley committed
498 499 500
				INSIST(!EMPTY(task->events));
				event = HEAD(task->events);
				DEQUEUE(task->events, event, link);
Bob Halley's avatar
base  
Bob Halley committed
501 502
				UNLOCK(&task->lock);

Bob Halley's avatar
update  
Bob Halley committed
503 504 505 506 507
				if (event->type == TASK_EVENT_SHUTDOWN)
					is_shutdown = TRUE;
				else
					is_shutdown = FALSE;

Bob Halley's avatar
base  
Bob Halley committed
508 509 510
				/*
				 * Execute the event action.
				 */
Bob Halley's avatar
Bob Halley committed
511
				XTRACE("execute action");
Bob Halley's avatar
update  
Bob Halley committed
512 513 514
				if (event->action != NULL)
					wants_shutdown =
						(event->action)(task, event);
Bob Halley's avatar
base  
Bob Halley committed
515 516
				else
					wants_shutdown = FALSE;
Bob Halley's avatar
Bob Halley committed
517
				dispatch_count++;
Bob Halley's avatar
update  
Bob Halley committed
518 519
				
				task_event_free(&event);
Bob Halley's avatar
base  
Bob Halley committed
520 521

				LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
522
				if (wants_shutdown || is_shutdown) {
Bob Halley's avatar
Bob Halley committed
523
					/*
Bob Halley's avatar
update  
Bob Halley committed
524 525 526 527
					 * The event action has either
					 * requested shutdown, or the event
					 * we just executed was the shutdown
					 * event.
Bob Halley's avatar
Bob Halley committed
528 529 530 531 532 533 534 535
					 *
					 * 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
536 537 538 539 540 541 542 543
					if (!EMPTY(task->events)) {
						remaining_events =
							task->events;
						INIT_LIST(task->events);
						discard_remaining = TRUE;
					}
					if (task->references == 0)
						free_task = TRUE;
Bob Halley's avatar
Bob Halley committed
544
					task->state = task_state_shutdown;
Bob Halley's avatar
update  
Bob Halley committed
545
					task->enqueue_allowed = FALSE;
Bob Halley's avatar
base  
Bob Halley committed
546
					done = TRUE;
Bob Halley's avatar
update  
Bob Halley committed
547
				} else if (EMPTY(task->events)) {
Bob Halley's avatar
Bob Halley committed
548 549 550 551
					/*
					 * Nothing else to do for this task.
					 * Put it to sleep.
					 */
Bob Halley's avatar
base  
Bob Halley committed
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
					task->state = task_state_idle;
					done = TRUE;
				} 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.
					 */
					task->state = task_state_ready;
					requeue = TRUE;
					done = TRUE;
				}
			}
			UNLOCK(&task->lock);

			if (discard_remaining) {
Bob Halley's avatar
Bob Halley committed
573
				task_event_t next_event;
Bob Halley's avatar
base  
Bob Halley committed
574 575 576 577 578

				for (event = HEAD(remaining_events);
				     event != NULL;
				     event = next_event) {
					next_event = NEXT(event, link);
Bob Halley's avatar
Bob Halley committed
579
					task_event_free(&event);
Bob Halley's avatar
base  
Bob Halley committed
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
				}
			}

			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);
			}
		}
	}
	INSIST(manager->workers > 0);
	manager->workers--;
	if (manager->workers == 0)
		no_workers = TRUE;
	UNLOCK(&manager->lock);

	if (no_workers)
		BROADCAST(&manager->no_workers);

Bob Halley's avatar
Bob Halley committed
621
	XTRACE("exit");
Bob Halley's avatar
base  
Bob Halley committed
622 623 624 625 626 627

	return (NULL);	
}

static void
manager_free(task_manager_t manager) {
Bob Halley's avatar
update  
Bob Halley committed
628 629 630
	(void)os_condition_destroy(&manager->work_available);
	(void)os_condition_destroy(&manager->no_workers);
	(void)os_mutex_destroy(&manager->lock);
Bob Halley's avatar
base  
Bob Halley committed
631 632 633 634
	manager->magic = 0;
	mem_put(manager->mctx, manager, sizeof *manager);
}

Bob Halley's avatar
Bob Halley committed
635 636 637 638 639
unsigned int
task_manager_create(mem_context_t mctx, unsigned int workers, 
		    unsigned int default_quantum, task_manager_t *managerp)
{
	unsigned int i, started = 0;
Bob Halley's avatar
base  
Bob Halley committed
640 641 642
	task_manager_t manager;
	os_thread_t thread;

Bob Halley's avatar
update  
Bob Halley committed
643 644
	if (workers == 0)
		return (0);
Bob Halley's avatar
base  
Bob Halley committed
645 646 647 648 649
	manager = mem_get(mctx, sizeof *manager);
	if (manager == NULL)
		return (0);
	manager->magic = TASK_MANAGER_MAGIC;
	manager->mctx = mctx;
Bob Halley's avatar
update  
Bob Halley committed
650 651 652 653
	if (!os_mutex_init(&manager->lock)) {
		mem_put(mctx, manager, sizeof *manager);
		return (0);
	}
Bob Halley's avatar
base  
Bob Halley committed
654 655 656 657 658
	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
update  
Bob Halley committed
659 660 661 662 663
	if (!os_condition_init(&manager->work_available)) {
		(void)os_mutex_destroy(&manager->lock);
		mem_put(mctx, manager, sizeof *manager);
		return (0);
	}
Bob Halley's avatar
base  
Bob Halley committed
664 665
	manager->exiting = FALSE;
	manager->workers = 0;
Bob Halley's avatar
update  
Bob Halley committed
666 667 668 669 670 671
	if (!os_condition_init(&manager->no_workers)) {
		(void)os_condition_destroy(&manager->work_available);
		(void)os_mutex_destroy(&manager->lock);
		mem_put(mctx, manager, sizeof *manager);
		return (0);
	}
Bob Halley's avatar
base  
Bob Halley committed
672 673 674 675 676 677 678 679 680

	LOCK(&manager->lock);
	/*
	 * Start workers.
	 */
	for (i = 0; i < workers; i++) {
		if (os_thread_create(task_manager_run, manager, &thread)) {
			manager->workers++;
			started++;
Bob Halley's avatar
update  
Bob Halley committed
681
			(void)os_thread_detach(thread);
Bob Halley's avatar
base  
Bob Halley committed
682 683 684 685 686 687 688 689 690 691 692 693 694 695
		}
	}
	UNLOCK(&manager->lock);

	if (started == 0) {
		manager_free(manager);
		return (0);
	}		

	*managerp = manager;

	return (started);
}

Bob Halley's avatar
update  
Bob Halley committed
696
void
Bob Halley's avatar
base  
Bob Halley committed
697 698 699 700 701 702 703 704
task_manager_destroy(task_manager_t *managerp) {
	task_manager_t manager;
	task_t task;

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

Bob Halley's avatar
Bob Halley committed
705
	XTRACE("task_manager_destroy");
Bob Halley's avatar
base  
Bob Halley committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
	/*
	 * 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
	 * task_manager_destroy(), e.g. by signalling a condition variable
	 * 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);
	manager->exiting = TRUE;

	/*
Bob Halley's avatar
update  
Bob Halley committed
732 733
	 * Post the shutdown event to every task (if it hasn't already been
	 * posted).
Bob Halley's avatar
base  
Bob Halley committed
734 735 736 737 738
	 */
	for (task = HEAD(manager->tasks);
	     task != NULL;
	     task = NEXT(task, link)) {
		LOCK(&task->lock);
Bob Halley's avatar
update  
Bob Halley committed
739 740 741 742 743 744 745 746 747 748 749 750
		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);
			task->enqueue_allowed = FALSE;
Bob Halley's avatar
base  
Bob Halley committed
751 752 753 754 755 756 757 758 759 760 761 762 763
		}
		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);

	/*
	 * Wait for all the worker threads to exit.
Bob Halley's avatar
update  
Bob Halley committed
764 765 766 767 768 769
	 *
	 * XXX  This will become a timed wait.  If all the workers haven't
	 *      died after we've waited the specified interval, we will
	 *	kill the worker threads.  Should we join with the worker
	 *      threads after killing them or just leave them detached and
	 *      hope they go away?
Bob Halley's avatar
base  
Bob Halley committed
770 771 772 773 774 775 776 777 778 779
	 */
	while (manager->workers > 0)
		WAIT(&manager->no_workers, &manager->lock);

	UNLOCK(&manager->lock);

	manager_free(manager);

	*managerp = NULL;
}