task.c 28.2 KB
Newer Older
Bob Halley's avatar
Bob Halley committed
1
/*
Brian Wellington's avatar
Brian Wellington committed
2
 * Copyright (C) 1998-2001  Internet Software Consortium.
3
 *
Bob Halley's avatar
Bob Halley committed
4 5 6
 * 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.
7
 *
8 9 10 11 12 13 14 15
 * 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
Bob Halley committed
16
 */
Bob Halley's avatar
base  
Bob Halley committed
17

Andreas Gustafsson's avatar
Andreas Gustafsson committed
18
/* $Id: task.c,v 1.83 2001/02/09 18:27:18 gson Exp $ */
David Lawrence's avatar
David Lawrence committed
19

Bob Halley's avatar
Bob Halley committed
20 21 22 23
/*
 * Principal Author: Bob Halley
 */

24 25 26 27 28
/*
 * XXXRTH  Need to document the states a task can be in, and the rules
 * for changing states.
 */

Bob Halley's avatar
Bob Halley committed
29 30
#include <config.h>

31
#include <isc/condition.h>
32
#include <isc/event.h>
33
#include <isc/mem.h>
34
#include <isc/msgs.h>
Brian Wellington's avatar
Brian Wellington committed
35
#include <isc/platform.h>
36
#include <isc/string.h>
Bob Halley's avatar
Bob Halley committed
37
#include <isc/task.h>
38
#include <isc/thread.h>
Michael Graff's avatar
Michael Graff committed
39
#include <isc/util.h>
Bob Halley's avatar
base  
Bob Halley committed
40

41
#ifndef ISC_PLATFORM_USETHREADS
42
#include "task_p.h"
43
#endif /* ISC_PLATFORM_USETHREADS */
44

45 46
#define ISC_TASK_NAMES 1

Bob Halley's avatar
Bob Halley committed
47
#ifdef ISC_TASK_TRACE
48
#define XTRACE(m)		fprintf(stderr, "task %p thread %lu: %s\n", \
49
				       task, isc_thread_self(), (m))
50
#define XTTRACE(t, m)		fprintf(stderr, "task %p thread %lu: %s\n", \
51
				       (t), isc_thread_self(), (m))
52
#define XTHREADTRACE(m)		fprintf(stderr, "thread %lu: %s\n", \
53
				       isc_thread_self(), (m))
Bob Halley's avatar
Bob Halley committed
54 55
#else
#define XTRACE(m)
56
#define XTTRACE(t, m)
57
#define XTHREADTRACE(m)
Bob Halley's avatar
Bob Halley committed
58
#endif
Bob Halley's avatar
base  
Bob Halley committed
59

Bob Halley's avatar
Bob Halley committed
60
/***
Bob Halley's avatar
Bob Halley committed
61
 *** Types.
Bob Halley's avatar
Bob Halley committed
62 63
 ***/

Bob Halley's avatar
Bob Halley committed
64 65
typedef enum {
	task_state_idle, task_state_ready, task_state_running,
66
	task_state_done
Bob Halley's avatar
Bob Halley committed
67 68 69 70 71 72
} 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
73
struct isc_task {
Bob Halley's avatar
Bob Halley committed
74 75
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
76
	isc_taskmgr_t *			manager;
Bob Halley's avatar
Bob Halley committed
77
	isc_mutex_t			lock;
Bob Halley's avatar
Bob Halley committed
78 79 80
	/* Locked by task lock. */
	task_state_t			state;
	unsigned int			references;
Bob Halley's avatar
Bob Halley committed
81
	isc_eventlist_t			events;
82
	isc_eventlist_t			on_shutdown;
Bob Halley's avatar
Bob Halley committed
83
	unsigned int			quantum;
84
	unsigned int			flags;
85 86 87 88
#ifdef ISC_TASK_NAMES
	char				name[16];
	void *				tag;
#endif
Bob Halley's avatar
Bob Halley committed
89
	/* Locked by task manager lock. */
Bob Halley's avatar
Bob Halley committed
90 91
	LINK(isc_task_t)		link;
	LINK(isc_task_t)		ready_link;
Bob Halley's avatar
Bob Halley committed
92 93
};

Bob Halley's avatar
Bob Halley committed
94
#define TASK_F_SHUTTINGDOWN		0x01
95

96 97
#define TASK_SHUTTINGDOWN(t)		(((t)->flags & TASK_F_SHUTTINGDOWN) \
					 != 0)
98

Bob Halley's avatar
Bob Halley committed
99 100 101 102
#define TASK_MANAGER_MAGIC		0x54534B4DU	/* TSKM. */
#define VALID_MANAGER(m)		((m) != NULL && \
					 (m)->magic == TASK_MANAGER_MAGIC)

