--- libaitsched/inc/aitsched.h 2012/05/31 22:31:48 1.10 +++ libaitsched/inc/aitsched.h 2012/08/21 13:15:49 1.15.2.1 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitsched.h,v 1.10 2012/05/31 22:31:48 misho Exp $ +* $Id: aitsched.h,v 1.15.2.1 2012/08/21 13:15:49 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -49,9 +49,14 @@ SUCH DAMAGE. #include #include +#include #include #include #include +#include +#ifdef EVFILT_LIO +#include +#endif /* criteria type */ @@ -62,6 +67,7 @@ SUCH DAMAGE. #define CRITERIA_VAL 4 #define CRITERIA_TS 5 #define CRITERIA_DATA 6 +#define CRITERIA_ID 7 /* early declaration for root & task */ @@ -75,12 +81,16 @@ typedef enum { taskALARM, taskNODE, taskPROC, - taskUSER, taskSIGNAL, + taskAIO, + taskLIO, + taskUSER, taskEVENT, - taskEVENTLO, + taskTASK, + taskSUSPEND, taskREADY, taskUNUSE, + taskTHREAD, taskMAX } sched_task_type_t; @@ -100,18 +110,30 @@ struct sched_HooksTask { sched_hook_func_t node; /* proc(sched_task_t *task, NULL) -> int */ sched_hook_func_t proc; - /* user(sched_task_t *task, NULL) -> int */ - sched_hook_func_t user; /* signal(sched_task_t *task, NULL) -> int */ sched_hook_func_t signal; + /* aio(sched_task_t *task, NULL) -> int */ + sched_hook_func_t aio; + /* lio(sched_task_t *task, NULL) -> int */ + sched_hook_func_t lio; + /* user(sched_task_t *task, NULL) -> int */ + sched_hook_func_t user; /* event(sched_task_t *task, NULL) -> int */ sched_hook_func_t event; - /* eventlo(sched_task_t *task, NULL) -> int */ - sched_hook_func_t eventlo; + /* task(sched_task_t *task, NULL) -> int */ + sched_hook_func_t task; + /* suspend(sched_task_t *task, NULL) -> int */ + sched_hook_func_t suspend; + /* thread(sched_task_t *task, NULL) -> int */ + sched_hook_func_t thread; } hook_add; struct { + /* exit(sched_task_t *task, void *exitValue) -> int */ + sched_hook_func_t exit; /* cancel(sched_task_t *task, NULL) -> int */ sched_hook_func_t cancel; + /* resume(sched_task_t *task, NULL) -> int */ + sched_hook_func_t resume; /* run(sched_root_task_t *root, NULL) -> int */ sched_hook_func_t run; /* fetch(sched_root_task_t *root, NULL) -> sched_task_t* */ @@ -142,16 +164,20 @@ typedef void *(*sched_task_func_t)(sched_task_t * /* c /* task & queue */ struct sched_Task { - volatile int task_lock; uintptr_t task_id; #define TASK_ID(x) ((struct sched_Task*) (x)->task_id) sched_task_type_t task_type; #define TASK_TYPE(x) (x)->task_type + volatile int task_lock; sched_root_task_t *task_root; #define TASK_ROOT(x) (x)->task_root sched_task_func_t task_func; #define TASK_FUNC(x) (x)->task_func + intptr_t task_ret; +#define TASK_RET(x) (x)->task_ret + unsigned int task_flag; +#define TASK_FLAG(x) (x)->task_flag void *task_arg; union { @@ -181,9 +207,11 @@ typedef TAILQ_HEAD(, sched_Task) sched_queue_t; /* root task */ struct sched_RootTask { int root_kq; + unsigned long root_miss; struct timespec root_wait; struct timespec root_poll; intptr_t root_cond; + void *root_ret; pthread_mutex_t root_mtx[taskMAX]; @@ -193,13 +221,16 @@ struct sched_RootTask { sched_queue_t root_alarm; sched_queue_t root_node; sched_queue_t root_proc; - sched_queue_t root_user; sched_queue_t root_signal; + sched_queue_t root_aio; + sched_queue_t root_lio; + sched_queue_t root_user; sched_queue_t root_event; - sched_queue_t root_eventlo; + sched_queue_t root_task; + sched_queue_t root_suspend; sched_queue_t root_ready; sched_queue_t root_unuse; - int root_eventlo_miss; + sched_queue_t root_thread; hooks_task_t root_hooks; struct iovec root_data; @@ -207,6 +238,7 @@ struct sched_RootTask { #define ROOT_DATLEN(x) (x)->root_data.iov_len }; #define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q)) +#define ROOT_RETURN(x) (x)->root_ret inline int sched_GetErrno(); @@ -237,6 +269,20 @@ int schedEnd(sched_root_task_t ** __restrict root); */ int schedRegisterHooks(sched_root_task_t * __restrict root); /* + * sched_useTask() - Get and init new task + * + * @root = root task + * return: NULL error or !=NULL prepared task + */ +inline sched_task_t *sched_useTask(sched_root_task_t * __restrict root); +/* + * sched_unuseTask() - Unlock and put task to unuse queue + * + * @task = task + * return: always is NULL + */ +inline sched_task_t *sched_unuseTask(sched_task_t * __restrict task); +/* * schedPolling() - Polling timeout period if no timer task is present * * @root = root task @@ -251,7 +297,7 @@ inline int schedPolling(sched_root_task_t * __restrict * * @root = root task * @condValue = condition value, kill schedRun() if condValue == killState - * return: -1 error ok 0 ok + * return: -1 error or 0 ok */ inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue); /* @@ -289,7 +335,7 @@ int schedCancel(sched_task_t * __restrict task); * @root = root task * @type = cancel from queue type, if =taskMAX cancel same task from all queues * @criteria = find task by criteria - * [CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TS|CRITERIA_DATA] + * [CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA] * @param = search parameter * @hook = custom cleanup hook function, may be NULL * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok @@ -389,7 +435,93 @@ sched_task_t *schedSignal(sched_root_task_t * __restri #define schedSignalSelf(x) schedSignal(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) +#ifdef EVFILT_LIO /* + * schedAIO() - Add AIO task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @acb = AIO cb structure address + * @opt_data = Optional data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedAIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + struct aiocb * __restrict acb, void *opt_data, size_t opt_dlen); +/* + * schedAIORead() - Add AIO read task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = file descriptor + * @buffer = Buffer + * @buflen = Buffer length + * @offset = Offset from start of file, if =-1 from current position + * return: NULL error or !=NULL new queued task + */ +inline sched_task_t *schedAIORead(sched_root_task_t * __restrict root, sched_task_func_t func, + void *arg, int fd, void *buffer, size_t buflen, off_t offset); +/* + * schedAIOWrite() - Add AIO write task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = file descriptor + * @buffer = Buffer + * @buflen = Buffer length + * @offset = Offset from start of file, if =-1 from current position + * return: NULL error or !=NULL new queued task + */ +inline sched_task_t *schedAIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func, + void *arg, int fd, void *buffer, size_t buflen, off_t offset); + +/* + * schedLIO() - Add AIO bulk tasks to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @acbs = AIO cb structure addresses + * @opt_data = Optional data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedLIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + struct aiocb ** __restrict acbs, void *opt_data, size_t opt_dlen); +/* + * schedLIORead() - Add list of AIO read tasks to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = file descriptor + * @bufs = Buffer's list + * @nbufs = Number of Buffers + * @offset = Offset from start of file, if =-1 from current position + * return: NULL error or !=NULL new queued task + */ +inline sched_task_t *schedLIORead(sched_root_task_t * __restrict root, sched_task_func_t func, + void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset); +/* + * schedLIOWrite() - Add list of AIO write tasks to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = file descriptor + * @bufs = Buffer's list + * @nbufs = Number of Buffers + * @offset = Offset from start of file, if =-1 from current position + * return: NULL error or !=NULL new queued task + */ +inline sched_task_t *schedLIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func, + void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset); +#endif /* EVFILT_LIO */ + +/* * schedUser() - Add trigger USER task to scheduler queue * * @root = root task @@ -443,20 +575,45 @@ sched_task_t *schedEvent(sched_root_task_t * __restric #define schedEventSelf(x) schedEvent(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) /* - * schedEventLo() - Add EVENT_Lo task to scheduler queue + * schedTask() - Add regular task to scheduler queue * * @root = root task * @func = task execution function * @arg = 1st func argument - * @val = additional func argument + * @prio = regular task priority, 0 is hi priority for regular tasks * @opt_data = Optional data * @opt_dlen = Optional data length * return: NULL error or !=NULL new queued task */ -sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, - unsigned long val, void *opt_data, size_t opt_dlen); -#define schedEventLoSelf(x) schedEventLo(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ +sched_task_t *schedTask(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + unsigned long prio, void *opt_data, size_t opt_dlen); +#define schedTaskSelf(x) schedTask(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* + * schedSuspend() - Add Suspended task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @id = Trigger ID + * @opt_data = Optional data + * @opt_dlen = Optional user's trigger flags + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedSuspend(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + unsigned long id, void *opt_data, size_t opt_dlen); +#define schedSuspendSelf(x) schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* + * schedResumeby() - Resume suspended task + * + * @root = root task + * @criteria = find task by criteria + * [CRITERIA_ANY|CRITERIA_ID|CRITERIA_DATA] + * @param = search parameter (sched_task_t *task| u_long id) + * return: -1 error or 0 resumed ok + */ +int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param); /* * schedCallOnce() - Call once from scheduler @@ -473,6 +630,48 @@ sched_task_t *schedCallOnce(sched_root_task_t * __rest unsigned long val, void *opt_data, size_t opt_dlen); #define schedCallAgain(x) schedCallOnce(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) + +/* + * schedThread() - Add thread task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @detach = Detach thread from scheduler, if !=0 + * @opt_data = Optional data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedThread(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + int detach, void *opt_data, size_t opt_dlen); +#define schedThreadSelf(x) schedThread(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* + * taskExit() - Exit routine for scheduler task + * + * @t = current executed task + * @x = exit value for task + * return: none + */ +#define taskExit(t, x) do { assert((t) && TASK_ROOT(t)); \ + if (TASK_ROOT(t)->root_hooks.hook_exec.exit) \ + TASK_ROOT(t)->root_hooks.hook_exec.exit((t), \ + (void*) (x)); \ + TASK_ROOT(t)->root_ret = (void*) (x); \ + if (TASK_TYPE(t) == taskTHREAD) { \ + sched_unuseTask(t); \ + pthread_exit((void*) (x)); \ + } else \ + return ((void*) (x)); \ +} while (0) +#define taskKill(t, s) do { assert((t) && TASK_ROOT(t)); \ + if (TASK_TYPE(t) == taskTHREAD) { \ + pthread_t _tid = (pthread_t) TASK_VAL((t)); \ + sched_unuseTask(t); \ + pthread_kill(_tid, (s)); \ + } else \ + schedCancel((t)); \ +} while (0) #endif