--- libaitsched/inc/aitsched.h 2012/01/08 00:51:17 1.4 +++ libaitsched/inc/aitsched.h 2012/05/31 22:31:48 1.10 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitsched.h,v 1.4 2012/01/08 00:51:17 misho Exp $ +* $Id: aitsched.h,v 1.10 2012/05/31 22:31:48 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 +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -51,14 +51,17 @@ SUCH DAMAGE. #include #include #include +#include /* criteria type */ -#define CRITERIA_CALL 0 -#define CRITERIA_ARG 1 -#define CRITERIA_FD 2 -#define CRITERIA_VAL 3 -#define CRITERIA_TV 4 +#define CRITERIA_ANY 0 +#define CRITERIA_CALL 1 +#define CRITERIA_ARG 2 +#define CRITERIA_FD 3 +#define CRITERIA_VAL 4 +#define CRITERIA_TS 5 +#define CRITERIA_DATA 6 /* early declaration for root & task */ @@ -69,7 +72,13 @@ typedef enum { taskREAD = 0, taskWRITE, taskTIMER, - taskEVENT, + taskALARM, + taskNODE, + taskPROC, + taskUSER, + taskSIGNAL, + taskEVENT, + taskEVENTLO, taskREADY, taskUNUSE, taskMAX @@ -83,12 +92,22 @@ struct sched_HooksTask { sched_hook_func_t read; /* write(sched_task_t *task, NULL) -> int */ sched_hook_func_t write; + /* timer(sched_task_t *task, struct timespec *ts) -> int */ + sched_hook_func_t timer; + /* alarm(sched_task_t *task, NULL) -> int */ + sched_hook_func_t alarm; + /* node(sched_task_t *task, NULL) -> int */ + 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; /* event(sched_task_t *task, NULL) -> int */ sched_hook_func_t event; /* eventlo(sched_task_t *task, NULL) -> int */ sched_hook_func_t eventlo; - /* timer(sched_task_t *task, struct timeval *tv) -> int */ - sched_hook_func_t timer; } hook_add; struct { /* cancel(sched_task_t *task, NULL) -> int */ @@ -99,6 +118,8 @@ struct sched_HooksTask { sched_hook_func_t fetch; /* exception(sched_root_task_t *root, NULL) -> int */ sched_hook_func_t exception; + /* condition(sched_root_task_t *root, intptr_t *stopValue) -> int */ + sched_hook_func_t condition; } hook_exec; struct { /* init(sched_root_task_t *root, void *data) -> int */ @@ -115,30 +136,33 @@ typedef struct sched_HooksTask hooks_task_t; typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/); /* task lock helpers */ -#define TASK_LOCK(x) ((x)->task_lock++) +#define TASK_LOCK(x) ((x)->task_lock = 42) #define TASK_UNLOCK(x) ((x)->task_lock ^= (x)->task_lock) #define TASK_ISLOCKED(x) ((x)->task_lock) /* task & queue */ struct sched_Task { volatile int task_lock; - unsigned int task_id; + 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 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 void *task_arg; union { unsigned long v; intptr_t fd; - struct timeval tv; + struct timespec ts; } task_val; #define TASK_ARG(x) (x)->task_arg #define TASK_VAL(x) (x)->task_val.v #define TASK_FD(x) (x)->task_val.fd -#define TASK_TV(x) (x)->task_val.tv +#define TASK_TS(x) (x)->task_val.ts struct iovec task_data; #define TASK_DATA(x) (x)->task_data.iov_base @@ -147,19 +171,34 @@ struct sched_Task { TAILQ_ENTRY(sched_Task) task_node; }; typedef TAILQ_HEAD(, sched_Task) sched_queue_t; +#define TASK_DATA_SET(x, _dp, _dl) do { \ + if ((x)) { \ + (x)->task_data.iov_base = (_dp); \ + (x)->task_data.iov_len = _dl; \ + } \ + while (0) /* root task */ struct sched_RootTask { int root_kq; - struct timeval root_wait; + struct timespec root_wait; + struct timespec root_poll; + intptr_t root_cond; + pthread_mutex_t root_mtx[taskMAX]; + sched_queue_t root_read; sched_queue_t root_write; sched_queue_t root_timer; + 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_event; + sched_queue_t root_eventlo; sched_queue_t root_ready; sched_queue_t root_unuse; - sched_queue_t root_eventlo; int root_eventlo_miss; hooks_task_t root_hooks; @@ -167,6 +206,7 @@ struct sched_RootTask { #define ROOT_DATA(x) (x)->root_data.iov_base #define ROOT_DATLEN(x) (x)->root_data.iov_len }; +#define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q)) inline int sched_GetErrno(); @@ -175,6 +215,7 @@ inline const char *sched_GetError(); /* * schedInit() - Init scheduler + * * @data = optional data if !=NULL * @datlen = data len if data is set * return: allocated root task if ok or NULL error @@ -183,108 +224,255 @@ sched_root_task_t *schedInit(void ** __restrict data, #define schedBegin() schedInit((void**) &schedRegisterHooks, 0) /* * schedEnd() - End scheduler & free all resources + * * @root = root task * return: -1 error or 0 ok */ int schedEnd(sched_root_task_t ** __restrict root); /* * schedRegisterHooks() - Register IO handles and bind tasks to it + * * @root = root task * return: -1 error or 0 ok */ int schedRegisterHooks(sched_root_task_t * __restrict root); /* + * schedPolling() - Polling timeout period if no timer task is present + * + * @root = root task + * @ts = timeout polling period, if ==NULL INFINIT timeout + * @tsold = old timeout polling if !=NULL + * return: -1 error or 0 ok + */ +inline int schedPolling(sched_root_task_t * __restrict root, + struct timespec * __restrict ts, struct timespec * __restrict tsold); +/* + * schedTermCondition() - Activate hook for scheduler condition kill + * + * @root = root task + * @condValue = condition value, kill schedRun() if condValue == killState + * return: -1 error ok 0 ok + */ +inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue); +/* * schedCall() - Call task execution function + * * @task = current task * return: !=NULL error or =NULL ok */ inline 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); /* * schedRun() - Scheduler *run loop* + * * @root = root task * @killState = kill condition variable, if !=0 stop scheduler loop * return: -1 error or 0 ok */ -int schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState); +int schedRun(sched_root_task_t *root, volatile intptr_t * __restrict killState); /* * schedCancel() - Cancel task from scheduler + * * @task = task * return: -1 error or 0 ok */ int schedCancel(sched_task_t * __restrict task); /* * schedCancelby() - Cancel task from scheduler by criteria + * * @root = root task - * @queue = cancel from queue, if =NULL cancel same task from all queues - * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV] + * @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] * @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_queue_t * __restrict queue, +int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type, u_char criteria, void *param, sched_hook_func_t hook); /* * schedRead() - Add READ I/O task 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 *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd); +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))) /* * schedWrite() - Add WRITE I/O task 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 *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd); +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))) /* + * schedAlarm() - Add ALARM 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 data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedAlarm(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + struct timespec ts, void *opt_data, size_t opt_dlen); +#define schedAlarmSelf(x) schedAlarm(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 + * @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 *schedNode(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + int fd, void *opt_data, size_t opt_dlen); +#define schedNodeSelf(x) schedNode(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 + * @func = task execution function + * @arg = 1st func argument + * @pid = PID + * @opt_data = Optional data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedProc(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + unsigned long pid, void *opt_data, size_t opt_dlen); +#define schedProcSelf(x) schedProc(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* + * schedSignal() - Add SIGNAL task to scheduler queue + * + * @root = root task + * @func = task execution function + * @arg = 1st func argument + * @sig = Signal + * @opt_data = Optional data + * @opt_dlen = Optional data length + * return: NULL error or !=NULL new queued task + */ +sched_task_t *schedSignal(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + unsigned long sig, void *opt_data, size_t opt_dlen); +#define schedSignalSelf(x) schedSignal(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) + +/* + * schedUser() - Add trigger USER 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 *schedUser(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + unsigned long id, void *opt_data, size_t opt_dlen); +#define schedUserSelf(x) schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \ + TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) +/* + * schedTrigger() - Triggering USER task + * + * @task = task + * return: -1 error or 0 ok + */ +int schedTrigger(sched_task_t * __restrict task); + +/* * schedTimer() - Add TIMER task to scheduler queue + * * @root = root task * @func = task execution function * @arg = 1st func argument - * @tv = timeout argument structure + * @ts = timeout argument structure + * @opt_data = Optional data + * @opt_dlen = Optional data length * return: NULL error or !=NULL new queued task */ -sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, struct timeval tv); +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 + * * @root = root task * @func = task execution function * @arg = 1st func argument * @val = additional func argument + * @opt_data = Optional data + * @opt_dlen = Optional data length * return: NULL error or !=NULL new queued task */ -sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val); +sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + unsigned long val, void *opt_data, size_t opt_dlen); +#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 + * * @root = root task * @func = task execution function * @arg = 1st func argument * @val = additional func argument + * @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); +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)), \ + TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x))) + /* * schedCallOnce() - Call once from scheduler + * * @root = root task * @func = task execution function * @arg = 1st func argument * @val = additional func argument + * @opt_data = Optional data + * @opt_dlen = Optional data length * return: return value from called func */ -sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val); +sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, + 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))) #endif