Bob Halley's avatar
Bob Halley committed
103
struct isc_taskmgr {
Bob Halley's avatar
Bob Halley committed
104 105
	/* Not locked. */
	unsigned int			magic;
Bob Halley's avatar
Bob Halley committed
106
	isc_mem_t *			mctx;
Bob Halley's avatar
Bob Halley committed
107
	isc_mutex_t			lock;
108
	unsigned int			workers;
109
#ifdef ISC_PLATFORM_USETHREADS
110
	isc_thread_t *			threads;
111
#endif /* ISC_PLATFORM_USETHREADS */
Bob Halley's avatar
Bob Halley committed
112 113
	/* Locked by task manager lock. */
	unsigned int			default_quantum;
Bob Halley's avatar
Bob Halley committed
114 115
	LIST(isc_task_t)		tasks;
	LIST(isc_task_t)		ready_tasks;
116
#ifdef ISC_PLATFORM_USETHREADS
Bob Halley's avatar
Bob Halley committed
117
	isc_condition_t			work_available;
118
#endif /* ISC_PLATFORM_USETHREADS */
Bob Halley's avatar
Bob Halley committed
119
	isc_boolean_t			exiting;
120 121
#ifndef ISC_PLATFORM_USETHREADS
	unsigned int			refs;
122
#endif /* ISC_PLATFORM_USETHREADS */
Bob Halley's avatar
Bob Halley committed
123
};
Bob Halley's avatar
Bob Halley committed
124

125
#define DEFAULT_TASKMGR_QUANTUM		10
Bob Halley's avatar
Bob Halley committed
126 127
#define DEFAULT_DEFAULT_QUANTUM		5
#define FINISHED(m)			((m)->exiting && EMPTY((m)->tasks))
Bob Halley's avatar
Bob Halley committed
128

129 130
#ifndef ISC_PLATFORM_USETHREADS
static isc_taskmgr_t *taskmgr = NULL;
131
#endif /* ISC_PLATFORM_USETHREADS */
132

Bob Halley's avatar
base  
Bob Halley committed
133 134 135 136 137
/***
 *** Tasks.
 ***/

static void
138
task_finished(isc_task_t *task) {
Bob Halley's avatar
Bob Halley committed
139
	isc_taskmgr_t *manager = task->manager;
Bob Halley's avatar
base  
Bob Halley committed
140 141

	REQUIRE(EMPTY(task->events));
142
	REQUIRE(EMPTY(task->on_shutdown));
143 144 145 146
	REQUIRE(task->references == 0);
	REQUIRE(task->state == task_state_done);

	XTRACE("task_finished");
Bob Halley's avatar
base  
Bob Halley committed
147 148 149

	LOCK(&manager->lock);
	UNLINK(manager->tasks, task, link);
150
#ifdef ISC_PLATFORM_USETHREADS
Bob Halley's avatar
base  
Bob Halley committed
151 152 153 154 155 156 157 158 159
	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);
	}
160
#endif /* ISC_PLATFORM_USETHREADS */
Bob Halley's avatar
base  
Bob Halley committed
161
	UNLOCK(&manager->lock);
162

Brian Wellington's avatar
Brian Wellington committed
163
	DESTROYLOCK(&task->lock);
Bob Halley's avatar
base  
Bob Halley committed
164
	task->magic = 0;
165
	isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
166 167
}

Bob Halley's avatar
Bob Halley committed
168
isc_result_t
169
isc_task_create(isc_taskmgr_t *manager, unsigned int quantum,
170
		isc_task_t **taskp)
Bob Halley's avatar
Bob Halley committed
171
{
Bob Halley's avatar
Bob Halley committed
172
	isc_task_t *task;
173
	isc_boolean_t exiting;
Bob Halley's avatar
base  
Bob Halley committed
174 175 176 177

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

178
	task = isc_mem_get(manager->mctx, sizeof *task);
Bob Halley's avatar
base  
Bob Halley committed
179
	if (task == NULL)
Bob Halley's avatar
Bob Halley committed
180
		return (ISC_R_NOMEMORY);
181
	XTRACE("isc_task_create");
Bob Halley's avatar
base  
Bob Halley committed
182
	task->manager = manager;
Bob Halley's avatar
Bob Halley committed
183
	if (isc_mutex_init(&task->lock) != ISC_R_SUCCESS) {
184
		isc_mem_put(manager->mctx, task, sizeof *task);
Bob Halley's avatar
Bob Halley committed
185
		UNEXPECTED_ERROR(__FILE__, __LINE__,
186 187 188
				 "isc_mutex_init() %s",
				 isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
						ISC_MSG_FAILED, "failed"));
Bob Halley's avatar
Bob Halley committed
189
		return (ISC_R_UNEXPECTED);
Bob Halley's avatar
update  
Bob Halley committed
190
	}
