--- libaitsched/inc/aitsched.h 2012/08/21 12:54:39 1.15 +++ libaitsched/inc/aitsched.h 2015/07/02 22:45:00 1.28 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitsched.h,v 1.15 2012/08/21 12:54:39 misho Exp $ +* $Id: aitsched.h,v 1.28 2015/07/02 22:45:00 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -12,7 +12,7 @@ terms: All of the documentation and software included in the ELWIX and AITNET Releases is copyrighted by ELWIX - Sofia/Bulgaria -Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 +Copyright 2004 - 2015 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -49,7 +49,7 @@ SUCH DAMAGE. #include #include -#include +#include #include #include #include @@ -67,7 +67,8 @@ SUCH DAMAGE. #define CRITERIA_VAL 4 #define CRITERIA_TS 5 #define CRITERIA_DATA 6 -#define CRITERIA_ID 7 +#define CRITERIA_DATLEN 7 +#define CRITERIA_ID 8 /* early declaration for root & task */ @@ -91,6 +92,7 @@ typedef enum { taskREADY, taskUNUSE, taskTHREAD, + taskRTC, taskMAX } sched_task_type_t; @@ -126,6 +128,8 @@ struct sched_HooksTask { sched_hook_func_t suspend; /* thread(sched_task_t *task, NULL) -> int */ sched_hook_func_t thread; + /* rtc(sched_task_t *task, NULL) -> int */ + sched_hook_func_t rtc; } hook_add; struct { /* exit(sched_task_t *task, void *exitValue) -> int */ @@ -156,6 +160,7 @@ typedef struct sched_HooksTask hooks_task_t; /* task callback, like pthread callback! */ typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/); +#define SCHED_TASK_DEFINE(x) void *(x)(sched_task_t*) /* task lock helpers */ #define TASK_LOCK(x) ((x)->task_lock = 42) @@ -176,7 +181,7 @@ struct sched_Task { #define TASK_FUNC(x) (x)->task_func intptr_t task_ret; #define TASK_RET(x) (x)->task_ret - unsigned int task_flag; + unsigned long task_flag; #define TASK_FLAG(x) (x)->task_flag void *task_arg; @@ -190,6 +195,9 @@ struct sched_Task { #define TASK_FD(x) (x)->task_val.fd #define TASK_TS(x) (x)->task_val.ts +#define TASK_TS2TV(x, tvp) (assert((tvp)), (tvp)->tv_sec = (x)->task_val.ts.tv_sec, \ + (tvp)->tv_usec = (x)->task_val.ts.tv_nsec / 1000) + struct iovec task_data; #define TASK_DATA(x) (x)->task_data.iov_base #define TASK_DATLEN(x) (x)->task_data.iov_len @@ -207,10 +215,11 @@ typedef TAILQ_HEAD(, sched_Task) sched_queue_t; /* root task */ struct sched_RootTask { int root_kq; - unsigned long root_miss; + fd_set root_fds[2]; struct timespec root_wait; struct timespec root_poll; - intptr_t root_cond; + unsigned long root_miss; + intptr_t root_cond[1]; void *root_ret; pthread_mutex_t root_mtx[taskMAX]; @@ -231,6 +240,7 @@ struct sched_RootTask { sched_queue_t root_ready; sched_queue_t root_unuse; sched_queue_t root_thread; + sched_queue_t root_rtc; hooks_task_t root_hooks; struct iovec root_data; @@ -241,8 +251,8 @@ struct sched_RootTask { #define ROOT_RETURN(x) (x)->root_ret -inline int sched_GetErrno(); -inline const char *sched_GetError(); +int sched_GetErrno(); +const char *sched_GetError(); /* @@ -274,14 +284,14 @@ int schedRegisterHooks(sched_root_task_t * __restrict * @root = root task * return: NULL error or !=NULL prepared task */ -inline sched_task_t *sched_useTask(sched_root_task_t * __restrict root); +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); +sched_task_t *sched_unuseTask(sched_task_t * __restrict task); /* * schedPolling() - Polling timeout period if no timer task is present * @@ -290,7 +300,7 @@ inline sched_task_t *sched_unuseTask(sched_task_t * __ * @tsold = old timeout polling if !=NULL * return: -1 error or 0 ok */ -inline int schedPolling(sched_root_task_t * __restrict root, +int schedPolling(sched_root_task_t * __restrict root, struct timespec * __restrict ts, struct timespec * __restrict tsold); /* * schedTermCondition() - Activate hook for scheduler condition kill @@ -299,21 +309,21 @@ inline int schedPolling(sched_root_task_t * __restrict * @condValue = condition value, kill schedRun() if condValue == killState * return: -1 error or 0 ok */ -inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue); +int schedTermCondition(sched_root_task_t * __restrict root, intptr_t * __restrict condValue); /* * schedCall() - Call task execution function * * @task = current task * return: !=NULL error or =NULL ok */ -inline void *schedCall(sched_task_t * __restrict task); +void *schedCall(sched_task_t * __restrict task); /* * schedFetch() - Fetch ready task * * @root = root task * return: =NULL error or !=NULL ready task */ -inline void *schedFetch(sched_root_task_t * __restrict root); +void *schedFetch(sched_root_task_t * __restrict root); /* * schedRun() - Scheduler *run loop* * @@ -335,13 +345,34 @@ 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_ID|CRITERIA_TS|CRITERIA_DATA] + * [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL| + * CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA|CRITERIA_DATLEN ] * @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 */ int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type, - u_char criteria, void *param, sched_hook_func_t hook); + unsigned char criteria, void *param, sched_hook_func_t hook); +/* + * schedQuery() - Query task in scheduler + * + * @task = task + * return: -1 error, 0 found and 1 not found + */ +int schedQuery(sched_task_t * __restrict task); +/* + * schedQueryby() - Query task in scheduler by criteria + * + * @root = root task + * @type = query from queue type, if =taskMAX query same task from all queues + * @criteria = find task by criteria + * [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL| + * CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA|CRITERIA_DATLEN ] + * @param = search parameter + * return: -1 error, 0 found or 1 not found + */ +int schedQueryby(sched_root_task_t * __restrict root, sched_task_type_t type, + unsigned char criteria, void *param); /* @@ -381,7 +412,7 @@ sched_task_t *schedWrite(sched_root_task_t * __restric * @func = task execution function * @arg = 1st func argument * @ts = timeout argument structure, minimum alarm timer resolution is 1msec! - * @opt_data = Optional data + * @opt_data = Alarm timer ID * @opt_dlen = Optional data length * return: NULL error or !=NULL new queued task */ @@ -390,6 +421,21 @@ sched_task_t *schedAlarm(sched_root_task_t * __restric #define schedAlarmSelf(x) schedAlarm(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x))) /* + * schedRTC() - Add RTC task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @ts = timeout argument structure, minimum alarm timer resolution is 1msec! + * @opt_data = Optional RTC ID + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedRTC(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + struct timespec ts, void *opt_data, size_t opt_dlen); +#define schedRTCSelf(x) schedRTC(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* * schedNode() - Add NODE task to scheduler queue * * @root = root task @@ -461,7 +507,7 @@ sched_task_t *schedAIO(sched_root_task_t * __restrict * @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, +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 @@ -475,7 +521,7 @@ inline sched_task_t *schedAIORead(sched_root_task_t * * @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, +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); /* @@ -503,7 +549,7 @@ sched_task_t *schedLIO(sched_root_task_t * __restrict * @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, +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 @@ -517,7 +563,7 @@ inline sched_task_t *schedLIORead(sched_root_task_t * * @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, +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 */ @@ -557,8 +603,6 @@ int schedTrigger(sched_task_t * __restrict task); */ sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, struct timespec ts, void *opt_data, size_t opt_dlen); -#define schedTimerSelf(x) schedTimer(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ - TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x))) /* * schedEvent() - Add EVENT task to scheduler queue * @@ -609,8 +653,8 @@ sched_task_t *schedSuspend(sched_root_task_t * __restr * * @root = root task * @criteria = find task by criteria - * [CRITERIA_ANY|CRITERIA_ID|CRITERIA_DATA] - * @param = search parameter (sched_task_t *task| u_long id) + * [ CRITERIA_ANY|CRITERIA_ID|CRITERIA_VAL|CRITERIA_DATA ] + * @param = search parameter (sched_task_t *task| unsigned long id) * return: -1 error or 0 resumed ok */ int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param); @@ -637,33 +681,31 @@ sched_task_t *schedCallOnce(sched_root_task_t * __rest * @root = root task * @func = task execution function * @arg = 1st func argument - * @detach = Detach thread from scheduler, if !=0 + * @ss = stack size * @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); + size_t ss, 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))) + (size_t) TASK_FLAG((x)), TASK_DATA((x)), TASK_DATLEN((x))) /* - * taskExit() - Exit routine for scheduler task + * sched_taskExit() - Exit routine for scheduler task, explicit required for thread tasks * + * @task = current task + * @retcode = return code + * return: return code + */ +void *sched_taskExit(sched_task_t *task, intptr_t retcode); +/* + * taskExit() - Exit helper 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 taskExit(t, x) return sched_taskExit((t), (intptr_t) (x)) #endif