--- libaitsched/inc/aitsched.h 2012/08/08 08:25:39 1.13 +++ libaitsched/inc/aitsched.h 2023/01/18 23:46:18 1.31 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitsched.h,v 1.13 2012/08/08 08:25:39 misho Exp $ +* $Id: aitsched.h,v 1.31 2023/01/18 23:46:18 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 - 2023 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -49,10 +49,11 @@ SUCH DAMAGE. #include #include -#include +#include #include #include #include +#include #ifdef EVFILT_LIO #include #endif @@ -66,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 */ @@ -89,6 +91,8 @@ typedef enum { taskSUSPEND, taskREADY, taskUNUSE, + taskTHREAD, + taskRTC, taskMAX } sched_task_type_t; @@ -122,8 +126,14 @@ struct sched_HooksTask { 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; + /* rtc(sched_task_t *task, NULL) -> int */ + sched_hook_func_t rtc; } 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 */ @@ -150,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) @@ -158,16 +169,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 long task_flag; +#define TASK_FLAG(x) (x)->task_flag void *task_arg; union { @@ -180,10 +195,16 @@ 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 + unsigned long task_harg; +#define TASK_HARG(x) (x)->task_harg + TAILQ_ENTRY(sched_Task) task_node; }; typedef TAILQ_HEAD(, sched_Task) sched_queue_t; @@ -197,11 +218,11 @@ typedef TAILQ_HEAD(, sched_Task) sched_queue_t; /* root task */ struct sched_RootTask { int root_kq; - unsigned int root_miss; - unsigned int root_task_miss; + fd_set root_fds[3]; 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]; @@ -221,6 +242,8 @@ struct sched_RootTask { sched_queue_t root_suspend; 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; @@ -231,8 +254,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(); /* @@ -259,6 +282,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 + */ +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 + */ +sched_task_t *sched_unuseTask(sched_task_t * __restrict task); +/* * schedPolling() - Polling timeout period if no timer task is present * * @root = root task @@ -266,7 +303,7 @@ int schedRegisterHooks(sched_root_task_t * __restrict * @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 @@ -275,29 +312,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); /* - * schedMissEvents() - Set new miss events rate for regular tasks - * - * @root = root task - * @missEvents = maximum number of missed events before firing tasks - * return: -1 error or 0 ok - */ -inline int schedMissEvents(sched_root_task_t * __restrict root, u_int missEvents); -/* * 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* * @@ -319,16 +348,51 @@ 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: NULL not found or !=NULL task + */ +sched_task_t *schedQueryby(sched_root_task_t * __restrict root, sched_task_type_t type, + unsigned char criteria, void *param); /* + * schedReadExt() - Add READ I/O task to scheduler queue with custom event mask + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = fd handle + * @opt_data = Optional data + * @opt_dlen = Optional data length + * @mask = Event mask + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedReadExt(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + int fd, void *opt_data, size_t opt_dlen, unsigned long mask); +/* * schedRead() - Add READ I/O task to scheduler queue * * @root = root task @@ -341,9 +405,23 @@ int schedCancelby(sched_root_task_t * __restrict root, */ sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd, void *opt_data, size_t opt_dlen); -#define schedReadSelf(x) schedRead(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ - TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x))) +#define schedReadSelf(x) schedReadExt(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)), TASK_HARG((x))) /* + * schedWriteExt() - Add WRITE I/O task to scheduler queue with custom event mask + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = fd handle + * @opt_data = Optional data + * @opt_dlen = Optional data length + * @mask = Event mask + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedWriteExt(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + int fd, void *opt_data, size_t opt_dlen, unsigned long mask); +/* * schedWrite() - Add WRITE I/O task to scheduler queue * * @root = root task @@ -356,8 +434,8 @@ sched_task_t *schedRead(sched_root_task_t * __restrict */ sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd, void *opt_data, size_t opt_dlen); -#define schedWriteSelf(x) schedWrite(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ - TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x))) +#define schedWriteSelf(x) schedWriteExt(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)), TASK_HARG((x))) /* * schedAlarm() - Add ALARM task to scheduler queue * @@ -365,7 +443,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 */ @@ -374,6 +452,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 @@ -389,6 +482,21 @@ sched_task_t *schedNode(sched_root_task_t * __restrict #define schedNodeSelf(x) schedNode(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x))) /* + * schedNode2() - Add NODE task with all events to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @fd = fd handle + * @opt_data = Optional data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedNode2(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + int fd, void *opt_data, size_t opt_dlen); +#define schedNode2Self(x) schedNode2(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* * schedProc() - Add PROC task to scheduler queue * * @root = root task @@ -445,7 +553,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 @@ -459,7 +567,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); /* @@ -487,7 +595,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 @@ -501,7 +609,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 */ @@ -541,8 +649,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 * @@ -593,8 +699,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); @@ -614,6 +720,38 @@ 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 + * @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, + size_t ss, void *opt_data, size_t opt_dlen); +#define schedThreadSelf(x) schedThread(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + (size_t) TASK_FLAG((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* + * 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) return sched_taskExit((t), (intptr_t) (x)) #endif