Bob Halley's avatar
base  
Bob Halley committed
191 192 193
	task->state = task_state_idle;
	task->references = 1;
	INIT_LIST(task->events);
194
	INIT_LIST(task->on_shutdown);
Bob Halley's avatar
base  
Bob Halley committed
195
	task->quantum = quantum;
Bob Halley's avatar
Bob Halley committed
196
	task->flags = 0;
197
#ifdef ISC_TASK_NAMES
Mark Andrews's avatar
Mark Andrews committed
198
	memset(task->name, 0, sizeof task->name);
199 200
	task->tag = NULL;
#endif
Bob Halley's avatar
base  
Bob Halley committed
201 202 203
	INIT_LINK(task, link);
	INIT_LINK(task, ready_link);

204
	exiting = ISC_FALSE;
Bob Halley's avatar
base  
Bob Halley committed
205
	LOCK(&manager->lock);
206 207 208 209 210 211
	if (!manager->exiting) {
		if (task->quantum == 0)
			task->quantum = manager->default_quantum;
		APPEND(manager->tasks, task, link);
	} else
		exiting = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
212 213
	UNLOCK(&manager->lock);

214
	if (exiting) {
Brian Wellington's avatar
Brian Wellington committed
215
		DESTROYLOCK(&task->lock);
216
		isc_mem_put(manager->mctx, task, sizeof *task);
217 218 219
		return (ISC_R_SHUTTINGDOWN);
	}

220
	task->magic = TASK_MAGIC;
Bob Halley's avatar
base  
Bob Halley committed
221 222
	*taskp = task;

Bob Halley's avatar
Bob Halley committed
223
	return (ISC_R_SUCCESS);
Bob Halley's avatar
base  
Bob Halley committed
224 225
}

Bob Halley's avatar
update  
Bob Halley committed
226
void
227
isc_task_attach(isc_task_t *source, isc_task_t **targetp) {
Bob Halley's avatar
base  
Bob Halley committed
228

229 230 231
	/*
	 * Attach *targetp to source.
	 */
Bob Halley's avatar
base  
Bob Halley committed
232

233 234
	REQUIRE(VALID_TASK(source));
	REQUIRE(targetp != NULL && *targetp == NULL);
Bob Halley's avatar
base  
Bob Halley committed
235

236
	XTTRACE(source, "isc_task_attach");
237

238 239 240 241 242
	LOCK(&source->lock);
	source->references++;
	UNLOCK(&source->lock);

	*targetp = source;
Bob Halley's avatar
base  
Bob Halley committed
243 244
}

245 246 247 248
static inline isc_boolean_t
task_shutdown(isc_task_t *task) {
	isc_boolean_t was_idle = ISC_FALSE;
	isc_event_t *event, *prev;
249

250 251 252 253 254 255 256
	/*
	 * Caller must be holding the task's lock.
	 */

	XTRACE("task_shutdown");

	if (! TASK_SHUTTINGDOWN(task)) {
257 258
		XTRACE(isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
				      ISC_MSG_SHUTTINGDOWN, "shutting down"));
259 260 261 262 263 264 265 266 267 268 269 270 271 272
		task->flags |= TASK_F_SHUTTINGDOWN;
		if (task->state == task_state_idle) {
			INSIST(EMPTY(task->events));
			task->state = task_state_ready;
			was_idle = ISC_TRUE;
		}
		INSIST(task->state == task_state_ready ||
		       task->state == task_state_running);
		/*
		 * Note that we post shutdown events LIFO.
		 */
		for (event = TAIL(task->on_shutdown);
		     event != NULL;
		     event = prev) {
273 274 275
			prev = PREV(event, ev_link);
			DEQUEUE(task->on_shutdown, event, ev_link);
			ENQUEUE(task->events, event, ev_link);
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
		}
	}

	return (was_idle);
}

static inline void
task_ready(isc_task_t *task) {
	isc_taskmgr_t *manager = task->manager;

	REQUIRE(VALID_MANAGER(manager));
	REQUIRE(task->state == task_state_ready);

	XTRACE("task_ready");

	LOCK(&manager->lock);

	ENQUEUE(manager->ready_tasks, task, ready_link);
294
#ifdef ISC_PLATFORM_USETHREADS
295
	SIGNAL(&manager->work_available);
296
#endif /* ISC_PLATFORM_USETHREADS */
297 298 299 300

	UNLOCK(&manager->lock);
}

