Annotation of libaitsched/inc/aitsched.h, revision 1.5
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.5 ! misho 6: * $Id: aitsched.h,v 1.4.2.7 2012/01/24 14:34:49 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:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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.1 misho 104: } hook_exec;
105: struct {
106: /* init(sched_root_task_t *root, void *data) -> int */
107: sched_hook_func_t init;
108: /* fini(sched_root_task_t *root, NULL) -> int */
109: sched_hook_func_t fini;
1.3 misho 110: /* error(sched_root_task_t *root, int errno) -> int */
111: sched_hook_func_t error;
1.1 misho 112: } hook_root;
113: };
114: typedef struct sched_HooksTask hooks_task_t;
115:
116: /* task callback, like pthread callback! */
1.2 misho 117: typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/);
1.1 misho 118:
1.4 misho 119: /* task lock helpers */
120: #define TASK_LOCK(x) ((x)->task_lock++)
121: #define TASK_UNLOCK(x) ((x)->task_lock ^= (x)->task_lock)
122: #define TASK_ISLOCKED(x) ((x)->task_lock)
123:
1.1 misho 124: /* task & queue */
125: struct sched_Task {
1.4 misho 126: volatile int task_lock;
1.1 misho 127: unsigned int task_id;
128: sched_task_type_t task_type;
1.5 ! misho 129: #define TASK_TYPE(x) (x)->task_type
1.1 misho 130:
131: sched_root_task_t *task_root;
1.2 misho 132: #define TASK_ROOT(x) (x)->task_root
1.1 misho 133: sched_task_func_t task_func;
134:
135: void *task_arg;
136: union {
137: unsigned long v;
1.3 misho 138: intptr_t fd;
1.5 ! misho 139: struct timespec ts;
1.1 misho 140: } task_val;
141: #define TASK_ARG(x) (x)->task_arg
142: #define TASK_VAL(x) (x)->task_val.v
143: #define TASK_FD(x) (x)->task_val.fd
1.5 ! misho 144: #define TASK_TS(x) (x)->task_val.ts
1.1 misho 145:
146: struct iovec task_data;
147: #define TASK_DATA(x) (x)->task_data.iov_base
148: #define TASK_DATLEN(x) (x)->task_data.iov_len
149:
150: TAILQ_ENTRY(sched_Task) task_node;
151: };
152: typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
1.5 ! misho 153: #define TASK_DATA_SET(x, _dp, _dl) do { \
! 154: if ((x)) { \
! 155: (x)->task_data.iov_base = (_dp); \
! 156: (x)->task_data.iov_len = _dl; \
! 157: } \
! 158: while (0)
1.1 misho 159:
160: /* root task */
161: struct sched_RootTask {
162: int root_kq;
1.5 ! misho 163: struct timespec root_wait;
! 164: struct timespec root_poll;
! 165: pthread_mutex_t root_mtx[taskMAX];
1.1 misho 166:
167: sched_queue_t root_read;
168: sched_queue_t root_write;
169: sched_queue_t root_timer;
170: sched_queue_t root_event;
171: sched_queue_t root_ready;
172: sched_queue_t root_unuse;
173: sched_queue_t root_eventlo;
174: int root_eventlo_miss;
175:
176: hooks_task_t root_hooks;
177: struct iovec root_data;
178: #define ROOT_DATA(x) (x)->root_data.iov_base
179: #define ROOT_DATLEN(x) (x)->root_data.iov_len
180: };
181:
182:
1.2 misho 183: inline int sched_GetErrno();
184: inline const char *sched_GetError();
185:
186:
1.1 misho 187: /*
188: * schedInit() - Init scheduler
189: * @data = optional data if !=NULL
190: * @datlen = data len if data is set
191: * return: allocated root task if ok or NULL error
192: */
193: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.2 misho 194: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 195: /*
196: * schedEnd() - End scheduler & free all resources
197: * @root = root task
198: * return: -1 error or 0 ok
199: */
1.2 misho 200: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 201: /*
1.2 misho 202: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.1 misho 203: * @root = root task
204: * return: -1 error or 0 ok
205: */
1.2 misho 206: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 207: /*
1.5 ! misho 208: * schedPolling() - Polling timeout period if no timer task is present
! 209: * @root = root task
! 210: * @ts = timeout polling period, if ==NULL INFINIT timeout
! 211: * @tsold = old timeout polling if !=NULL
! 212: * return: -1 error or 0 ok
! 213: */
! 214: inline int schedPolling(sched_root_task_t * __restrict root,
! 215: struct timespec * __restrict ts, struct timespec * __restrict tsold);
! 216: /*
1.1 misho 217: * schedCall() - Call task execution function
218: * @task = current task
219: * return: !=NULL error or =NULL ok
220: */
221: inline void *schedCall(sched_task_t * __restrict task);
222: /*
223: * schedFetch() - Fetch ready task
224: * @root = root task
225: * return: =NULL error or !=NULL ready task
226: */
227: inline void *schedFetch(sched_root_task_t * __restrict root);
228: /*
229: * schedRun() - Scheduler *run loop*
230: * @root = root task
1.2 misho 231: * @killState = kill condition variable, if !=0 stop scheduler loop
1.1 misho 232: * return: -1 error or 0 ok
233: */
1.2 misho 234: int schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState);
1.1 misho 235: /*
236: * schedCancel() - Cancel task from scheduler
237: * @task = task
238: * return: -1 error or 0 ok
239: */
240: int schedCancel(sched_task_t * __restrict task);
241: /*
242: * schedCancelby() - Cancel task from scheduler by criteria
243: * @root = root task
1.5 ! misho 244: * @type = cancel from queue type, if =taskMAX cancel same task from all queues
1.1 misho 245: * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV]
246: * @param = search parameter
247: * @hook = custom cleanup hook function, may be NULL
1.3 misho 248: * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
1.1 misho 249: */
1.5 ! misho 250: int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type,
1.1 misho 251: u_char criteria, void *param, sched_hook_func_t hook);
252:
253:
254: /*
1.2 misho 255: * schedRead() - Add READ I/O task to scheduler queue
1.1 misho 256: * @root = root task
257: * @func = task execution function
258: * @arg = 1st func argument
1.2 misho 259: * @fd = fd handle
1.5 ! misho 260: * @opt_data = Optional data
! 261: * @opt_dlen = Optional data length
1.1 misho 262: * return: NULL error or !=NULL new queued task
263: */
1.5 ! misho 264: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
! 265: int fd, void *opt_data, size_t opt_dlen);
1.1 misho 266: /*
1.2 misho 267: * schedWrite() - Add WRITE I/O task to scheduler queue
1.1 misho 268: * @root = root task
269: * @func = task execution function
270: * @arg = 1st func argument
1.2 misho 271: * @fd = fd handle
1.5 ! misho 272: * @opt_data = Optional data
! 273: * @opt_dlen = Optional data length
1.1 misho 274: * return: NULL error or !=NULL new queued task
275: */
1.5 ! misho 276: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
! 277: int fd, void *opt_data, size_t opt_dlen);
1.1 misho 278: /*
279: * schedTimer() - Add TIMER task to scheduler queue
280: * @root = root task
281: * @func = task execution function
282: * @arg = 1st func argument
1.5 ! misho 283: * @ts = timeout argument structure
! 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 *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
! 289: struct timespec ts, void *opt_data, size_t opt_dlen);
1.1 misho 290: /*
291: * schedEvent() - Add EVENT task to scheduler queue
292: * @root = root task
293: * @func = task execution function
294: * @arg = 1st func argument
1.2 misho 295: * @val = additional func argument
1.5 ! misho 296: * @opt_data = Optional data
! 297: * @opt_dlen = Optional data length
1.1 misho 298: * return: NULL error or !=NULL new queued task
299: */
1.5 ! misho 300: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
! 301: unsigned long val, void *opt_data, size_t opt_dlen);
1.1 misho 302: /*
303: * schedEventLo() - Add EVENT_Lo task to scheduler queue
304: * @root = root task
305: * @func = task execution function
306: * @arg = 1st func argument
1.2 misho 307: * @val = additional func argument
1.5 ! misho 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 *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
! 313: unsigned long val, void *opt_data, size_t opt_dlen);
1.1 misho 314: /*
315: * schedCallOnce() - Call once from scheduler
316: * @root = root task
317: * @func = task execution function
318: * @arg = 1st func argument
1.2 misho 319: * @val = additional func argument
1.5 ! misho 320: * @opt_data = Optional data
! 321: * @opt_dlen = Optional data length
1.2 misho 322: * return: return value from called func
1.1 misho 323: */
1.5 ! misho 324: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,
! 325: unsigned long val, void *opt_data, size_t opt_dlen);
1.1 misho 326:
327:
328: #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