Annotation of libaitsched/inc/aitsched.h, revision 1.33
1.1 misho 1: /*************************************************************************
2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
1.33 ! misho 6: * $Id: aitsched.h,v 1.32.16.1 2024/03/20 12:48:45 misho Exp $
1.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
1.33 ! misho 15: Copyright 2004 - 2024
1.1 misho 16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __AITSCHED_H
47: #define __AITSCHED_H
48:
49:
1.2 misho 50: #include <sys/types.h>
51: #include <sys/queue.h>
1.25 misho 52: #include <sys/select.h>
1.2 misho 53: #include <sys/uio.h>
1.3 misho 54: #include <stdint.h>
1.5 misho 55: #include <pthread.h>
1.15 misho 56: #include <assert.h>
1.12 misho 57: #ifdef EVFILT_LIO
58: #include <aio.h>
59: #endif
1.2 misho 60:
61:
1.1 misho 62: /* criteria type */
1.10 misho 63: #define CRITERIA_ANY 0
64: #define CRITERIA_CALL 1
65: #define CRITERIA_ARG 2
66: #define CRITERIA_FD 3
67: #define CRITERIA_VAL 4
68: #define CRITERIA_TS 5
69: #define CRITERIA_DATA 6
1.24 misho 70: #define CRITERIA_DATLEN 7
71: #define CRITERIA_ID 8
1.1 misho 72:
73:
74: /* early declaration for root & task */
75: typedef struct sched_Task sched_task_t;
76: typedef struct sched_RootTask sched_root_task_t;
77:
78: typedef enum {
79: taskREAD = 0,
80: taskWRITE,
81: taskTIMER,
1.10 misho 82: taskALARM,
83: taskNODE,
84: taskPROC,
1.12 misho 85: taskSIGNAL,
86: taskAIO,
87: taskLIO,
1.10 misho 88: taskUSER,
1.9 misho 89: taskEVENT,
1.13 misho 90: taskTASK,
1.11 misho 91: taskSUSPEND,
1.1 misho 92: taskREADY,
93: taskUNUSE,
1.15 misho 94: taskTHREAD,
1.20 misho 95: taskRTC,
1.1 misho 96: taskMAX
97: } sched_task_type_t;
98:
99: /* hooks */
100: typedef void *(*sched_hook_func_t)(void *, void *);
101: struct sched_HooksTask {
102: struct {
103: /* read(sched_task_t *task, NULL) -> int */
104: sched_hook_func_t read;
105: /* write(sched_task_t *task, NULL) -> int */
106: sched_hook_func_t write;
1.10 misho 107: /* timer(sched_task_t *task, struct timespec *ts) -> int */
108: sched_hook_func_t timer;
109: /* alarm(sched_task_t *task, NULL) -> int */
110: sched_hook_func_t alarm;
111: /* node(sched_task_t *task, NULL) -> int */
112: sched_hook_func_t node;
113: /* proc(sched_task_t *task, NULL) -> int */
114: sched_hook_func_t proc;
1.12 misho 115: /* signal(sched_task_t *task, NULL) -> int */
116: sched_hook_func_t signal;
117: /* aio(sched_task_t *task, NULL) -> int */
118: sched_hook_func_t aio;
119: /* lio(sched_task_t *task, NULL) -> int */
120: sched_hook_func_t lio;
1.10 misho 121: /* user(sched_task_t *task, NULL) -> int */
122: sched_hook_func_t user;
1.1 misho 123: /* event(sched_task_t *task, NULL) -> int */
124: sched_hook_func_t event;
1.13 misho 125: /* task(sched_task_t *task, NULL) -> int */
126: sched_hook_func_t task;
1.11 misho 127: /* suspend(sched_task_t *task, NULL) -> int */
128: sched_hook_func_t suspend;
1.15 misho 129: /* thread(sched_task_t *task, NULL) -> int */
130: sched_hook_func_t thread;
1.20 misho 131: /* rtc(sched_task_t *task, NULL) -> int */
132: sched_hook_func_t rtc;
1.1 misho 133: } hook_add;
134: struct {
1.15 misho 135: /* exit(sched_task_t *task, void *exitValue) -> int */
136: sched_hook_func_t exit;
1.1 misho 137: /* cancel(sched_task_t *task, NULL) -> int */
138: sched_hook_func_t cancel;
1.11 misho 139: /* resume(sched_task_t *task, NULL) -> int */
140: sched_hook_func_t resume;
1.1 misho 141: /* run(sched_root_task_t *root, NULL) -> int */
142: sched_hook_func_t run;
143: /* fetch(sched_root_task_t *root, NULL) -> sched_task_t* */
144: sched_hook_func_t fetch;
1.3 misho 145: /* exception(sched_root_task_t *root, NULL) -> int */
146: sched_hook_func_t exception;
1.6 misho 147: /* condition(sched_root_task_t *root, intptr_t *stopValue) -> int */
148: sched_hook_func_t condition;
1.1 misho 149: } hook_exec;
150: struct {
151: /* init(sched_root_task_t *root, void *data) -> int */
152: sched_hook_func_t init;
153: /* fini(sched_root_task_t *root, NULL) -> int */
154: sched_hook_func_t fini;
1.3 misho 155: /* error(sched_root_task_t *root, int errno) -> int */
156: sched_hook_func_t error;
1.1 misho 157: } hook_root;
158: };
159: typedef struct sched_HooksTask hooks_task_t;
160:
161: /* task callback, like pthread callback! */
1.2 misho 162: typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/);
1.26 misho 163: #define SCHED_TASK_DEFINE(x) void *(x)(sched_task_t*)
1.1 misho 164:
1.4 misho 165: /* task lock helpers */
1.10 misho 166: #define TASK_LOCK(x) ((x)->task_lock = 42)
1.4 misho 167: #define TASK_UNLOCK(x) ((x)->task_lock ^= (x)->task_lock)
168: #define TASK_ISLOCKED(x) ((x)->task_lock)
169:
1.1 misho 170: /* task & queue */
171: struct sched_Task {
1.10 misho 172: uintptr_t task_id;
173: #define TASK_ID(x) ((struct sched_Task*) (x)->task_id)
1.1 misho 174: sched_task_type_t task_type;
1.5 misho 175: #define TASK_TYPE(x) (x)->task_type
1.15 misho 176: volatile int task_lock;
1.1 misho 177:
178: sched_root_task_t *task_root;
1.2 misho 179: #define TASK_ROOT(x) (x)->task_root
1.1 misho 180: sched_task_func_t task_func;
1.8 misho 181: #define TASK_FUNC(x) (x)->task_func
1.15 misho 182: intptr_t task_ret;
183: #define TASK_RET(x) (x)->task_ret
1.20 misho 184: unsigned long task_flag;
1.15 misho 185: #define TASK_FLAG(x) (x)->task_flag
1.1 misho 186:
187: void *task_arg;
188: union {
189: unsigned long v;
1.3 misho 190: intptr_t fd;
1.5 misho 191: struct timespec ts;
1.1 misho 192: } task_val;
193: #define TASK_ARG(x) (x)->task_arg
194: #define TASK_VAL(x) (x)->task_val.v
195: #define TASK_FD(x) (x)->task_val.fd
1.5 misho 196: #define TASK_TS(x) (x)->task_val.ts
1.1 misho 197:
1.25 misho 198: #define TASK_TS2TV(x, tvp) (assert((tvp)), (tvp)->tv_sec = (x)->task_val.ts.tv_sec, \
199: (tvp)->tv_usec = (x)->task_val.ts.tv_nsec / 1000)
200:
1.1 misho 201: struct iovec task_data;
202: #define TASK_DATA(x) (x)->task_data.iov_base
203: #define TASK_DATLEN(x) (x)->task_data.iov_len
204:
1.30 misho 205: unsigned long task_harg;
206: #define TASK_HARG(x) (x)->task_harg
207:
1.1 misho 208: TAILQ_ENTRY(sched_Task) task_node;
209: };
210: typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
1.5 misho 211: #define TASK_DATA_SET(x, _dp, _dl) do { \
212: if ((x)) { \
213: (x)->task_data.iov_base = (_dp); \
214: (x)->task_data.iov_len = _dl; \
215: } \
216: while (0)
1.1 misho 217:
218: /* root task */
219: struct sched_RootTask {
220: int root_kq;
1.30 misho 221: fd_set root_fds[3];
1.5 misho 222: struct timespec root_wait;
223: struct timespec root_poll;
1.25 misho 224: unsigned long root_miss;
1.27 misho 225: intptr_t root_cond[1];
1.12 misho 226: void *root_ret;
1.32 misho 227: #ifdef HAVE_LIBPTHREAD
228: pthread_mutex_t root_sigmtx;
229: pthread_t root_sigthr;
230: sigset_t root_sigset;
231: sigset_t root_oldset;
232: #endif
1.6 misho 233:
1.5 misho 234: pthread_mutex_t root_mtx[taskMAX];
1.1 misho 235:
236: sched_queue_t root_read;
237: sched_queue_t root_write;
238: sched_queue_t root_timer;
1.9 misho 239: sched_queue_t root_alarm;
1.10 misho 240: sched_queue_t root_node;
241: sched_queue_t root_proc;
1.12 misho 242: sched_queue_t root_signal;
243: sched_queue_t root_aio;
244: sched_queue_t root_lio;
1.10 misho 245: sched_queue_t root_user;
1.1 misho 246: sched_queue_t root_event;
1.13 misho 247: sched_queue_t root_task;
1.11 misho 248: sched_queue_t root_suspend;
1.1 misho 249: sched_queue_t root_ready;
250: sched_queue_t root_unuse;
1.15 misho 251: sched_queue_t root_thread;
1.20 misho 252: sched_queue_t root_rtc;
1.1 misho 253:
254: hooks_task_t root_hooks;
255: struct iovec root_data;
256: #define ROOT_DATA(x) (x)->root_data.iov_base
257: #define ROOT_DATLEN(x) (x)->root_data.iov_len
258: };
1.7 misho 259: #define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q))
1.12 misho 260: #define ROOT_RETURN(x) (x)->root_ret
1.1 misho 261:
262:
1.18 misho 263: int sched_GetErrno();
264: const char *sched_GetError();
1.2 misho 265:
266:
1.1 misho 267: /*
268: * schedInit() - Init scheduler
1.6 misho 269: *
1.1 misho 270: * @data = optional data if !=NULL
271: * @datlen = data len if data is set
272: * return: allocated root task if ok or NULL error
273: */
274: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.2 misho 275: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 276: /*
277: * schedEnd() - End scheduler & free all resources
1.6 misho 278: *
1.1 misho 279: * @root = root task
280: * return: -1 error or 0 ok
281: */
1.2 misho 282: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 283: /*
1.2 misho 284: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.6 misho 285: *
1.1 misho 286: * @root = root task
287: * return: -1 error or 0 ok
288: */
1.2 misho 289: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 290: /*
1.15 misho 291: * sched_useTask() - Get and init new task
292: *
293: * @root = root task
294: * return: NULL error or !=NULL prepared task
295: */
1.18 misho 296: sched_task_t *sched_useTask(sched_root_task_t * __restrict root);
1.15 misho 297: /*
298: * sched_unuseTask() - Unlock and put task to unuse queue
299: *
300: * @task = task
301: * return: always is NULL
302: */
1.18 misho 303: sched_task_t *sched_unuseTask(sched_task_t * __restrict task);
1.15 misho 304: /*
1.5 misho 305: * schedPolling() - Polling timeout period if no timer task is present
1.6 misho 306: *
1.5 misho 307: * @root = root task
308: * @ts = timeout polling period, if ==NULL INFINIT timeout
309: * @tsold = old timeout polling if !=NULL
310: * return: -1 error or 0 ok
311: */
1.18 misho 312: int schedPolling(sched_root_task_t * __restrict root,
1.5 misho 313: struct timespec * __restrict ts, struct timespec * __restrict tsold);
314: /*
1.6 misho 315: * schedTermCondition() - Activate hook for scheduler condition kill
316: *
317: * @root = root task
318: * @condValue = condition value, kill schedRun() if condValue == killState
1.13 misho 319: * return: -1 error or 0 ok
1.6 misho 320: */
1.27 misho 321: int schedTermCondition(sched_root_task_t * __restrict root, intptr_t * __restrict condValue);
1.6 misho 322: /*
1.1 misho 323: * schedCall() - Call task execution function
1.6 misho 324: *
1.1 misho 325: * @task = current task
326: * return: !=NULL error or =NULL ok
327: */
1.18 misho 328: void *schedCall(sched_task_t * __restrict task);
1.1 misho 329: /*
330: * schedFetch() - Fetch ready task
1.6 misho 331: *
1.1 misho 332: * @root = root task
333: * return: =NULL error or !=NULL ready task
334: */
1.18 misho 335: void *schedFetch(sched_root_task_t * __restrict root);
1.1 misho 336: /*
337: * schedRun() - Scheduler *run loop*
1.6 misho 338: *
1.1 misho 339: * @root = root task
1.2 misho 340: * @killState = kill condition variable, if !=0 stop scheduler loop
1.1 misho 341: * return: -1 error or 0 ok
342: */
1.7 misho 343: int schedRun(sched_root_task_t *root, volatile intptr_t * __restrict killState);
1.1 misho 344: /*
345: * schedCancel() - Cancel task from scheduler
1.6 misho 346: *
1.1 misho 347: * @task = task
348: * return: -1 error or 0 ok
349: */
350: int schedCancel(sched_task_t * __restrict task);
351: /*
352: * schedCancelby() - Cancel task from scheduler by criteria
1.6 misho 353: *
1.1 misho 354: * @root = root task
1.5 misho 355: * @type = cancel from queue type, if =taskMAX cancel same task from all queues
1.10 misho 356: * @criteria = find task by criteria
1.23 misho 357: * [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|
1.24 misho 358: * CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA|CRITERIA_DATLEN ]
1.1 misho 359: * @param = search parameter
360: * @hook = custom cleanup hook function, may be NULL
1.3 misho 361: * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
1.1 misho 362: */
1.5 misho 363: int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.23 misho 364: unsigned char criteria, void *param, sched_hook_func_t hook);
365: /*
366: * schedQuery() - Query task in scheduler
367: *
368: * @task = task
369: * return: -1 error, 0 found and 1 not found
370: */
371: int schedQuery(sched_task_t * __restrict task);
372: /*
373: * schedQueryby() - Query task in scheduler by criteria
374: *
375: * @root = root task
376: * @type = query from queue type, if =taskMAX query same task from all queues
377: * @criteria = find task by criteria
378: * [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|
1.24 misho 379: * CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA|CRITERIA_DATLEN ]
1.23 misho 380: * @param = search parameter
1.31 misho 381: * return: NULL not found or !=NULL task
1.23 misho 382: */
1.31 misho 383: sched_task_t *schedQueryby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.23 misho 384: unsigned char criteria, void *param);
1.32 misho 385: /*
386: * schedSignalDispatch() - Activate or Deactivate signal dispatcher
387: *
388: * @root = root task
389: * @on = Activate or =0 deactivate
1.33 ! misho 390: * return: -1 error, 1 already started, 2 another thread already started or 0 ok
1.32 misho 391: */
392: int schedSignalDispatch(sched_root_task_t * __restrict root, int on);
1.1 misho 393:
394:
395: /*
1.30 misho 396: * schedReadExt() - Add READ I/O task to scheduler queue with custom event mask
397: *
398: * @root = root task
399: * @func = task execution function
400: * @arg = 1st func argument
401: * @fd = fd handle
402: * @opt_data = Optional data
403: * @opt_dlen = Optional data length
404: * @mask = Event mask
405: * return: NULL error or !=NULL new queued task
406: */
407: sched_task_t *schedReadExt(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
408: int fd, void *opt_data, size_t opt_dlen, unsigned long mask);
409: /*
1.2 misho 410: * schedRead() - Add READ I/O task to scheduler queue
1.6 misho 411: *
1.1 misho 412: * @root = root task
413: * @func = task execution function
414: * @arg = 1st func argument
1.2 misho 415: * @fd = fd handle
1.5 misho 416: * @opt_data = Optional data
417: * @opt_dlen = Optional data length
1.1 misho 418: * return: NULL error or !=NULL new queued task
419: */
1.5 misho 420: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
421: int fd, void *opt_data, size_t opt_dlen);
1.30 misho 422: #define schedReadSelf(x) schedReadExt(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
423: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)), TASK_HARG((x)))
424: /*
425: * schedWriteExt() - Add WRITE I/O task to scheduler queue with custom event mask
426: *
427: * @root = root task
428: * @func = task execution function
429: * @arg = 1st func argument
430: * @fd = fd handle
431: * @opt_data = Optional data
432: * @opt_dlen = Optional data length
433: * @mask = Event mask
434: * return: NULL error or !=NULL new queued task
435: */
436: sched_task_t *schedWriteExt(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
437: int fd, void *opt_data, size_t opt_dlen, unsigned long mask);
1.1 misho 438: /*
1.2 misho 439: * schedWrite() - Add WRITE I/O task to scheduler queue
1.6 misho 440: *
1.1 misho 441: * @root = root task
442: * @func = task execution function
443: * @arg = 1st func argument
1.2 misho 444: * @fd = fd handle
1.5 misho 445: * @opt_data = Optional data
446: * @opt_dlen = Optional data length
1.1 misho 447: * return: NULL error or !=NULL new queued task
448: */
1.5 misho 449: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
450: int fd, void *opt_data, size_t opt_dlen);
1.30 misho 451: #define schedWriteSelf(x) schedWriteExt(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
452: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)), TASK_HARG((x)))
1.1 misho 453: /*
1.9 misho 454: * schedAlarm() - Add ALARM task to scheduler queue
455: *
456: * @root = root task
457: * @func = task execution function
458: * @arg = 1st func argument
459: * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!
1.20 misho 460: * @opt_data = Alarm timer ID
1.9 misho 461: * @opt_dlen = Optional data length
462: * return: NULL error or !=NULL new queued task
463: */
464: sched_task_t *schedAlarm(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
465: struct timespec ts, void *opt_data, size_t opt_dlen);
466: #define schedAlarmSelf(x) schedAlarm(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
467: TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
468: /*
1.20 misho 469: * schedRTC() - Add RTC task to scheduler queue
470: *
471: * @root = root task
472: * @func = task execution function
473: * @arg = 1st func argument
474: * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!
475: * @opt_data = Optional RTC ID
1.21 misho 476: * @opt_dlen = Optional data length
1.20 misho 477: * return: NULL error or !=NULL new queued task
478: */
479: sched_task_t *schedRTC(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
480: struct timespec ts, void *opt_data, size_t opt_dlen);
481: #define schedRTCSelf(x) schedRTC(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
482: TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
483: /*
1.10 misho 484: * schedNode() - Add NODE task to scheduler queue
485: *
486: * @root = root task
487: * @func = task execution function
488: * @arg = 1st func argument
489: * @fd = fd handle
490: * @opt_data = Optional data
491: * @opt_dlen = Optional data length
492: * return: NULL error or !=NULL new queued task
493: */
494: sched_task_t *schedNode(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
495: int fd, void *opt_data, size_t opt_dlen);
496: #define schedNodeSelf(x) schedNode(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.29 misho 497: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
498: /*
499: * schedNode2() - Add NODE task with all events to scheduler queue
500: *
501: * @root = root task
502: * @func = task execution function
503: * @arg = 1st func argument
504: * @fd = fd handle
505: * @opt_data = Optional data
506: * @opt_dlen = Optional data length
507: * return: NULL error or !=NULL new queued task
508: */
509: sched_task_t *schedNode2(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
510: int fd, void *opt_data, size_t opt_dlen);
511: #define schedNode2Self(x) schedNode2(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.10 misho 512: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
513: /*
514: * schedProc() - Add PROC task to scheduler queue
515: *
516: * @root = root task
517: * @func = task execution function
518: * @arg = 1st func argument
519: * @pid = PID
520: * @opt_data = Optional data
521: * @opt_dlen = Optional data length
522: * return: NULL error or !=NULL new queued task
523: */
524: sched_task_t *schedProc(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
525: unsigned long pid, void *opt_data, size_t opt_dlen);
526: #define schedProcSelf(x) schedProc(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
527: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
528: /*
529: * schedSignal() - Add SIGNAL task to scheduler queue
530: *
531: * @root = root task
532: * @func = task execution function
533: * @arg = 1st func argument
534: * @sig = Signal
535: * @opt_data = Optional data
536: * @opt_dlen = Optional data length
537: * return: NULL error or !=NULL new queued task
538: */
539: sched_task_t *schedSignal(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
540: unsigned long sig, void *opt_data, size_t opt_dlen);
541: #define schedSignalSelf(x) schedSignal(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
542: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
543:
1.12 misho 544: #ifdef EVFILT_LIO
545: /*
546: * schedAIO() - Add AIO task to scheduler queue
547: *
548: * @root = root task
549: * @func = task execution function
550: * @arg = 1st func argument
551: * @acb = AIO cb structure address
552: * @opt_data = Optional data
553: * @opt_dlen = Optional data length
554: * return: NULL error or !=NULL new queued task
555: */
556: sched_task_t *schedAIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
557: struct aiocb * __restrict acb, void *opt_data, size_t opt_dlen);
558: /*
559: * schedAIORead() - Add AIO read task to scheduler queue
560: *
561: * @root = root task
562: * @func = task execution function
563: * @arg = 1st func argument
564: * @fd = file descriptor
565: * @buffer = Buffer
566: * @buflen = Buffer length
567: * @offset = Offset from start of file, if =-1 from current position
568: * return: NULL error or !=NULL new queued task
569: */
1.18 misho 570: sched_task_t *schedAIORead(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 571: void *arg, int fd, void *buffer, size_t buflen, off_t offset);
572: /*
573: * schedAIOWrite() - Add AIO write task to scheduler queue
574: *
575: * @root = root task
576: * @func = task execution function
577: * @arg = 1st func argument
578: * @fd = file descriptor
579: * @buffer = Buffer
580: * @buflen = Buffer length
581: * @offset = Offset from start of file, if =-1 from current position
582: * return: NULL error or !=NULL new queued task
583: */
1.18 misho 584: sched_task_t *schedAIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 585: void *arg, int fd, void *buffer, size_t buflen, off_t offset);
586:
587: /*
588: * schedLIO() - Add AIO bulk tasks to scheduler queue
589: *
590: * @root = root task
591: * @func = task execution function
592: * @arg = 1st func argument
593: * @acbs = AIO cb structure addresses
594: * @opt_data = Optional data
595: * @opt_dlen = Optional data length
596: * return: NULL error or !=NULL new queued task
597: */
598: sched_task_t *schedLIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
599: struct aiocb ** __restrict acbs, void *opt_data, size_t opt_dlen);
600: /*
601: * schedLIORead() - Add list of AIO read tasks to scheduler queue
602: *
603: * @root = root task
604: * @func = task execution function
605: * @arg = 1st func argument
606: * @fd = file descriptor
607: * @bufs = Buffer's list
608: * @nbufs = Number of Buffers
609: * @offset = Offset from start of file, if =-1 from current position
610: * return: NULL error or !=NULL new queued task
611: */
1.18 misho 612: sched_task_t *schedLIORead(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 613: void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);
614: /*
615: * schedLIOWrite() - Add list of AIO write tasks to scheduler queue
616: *
617: * @root = root task
618: * @func = task execution function
619: * @arg = 1st func argument
620: * @fd = file descriptor
621: * @bufs = Buffer's list
622: * @nbufs = Number of Buffers
623: * @offset = Offset from start of file, if =-1 from current position
624: * return: NULL error or !=NULL new queued task
625: */
1.18 misho 626: sched_task_t *schedLIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 627: void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);
628: #endif /* EVFILT_LIO */
629:
1.10 misho 630: /*
631: * schedUser() - Add trigger USER task to scheduler queue
632: *
633: * @root = root task
634: * @func = task execution function
635: * @arg = 1st func argument
636: * @id = Trigger ID
637: * @opt_data = Optional data
638: * @opt_dlen = Optional user's trigger flags
639: * return: NULL error or !=NULL new queued task
640: */
641: sched_task_t *schedUser(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
642: unsigned long id, void *opt_data, size_t opt_dlen);
643: #define schedUserSelf(x) schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
644: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
645: /*
646: * schedTrigger() - Triggering USER task
647: *
648: * @task = task
649: * return: -1 error or 0 ok
650: */
651: int schedTrigger(sched_task_t * __restrict task);
652:
653: /*
1.1 misho 654: * schedTimer() - Add TIMER task to scheduler queue
1.6 misho 655: *
1.1 misho 656: * @root = root task
657: * @func = task execution function
658: * @arg = 1st func argument
1.5 misho 659: * @ts = timeout argument structure
660: * @opt_data = Optional data
661: * @opt_dlen = Optional data length
1.1 misho 662: * return: NULL error or !=NULL new queued task
663: */
1.5 misho 664: sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
665: struct timespec ts, void *opt_data, size_t opt_dlen);
1.1 misho 666: /*
667: * schedEvent() - Add EVENT task to scheduler queue
1.6 misho 668: *
1.1 misho 669: * @root = root task
670: * @func = task execution function
671: * @arg = 1st func argument
1.2 misho 672: * @val = additional func argument
1.5 misho 673: * @opt_data = Optional data
674: * @opt_dlen = Optional data length
1.1 misho 675: * return: NULL error or !=NULL new queued task
676: */
1.5 misho 677: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
678: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 misho 679: #define schedEventSelf(x) schedEvent(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
680: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 681: /*
1.13 misho 682: * schedTask() - Add regular task to scheduler queue
1.6 misho 683: *
1.1 misho 684: * @root = root task
685: * @func = task execution function
686: * @arg = 1st func argument
1.13 misho 687: * @prio = regular task priority, 0 is hi priority for regular tasks
1.5 misho 688: * @opt_data = Optional data
689: * @opt_dlen = Optional data length
1.1 misho 690: * return: NULL error or !=NULL new queued task
691: */
1.13 misho 692: sched_task_t *schedTask(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
693: unsigned long prio, void *opt_data, size_t opt_dlen);
694: #define schedTaskSelf(x) schedTask(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.8 misho 695: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.11 misho 696: /*
697: * schedSuspend() - Add Suspended task to scheduler queue
698: *
699: * @root = root task
700: * @func = task execution function
701: * @arg = 1st func argument
702: * @id = Trigger ID
703: * @opt_data = Optional data
704: * @opt_dlen = Optional user's trigger flags
705: * return: NULL error or !=NULL new queued task
706: */
707: sched_task_t *schedSuspend(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
708: unsigned long id, void *opt_data, size_t opt_dlen);
709: #define schedSuspendSelf(x) schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
710: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
711: /*
712: * schedResumeby() - Resume suspended task
713: *
714: * @root = root task
715: * @criteria = find task by criteria
1.24 misho 716: * [ CRITERIA_ANY|CRITERIA_ID|CRITERIA_VAL|CRITERIA_DATA ]
1.23 misho 717: * @param = search parameter (sched_task_t *task| unsigned long id)
1.11 misho 718: * return: -1 error or 0 resumed ok
719: */
720: int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param);
1.10 misho 721:
1.1 misho 722: /*
723: * schedCallOnce() - Call once from scheduler
1.6 misho 724: *
1.1 misho 725: * @root = root task
726: * @func = task execution function
727: * @arg = 1st func argument
1.2 misho 728: * @val = additional func argument
1.5 misho 729: * @opt_data = Optional data
730: * @opt_dlen = Optional data length
1.2 misho 731: * return: return value from called func
1.1 misho 732: */
1.5 misho 733: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
734: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 misho 735: #define schedCallAgain(x) schedCallOnce(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
736: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 737:
1.15 misho 738: /*
739: * schedThread() - Add thread task to scheduler queue
740: *
741: * @root = root task
742: * @func = task execution function
743: * @arg = 1st func argument
1.17 misho 744: * @ss = stack size
1.15 misho 745: * @opt_data = Optional data
746: * @opt_dlen = Optional data length
747: * return: NULL error or !=NULL new queued task
748: */
749: sched_task_t *schedThread(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
1.22 misho 750: size_t ss, void *opt_data, size_t opt_dlen);
1.15 misho 751: #define schedThreadSelf(x) schedThread(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.22 misho 752: (size_t) TASK_FLAG((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.15 misho 753: /*
1.16 misho 754: * sched_taskExit() - Exit routine for scheduler task, explicit required for thread tasks
755: *
756: * @task = current task
757: * @retcode = return code
758: * return: return code
759: */
1.18 misho 760: void *sched_taskExit(sched_task_t *task, intptr_t retcode);
1.16 misho 761: /*
762: * taskExit() - Exit helper for scheduler task
1.15 misho 763: *
764: * @t = current executed task
765: * @x = exit value for task
766: * return: none
767: */
1.16 misho 768: #define taskExit(t, x) return sched_taskExit((t), (intptr_t) (x))
1.15 misho 769:
1.1 misho 770:
771: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitsched.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitsched / inc