Bob Halley's avatar
Bob Halley committed
301
static inline isc_boolean_t
302 303 304 305 306 307 308 309 310 311 312
task_detach(isc_task_t *task) {

	/*
	 * Caller must be holding the task lock.
	 */

	REQUIRE(task->references > 0);

	XTRACE("detach");

	task->references--;
Bob Halley's avatar
Bob Halley committed
313 314 315 316 317 318 319
	if (task->references == 0 && task->state == task_state_idle) {
		INSIST(EMPTY(task->events));
		/*
		 * There are no references to this task, and no
		 * pending events.  We could try to optimize and
		 * either initiate shutdown or clean up the task,
		 * depending on its state, but it's easier to just
320 321
		 * make the task ready and allow run() or the event
		 * loop to deal with shutting down and termination.
Bob Halley's avatar
Bob Halley committed
322 323 324
		 */
		task->state = task_state_ready;
		return (ISC_TRUE);
325 326
	}

Bob Halley's avatar
Bob Halley committed
327
	return (ISC_FALSE);
328 329
}

Bob Halley's avatar
Bob Halley committed
330
void
Bob Halley's avatar
Bob Halley committed
331 332
isc_task_detach(isc_task_t **taskp) {
	isc_task_t *task;
Bob Halley's avatar
Bob Halley committed
333
	isc_boolean_t was_idle;
Bob Halley's avatar
base  
Bob Halley committed
334

335 336 337 338
	/*
	 * Detach *taskp from its task.
	 */

Bob Halley's avatar
base  
Bob Halley committed
339 340 341 342
	REQUIRE(taskp != NULL);
	task = *taskp;
	REQUIRE(VALID_TASK(task));

343 344
	XTRACE("isc_task_detach");

Bob Halley's avatar
base  
Bob Halley committed
345
	LOCK(&task->lock);
Bob Halley's avatar
Bob Halley committed
346
	was_idle = task_detach(task);
Bob Halley's avatar
base  
Bob Halley committed
347 348
	UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
349
	if (was_idle)
350
		task_ready(task);
Bob Halley's avatar
base  
Bob Halley committed
351 352 353 354

	*taskp = NULL;
}

Bob Halley's avatar
Bob Halley committed
355 356 357
static inline isc_boolean_t
task_send(isc_task_t *task, isc_event_t **eventp) {
	isc_boolean_t was_idle = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
358
	isc_event_t *event;
359

360
	/*
361
	 * Caller must be holding the task lock.
362 363
	 */

Bob Halley's avatar
update  
Bob Halley committed
364 365
	REQUIRE(eventp != NULL);
	event = *eventp;
Bob Halley's avatar
base  
Bob Halley committed
366
	REQUIRE(event != NULL);
367
	REQUIRE(event->ev_type > 0);
Bob Halley's avatar
Bob Halley committed
368
	REQUIRE(task->state != task_state_done);
Bob Halley's avatar
base  
Bob Halley committed
369

370 371
	XTRACE("task_send");

Bob Halley's avatar
Bob Halley committed
372 373 374 375
	if (task->state == task_state_idle) {
		was_idle = ISC_TRUE;
		INSIST(EMPTY(task->events));
		task->state = task_state_ready;
376
	}
Bob Halley's avatar
Bob Halley committed
377 378
	INSIST(task->state == task_state_ready ||
	       task->state == task_state_running);
379
	ENQUEUE(task->events, event, ev_link);
Bob Halley's avatar
Bob Halley committed
380
	*eventp = NULL;
381

Bob Halley's avatar
Bob Halley committed
382
	return (was_idle);
383
}
384

Bob Halley's avatar
Bob Halley committed
385
void
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
isc_task_send(isc_task_t *task, isc_event_t **eventp) {
	isc_boolean_t was_idle;

	/*
	 * Send '*event' to 'task'.
	 */

	REQUIRE(VALID_TASK(task));

	XTRACE("isc_task_send");

	/*
	 * 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 the lock is released.
	 */
	LOCK(&task->lock);
Bob Halley's avatar
Bob Halley committed
403
	was_idle = task_send(task, eventp);
Bob Halley's avatar
base  
Bob Halley committed
404 405 406 407 408 409
	UNLOCK(&task->lock);

	if (was_idle) {
		/*
		 * We need to add this task to the ready queue.
		 *
410 411 412
		 * We've waited until now to do it because making a task
		 * ready requires locking the manager.  If we tried to do
		 * this while holding the task lock, we could deadlock.
Bob Halley's avatar
base  
Bob Halley committed
413 414
		 *
		 * We've changed the state to ready, so no one else will
415 416 417
		 * 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,
418
		 * removed, or a shutdown is started in the interval
419 420
		 * 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
421
		 */
422
		task_ready(task);
Bob Halley's avatar
base  
Bob Halley committed
423
	}
424 425
}

