mirror of
https://github.com/isc-projects/bind9.git
synced 2026-03-01 21:10:55 -05:00
184 lines
4.2 KiB
C
184 lines
4.2 KiB
C
/*
|
|
* Copyright (C) 1998, 1999 Internet Software Consortium.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef ISC_TASK_H
|
|
#define ISC_TASK_H 1
|
|
|
|
/*****
|
|
***** Module Info
|
|
*****/
|
|
|
|
/*
|
|
* Task System
|
|
*
|
|
* XXX <TBS> XXX
|
|
*
|
|
* MP:
|
|
* The module ensures appropriate synchronization of data structures it
|
|
* creates and manipulates.
|
|
*
|
|
* The caller must ensure that isc_taskmgr_destroy() is called only
|
|
* once for a given manager.
|
|
*
|
|
* Reliability:
|
|
* No anticipated impact.
|
|
*
|
|
* Resources:
|
|
* <TBS>
|
|
*
|
|
* Security:
|
|
* No anticipated impact.
|
|
*
|
|
* Standards:
|
|
* None.
|
|
*/
|
|
|
|
|
|
/***
|
|
*** Imports.
|
|
***/
|
|
|
|
#include <stddef.h>
|
|
|
|
#include <isc/lang.h>
|
|
#include <isc/list.h>
|
|
#include <isc/mem.h>
|
|
#include <isc/result.h>
|
|
|
|
ISC_LANG_BEGINDECLS
|
|
|
|
/***
|
|
*** Core Types.
|
|
***/
|
|
|
|
typedef struct isc_event isc_event_t;
|
|
typedef struct isc_task isc_task_t;
|
|
typedef struct isc_taskmgr isc_taskmgr_t;
|
|
|
|
|
|
/*****
|
|
***** Events.
|
|
*****/
|
|
|
|
/*
|
|
* Negative event types are reserved for use by the task manager.
|
|
*
|
|
* Type 0 means "any type".
|
|
*/
|
|
typedef int isc_eventtype_t;
|
|
|
|
typedef void (*isc_taskaction_t)(isc_task_t *, isc_event_t *);
|
|
typedef void (*isc_eventdestructor_t)(isc_event_t *);
|
|
|
|
/*
|
|
* This structure is public because "subclassing" it may be useful when
|
|
* defining new event types.
|
|
*/
|
|
struct isc_event {
|
|
isc_mem_t * mctx;
|
|
size_t size;
|
|
void * sender;
|
|
isc_eventtype_t type;
|
|
isc_taskaction_t action;
|
|
void * arg;
|
|
isc_eventdestructor_t destroy;
|
|
ISC_LINK(struct isc_event) link;
|
|
};
|
|
|
|
#define ISC_TASKEVENT_ANYEVENT 0
|
|
#define ISC_TASKEVENT_SHUTDOWN (-1)
|
|
|
|
typedef ISC_LIST(struct isc_event) isc_eventlist_t;
|
|
|
|
isc_event_t * isc_event_allocate(isc_mem_t *,
|
|
void *,
|
|
isc_eventtype_t,
|
|
isc_taskaction_t,
|
|
void *arg,
|
|
size_t);
|
|
void isc_event_free(isc_event_t **);
|
|
|
|
|
|
/*****
|
|
***** Tasks.
|
|
*****/
|
|
|
|
isc_result_t isc_task_create(isc_taskmgr_t *,
|
|
isc_mem_t *,
|
|
unsigned int,
|
|
isc_task_t **);
|
|
void isc_task_attach(isc_task_t *,
|
|
isc_task_t **);
|
|
void isc_task_detach(isc_task_t **);
|
|
isc_mem_t * isc_task_mem(isc_task_t *);
|
|
isc_result_t isc_task_send(isc_task_t *,
|
|
isc_event_t **);
|
|
unsigned int isc_task_purge(isc_task_t *, void *,
|
|
isc_eventtype_t);
|
|
isc_result_t isc_task_allowsend(isc_task_t *,
|
|
isc_boolean_t);
|
|
isc_result_t isc_task_onshutdown(isc_task_t *,
|
|
isc_taskaction_t,
|
|
void *);
|
|
void isc_task_shutdown(isc_task_t *);
|
|
void isc_task_destroy(isc_task_t **);
|
|
|
|
|
|
/*****
|
|
***** Task Manager.
|
|
*****/
|
|
|
|
isc_result_t
|
|
isc_taskmgr_create(isc_mem_t *mctx, unsigned int workers,
|
|
unsigned int default_quantum, isc_taskmgr_t **managerp);
|
|
/*
|
|
* Create a new task manager.
|
|
*
|
|
* Notes:
|
|
*
|
|
* 'workers' in the number of worker threads to create. In general,
|
|
* the value should be close to the number of processors in the system.
|
|
* The 'workers' value is advisory only. An attempt will be made to
|
|
* create 'workers' threads, but if at least one thread creation
|
|
* succeeds, isc_taskmgr_create() may return ISC_R_SUCCESS.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'mctx' is a valid memory context.
|
|
*
|
|
* workers > 0
|
|
*
|
|
* managerp != NULL && *managerp == NULL
|
|
*
|
|
* Ensures:
|
|
*
|
|
* On success, '*managerp' will be attached to the newly created task
|
|
* manager.
|
|
*
|
|
* Returns:
|
|
*
|
|
* ISC_R_SUCCESS
|
|
* ISC_R_NOMEMORY
|
|
* ISC_R_NOTHREADS No threads could be created.
|
|
* ISC_R_UNEXPECTED An unexpected error occurred.
|
|
*/
|
|
|
|
void isc_taskmgr_destroy(isc_taskmgr_t **);
|
|
|
|
ISC_LANG_ENDDECLS
|
|
|
|
#endif /* ISC_TASK_H */
|