Annotation of libaitsched/inc/aitsched.h, revision 1.31.2.2
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.31.2.2! misho 6: * $Id: aitsched.h,v 1.31.2.1 2023/02/23 15:36:41 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.31 misho 15: Copyright 2004 - 2023
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.31.2.1 misho 227: #ifdef HAVE_LIBPTHREAD
228: pthread_t root_sigthr;
1.31.2.2! misho 229: sigset_t root_sigset;
1.31.2.1 misho 230: #endif
1.6 misho 231:
1.5 misho 232: pthread_mutex_t root_mtx[taskMAX];
1.1 misho 233:
234: sched_queue_t root_read;
235: sched_queue_t root_write;
236: sched_queue_t root_timer;
1.9 misho 237: sched_queue_t root_alarm;
1.10 misho 238: sched_queue_t root_node;
239: sched_queue_t root_proc;
1.12 misho 240: sched_queue_t root_signal;
241: sched_queue_t root_aio;
242: sched_queue_t root_lio;
1.10 misho 243: sched_queue_t root_user;
1.1 misho 244: sched_queue_t root_event;
1.13 misho 245: sched_queue_t root_task;
1.11 misho 246: sched_queue_t root_suspend;
1.1 misho 247: sched_queue_t root_ready;
248: sched_queue_t root_unuse;
1.15 misho 249: sched_queue_t root_thread;
1.20 misho 250: sched_queue_t root_rtc;
1.1 misho 251:
252: hooks_task_t root_hooks;
253: struct iovec root_data;
254: #define ROOT_DATA(x) (x)->root_data.iov_base
255: #define ROOT_DATLEN(x) (x)->root_data.iov_len
256: };
1.7 misho 257: #define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q))
1.12 misho 258: #define ROOT_RETURN(x) (x)->root_ret
1.1 misho 259:
260:
1.18 misho 261: int sched_GetErrno();
262: const char *sched_GetError();
1.2 misho 263:
264:
1.1 misho 265: /*
266: * schedInit() - Init scheduler
1.6 misho 267: *
1.1 misho 268: * @data = optional data if !=NULL
269: * @datlen = data len if data is set
270: * return: allocated root task if ok or NULL error
271: */
272: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.2 misho 273: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 274: /*
275: * schedEnd() - End scheduler & free all resources
1.6 misho 276: *
1.1 misho 277: * @root = root task
278: * return: -1 error or 0 ok
279: */
1.2 misho 280: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 281: /*
1.2 misho 282: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.6 misho 283: *
1.1 misho 284: * @root = root task
285: * return: -1 error or 0 ok
286: */
1.2 misho 287: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 288: /*
1.15 misho 289: * sched_useTask() - Get and init new task
290: *
291: * @root = root task
292: * return: NULL error or !=NULL prepared task
293: */
1.18 misho 294: sched_task_t *sched_useTask(sched_root_task_t * __restrict root);
1.15 misho 295: /*
296: * sched_unuseTask() - Unlock and put task to unuse queue
297: *
298: * @task = task
299: * return: always is NULL
300: */
1.18 misho 301: sched_task_t *sched_unuseTask(sched_task_t * __restrict task);
1.15 misho 302: /*
1.5 misho 303: * schedPolling() - Polling timeout period if no timer task is present
1.6 misho 304: *
1.5 misho 305: * @root = root task
306: * @ts = timeout polling period, if ==NULL INFINIT timeout
307: * @tsold = old timeout polling if !=NULL
308: * return: -1 error or 0 ok
309: */
1.18 misho 310: int schedPolling(sched_root_task_t * __restrict root,
1.5 misho 311: struct timespec * __restrict ts, struct timespec * __restrict tsold);
312: /*
1.6 misho 313: * schedTermCondition() - Activate hook for scheduler condition kill
314: *
315: * @root = root task
316: * @condValue = condition value, kill schedRun() if condValue == killState
1.13 misho 317: * return: -1 error or 0 ok
1.6 misho 318: */
1.27 misho 319: int schedTermCondition(sched_root_task_t * __restrict root, intptr_t * __restrict condValue);
1.6 misho 320: /*
1.1 misho 321: * schedCall() - Call task execution function
1.6 misho 322: *
1.1 misho 323: * @task = current task
324: * return: !=NULL error or =NULL ok
325: */
1.18 misho 326: void *schedCall(sched_task_t * __restrict task);
1.1 misho 327: /*
328: * schedFetch() - Fetch ready task
1.6 misho 329: *
1.1 misho 330: * @root = root task
331: * return: =NULL error or !=NULL ready task
332: */
1.18 misho 333: void *schedFetch(sched_root_task_t * __restrict root);
1.1 misho 334: /*
335: * schedRun() - Scheduler *run loop*
1.6 misho 336: *
1.1 misho 337: * @root = root task
1.2 misho 338: * @killState = kill condition variable, if !=0 stop scheduler loop
1.1 misho 339: * return: -1 error or 0 ok
340: */
1.7 misho 341: int schedRun(sched_root_task_t *root, volatile intptr_t * __restrict killState);
1.1 misho 342: /*
343: * schedCancel() - Cancel task from scheduler
1.6 misho 344: *
1.1 misho 345: * @task = task
346: * return: -1 error or 0 ok
347: */
348: int schedCancel(sched_task_t * __restrict task);
349: /*
350: * schedCancelby() - Cancel task from scheduler by criteria
1.6 misho 351: *
1.1 misho 352: * @root = root task
1.5 misho 353: * @type = cancel from queue type, if =taskMAX cancel same task from all queues
1.10 misho 354: * @criteria = find task by criteria
1.23 misho 355: * [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|
1.24 misho 356: * CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA|CRITERIA_DATLEN ]
1.1 misho 357: * @param = search parameter
358: * @hook = custom cleanup hook function, may be NULL
1.3 misho 359: * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
1.1 misho 360: */
1.5 misho 361: int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.23 misho 362: unsigned char criteria, void *param, sched_hook_func_t hook);
363: /*
364: * schedQuery() - Query task in scheduler
365: *
366: * @task = task
367: * return: -1 error, 0 found and 1 not found
368: */
369: int schedQuery(sched_task_t * __restrict task);
370: /*
371: * schedQueryby() - Query task in scheduler by criteria
372: *
373: * @root = root task
374: * @type = query from queue type, if =taskMAX query same task from all queues
375: * @criteria = find task by criteria
376: * [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|
1.24 misho 377: * CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA|CRITERIA_DATLEN ]
1.23 misho 378: * @param = search parameter
1.31 misho 379: * return: NULL not found or !=NULL task
1.23 misho 380: */
1.31 misho 381: sched_task_t *schedQueryby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.23 misho 382: unsigned char criteria, void *param);
1.31.2.1 misho 383: /*
384: * schedSignalDispatch() - Activate or Deactivate signal dispatcher
385: *
386: * @root = root task
387: * @on = Activate or =0 deactivate
388: * return: -1 error or 0 ok
389: */
390: int schedSignalDispatch(sched_root_task_t * __restrict root, int on);
1.1 misho 391:
392:
393: /*
1.30 misho 394: * schedReadExt() - Add READ I/O task to scheduler queue with custom event mask
395: *
396: * @root = root task
397: * @func = task execution function
398: * @arg = 1st func argument
399: * @fd = fd handle
400: * @opt_data = Optional data
401: * @opt_dlen = Optional data length
402: * @mask = Event mask
403: * return: NULL error or !=NULL new queued task
404: */
405: sched_task_t *schedReadExt(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
406: int fd, void *opt_data, size_t opt_dlen, unsigned long mask);
407: /*
1.2 misho 408: * schedRead() - Add READ I/O task to scheduler queue
1.6 misho 409: *
1.1 misho 410: * @root = root task
411: * @func = task execution function
412: * @arg = 1st func argument
1.2 misho 413: * @fd = fd handle
1.5 misho 414: * @opt_data = Optional data
415: * @opt_dlen = Optional data length
1.1 misho 416: * return: NULL error or !=NULL new queued task
417: */
1.5 misho 418: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
419: int fd, void *opt_data, size_t opt_dlen);
1.30 misho 420: #define schedReadSelf(x) schedReadExt(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
421: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)), TASK_HARG((x)))
422: /*
423: * schedWriteExt() - Add WRITE I/O task to scheduler queue with custom event mask
424: *
425: * @root = root task
426: * @func = task execution function
427: * @arg = 1st func argument
428: * @fd = fd handle
429: * @opt_data = Optional data
430: * @opt_dlen = Optional data length
431: * @mask = Event mask
432: * return: NULL error or !=NULL new queued task
433: */
434: sched_task_t *schedWriteExt(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
435: int fd, void *opt_data, size_t opt_dlen, unsigned long mask);
1.1 misho 436: /*
1.2 misho 437: * schedWrite() - Add WRITE I/O task to scheduler queue
1.6 misho 438: *
1.1 misho 439: * @root = root task
440: * @func = task execution function
441: * @arg = 1st func argument
1.2 misho 442: * @fd = fd handle
1.5 misho 443: * @opt_data = Optional data
444: * @opt_dlen = Optional data length
1.1 misho 445: * return: NULL error or !=NULL new queued task
446: */
1.5 misho 447: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
448: int fd, void *opt_data, size_t opt_dlen);
1.30 misho 449: #define schedWriteSelf(x) schedWriteExt(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
450: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)), TASK_HARG((x)))
1.1 misho 451: /*
1.9 misho 452: * schedAlarm() - Add ALARM task to scheduler queue
453: *
454: * @root = root task
455: * @func = task execution function
456: * @arg = 1st func argument
457: * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!
1.20 misho 458: * @opt_data = Alarm timer ID
1.9 misho 459: * @opt_dlen = Optional data length
460: * return: NULL error or !=NULL new queued task
461: */
462: sched_task_t *schedAlarm(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
463: struct timespec ts, void *opt_data, size_t opt_dlen);
464: #define schedAlarmSelf(x) schedAlarm(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
465: TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
466: /*
1.20 misho 467: * schedRTC() - Add RTC task to scheduler queue
468: *
469: * @root = root task
470: * @func = task execution function
471: * @arg = 1st func argument
472: * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!
473: * @opt_data = Optional RTC ID
1.21 misho 474: * @opt_dlen = Optional data length
1.20 misho 475: * return: NULL error or !=NULL new queued task
476: */
477: sched_task_t *schedRTC(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
478: struct timespec ts, void *opt_data, size_t opt_dlen);
479: #define schedRTCSelf(x) schedRTC(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
480: TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
481: /*
1.10 misho 482: * schedNode() - Add NODE task to scheduler queue
483: *
484: * @root = root task
485: * @func = task execution function
486: * @arg = 1st func argument
487: * @fd = fd handle
488: * @opt_data = Optional data
489: * @opt_dlen = Optional data length
490: * return: NULL error or !=NULL new queued task
491: */
492: sched_task_t *schedNode(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
493: int fd, void *opt_data, size_t opt_dlen);
494: #define schedNodeSelf(x) schedNode(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.29 misho 495: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
496: /*
497: * schedNode2() - Add NODE task with all events to scheduler queue
498: *
499: * @root = root task
500: * @func = task execution function
501: * @arg = 1st func argument
502: * @fd = fd handle
503: * @opt_data = Optional data
504: * @opt_dlen = Optional data length
505: * return: NULL error or !=NULL new queued task
506: */
507: sched_task_t *schedNode2(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
508: int fd, void *opt_data, size_t opt_dlen);
509: #define schedNode2Self(x) schedNode2(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.10 misho 510: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
511: /*
512: * schedProc() - Add PROC task to scheduler queue
513: *
514: * @root = root task
515: * @func = task execution function
516: * @arg = 1st func argument
517: * @pid = PID
518: * @opt_data = Optional data
519: * @opt_dlen = Optional data length
520: * return: NULL error or !=NULL new queued task
521: */
522: sched_task_t *schedProc(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
523: unsigned long pid, void *opt_data, size_t opt_dlen);
524: #define schedProcSelf(x) schedProc(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
525: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
526: /*
527: * schedSignal() - Add SIGNAL task to scheduler queue
528: *
529: * @root = root task
530: * @func = task execution function
531: * @arg = 1st func argument
532: * @sig = Signal
533: * @opt_data = Optional data
534: * @opt_dlen = Optional data length
535: * return: NULL error or !=NULL new queued task
536: */
537: sched_task_t *schedSignal(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
538: unsigned long sig, void *opt_data, size_t opt_dlen);
539: #define schedSignalSelf(x) schedSignal(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
540: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
541:
1.12 misho 542: #ifdef EVFILT_LIO
543: /*
544: * schedAIO() - Add AIO task to scheduler queue
545: *
546: * @root = root task
547: * @func = task execution function
548: * @arg = 1st func argument
549: * @acb = AIO cb structure address
550: * @opt_data = Optional data
551: * @opt_dlen = Optional data length
552: * return: NULL error or !=NULL new queued task
553: */
554: sched_task_t *schedAIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
555: struct aiocb * __restrict acb, void *opt_data, size_t opt_dlen);
556: /*
557: * schedAIORead() - Add AIO read task to scheduler queue
558: *
559: * @root = root task
560: * @func = task execution function
561: * @arg = 1st func argument
562: * @fd = file descriptor
563: * @buffer = Buffer
564: * @buflen = Buffer length
565: * @offset = Offset from start of file, if =-1 from current position
566: * return: NULL error or !=NULL new queued task
567: */
1.18 misho 568: sched_task_t *schedAIORead(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 569: void *arg, int fd, void *buffer, size_t buflen, off_t offset);
570: /*
571: * schedAIOWrite() - Add AIO write task to scheduler queue
572: *
573: * @root = root task
574: * @func = task execution function
575: * @arg = 1st func argument
576: * @fd = file descriptor
577: * @buffer = Buffer
578: * @buflen = Buffer length
579: * @offset = Offset from start of file, if =-1 from current position
580: * return: NULL error or !=NULL new queued task
581: */
1.18 misho 582: sched_task_t *schedAIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 583: void *arg, int fd, void *buffer, size_t buflen, off_t offset);
584:
585: /*
586: * schedLIO() - Add AIO bulk tasks to scheduler queue
587: *
588: * @root = root task
589: * @func = task execution function
590: * @arg = 1st func argument
591: * @acbs = AIO cb structure addresses
592: * @opt_data = Optional data
593: * @opt_dlen = Optional data length
594: * return: NULL error or !=NULL new queued task
595: */
596: sched_task_t *schedLIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
597: struct aiocb ** __restrict acbs, void *opt_data, size_t opt_dlen);
598: /*
599: * schedLIORead() - Add list of AIO read tasks to scheduler queue
600: *
601: * @root = root task
602: * @func = task execution function
603: * @arg = 1st func argument
604: * @fd = file descriptor
605: * @bufs = Buffer's list
606: * @nbufs = Number of Buffers
607: * @offset = Offset from start of file, if =-1 from current position
608: * return: NULL error or !=NULL new queued task
609: */
1.18 misho 610: sched_task_t *schedLIORead(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 611: void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);
612: /*
613: * schedLIOWrite() - Add list of AIO write tasks to scheduler queue
614: *
615: * @root = root task
616: * @func = task execution function
617: * @arg = 1st func argument
618: * @fd = file descriptor
619: * @bufs = Buffer's list
620: * @nbufs = Number of Buffers
621: * @offset = Offset from start of file, if =-1 from current position
622: * return: NULL error or !=NULL new queued task
623: */
1.18 misho 624: sched_task_t *schedLIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func,
1.12 misho 625: void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);
626: #endif /* EVFILT_LIO */
627:
1.10 misho 628: /*
629: * schedUser() - Add trigger USER task to scheduler queue
630: *
631: * @root = root task
632: * @func = task execution function
633: * @arg = 1st func argument
634: * @id = Trigger ID
635: * @opt_data = Optional data
636: * @opt_dlen = Optional user's trigger flags
637: * return: NULL error or !=NULL new queued task
638: */
639: sched_task_t *schedUser(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
640: unsigned long id, void *opt_data, size_t opt_dlen);
641: #define schedUserSelf(x) schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
642: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
643: /*
644: * schedTrigger() - Triggering USER task
645: *
646: * @task = task
647: * return: -1 error or 0 ok
648: */
649: int schedTrigger(sched_task_t * __restrict task);
650:
651: /*
1.1 misho 652: * schedTimer() - Add TIMER task to scheduler queue
1.6 misho 653: *
1.1 misho 654: * @root = root task
655: * @func = task execution function
656: * @arg = 1st func argument
1.5 misho 657: * @ts = timeout argument structure
658: * @opt_data = Optional data
659: * @opt_dlen = Optional data length
1.1 misho 660: * return: NULL error or !=NULL new queued task
661: */
1.5 misho 662: sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
663: struct timespec ts, void *opt_data, size_t opt_dlen);
1.1 misho 664: /*
665: * schedEvent() - Add EVENT task to scheduler queue
1.6 misho 666: *
1.1 misho 667: * @root = root task
668: * @func = task execution function
669: * @arg = 1st func argument
1.2 misho 670: * @val = additional func argument
1.5 misho 671: * @opt_data = Optional data
672: * @opt_dlen = Optional data length
1.1 misho 673: * return: NULL error or !=NULL new queued task
674: */
1.5 misho 675: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
676: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 misho 677: #define schedEventSelf(x) schedEvent(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
678: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 679: /*
1.13 misho 680: * schedTask() - Add regular task to scheduler queue
1.6 misho 681: *
1.1 misho 682: * @root = root task
683: * @func = task execution function
684: * @arg = 1st func argument
1.13 misho 685: * @prio = regular task priority, 0 is hi priority for regular tasks
1.5 misho 686: * @opt_data = Optional data
687: * @opt_dlen = Optional data length
1.1 misho 688: * return: NULL error or !=NULL new queued task
689: */
1.13 misho 690: sched_task_t *schedTask(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
691: unsigned long prio, void *opt_data, size_t opt_dlen);
692: #define schedTaskSelf(x) schedTask(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.8 misho 693: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.11 misho 694: /*
695: * schedSuspend() - Add Suspended task to scheduler queue
696: *
697: * @root = root task
698: * @func = task execution function
699: * @arg = 1st func argument
700: * @id = Trigger ID
701: * @opt_data = Optional data
702: * @opt_dlen = Optional user's trigger flags
703: * return: NULL error or !=NULL new queued task
704: */
705: sched_task_t *schedSuspend(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
706: unsigned long id, void *opt_data, size_t opt_dlen);
707: #define schedSuspendSelf(x) schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
708: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
709: /*
710: * schedResumeby() - Resume suspended task
711: *
712: * @root = root task
713: * @criteria = find task by criteria
1.24 misho 714: * [ CRITERIA_ANY|CRITERIA_ID|CRITERIA_VAL|CRITERIA_DATA ]
1.23 misho 715: * @param = search parameter (sched_task_t *task| unsigned long id)
1.11 misho 716: * return: -1 error or 0 resumed ok
717: */
718: int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param);
1.10 misho 719:
1.1 misho 720: /*
721: * schedCallOnce() - Call once from scheduler
1.6 misho 722: *
1.1 misho 723: * @root = root task
724: * @func = task execution function
725: * @arg = 1st func argument
1.2 misho 726: * @val = additional func argument
1.5 misho 727: * @opt_data = Optional data
728: * @opt_dlen = Optional data length
1.2 misho 729: * return: return value from called func
1.1 misho 730: */
1.5 misho 731: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
732: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 misho 733: #define schedCallAgain(x) schedCallOnce(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
734: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 735:
1.15 misho 736: /*
737: * schedThread() - Add thread task to scheduler queue
738: *
739: * @root = root task
740: * @func = task execution function
741: * @arg = 1st func argument
1.17 misho 742: * @ss = stack size
1.15 misho 743: * @opt_data = Optional data
744: * @opt_dlen = Optional data length
745: * return: NULL error or !=NULL new queued task
746: */
747: sched_task_t *schedThread(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
1.22 misho 748: size_t ss, void *opt_data, size_t opt_dlen);
1.15 misho 749: #define schedThreadSelf(x) schedThread(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
1.22 misho 750: (size_t) TASK_FLAG((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.15 misho 751: /*
1.16 misho 752: * sched_taskExit() - Exit routine for scheduler task, explicit required for thread tasks
753: *
754: * @task = current task
755: * @retcode = return code
756: * return: return code
757: */
1.18 misho 758: void *sched_taskExit(sched_task_t *task, intptr_t retcode);
1.16 misho 759: /*
760: * taskExit() - Exit helper for scheduler task
1.15 misho 761: *
762: * @t = current executed task
763: * @x = exit value for task
764: * return: none
765: */
1.16 misho 766: #define taskExit(t, x) return sched_taskExit((t), (intptr_t) (x))
1.15 misho 767:
1.1 misho 768:
769: #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