Bob Halley's avatar
Bob Halley committed
426
void
427
isc_task_sendanddetach(isc_task_t **taskp, isc_event_t **eventp) {
Bob Halley's avatar
Bob Halley committed
428
	isc_boolean_t idle1, idle2;
429 430 431 432 433 434 435 436 437 438 439 440
	isc_task_t *task;

	/*
	 * Send '*event' to '*taskp' and then detach '*taskp' from its
	 * task.
	 */

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

	XTRACE("isc_task_sendanddetach");
Bob Halley's avatar
update  
Bob Halley committed
441

442
	LOCK(&task->lock);
Bob Halley's avatar
Bob Halley committed
443 444
	idle1 = task_send(task, eventp);
	idle2 = task_detach(task);
445 446
	UNLOCK(&task->lock);

Bob Halley's avatar
Bob Halley committed
447 448 449 450 451 452
	/*
	 * If idle1, then idle2 shouldn't be true as well since we're holding
	 * the task lock, and thus the task cannot switch from ready back to
	 * idle.
	 */
	INSIST(!(idle1 && idle2));
453

Bob Halley's avatar
Bob Halley committed
454 455
	if (idle1 || idle2)
		task_ready(task);
456 457

	*taskp = NULL;
Bob Halley's avatar
base  
Bob Halley committed
458 459
}

460
#define PURGE_OK(event)	(((event)->ev_attributes & ISC_EVENTATTR_NOPURGE) == 0)
461 462 463 464 465

static unsigned int
dequeue_events(isc_task_t *task, void *sender, isc_eventtype_t first,
	       isc_eventtype_t last, void *tag,
	       isc_eventlist_t *events, isc_boolean_t purging)
466
{
Bob Halley's avatar
Bob Halley committed
467
	isc_event_t *event, *next_event;
468
	unsigned int count = 0;
469

Bob Halley's avatar
Bob Halley committed
470
	REQUIRE(VALID_TASK(task));
471
	REQUIRE(last >= first);
Bob Halley's avatar
Bob Halley committed
472

473
	XTRACE("dequeue_events");
Bob Halley's avatar
Bob Halley committed
474

Bob Halley's avatar
Bob Halley committed
475
	/*
476 477 478
	 * Events matching 'sender', whose type is >= first and <= last, and
	 * whose tag is 'tag' will be dequeued.  If 'purging', matching events
	 * which are marked as unpurgable will not be dequeued.
479
	 *
480
	 * sender == NULL means "any sender", and tag == NULL means "any tag".
Bob Halley's avatar
Bob Halley committed
481 482 483
	 */

	LOCK(&task->lock);
484 485

	for (event = HEAD(task->events); event != NULL; event = next_event) {
486 487 488 489
		next_event = NEXT(event, ev_link);
		if (event->ev_type >= first && event->ev_type <= last &&
		    (sender == NULL || event->ev_sender == sender) &&
		    (tag == NULL || event->ev_tag == tag) &&
490
		    (!purging || PURGE_OK(event))) {
491 492
			DEQUEUE(task->events, event, ev_link);
			ENQUEUE(*events, event, ev_link);
493
			count++;
Bob Halley's avatar
Bob Halley committed
494 495
		}
	}
496

Bob Halley's avatar
Bob Halley committed
497 498
	UNLOCK(&task->lock);

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
	return (count);
}

unsigned int
isc_task_purgerange(isc_task_t *task, void *sender, isc_eventtype_t first,
		    isc_eventtype_t last, void *tag)
{
	unsigned int count;
	isc_eventlist_t events;
	isc_event_t *event, *next_event;

	/*
	 * Purge events from a task's event queue.
	 */

	XTRACE("isc_task_purgerange");

	ISC_LIST_INIT(events);

	count = dequeue_events(task, sender, first, last, tag, &events,
			       ISC_TRUE);

	for (event = HEAD(events); event != NULL; event = next_event) {
522
		next_event = NEXT(event, ev_link);
Bob Halley's avatar
Bob Halley committed
523
		isc_event_free(&event);
Bob Halley's avatar
Bob Halley committed
524
	}
525

526 527 528 529 530
	/*
	 * Note that purging never changes the state of the task.
	 */

	return (count);
Bob Halley's avatar
Bob Halley committed
531 532
}

533
unsigned int
Bob Halley's avatar
Bob Halley committed
534
isc_task_purge(isc_task_t *task, void *sender, isc_eventtype_t type,
535
	       void *tag)
Bob Halley's avatar
Bob Halley committed
536
{
537 538 539 540
	/*
	 * Purge events from a task's event queue.
	 */

541 542
	XTRACE("isc_task_purge");

Bob Halley's avatar
Bob Halley committed
543
	return (isc_task_purgerange(task, sender, type, type, tag));
544 545
}

