task.c 21.3 KB
Newer Older
Bob Halley's avatar
Bob Halley committed
1
/*
Bob Halley's avatar
Bob Halley committed
2
 * Copyright (C) 1998, 1999  Internet Software Consortium.
Bob Halley's avatar
Bob Halley committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 * 
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 */
Bob Halley's avatar
base  
Bob Halley committed
17

Bob Halley's avatar
Bob Halley committed
18 19 20 21
/*
 * Principal Author: Bob Halley
 */

Bob Halley's avatar
Bob Halley committed
22 23
#include <config.h>

Bob Halley's avatar
base  
Bob Halley committed
24
#include <isc/assertions.h>
25
#include <isc/boolean.h>
Bob Halley's avatar
Bob Halley committed
26
#include <isc/thread.h>
27 28
#include <isc/mutex.h>
#include <isc/condition.h>
29
#include <isc/error.h>
30
#include <isc/event.h>
Bob Halley's avatar
Bob Halley committed
31
#include <isc/task.h>
Bob Halley's avatar
base  
Bob Halley committed
32

33
#include "util.h"
Bob Halley's avatar
base  
Bob Halley committed
34

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

Bob Halley's avatar
Bob Halley committed
45 46

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

Bob Halley's avatar
Bob Halley committed
50 51
typedef enum {
	task_state_idle, task_state_ready, task_state_running,
52
	task_state_done
Bob Halley's avatar
Bob Halley committed
53 54 55 56 57 58
} 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
59
struct isc_task {
Bob Halley's avatar
Bob Halley committed
60 61
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
62
	isc_taskmgr_t *			manager;
Bob Halley's avatar
Bob Halley committed
63
	isc_mutex_t			lock;
Bob Halley's avatar
Bob Halley committed
64
	isc_mem_t *			mctx;
Bob Halley's avatar
Bob Halley committed
65 66 67
	/* Locked by task lock. */
	task_state_t			state;
	unsigned int			references;
Bob Halley's avatar
Bob Halley committed
68
	isc_eventlist_t			events;
69
	isc_eventlist_t			on_shutdown;
Bob Halley's avatar
Bob Halley committed
70
	unsigned int			quantum;
71
	unsigned int			flags;
Bob Halley's avatar
Bob Halley committed
72
	/* Locked by task manager lock. */
Bob Halley's avatar
Bob Halley committed
73 74
	LINK(isc_task_t)		link;
	LINK(isc_task_t)		ready_link;
Bob Halley's avatar
Bob Halley committed
75 76
};

77 78 79 80 81 82 83 84
#define TASK_F_DONEOK			0x01
#define TASK_F_SENDOK			0x02
#define TASK_F_SHUTTINGDOWN		0x04

#define DONE_FLAGS			(TASK_F_DONEOK|TASK_F_SHUTTINGDOWN)
#define TASK_DONE(t)			(((t)->flags & DONE_FLAGS) == \
					 DONE_FLAGS)

Bob Halley's avatar
Bob Halley committed
85 86 87 88
#define TASK_MANAGER_MAGIC		0x54534B4DU	/* TSKM. */
#define VALID_MANAGER(m)		((m) != NULL && \
					 (m)->magic == TASK_MANAGER_MAGIC)

Bob Halley's avatar
Bob Halley committed
89
struct isc_taskmgr {
Bob Halley's avatar
Bob Halley committed
90 91
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
92
	isc_mem_t *			mctx;
Bob Halley's avatar
Bob Halley committed
93
	isc_mutex_t			lock;
94 95
	unsigned int			workers;
	isc_thread_t *			threads;
Bob Halley's avatar
Bob Halley committed
96 97
	/* Locked by task manager lock. */
	unsigned int			default_quantum;
Bob Halley's avatar
Bob Halley committed
98 99
	LIST(isc_task_t)		tasks;
	LIST(isc_task_t)		ready_tasks;
Bob Halley's avatar
Bob Halley committed
100
	isc_condition_t			work_available;
Bob Halley's avatar
Bob Halley committed
101
	isc_boolean_t			exiting;
Bob Halley's avatar
Bob Halley committed
102
};
Bob Halley's avatar
Bob Halley committed
103

