Annotation of libaitsched/inc/aitsched.h, revision 1.6
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.6 ! misho 6: * $Id: aitsched.h,v 1.5.2.1 2012/03/13 10:00:37 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
62: #define CRITERIA_TV 4
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;
136:
137: void *task_arg;
138: union {
139: unsigned long v;
1.3 misho 140: intptr_t fd;
1.5 misho 141: struct timespec ts;
1.1 misho 142: } task_val;
143: #define TASK_ARG(x) (x)->task_arg
144: #define TASK_VAL(x) (x)->task_val.v
145: #define TASK_FD(x) (x)->task_val.fd
1.5 misho 146: #define TASK_TS(x) (x)->task_val.ts
1.1 misho 147:
148: struct iovec task_data;
149: #define TASK_DATA(x) (x)->task_data.iov_base
150: #define TASK_DATLEN(x) (x)->task_data.iov_len
151:
152: TAILQ_ENTRY(sched_Task) task_node;
153: };
154: typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
1.5 misho 155: #define TASK_DATA_SET(x, _dp, _dl) do { \
156: if ((x)) { \
157: (x)->task_data.iov_base = (_dp); \
158: (x)->task_data.iov_len = _dl; \
159: } \
160: while (0)
1.1 misho 161:
162: /* root task */
163: struct sched_RootTask {
164: int root_kq;
1.5 misho 165: struct timespec root_wait;
166: struct timespec root_poll;
1.6 ! misho 167: intptr_t root_cond;
! 168:
1.5 misho 169: pthread_mutex_t root_mtx[taskMAX];
1.1 misho 170:
171: sched_queue_t root_read;
172: sched_queue_t root_write;
173: sched_queue_t root_timer;
174: sched_queue_t root_event;
175: sched_queue_t root_ready;
176: sched_queue_t root_unuse;
177: sched_queue_t root_eventlo;
178: int root_eventlo_miss;
179:
180: hooks_task_t root_hooks;
181: struct iovec root_data;
182: #define ROOT_DATA(x) (x)->root_data.iov_base
183: #define ROOT_DATLEN(x) (x)->root_data.iov_len
184: };
185:
186:
1.2 misho 187: inline int sched_GetErrno();
188: inline const char *sched_GetError();
189:
190:
1.1 misho 191: /*
192: * schedInit() - Init scheduler
1.6 ! misho 193: *
1.1 misho 194: * @data = optional data if !=NULL
195: * @datlen = data len if data is set
196: * return: allocated root task if ok or NULL error
197: */
198: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.2 misho 199: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 200: /*
201: * schedEnd() - End scheduler & free all resources
1.6 ! misho 202: *
1.1 misho 203: * @root = root task
204: * return: -1 error or 0 ok
205: */
1.2 misho 206: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 207: /*
1.2 misho 208: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.6 ! misho 209: *
1.1 misho 210: * @root = root task
211: * return: -1 error or 0 ok
212: */
1.2 misho 213: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 214: /*
1.5 misho 215: * schedPolling() - Polling timeout period if no timer task is present
1.6 ! misho 216: *
1.5 misho 217: * @root = root task
218: * @ts = timeout polling period, if ==NULL INFINIT timeout
219: * @tsold = old timeout polling if !=NULL
220: * return: -1 error or 0 ok
221: */
222: inline int schedPolling(sched_root_task_t * __restrict root,
223: struct timespec * __restrict ts, struct timespec * __restrict tsold);
224: /*
1.6 ! misho 225: * schedTermCondition() - Activate hook for scheduler condition kill
! 226: *
! 227: * @root = root task
! 228: * @condValue = condition value, kill schedRun() if condValue == killState
! 229: * return: -1 error ok 0 ok
! 230: */
! 231: inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue);
! 232: /*
1.1 misho 233: * schedCall() - Call task execution function
1.6 ! misho 234: *
1.1 misho 235: * @task = current task
236: * return: !=NULL error or =NULL ok
237: */
238: inline void *schedCall(sched_task_t * __restrict task);
239: /*
240: * schedFetch() - Fetch ready task
1.6 ! misho 241: *
1.1 misho 242: * @root = root task
243: * return: =NULL error or !=NULL ready task
244: */
245: inline void *schedFetch(sched_root_task_t * __restrict root);
246: /*
247: * schedRun() - Scheduler *run loop*
1.6 ! misho 248: *
1.1 misho 249: * @root = root task
1.2 misho 250: * @killState = kill condition variable, if !=0 stop scheduler loop
1.1 misho 251: * return: -1 error or 0 ok
252: */
1.2 misho 253: int schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState);
1.1 misho 254: /*
255: * schedCancel() - Cancel task from scheduler
1.6 ! misho 256: *
1.1 misho 257: * @task = task
258: * return: -1 error or 0 ok
259: */
260: int schedCancel(sched_task_t * __restrict task);
261: /*
262: * schedCancelby() - Cancel task from scheduler by criteria
1.6 ! misho 263: *
1.1 misho 264: * @root = root task
1.5 misho 265: * @type = cancel from queue type, if =taskMAX cancel same task from all queues
1.1 misho 266: * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV]
267: * @param = search parameter
268: * @hook = custom cleanup hook function, may be NULL
1.3 misho 269: * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
1.1 misho 270: */
1.5 misho 271: int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.1 misho 272: u_char criteria, void *param, sched_hook_func_t hook);
273:
274:
275: /*
1.2 misho 276: * schedRead() - Add READ I/O task to scheduler queue
1.6 ! misho 277: *
1.1 misho 278: * @root = root task
279: * @func = task execution function
280: * @arg = 1st func argument
1.2 misho 281: * @fd = fd handle
1.5 misho 282: * @opt_data = Optional data
283: * @opt_dlen = Optional data length
1.1 misho 284: * return: NULL error or !=NULL new queued task
285: */
1.5 misho 286: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
287: int fd, void *opt_data, size_t opt_dlen);
1.1 misho 288: /*
1.2 misho 289: * schedWrite() - Add WRITE I/O task to scheduler queue
1.6 ! misho 290: *
1.1 misho 291: * @root = root task
292: * @func = task execution function
293: * @arg = 1st func argument
1.2 misho 294: * @fd = fd handle
1.5 misho 295: * @opt_data = Optional data
296: * @opt_dlen = Optional data length
1.1 misho 297: * return: NULL error or !=NULL new queued task
298: */
1.5 misho 299: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
300: int fd, void *opt_data, size_t opt_dlen);
1.1 misho 301: /*
302: * schedTimer() - Add TIMER task to scheduler queue
1.6 ! misho 303: *
1.1 misho 304: * @root = root task
305: * @func = task execution function
306: * @arg = 1st func argument
1.5 misho 307: * @ts = timeout argument structure
308: * @opt_data = Optional data
309: * @opt_dlen = Optional data length
1.1 misho 310: * return: NULL error or !=NULL new queued task
311: */
1.5 misho 312: sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
313: struct timespec ts, void *opt_data, size_t opt_dlen);
1.1 misho 314: /*
315: * schedEvent() - Add EVENT task to scheduler queue
1.6 ! misho 316: *
1.1 misho 317: * @root = root task
318: * @func = task execution function
319: * @arg = 1st func argument
1.2 misho 320: * @val = additional func argument
1.5 misho 321: * @opt_data = Optional data
322: * @opt_dlen = Optional data length
1.1 misho 323: * return: NULL error or !=NULL new queued task
324: */
1.5 misho 325: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
326: unsigned long val, void *opt_data, size_t opt_dlen);
1.1 misho 327: /*
328: * schedEventLo() - Add EVENT_Lo task to scheduler queue
1.6 ! misho 329: *
1.1 misho 330: * @root = root task
331: * @func = task execution function
332: * @arg = 1st func argument
1.2 misho 333: * @val = additional func argument
1.5 misho 334: * @opt_data = Optional data
335: * @opt_dlen = Optional data length
1.1 misho 336: * return: NULL error or !=NULL new queued task
337: */
1.5 misho 338: sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
339: unsigned long val, void *opt_data, size_t opt_dlen);
1.1 misho 340: /*
341: * schedCallOnce() - Call once from scheduler
1.6 ! misho 342: *
1.1 misho 343: * @root = root task
344: * @func = task execution function
345: * @arg = 1st func argument
1.2 misho 346: * @val = additional func argument
1.5 misho 347: * @opt_data = Optional data
348: * @opt_dlen = Optional data length
1.2 misho 349: * return: return value from called func
1.1 misho 350: */
1.5 misho 351: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
352: unsigned long val, void *opt_data, size_t opt_dlen);
1.1 misho 353:
354:
355: #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