Bob Halley's avatar
Bob Halley committed
546 547 548 549 550 551
isc_boolean_t
isc_task_purgeevent(isc_task_t *task, isc_event_t *event) {
	isc_event_t *curr_event, *next_event;

	/*
	 * Purge 'event' from a task's event queue.
552 553
	 *
	 * XXXRTH:  WARNING:  This method may be removed before beta.
Bob Halley's avatar
Bob Halley committed
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
	 */

	REQUIRE(VALID_TASK(task));

	/*
	 * If 'event' is on the task's event queue, it will be purged,
	 * unless it is marked as unpurgeable.  'event' does not have to be
	 * on the task's event queue; in fact, it can even be an invalid
	 * pointer.  Purging only occurs if the event is actually on the task's
	 * event queue.
	 *
	 * Purging never changes the state of the task.
	 */

	LOCK(&task->lock);
	for (curr_event = HEAD(task->events);
	     curr_event != NULL;
	     curr_event = next_event) {
572
		next_event = NEXT(curr_event, ev_link);
573
		if (curr_event == event && PURGE_OK(event)) {
574
			DEQUEUE(task->events, curr_event, ev_link);
Bob Halley's avatar
Bob Halley committed
575 576 577 578 579 580 581 582 583 584 585 586 587
			break;
		}
	}
	UNLOCK(&task->lock);

	if (curr_event == NULL)
		return (ISC_FALSE);

	isc_event_free(&curr_event);

	return (ISC_TRUE);
}

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
unsigned int
isc_task_unsendrange(isc_task_t *task, void *sender, isc_eventtype_t first,
		     isc_eventtype_t last, void *tag,
		     isc_eventlist_t *events)
{
	/*
	 * Remove events from a task's event queue.
	 */

	XTRACE("isc_task_unsendrange");

	return (dequeue_events(task, sender, first, last, tag, events,
			       ISC_FALSE));
}

unsigned int
isc_task_unsend(isc_task_t *task, void *sender, isc_eventtype_t type,
		void *tag, isc_eventlist_t *events)
{
	/*
	 * Remove events from a task's event queue.
	 */

	XTRACE("isc_task_unsend");

	return (dequeue_events(task, sender, type, type, tag, events,
			       ISC_FALSE));
}

617
isc_result_t
David Lawrence's avatar
David Lawrence committed
618 619
isc_task_onshutdown(isc_task_t *task, isc_taskaction_t action, const void *arg)
{
620 621 622 623
	isc_boolean_t disallowed = ISC_FALSE;
	isc_result_t result = ISC_R_SUCCESS;
	isc_event_t *event;

624 625 626 627 628
	/*
	 * Send a shutdown event with action 'action' and argument 'arg' when
	 * 'task' is shutdown.
	 */

629
	REQUIRE(VALID_TASK(task));
630
	REQUIRE(action != NULL);
631

632
	event = isc_event_allocate(task->manager->mctx,
633 634 635 636 637
				   NULL,
				   ISC_TASKEVENT_SHUTDOWN,
				   action,
				   arg,
				   sizeof *event);
638 639 640 641
	if (event == NULL)
		return (ISC_R_NOMEMORY);

	LOCK(&task->lock);
Bob Halley's avatar
Bob Halley committed
642
	if (TASK_SHUTTINGDOWN(task)) {
643
		disallowed = ISC_TRUE;
644
		result = ISC_R_SHUTTINGDOWN;
645
	} else
646
		ENQUEUE(task->on_shutdown, event, ev_link);
647 648 649
	UNLOCK(&task->lock);

	if (disallowed)
650
		isc_mem_put(task->manager->mctx, event, sizeof *event);
651 652 653 654

	return (result);
}

Bob Halley's avatar
Bob Halley committed
655
void
Bob Halley's avatar
Bob Halley committed
656
isc_task_shutdown(isc_task_t *task) {
657
	isc_boolean_t was_idle;
Bob Halley's avatar
base  
Bob Halley committed
658

659 660 661 662
	/*
	 * Shutdown 'task'.
	 */

Bob Halley's avatar
base  
Bob Halley committed
663 664 665
	REQUIRE(VALID_TASK(task));

	LOCK(&task->lock);
666
	was_idle = task_shutdown(task);
Bob Halley's avatar
base  
Bob Halley committed
667 668
	UNLOCK(&task->lock);

669 670
	if (was_idle)
		task_ready(task);
Bob Halley's avatar
Bob Halley committed
671
}
Bob Halley's avatar
base  
Bob Halley committed
672