Bob Halley's avatar
Bob Halley committed
104 105
#define DEFAULT_DEFAULT_QUANTUM		5
#define FINISHED(m)			((m)->exiting && EMPTY((m)->tasks))
Bob Halley's avatar
Bob Halley committed
106

Bob Halley's avatar
update  
Bob Halley committed
107

Bob Halley's avatar
base  
Bob Halley committed
108 109 110 111 112
/***
 *** Tasks.
 ***/

static void
Bob Halley's avatar
Bob Halley committed
113 114
task_free(isc_task_t *task) {
	isc_taskmgr_t *manager = task->manager;
Bob Halley's avatar
base  
Bob Halley committed
115

Bob Halley's avatar
Bob Halley committed
116
	XTRACE("free task");
Bob Halley's avatar
base  
Bob Halley committed
117
	REQUIRE(EMPTY(task->events));
118
	REQUIRE(EMPTY(task->on_shutdown));
Bob Halley's avatar
base  
Bob Halley committed
119 120 121 122 123 124 125 126 127 128 129 130 131

	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
132
	(void)isc_mutex_destroy(&task->lock);
Bob Halley's avatar
base  
Bob Halley committed
133
	task->magic = 0;
134
	isc_mem_put(task->mctx, task, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
135 136
}

Bob Halley's avatar
Bob Halley committed
137
isc_result_t
Bob Halley's avatar
Bob Halley committed
138
isc_task_create(isc_taskmgr_t *manager, isc_mem_t *mctx, unsigned int quantum,
139
		isc_task_t **taskp)
Bob Halley's avatar
Bob Halley committed
140
{
Bob Halley's avatar
Bob Halley committed
141
	isc_task_t *task;
Bob Halley's avatar
base  
Bob Halley committed
142 143 144 145

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

Bob Halley's avatar
Bob Halley committed
146 147 148
	if (mctx == NULL)
		mctx = manager->mctx;
	task = isc_mem_get(mctx, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
149
	if (task == NULL)
Bob Halley's avatar
Bob Halley committed
150
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
151
	task->manager = manager;
Bob Halley's avatar
Bob Halley committed
152
	task->mctx = mctx;
Bob Halley's avatar
Bob Halley committed
153
	if (isc_mutex_init(&task->lock) != ISC_R_SUCCESS) {
Bob Halley's avatar
Bob Halley committed
154
		isc_mem_put(mctx, task, sizeof *task);
Bob Halley's avatar
Bob Halley committed
155 156 157
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_mutex_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
158
	}
Bob Halley's avatar
base  
Bob Halley committed
159 160 161
	task->state = task_state_idle;
	task->references = 1;
	INIT_LIST(task->events);
162
	INIT_LIST(task->on_shutdown);
Bob Halley's avatar
base  
Bob Halley committed
163
	task->quantum = quantum;
164
	task->flags = (TASK_F_DONEOK|TASK_F_SENDOK);
Bob Halley's avatar
base  
Bob Halley committed
165 166 167 168
	INIT_LINK(task, link);
	INIT_LINK(task, ready_link);

	LOCK(&manager->lock);
Bob Halley's avatar
Bob Halley committed
169
	/* XXX Should disallow if task manager is exiting. */
Bob Halley's avatar
base  
Bob Halley committed
170 171 172 173 174
	if (task->quantum == 0)
		task->quantum = manager->default_quantum;
	APPEND(manager->tasks, task, link);
	UNLOCK(&manager->lock);

175
	task->magic = TASK_MAGIC;
Bob Halley's avatar
base  
Bob Halley committed
176 177
	*taskp = task;

Bob Halley's avatar
Bob Halley committed
178
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
179 180
}

Bob Halley's avatar
update  
Bob Halley committed
181
void
Bob Halley's avatar
Bob Halley committed
182
isc_task_attach(isc_task_t *task, isc_task_t **taskp) {
Bob Halley's avatar
base  
Bob Halley committed
183 184 185 186 187 188 189 190 191 192 193

	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
194
void
Bob Halley's avatar
Bob Halley committed
195
isc_task_detach(isc_task_t **taskp) {
Bob Halley's avatar
Bob Halley committed
196
	isc_boolean_t free_task = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
197
	isc_task_t *task;
Bob Halley's avatar
base  
Bob Halley committed
198 199 200 201 202

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

203 204
	XTRACE("isc_task_detach");

Bob Halley's avatar
base  
Bob Halley committed
205 206 207
	LOCK(&task->lock);
	REQUIRE(task->references > 0);
	task->references--;
208
	if (task->state == task_state_done && task->references == 0)
Bob Halley's avatar
Bob Halley committed
209
		free_task = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
210 211 212 213 214 215 216 217
	UNLOCK(&task->lock);

	if (free_task)
		task_free(task);

	*taskp = NULL;
}

Bob Halley's avatar
Bob Halley committed
218 219 220 221 222 223 224 225
isc_mem_t *
isc_task_mem(isc_task_t *task) {

	REQUIRE(VALID_TASK(task));
	
	return (task->mctx);
}

226
isc_result_t
Bob Halley's avatar
Bob Halley committed
227
isc_task_send(isc_task_t *task, isc_event_t **eventp) {
Bob Halley's avatar
Bob Halley committed
228
	isc_boolean_t was_idle = ISC_FALSE;
229 230
	isc_boolean_t disallowed = ISC_FALSE;
	isc_result_t result = ISC_R_SUCCESS;
Bob Halley's avatar
Bob Halley committed
231
	isc_event_t *event;
Bob Halley's avatar
base  
Bob Halley committed
232 233

	REQUIRE(VALID_TASK(task));
Bob Halley's avatar
update  
Bob Halley committed
234 235
	REQUIRE(eventp != NULL);
	event = *eventp;
Bob Halley's avatar
base  
Bob Halley committed
236
	REQUIRE(event != NULL);
Bob Halley's avatar
Bob Halley committed
237 238
	REQUIRE(event->sender != NULL);
	REQUIRE(event->type > 0);
Bob Halley's avatar
base  
Bob Halley committed
239

Bob Halley's avatar
Bob Halley committed
240
	XTRACE("sending");
Bob Halley's avatar
base  
Bob Halley committed
241 242 243 244 245 246
	/*
	 * 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);
247
	/*
248 249
	 * Note: we require that task->state == task_state_done implies
	 * (task->flags & TASK_F_SENDOK) == 0.
250
	 */
251
	if ((task->flags & TASK_F_SENDOK) != 0) {
Bob Halley's avatar
base  
Bob Halley committed
252
		if (task->state == task_state_idle) {
Bob Halley's avatar
Bob Halley committed
253
			was_idle = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
254 255 256 257 258 259
			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);
260 261
	} else {
		disallowed = ISC_TRUE;
262 263
		if (task->state == task_state_done)
			result = ISC_R_TASKDONE;
264 265 266
		else
			result = ISC_R_TASKNOSEND;
	}
Bob Halley's avatar
base  
Bob Halley committed
267 268
	UNLOCK(&task->lock);

269 270
	if (disallowed)
		return (result);
Bob Halley's avatar
base  
Bob Halley committed
271 272

	if (was_idle) {
Bob Halley's avatar
Bob Halley committed
273
		isc_taskmgr_t *manager;
Bob Halley's avatar
base  
Bob Halley committed
274 275 276 277 278 279 280 281 282

		/*
		 * 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
283 284 285 286 287 288
		 * be trying to add this task to the ready queue.  The
		 * only way to leave the ready state is by executing the
		 * task.  It thus doesn't matter if events are added,
		 * removed, or shutting_down is started in the interval
		 * between the time we released the task lock, and the time
		 * we add the task to the ready queue.
Bob Halley's avatar
base  
Bob Halley committed
289 290 291 292 293
		 */
		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		ENQUEUE(manager->ready_tasks, task, ready_link);
294
		SIGNAL(&manager->work_available);
Bob Halley's avatar
base  
Bob Halley committed
295 296 297
		UNLOCK(&manager->lock);
	}

Bob Halley's avatar
update  
Bob Halley committed
298 299
	*eventp = NULL;

Bob Halley's avatar
Bob Halley committed
300
	XTRACE("sent");
301 302

	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
303 304
}

305
unsigned int
Bob Halley's avatar
Bob Halley committed
306
isc_task_purge(isc_task_t *task, void *sender, isc_eventtype_t type) {
307 308 309 310 311 312 313
	return (isc_task_purgerange(task, sender, type, type));
}

unsigned int
isc_task_purgerange(isc_task_t *task, void *sender, isc_eventtype_t first,
		    isc_eventtype_t last)
{
Bob Halley's avatar
Bob Halley committed
314
	isc_event_t *event, *next_event;
Bob Halley's avatar
Bob Halley committed
315
	isc_eventlist_t purgeable;
316
	unsigned int purge_count;
Bob Halley's avatar
Bob Halley committed
317 318 319 320

	REQUIRE(VALID_TASK(task));

	/*
321 322
	 * Purge events matching 'sender' and whose type is >= first and
	 * <= last.  sender == NULL means "any sender".
323 324
	 *
	 * Purging never changes the state of the task.
Bob Halley's avatar
Bob Halley committed
325 326 327
	 */

	INIT_LIST(purgeable);
328
	purge_count = 0;
Bob Halley's avatar
Bob Halley committed
329 330 331 332 333 334 335

	LOCK(&task->lock);
	for (event = HEAD(task->events);
	     event != NULL;
	     event = next_event) {
		next_event = NEXT(event, link);
		if ((sender == NULL || event->sender == sender) &&
336
		    event->type >= first && event->type <= last) {
Bob Halley's avatar
Bob Halley committed
337 338 339 340 341 342 343 344 345 346
			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
347
		isc_event_free(&event);
348
		purge_count++;
Bob Halley's avatar
Bob Halley committed
349
	}
350 351

	return (purge_count);
Bob Halley's avatar
Bob Halley committed
352 353
}

354
isc_result_t
355
isc_task_allowsend(isc_task_t *task, isc_boolean_t allowed) {
356 357 358 359 360
	isc_result_t result = ISC_R_SUCCESS;

	REQUIRE(VALID_TASK(task));

	LOCK(&task->lock);
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
	if (task->state == task_state_done)
		result = ISC_R_TASKDONE;
	else {
		if (allowed)
			task->flags |= TASK_F_SENDOK;
		else
			task->flags &= ~TASK_F_SENDOK;
	}
	UNLOCK(&task->lock);

	return (result);
}

isc_result_t
isc_task_allowdone(isc_task_t *task, isc_boolean_t allowed) {
	isc_result_t result = ISC_R_SUCCESS;

	REQUIRE(VALID_TASK(task));

	LOCK(&task->lock);
	if (task->state == task_state_done)
		result = ISC_R_TASKDONE;
	else if (allowed &&
		 (task->flags & TASK_F_SHUTTINGDOWN) != 0 &&
		 task->state == task_state_idle) {
		task->flags &= ~TASK_F_SENDOK;
		task->state = task_state_done;
	} else {
		if (allowed)
			task->flags |= TASK_F_DONEOK;
		else
			task->flags &= ~TASK_F_DONEOK;
	}
394 395 396 397 398 399 400 401 402 403 404 405 406
	UNLOCK(&task->lock);

	return (result);
}

isc_result_t
isc_task_onshutdown(isc_task_t *task, isc_taskaction_t action, void *arg) {
	isc_boolean_t disallowed = ISC_FALSE;
	isc_result_t result = ISC_R_SUCCESS;
	isc_event_t *event;

	REQUIRE(VALID_TASK(task));

407 408 409 410 411 412
	event = isc_event_allocate(task->mctx,
				   NULL,
				   ISC_TASKEVENT_SHUTDOWN,
				   action,
				   arg,
				   sizeof *event);
413 414 415 416
	if (event == NULL)
		return (ISC_R_NOMEMORY);

	LOCK(&task->lock);
417
	if (task->state == task_state_done) {
418
		disallowed = ISC_TRUE;
419 420
		result = ISC_R_TASKDONE;
	} else if ((task->flags & TASK_F_SHUTTINGDOWN) != 0) {
421 422 423 424 425 426 427
		disallowed = ISC_TRUE;
		result = ISC_R_TASKSHUTTINGDOWN;
	} else
		ENQUEUE(task->on_shutdown, event, link);
	UNLOCK(&task->lock);

	if (disallowed)
Bob Halley's avatar
Bob Halley committed
428
		isc_mem_put(task->mctx, event, sizeof *event);
429 430 431 432

	return (result);
}

Bob Halley's avatar
Bob Halley committed
433
void
Bob Halley's avatar
Bob Halley committed
434
isc_task_shutdown(isc_task_t *task) {
Bob Halley's avatar
Bob Halley committed
435
	isc_boolean_t was_idle = ISC_FALSE;
436 437
	isc_boolean_t queued_something = ISC_FALSE;
	isc_event_t *event, *prev;
Bob Halley's avatar
base  
Bob Halley committed
438 439 440 441

	REQUIRE(VALID_TASK(task));

	/*
442
	 * This routine is very similar to isc_task_send() above.
Bob Halley's avatar
base  
Bob Halley committed
443 444 445
	 */

	LOCK(&task->lock);
446 447 448
	if ((task->flags & TASK_F_SHUTTINGDOWN) == 0) {
		XTRACE("shutting down");
		task->flags |= TASK_F_SHUTTINGDOWN;
Bob Halley's avatar
base  
Bob Halley committed
449
		if (task->state == task_state_idle) {
Bob Halley's avatar
Bob Halley committed
450
			was_idle = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
451
			INSIST(EMPTY(task->events));
452 453 454 455 456
			if (EMPTY(task->on_shutdown) && TASK_DONE(task)) {
				task->flags &= ~TASK_F_SENDOK;
				task->state = task_state_done;
			} else
				task->state = task_state_ready;
Bob Halley's avatar
base  
Bob Halley committed
457 458
		}
		INSIST(task->state == task_state_ready ||
459 460 461 462 463 464 465 466 467 468 469 470 471 472
		       task->state == task_state_running ||
		       task->state == task_state_done);
		if (task->state != task_state_done) {
			/*
			 * Note that we post shutdown events LIFO.
			 */
			for (event = TAIL(task->on_shutdown);
			     event != NULL;
			     event = prev) {
				prev = PREV(event, link);
				DEQUEUE(task->on_shutdown, event, link);
				ENQUEUE(task->events, event, link);
				queued_something = ISC_TRUE;
			}
473 474
		}
	}
Bob Halley's avatar
base  
Bob Halley committed
475 476
	UNLOCK(&task->lock);

477
	if (was_idle && queued_something) {
Bob Halley's avatar
Bob Halley committed
478
		isc_taskmgr_t *manager;
Bob Halley's avatar
base  
Bob Halley committed
479 480 481 482 483

		manager = task->manager;
		INSIST(VALID_MANAGER(manager));
		LOCK(&manager->lock);
		ENQUEUE(manager->ready_tasks, task, ready_link);
484
		SIGNAL(&manager->work_available);
Bob Halley's avatar
base  
Bob Halley committed
485 486
		UNLOCK(&manager->lock);
	}
Bob Halley's avatar
Bob Halley committed
487
}
Bob Halley's avatar
base  
Bob Halley committed
488

Bob Halley's avatar
Bob Halley committed
489
void
Bob Halley's avatar
Bob Halley committed
490
isc_task_destroy(isc_task_t **taskp) {
Bob Halley's avatar
Bob Halley committed
491 492 493

	REQUIRE(taskp != NULL);

Bob Halley's avatar
Bob Halley committed
494 495
	isc_task_shutdown(*taskp);
	isc_task_detach(taskp);
Bob Halley's avatar
base  
Bob Halley committed
496 497 498
}


Bob Halley's avatar
Bob Halley committed
499

Bob Halley's avatar
base  
Bob Halley committed
500 501 502 503
/***
 *** Task Manager.
 ***/

Bob Halley's avatar
update  
Bob Halley committed
504
static isc_threadresult_t
Bob Halley's avatar
Bob Halley committed
505 506 507
#ifdef _WIN32
WINAPI
#endif
Bob Halley's avatar
update  
Bob Halley committed
508
run(void *uap) {
Bob Halley's avatar
Bob Halley committed
509 510
	isc_taskmgr_t *manager = uap;
	isc_task_t *task;
Bob Halley's avatar
base  
Bob Halley committed
511

512
	XTHREADTRACE("start");
Bob Halley's avatar
base  
Bob Halley committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569

	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
570
		 * isc_task_send() above, it is safe for us to dequeue
Bob Halley's avatar
base  
Bob Halley committed
571 572 573 574 575
		 * 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)) {
576
			XTHREADTRACE("wait");
Bob Halley's avatar
base  
Bob Halley committed
577
			WAIT(&manager->work_available, &manager->lock);
578
			XTHREADTRACE("awake");
Bob Halley's avatar
base  
Bob Halley committed
579
		}
580
		XTHREADTRACE("working");
Bob Halley's avatar
base  
Bob Halley committed
581 582 583
		
		task = HEAD(manager->ready_tasks);
		if (task != NULL) {
Bob Halley's avatar
Bob Halley committed
584
			unsigned int dispatch_count = 0;
Bob Halley's avatar
Bob Halley committed
585 586 587
			isc_boolean_t done = ISC_FALSE;
			isc_boolean_t requeue = ISC_FALSE;
			isc_boolean_t free_task = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
588
			isc_event_t *event;
Bob Halley's avatar
base  
Bob Halley committed
589 590 591 592 593 594 595 596 597 598 599 600

			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
601 602 603 604 605 606 607 608
			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
609
				done = ISC_TRUE;
Bob Halley's avatar
Bob Halley committed
610 611 612
				XTRACE("ready but empty");
			} else
				task->state = task_state_running;
Bob Halley's avatar
base  
Bob Halley committed
613
			while (!done) {
Bob Halley's avatar
update  
Bob Halley committed
614 615 616
				INSIST(!EMPTY(task->events));
				event = HEAD(task->events);
				DEQUEUE(task->events, event, link);
Bob Halley's avatar
base  
Bob Halley committed
617 618 619 620

				/*
				 * Execute the event action.
				 */
Bob Halley's avatar
Bob Halley committed
621
				XTRACE("execute action");
622 623
				if (event->action != NULL) {
					UNLOCK(&task->lock);
624
					(event->action)(task, event);
625 626
					LOCK(&task->lock);
				}
Bob Halley's avatar
Bob Halley committed
627
				dispatch_count++;
Bob Halley's avatar
update  
Bob Halley committed
628
				
629
				if (EMPTY(task->events)) {
Bob Halley's avatar
Bob Halley committed
630
					/*
631 632 633 634
					 * Nothing else to do for this task
					 * right now.  If it is shutting down,
					 * then it is done, otherwise we just
					 * put it to sleep.
Bob Halley's avatar
Bob Halley committed
635
					 */
Bob Halley's avatar
Bob Halley committed
636
					XTRACE("empty");
637 638
					if (TASK_DONE(task)) {
						XTRACE("done");
639 640
						if (task->references == 0)
							free_task = ISC_TRUE;
641 642 643
						task->flags &=
							~TASK_F_SENDOK;
						task->state = task_state_done;
644 645
					} else
						task->state = task_state_idle;
Bob Halley's avatar
Bob Halley committed
646
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
647 648 649 650 651 652 653 654 655 656 657
				} 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
658
					XTRACE("quantum");
Bob Halley's avatar
base  
Bob Halley committed
659
					task->state = task_state_ready;
Bob Halley's avatar
Bob Halley committed
660 661
					requeue = ISC_TRUE;
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
				}
			}
			UNLOCK(&task->lock);

			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);

697
	XTHREADTRACE("exit");
Bob Halley's avatar
base  
Bob Halley committed
698

Bob Halley's avatar
update  
Bob Halley committed
699
	return ((isc_threadresult_t)0);
Bob Halley's avatar
base  
Bob Halley committed
700 701 702
}

