Annotation of libaitsched/inc/aitsched.h, revision 1.8
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.8 ! misho 6: * $Id: aitsched.h,v 1.7.2.2 2012/05/15 15:47:12 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.6 misho 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
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>
52: #include <sys/uio.h>
1.3 misho 53: #include <stdint.h>
1.5 misho 54: #include <pthread.h>
1.2 misho 55:
56:
1.1 misho 57: /* criteria type */
58: #define CRITERIA_CALL 0
59: #define CRITERIA_ARG 1
60: #define CRITERIA_FD 2
61: #define CRITERIA_VAL 3
1.8 ! misho 62: #define CRITERIA_TS 4
1.1 misho 63:
64:
65: /* early declaration for root & task */
66: typedef struct sched_Task sched_task_t;
67: typedef struct sched_RootTask sched_root_task_t;
68:
69: typedef enum {
70: taskREAD = 0,
71: taskWRITE,
72: taskTIMER,
73: taskEVENT,
1.5 misho 74: taskEVENTLO,
1.1 misho 75: taskREADY,
76: taskUNUSE,
77: taskMAX
78: } sched_task_type_t;
79:
80: /* hooks */
81: typedef void *(*sched_hook_func_t)(void *, void *);
82: struct sched_HooksTask {
83: struct {
84: /* read(sched_task_t *task, NULL) -> int */
85: sched_hook_func_t read;
86: /* write(sched_task_t *task, NULL) -> int */
87: sched_hook_func_t write;
88: /* event(sched_task_t *task, NULL) -> int */
89: sched_hook_func_t event;
90: /* eventlo(sched_task_t *task, NULL) -> int */
91: sched_hook_func_t eventlo;
1.5 misho 92: /* timer(sched_task_t *task, struct timespec *ts) -> int */
1.1 misho 93: sched_hook_func_t timer;
94: } hook_add;
95: struct {
96: /* cancel(sched_task_t *task, NULL) -> int */
97: sched_hook_func_t cancel;
98: /* run(sched_root_task_t *root, NULL) -> int */
99: sched_hook_func_t run;
100: /* fetch(sched_root_task_t *root, NULL) -> sched_task_t* */
101: sched_hook_func_t fetch;
1.3 misho 102: /* exception(sched_root_task_t *root, NULL) -> int */
103: sched_hook_func_t exception;
1.6 misho 104: /* condition(sched_root_task_t *root, intptr_t *stopValue) -> int */
105: sched_hook_func_t condition;
1.1 misho 106: } hook_exec;
107: struct {
108: /* init(sched_root_task_t *root, void *data) -> int */
109: sched_hook_func_t init;
110: /* fini(sched_root_task_t *root, NULL) -> int */
111: sched_hook_func_t fini;
1.3 misho 112: /* error(sched_root_task_t *root, int errno) -> int */
113: sched_hook_func_t error;
1.1 misho 114: } hook_root;
115: };
116: typedef struct sched_HooksTask hooks_task_t;
117:
118: /* task callback, like pthread callback! */
1.2 misho 119: typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/);
1.1 misho 120:
1.4 misho 121: /* task lock helpers */
122: #define TASK_LOCK(x) ((x)->task_lock++)
123: #define TASK_UNLOCK(x) ((x)->task_lock ^= (x)->task_lock)
124: #define TASK_ISLOCKED(x) ((x)->task_lock)
125:
1.1 misho 126: /* task & queue */
127: struct sched_Task {
1.4 misho 128: volatile int task_lock;
1.1 misho 129: unsigned int task_id;
130: sched_task_type_t task_type;
1.5 misho 131: #define TASK_TYPE(x) (x)->task_type
1.1 misho 132:
133: sched_root_task_t *task_root;
1.2 misho 134: #define TASK_ROOT(x) (x)->task_root
1.1 misho 135: sched_task_func_t task_func;
1.8 ! misho 136: #define TASK_FUNC(x) (x)->task_func
1.1 misho 137:
138: void *task_arg;
139: union {
140: unsigned long v;
1.3 misho 141: intptr_t fd;
1.5 misho 142: struct timespec ts;
1.1 misho 143: } task_val;
144: #define TASK_ARG(x) (x)->task_arg
145: #define TASK_VAL(x) (x)->task_val.v
146: #define TASK_FD(x) (x)->task_val.fd
1.5 misho 147: #define TASK_TS(x) (x)->task_val.ts
1.1 misho 148:
149: struct iovec task_data;
150: #define TASK_DATA(x) (x)->task_data.iov_base
151: #define TASK_DATLEN(x) (x)->task_data.iov_len
152:
153: TAILQ_ENTRY(sched_Task) task_node;
154: };
155: typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
1.5 misho 156: #define TASK_DATA_SET(x, _dp, _dl) do { \
157: if ((x)) { \
158: (x)->task_data.iov_base = (_dp); \
159: (x)->task_data.iov_len = _dl; \
160: } \
161: while (0)
1.1 misho 162:
163: /* root task */
164: struct sched_RootTask {
165: int root_kq;
1.5 misho 166: struct timespec root_wait;
167: struct timespec root_poll;
1.6 misho 168: intptr_t root_cond;
169:
1.5 misho 170: pthread_mutex_t root_mtx[taskMAX];
1.1 misho 171:
172: sched_queue_t root_read;
173: sched_queue_t root_write;
174: sched_queue_t root_timer;
175: sched_queue_t root_event;
176: sched_queue_t root_ready;
177: sched_queue_t root_unuse;
178: sched_queue_t root_eventlo;
179: int root_eventlo_miss;
180:
181: hooks_task_t root_hooks;
182: struct iovec root_data;
183: #define ROOT_DATA(x) (x)->root_data.iov_base
184: #define ROOT_DATLEN(x) (x)->root_data.iov_len
185: };
1.7 misho 186: #define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q))
1.1 misho 187:
188:
1.2 misho 189: inline int sched_GetErrno();
190: inline const char *sched_GetError();
191:
192:
1.1 misho 193: /*
194: * schedInit() - Init scheduler
1.6 misho 195: *
1.1 misho 196: * @data = optional data if !=NULL
197: * @datlen = data len if data is set
198: * return: allocated root task if ok or NULL error
199: */
200: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.2 misho 201: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 202: /*
203: * schedEnd() - End scheduler & free all resources
1.6 misho 204: *
1.1 misho 205: * @root = root task
206: * return: -1 error or 0 ok
207: */
1.2 misho 208: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 209: /*
1.2 misho 210: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.6 misho 211: *
1.1 misho 212: * @root = root task
213: * return: -1 error or 0 ok
214: */
1.2 misho 215: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 216: /*
1.5 misho 217: * schedPolling() - Polling timeout period if no timer task is present
1.6 misho 218: *
1.5 misho 219: * @root = root task
220: * @ts = timeout polling period, if ==NULL INFINIT timeout
221: * @tsold = old timeout polling if !=NULL
222: * return: -1 error or 0 ok
223: */
224: inline int schedPolling(sched_root_task_t * __restrict root,
225: struct timespec * __restrict ts, struct timespec * __restrict tsold);
226: /*
1.6 misho 227: * schedTermCondition() - Activate hook for scheduler condition kill
228: *
229: * @root = root task
230: * @condValue = condition value, kill schedRun() if condValue == killState
231: * return: -1 error ok 0 ok
232: */
233: inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue);
234: /*
1.1 misho 235: * schedCall() - Call task execution function
1.6 misho 236: *
1.1 misho 237: * @task = current task
238: * return: !=NULL error or =NULL ok
239: */
240: inline void *schedCall(sched_task_t * __restrict task);
241: /*
242: * schedFetch() - Fetch ready task
1.6 misho 243: *
1.1 misho 244: * @root = root task
245: * return: =NULL error or !=NULL ready task
246: */
247: inline void *schedFetch(sched_root_task_t * __restrict root);
248: /*
249: * schedRun() - Scheduler *run loop*
1.6 misho 250: *
1.1 misho 251: * @root = root task
1.2 misho 252: * @killState = kill condition variable, if !=0 stop scheduler loop
1.1 misho 253: * return: -1 error or 0 ok
254: */
1.7 misho 255: int schedRun(sched_root_task_t *root, volatile intptr_t * __restrict killState);
1.1 misho 256: /*
257: * schedCancel() - Cancel task from scheduler
1.6 misho 258: *
1.1 misho 259: * @task = task
260: * return: -1 error or 0 ok
261: */
262: int schedCancel(sched_task_t * __restrict task);
263: /*
264: * schedCancelby() - Cancel task from scheduler by criteria
1.6 misho 265: *
1.1 misho 266: * @root = root task
1.5 misho 267: * @type = cancel from queue type, if =taskMAX cancel same task from all queues
1.8 ! misho 268: * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TS]
1.1 misho 269: * @param = search parameter
270: * @hook = custom cleanup hook function, may be NULL
1.3 misho 271: * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
1.1 misho 272: */
1.5 misho 273: int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.1 misho 274: u_char criteria, void *param, sched_hook_func_t hook);
275:
276:
277: /*
1.2 misho 278: * schedRead() - Add READ I/O task to scheduler queue
1.6 misho 279: *
1.1 misho 280: * @root = root task
281: * @func = task execution function
282: * @arg = 1st func argument
1.2 misho 283: * @fd = fd handle
1.5 misho 284: * @opt_data = Optional data
285: * @opt_dlen = Optional data length
1.1 misho 286: * return: NULL error or !=NULL new queued task
287: */
1.5 misho 288: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
289: int fd, void *opt_data, size_t opt_dlen);
1.8 ! misho 290: #define schedReadSelf(x) schedRead(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
! 291: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 292: /*
1.2 misho 293: * schedWrite() - Add WRITE I/O task to scheduler queue
1.6 misho 294: *
1.1 misho 295: * @root = root task
296: * @func = task execution function
297: * @arg = 1st func argument
1.2 misho 298: * @fd = fd handle
1.5 misho 299: * @opt_data = Optional data
300: * @opt_dlen = Optional data length
1.1 misho 301: * return: NULL error or !=NULL new queued task
302: */
1.5 misho 303: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
304: int fd, void *opt_data, size_t opt_dlen);
1.8 ! misho 305: #define schedWriteSelf(x) schedWrite(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
! 306: TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 307: /*
308: * schedTimer() - Add TIMER task to scheduler queue
1.6 misho 309: *
1.1 misho 310: * @root = root task
311: * @func = task execution function
312: * @arg = 1st func argument
1.5 misho 313: * @ts = timeout argument structure
314: * @opt_data = Optional data
315: * @opt_dlen = Optional data length
1.1 misho 316: * return: NULL error or !=NULL new queued task
317: */
1.5 misho 318: sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
319: struct timespec ts, void *opt_data, size_t opt_dlen);
1.8 ! misho 320: #define schedTimerSelf(x) schedTimer(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
! 321: TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 322: /*
323: * schedEvent() - Add EVENT task to scheduler queue
1.6 misho 324: *
1.1 misho 325: * @root = root task
326: * @func = task execution function
327: * @arg = 1st func argument
1.2 misho 328: * @val = additional func argument
1.5 misho 329: * @opt_data = Optional data
330: * @opt_dlen = Optional data length
1.1 misho 331: * return: NULL error or !=NULL new queued task
332: */
1.5 misho 333: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
334: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 ! misho 335: #define schedEventSelf(x) schedEvent(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
! 336: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 337: /*
338: * schedEventLo() - Add EVENT_Lo task to scheduler queue
1.6 misho 339: *
1.1 misho 340: * @root = root task
341: * @func = task execution function
342: * @arg = 1st func argument
1.2 misho 343: * @val = additional func argument
1.5 misho 344: * @opt_data = Optional data
345: * @opt_dlen = Optional data length
1.1 misho 346: * return: NULL error or !=NULL new queued task
347: */
1.5 misho 348: sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
349: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 ! misho 350: #define schedEventLoSelf(x) schedEventLo(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
! 351: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 352: /*
353: * schedCallOnce() - Call once from scheduler
1.6 misho 354: *
1.1 misho 355: * @root = root task
356: * @func = task execution function
357: * @arg = 1st func argument
1.2 misho 358: * @val = additional func argument
1.5 misho 359: * @opt_data = Optional data
360: * @opt_dlen = Optional data length
1.2 misho 361: * return: return value from called func
1.1 misho 362: */
1.5 misho 363: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
364: unsigned long val, void *opt_data, size_t opt_dlen);
1.8 ! misho 365: #define schedCallAgain(x) schedCallOnce(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
! 366: TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
1.1 misho 367:
368:
369: #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