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