Bob Halley's avatar
Bob Halley committed
673
void
Bob Halley's avatar
Bob Halley committed
674
isc_task_destroy(isc_task_t **taskp) {
Bob Halley's avatar
Bob Halley committed
675

676 677 678 679
	/*
	 * Destroy '*taskp'.
	 */

Bob Halley's avatar
Bob Halley committed
680 681
	REQUIRE(taskp != NULL);

Bob Halley's avatar
Bob Halley committed
682 683
	isc_task_shutdown(*taskp);
	isc_task_detach(taskp);
Bob Halley's avatar
base  
Bob Halley committed
684 685
}

686
void
David Lawrence's avatar
David Lawrence committed
687
isc_task_setname(isc_task_t *task, const char *name, void *tag) {
688 689 690 691 692 693 694 695 696 697 698 699 700 701

	/*
	 * Name 'task'.
	 */

	REQUIRE(VALID_TASK(task));

#ifdef ISC_TASK_NAMES
	LOCK(&task->lock);
	memset(task->name, 0, sizeof(task->name));
	strncpy(task->name, name, sizeof(task->name) - 1);
	task->tag = tag;
	UNLOCK(&task->lock);
#else
Andreas Gustafsson's avatar
Andreas Gustafsson committed
702 703
	UNUSED(name);
	UNUSED(tag);
704
#endif
Bob Halley's avatar
base  
Bob Halley committed
705

706
}
Bob Halley's avatar
Bob Halley committed
707

708 709 710 711 712 713 714 715 716 717 718
const char *
isc_task_getname(isc_task_t *task) {
	return (task->name);
}

void *
isc_task_gettag(isc_task_t *task) {
	return (task->tag);
}


Bob Halley's avatar
base  
Bob Halley committed
719 720 721
/***
 *** Task Manager.
 ***/