static void
Bob Halley's avatar
Bob Halley committed
703
manager_free(isc_taskmgr_t *manager) {
Bob Halley's avatar
Bob Halley committed
704 705
	(void)isc_condition_destroy(&manager->work_available);
	(void)isc_mutex_destroy(&manager->lock);
706 707
	isc_mem_put(manager->mctx, manager->threads,
		    manager->workers * sizeof (isc_thread_t));
Bob Halley's avatar
base  
Bob Halley committed
708
	manager->magic = 0;
Bob Halley's avatar
Bob Halley committed
709
	isc_mem_put(manager->mctx, manager, sizeof *manager);
Bob Halley's avatar
base  
Bob Halley committed
710 711
}

Bob Halley's avatar
Bob Halley committed
712
isc_result_t
Bob Halley's avatar
Bob Halley committed
713
isc_taskmgr_create(isc_mem_t *mctx, unsigned int workers, 
Bob Halley's avatar
Bob Halley committed
714
		   unsigned int default_quantum, isc_taskmgr_t **managerp)
Bob Halley's avatar
Bob Halley committed
715 716
{
	unsigned int i, started = 0;
Bob Halley's avatar
Bob Halley committed
717
	isc_taskmgr_t *manager;
718
	isc_thread_t *threads;
Bob Halley's avatar
Bob Halley committed
719 720

	REQUIRE(workers > 0);
Bob Halley's avatar
Bob Halley committed
721
	REQUIRE(managerp != NULL && *managerp == NULL);
Bob Halley's avatar
base  
Bob Halley committed
722

Bob Halley's avatar
Bob Halley committed
723
	manager = isc_mem_get(mctx, sizeof *manager);
Bob Halley's avatar
base  
Bob Halley committed
724
	if (manager == NULL)
Bob Halley's avatar
Bob Halley committed
725
		return (ISC_R_NOMEMORY);
Bob Halley's avatar
base  
Bob Halley committed
726 727
	manager->magic = TASK_MANAGER_MAGIC;
	manager->mctx = mctx;
728 729 730 731 732 733 734
	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
735
	if (isc_mutex_init(&manager->lock) != ISC_R_SUCCESS) {
736
		isc_mem_put(mctx, threads, workers * sizeof (isc_thread_t));
Bob Halley's avatar
Bob Halley committed
737
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
738 739 740
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_mutex_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
741
	}
Bob Halley's avatar
base  
Bob Halley committed
742 743 744 745 746
	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
747 748
	if (isc_condition_init(&manager->work_available) != ISC_R_SUCCESS) {
		(void)isc_mutex_destroy(&manager->lock);
749
		isc_mem_put(mctx, threads, workers * sizeof (isc_thread_t));
Bob Halley's avatar
Bob Halley committed
750
		isc_mem_put(mctx, manager, sizeof *manager);
Bob Halley's avatar
Bob Halley committed
751 752 753
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				 "isc_condition_init() failed");
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
754
	}
