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