Annotation of libaitsched/inc/aitsched.h, revision 1.2.2.1
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.2.2.1 ! misho 6: * $Id: aitsched.h,v 1.2 2011/10/04 12:34:33 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>
53:
54:
1.1 misho 55: /* criteria type */
56: #define CRITERIA_CALL 0
57: #define CRITERIA_ARG 1
58: #define CRITERIA_FD 2
59: #define CRITERIA_VAL 3
60: #define CRITERIA_TV 4
61:
62:
63: /* early declaration for root & task */
64: typedef struct sched_Task sched_task_t;
65: typedef struct sched_RootTask sched_root_task_t;
66:
67: typedef enum {
68: taskREAD = 0,
69: taskWRITE,
70: taskTIMER,
71: taskEVENT,
72: taskREADY,
73: taskUNUSE,
74: taskMAX
75: } sched_task_type_t;
76:
77: /* hooks */
78: typedef void *(*sched_hook_func_t)(void *, void *);
79: struct sched_HooksTask {
80: struct {
81: /* read(sched_task_t *task, NULL) -> int */
82: sched_hook_func_t read;
83: /* write(sched_task_t *task, NULL) -> int */
84: sched_hook_func_t write;
85: /* event(sched_task_t *task, NULL) -> int */
86: sched_hook_func_t event;
87: /* eventlo(sched_task_t *task, NULL) -> int */
88: sched_hook_func_t eventlo;
89: /* timer(sched_task_t *task, struct timeval *tv) -> int */
90: sched_hook_func_t timer;
91: } hook_add;
92: struct {
93: /* cancel(sched_task_t *task, NULL) -> int */
94: sched_hook_func_t cancel;
95: /* run(sched_root_task_t *root, NULL) -> int */
96: sched_hook_func_t run;
97: /* fetch(sched_root_task_t *root, NULL) -> sched_task_t* */
98: sched_hook_func_t fetch;
1.2.2.1 ! misho 99: /* exception(sched_root_task_t *root, NULL) -> int */
! 100: sched_hook_func_t exception;
1.1 misho 101: } hook_exec;
102: struct {
103: /* init(sched_root_task_t *root, void *data) -> int */
104: sched_hook_func_t init;
105: /* fini(sched_root_task_t *root, NULL) -> int */
106: sched_hook_func_t fini;
107: } hook_root;
108: };
109: typedef struct sched_HooksTask hooks_task_t;
110:
111: /* task callback, like pthread callback! */
1.2 misho 112: typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/);
1.1 misho 113:
114: /* task & queue */
115: struct sched_Task {
116: unsigned int task_id;
117: sched_task_type_t task_type;
118:
119: sched_root_task_t *task_root;
1.2 misho 120: #define TASK_ROOT(x) (x)->task_root
1.1 misho 121: sched_task_func_t task_func;
122:
123: void *task_arg;
124: union {
125: unsigned long v;
126: int fd;
127: struct timeval tv;
128: } task_val;
129: #define TASK_ARG(x) (x)->task_arg
130: #define TASK_VAL(x) (x)->task_val.v
131: #define TASK_FD(x) (x)->task_val.fd
132: #define TASK_TV(x) (x)->task_val.tv
133:
134: struct iovec task_data;
135: #define TASK_DATA(x) (x)->task_data.iov_base
136: #define TASK_DATLEN(x) (x)->task_data.iov_len
137:
138: TAILQ_ENTRY(sched_Task) task_node;
139: };
140: typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
141:
142: /* root task */
143: struct sched_RootTask {
144: int root_kq;
145: struct timeval root_wait;
146:
147: sched_queue_t root_read;
148: sched_queue_t root_write;
149: sched_queue_t root_timer;
150: sched_queue_t root_event;
151: sched_queue_t root_ready;
152: sched_queue_t root_unuse;
153: sched_queue_t root_eventlo;
154: int root_eventlo_miss;
155:
156: hooks_task_t root_hooks;
157: struct iovec root_data;
158: #define ROOT_DATA(x) (x)->root_data.iov_base
159: #define ROOT_DATLEN(x) (x)->root_data.iov_len
160: };
161:
162:
1.2 misho 163: inline int sched_GetErrno();
164: inline const char *sched_GetError();
165: inline void sched_SetErr(int, char *, ...);
166:
167:
1.1 misho 168: /*
169: * schedInit() - Init scheduler
170: * @data = optional data if !=NULL
171: * @datlen = data len if data is set
172: * return: allocated root task if ok or NULL error
173: */
174: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.2 misho 175: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 176: /*
177: * schedEnd() - End scheduler & free all resources
178: * @root = root task
179: * return: -1 error or 0 ok
180: */
1.2 misho 181: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 182: /*
1.2 misho 183: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.1 misho 184: * @root = root task
185: * return: -1 error or 0 ok
186: */
1.2 misho 187: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 188: /*
189: * schedCall() - Call task execution function
190: * @task = current task
191: * return: !=NULL error or =NULL ok
192: */
193: inline void *schedCall(sched_task_t * __restrict task);
194: /*
195: * schedFetch() - Fetch ready task
196: * @root = root task
197: * return: =NULL error or !=NULL ready task
198: */
199: inline void *schedFetch(sched_root_task_t * __restrict root);
200: /*
201: * schedRun() - Scheduler *run loop*
202: * @root = root task
1.2 misho 203: * @killState = kill condition variable, if !=0 stop scheduler loop
1.1 misho 204: * return: -1 error or 0 ok
205: */
1.2 misho 206: int schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState);
1.1 misho 207: /*
208: * schedCancel() - Cancel task from scheduler
209: * @task = task
210: * return: -1 error or 0 ok
211: */
212: int schedCancel(sched_task_t * __restrict task);
213: /*
214: * schedCancelby() - Cancel task from scheduler by criteria
215: * @root = root task
216: * @queue = cancel from queue, if =NULL cancel same task from all queues
217: * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV]
218: * @param = search parameter
219: * @hook = custom cleanup hook function, may be NULL
220: * return: -1 error or 0 ok
221: */
222: int schedCancelby(sched_root_task_t * __restrict root, sched_queue_t * __restrict queue,
223: u_char criteria, void *param, sched_hook_func_t hook);
224:
225:
226: /*
1.2 misho 227: * schedRead() - Add READ I/O task to scheduler queue
1.1 misho 228: * @root = root task
229: * @func = task execution function
230: * @arg = 1st func argument
1.2 misho 231: * @fd = fd handle
1.1 misho 232: * return: NULL error or !=NULL new queued task
233: */
1.2 misho 234: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd);
1.1 misho 235: /*
1.2 misho 236: * schedWrite() - Add WRITE I/O task to scheduler queue
1.1 misho 237: * @root = root task
238: * @func = task execution function
239: * @arg = 1st func argument
1.2 misho 240: * @fd = fd handle
1.1 misho 241: * return: NULL error or !=NULL new queued task
242: */
1.2 misho 243: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd);
1.1 misho 244: /*
245: * schedTimer() - Add TIMER task to scheduler queue
246: * @root = root task
247: * @func = task execution function
248: * @arg = 1st func argument
1.2 misho 249: * @ms = arguments in microSecs, define period 1sec == 1000000
1.1 misho 250: * return: NULL error or !=NULL new queued task
251: */
1.2 misho 252: sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned int ms);
1.1 misho 253: /*
254: * schedEvent() - Add EVENT task to scheduler queue
255: * @root = root task
256: * @func = task execution function
257: * @arg = 1st func argument
1.2 misho 258: * @val = additional func argument
1.1 misho 259: * return: NULL error or !=NULL new queued task
260: */
1.2 misho 261: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);
1.1 misho 262: /*
263: * schedEventLo() - Add EVENT_Lo task to scheduler queue
264: * @root = root task
265: * @func = task execution function
266: * @arg = 1st func argument
1.2 misho 267: * @val = additional func argument
1.1 misho 268: * return: NULL error or !=NULL new queued task
269: */
1.2 misho 270: sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);
1.1 misho 271: /*
272: * schedCallOnce() - Call once from scheduler
273: * @root = root task
274: * @func = task execution function
275: * @arg = 1st func argument
1.2 misho 276: * @val = additional func argument
277: * return: return value from called func
1.1 misho 278: */
1.2 misho 279: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);
1.1 misho 280:
281:
282: #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