722 723
static void
dispatch(isc_taskmgr_t *manager) {
Bob Halley's avatar
Bob Halley committed
724
	isc_task_t *task;
725 726
#ifndef ISC_PLATFORM_USETHREADS
	unsigned int total_dispatch_count = 0;
727
#endif /* ISC_PLATFORM_USETHREADS */
Bob Halley's avatar
base  
Bob Halley committed
728 729 730 731 732 733

	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.
734
	 *
Bob Halley's avatar
base  
Bob Halley committed
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
	 * 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.
762
	 *
Bob Halley's avatar
base  
Bob Halley committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
	 * 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)) {
783
#ifdef ISC_PLATFORM_USETHREADS
Bob Halley's avatar
base  
Bob Halley committed
784 785
		/*
		 * For reasons similar to those given in the comment in
786
		 * isc_task_send() above, it is safe for us to dequeue
Bob Halley's avatar
base  
Bob Halley committed
787 788 789 790 791
		 * 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)) {
792 793 794
			XTHREADTRACE(isc_msgcat_get(isc_msgcat,
						    ISC_MSGSET_GENERAL,
						    ISC_MSG_WAIT, "wait"));
Bob Halley's avatar
base  
Bob Halley committed
795
			WAIT(&manager->work_available, &manager->lock);
796 797 798
			XTHREADTRACE(isc_msgcat_get(isc_msgcat,
						    ISC_MSGSET_TASK,
						    ISC_MSG_AWAKE, "awake"));
Bob Halley's avatar
base  
Bob Halley committed
799
		}
800
#else /* ISC_PLATFORM_USETHREADS */
801 802 803
		if (total_dispatch_count >= DEFAULT_TASKMGR_QUANTUM ||
		    EMPTY(manager->ready_tasks))
			break;
804
#endif /* ISC_PLATFORM_USETHREADS */
805 806
		XTHREADTRACE(isc_msgcat_get(isc_msgcat, ISC_MSGSET_TASK,
					    ISC_MSG_WORKING, "working"));
807

Bob Halley's avatar
base  
Bob Halley committed
808 809
		task = HEAD(manager->ready_tasks);
		if (task != NULL) {
Bob Halley's avatar
Bob Halley committed
810
			unsigned int dispatch_count = 0;
Bob Halley's avatar
Bob Halley committed
811 812
			isc_boolean_t done = ISC_FALSE;
			isc_boolean_t requeue = ISC_FALSE;
813
			isc_boolean_t finished = ISC_FALSE;
Bob Halley's avatar
Bob Halley committed
814
			isc_event_t *event;
Bob Halley's avatar
base  
Bob Halley committed
815 816 817 818 819

			INSIST(VALID_TASK(task));

			/*
			 * Note we only unlock the manager lock if we actually
820
			 * have a task to do.  We must reacquire the manager
Bob Halley's avatar
base  
Bob Halley committed
821 822 823 824 825 826
			 * 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
827
			INSIST(task->state == task_state_ready);
828
			task->state = task_state_running;
829 830
			XTRACE(isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
					      ISC_MSG_RUNNING, "running"));
831 832 833
			do {
				if (!EMPTY(task->events)) {
					event = HEAD(task->events);
834
					DEQUEUE(task->events, event, ev_link);
Bob Halley's avatar
base  
Bob Halley committed
835

836 837 838
					/*
					 * Execute the event action.
					 */
839 840 841 842
					XTRACE(isc_msgcat_get(isc_msgcat,
							    ISC_MSGSET_TASK,
							    ISC_MSG_EXECUTE,
							    "execute action"));
843
					if (event->ev_action != NULL) {
844
						UNLOCK(&task->lock);
845
						(event->ev_action)(task,event);
846 847 848
						LOCK(&task->lock);
					}
					dispatch_count++;
849 850
#ifndef ISC_PLATFORM_USETHREADS
					total_dispatch_count++;
851
#endif /* ISC_PLATFORM_USETHREADS */
852
				}
853

Bob Halley's avatar
Bob Halley committed
854 855 856 857
				if (task->references == 0 &&
				    EMPTY(task->events) &&
				    !TASK_SHUTTINGDOWN(task)) {
					isc_boolean_t was_idle;
858

Bob Halley's avatar
Bob Halley committed
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
					/*
					 * There are no references and no
					 * pending events for this task,
					 * which means it will not become
					 * runnable again via an external
					 * action (such as sending an event
					 * or detaching).
					 *
					 * We initiate shutdown to prevent
					 * it from becoming a zombie.
					 *
					 * We do this here instead of in
					 * the "if EMPTY(task->events)" block
					 * below because:
					 *
					 *	If we post no shutdown events,
					 *	we want the task to finish.
					 *
					 *	If we did post shutdown events,
					 *	will still want the task's
					 *	quantum to be applied.
					 */
					was_idle = task_shutdown(task);
					INSIST(!was_idle);
883 884
				}

885
				if (EMPTY(task->events)) {
Bob Halley's avatar
Bob Halley committed
886
					/*
887
					 * Nothing else to do for this task
Bob Halley's avatar
Bob Halley committed
888
					 * right now.
Bob Halley's avatar
Bob Halley committed
889
					 */
890 891 892 893
					XTRACE(isc_msgcat_get(isc_msgcat,
							      ISC_MSGSET_TASK,
							      ISC_MSG_EMPTY,
							      "empty"));
Bob Halley's avatar
Bob Halley committed
894 895 896 897 898
					if (task->references == 0 &&
					    TASK_SHUTTINGDOWN(task)) {
						/*
						 * The task is done.
						 */
899 900 901 902 903
						XTRACE(isc_msgcat_get(
							       isc_msgcat,
							       ISC_MSGSET_TASK,
							       ISC_MSG_DONE,
							       "done"));
Bob Halley's avatar
Bob Halley committed
904
						finished = ISC_TRUE;
905
						task->state = task_state_done;
906 907
					} else
						task->state = task_state_idle;
Bob Halley's avatar
Bob Halley committed
908
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
909 910 911 912 913 914 915 916 917 918 919
				} 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.
					 */
920 921 922 923
					XTRACE(isc_msgcat_get(isc_msgcat,
							      ISC_MSGSET_TASK,
							      ISC_MSG_QUANTUM,
							      "quantum"));
Bob Halley's avatar
base  
Bob Halley committed
924
					task->state = task_state_ready;
Bob Halley's avatar
Bob Halley committed
925 926
					requeue = ISC_TRUE;
					done = ISC_TRUE;
Bob Halley's avatar
base  
Bob Halley committed
927
				}
928
			} while (!done);
Bob Halley's avatar
base  
Bob Halley committed
929 930
			UNLOCK(&task->lock);

931 932
			if (finished)
				task_finished(task);
Bob Halley's avatar
base  
Bob Halley committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960

			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);
961 962 963 964 965 966 967 968 969 970
}

#ifdef ISC_PLATFORM_USETHREADS
static isc_threadresult_t
#ifdef _WIN32
WINAPI
#endif
run(void *uap) {
	isc_taskmgr_t *manager = uap;

971 972
	XTHREADTRACE(isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
				    ISC_MSG_STARTING, "starting"));
973 974

	dispatch(manager);
Bob Halley's avatar
base  
Bob Halley committed
975

976 977
	XTHREADTRACE(isc_msgcat_get(isc_msgcat, ISC_MSGSET_GENERAL,
				    ISC_MSG_EXITING, "exiting"));
Bob Halley's avatar
base  
Bob Halley committed
978

Bob Halley's avatar
update  
Bob Halley committed
979
	return ((isc_threadresult_t)0);
Bob Halley's avatar
base  
Bob Halley committed
980
}