Bob Halley's avatar
Bob Halley committed
755
	manager->exiting = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
756 757 758 759 760 761 762
	manager->workers = 0;

	LOCK(&manager->lock);
	/*
	 * Start workers.
	 */
	for (i = 0; i < workers; i++) {
763 764
		if (isc_thread_create(run, manager,
				      &manager->threads[manager->workers]) == 
Bob Halley's avatar
Bob Halley committed
765
		    ISC_R_SUCCESS) {
Bob Halley's avatar
base  
Bob Halley committed
766 767 768 769 770 771 772 773
			manager->workers++;
			started++;
		}
	}
	UNLOCK(&manager->lock);

	if (started == 0) {
		manager_free(manager);
Bob Halley's avatar
Bob Halley committed
774
		return (ISC_R_NOTHREADS);
Bob Halley's avatar
base  
Bob Halley committed
775 776 777 778
	}		

	*managerp = manager;

Bob Halley's avatar
Bob Halley committed
779
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
780 781
}

Bob Halley's avatar
update  
Bob Halley committed
782
void
Bob Halley's avatar
Bob Halley committed
783 784 785
isc_taskmgr_destroy(isc_taskmgr_t **managerp) {
	isc_taskmgr_t *manager;
	isc_task_t *task;
786
	isc_event_t *event, *prev;
787
	unsigned int i;
Bob Halley's avatar
base  
Bob Halley committed
788 789 790 791 792

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

793
	XTHREADTRACE("isc_taskmgr_destroy");
Bob Halley's avatar
base  
Bob Halley committed
794 795 796 797
	/*
	 * 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
798
	 * isc_taskmgr_destroy(), e.g. by signalling a condition variable
Bob Halley's avatar
base  
Bob Halley committed
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
	 * 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
817
	manager->exiting = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
818 819

	/*
820
	 * Post shutdown event(s) to every task (if they haven't already been
Bob Halley's avatar
update  
Bob Halley committed
821
	 * posted).
Bob Halley's avatar
base  
Bob Halley committed
822 823 824 825 826
	 */
	for (task = HEAD(manager->tasks);
	     task != NULL;
	     task = NEXT(task, link)) {
		LOCK(&task->lock);
827 828
		if ((task->flags & TASK_F_SHUTTINGDOWN) == 0) {
			task->flags |= TASK_F_SHUTTINGDOWN;
Bob Halley's avatar
update  
Bob Halley committed
829
			if (task->state == task_state_idle) {
830 831 832 833 834 835 836 837 838 839
				INSIST(EMPTY(task->events));
				if (EMPTY(task->on_shutdown) &&
				    TASK_DONE(task)) {
					task->flags &= ~TASK_F_SENDOK;
					task->state = task_state_done;
				} else {
					task->state = task_state_ready;
					ENQUEUE(manager->ready_tasks, task,
						ready_link);
				}
Bob Halley's avatar
update  
Bob Halley committed
840 841
			}
			INSIST(task->state == task_state_ready ||
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
			       task->state == task_state_running ||
			       task->state == task_state_done);
			if (task->state != task_state_done) {
				/*
				 * Note that we post shutdown events LIFO.
				 */
				for (event = TAIL(task->on_shutdown);
				     event != NULL;
				     event = prev) {
					prev = PREV(event, link);
					DEQUEUE(task->on_shutdown, event,
						link);
					ENQUEUE(task->events, event, link);
				}
			}
Bob Halley's avatar
base  
Bob Halley committed
857 858 859 860 861 862 863 864 865 866
		}
		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);
867
	UNLOCK(&manager->lock);
Bob Halley's avatar
base  
Bob Halley committed
868 869 870 871

	/*
	 * Wait for all the worker threads to exit.
	 */
872 873
	for (i = 0; i < manager->workers; i++)
		(void)isc_thread_join(manager->threads[i], NULL);
Bob Halley's avatar
base  
Bob Halley committed
874 875 876 877 878

	manager_free(manager);

	*managerp = NULL;
}