Annotation of libaitsched/inc/aitsched.h, revision 1.1.1.1.2.4
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.1.1.1.2.4! misho 6: * $Id: aitsched.h,v 1.1.1.1.2.3 2011/08/13 17:26:26 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.1.1.1.2.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;
99: } hook_exec;
100: struct {
101: /* init(sched_root_task_t *root, void *data) -> int */
102: sched_hook_func_t init;
103: /* fini(sched_root_task_t *root, NULL) -> int */
104: sched_hook_func_t fini;
105: } hook_root;
106: };
107: typedef struct sched_HooksTask hooks_task_t;
108:
109: /* task callback, like pthread callback! */
1.1.1.1.2.3 misho 110: typedef void *(*sched_task_func_t)(void * /*sched_task_t* - current task data*/);
1.1 misho 111:
112: /* task & queue */
113: struct sched_Task {
114: unsigned int task_id;
115: sched_task_type_t task_type;
116:
117: sched_root_task_t *task_root;
118: sched_task_func_t task_func;
119:
120: void *task_arg;
121: union {
122: unsigned long v;
123: int fd;
124: struct timeval tv;
125: } task_val;
126: #define TASK_ARG(x) (x)->task_arg
127: #define TASK_VAL(x) (x)->task_val.v
128: #define TASK_FD(x) (x)->task_val.fd
129: #define TASK_TV(x) (x)->task_val.tv
130:
131: struct iovec task_data;
132: #define TASK_DATA(x) (x)->task_data.iov_base
133: #define TASK_DATLEN(x) (x)->task_data.iov_len
134:
135: TAILQ_ENTRY(sched_Task) task_node;
136: };
137: typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
138:
139: /* root task */
140: struct sched_RootTask {
141: int root_kq;
142: struct timeval root_wait;
143:
144: sched_queue_t root_read;
145: sched_queue_t root_write;
146: sched_queue_t root_timer;
147: sched_queue_t root_event;
148: sched_queue_t root_ready;
149: sched_queue_t root_unuse;
150: sched_queue_t root_eventlo;
151: int root_eventlo_miss;
152:
153: hooks_task_t root_hooks;
154: struct iovec root_data;
155: #define ROOT_DATA(x) (x)->root_data.iov_base
156: #define ROOT_DATLEN(x) (x)->root_data.iov_len
157: };
158:
159:
1.1.1.1.2.2 misho 160: inline int sched_GetErrno();
161: inline const char *sched_GetError();
162: inline void sched_SetErr(int, char *, ...);
163:
164:
1.1 misho 165: /*
166: * schedInit() - Init scheduler
167: * @data = optional data if !=NULL
168: * @datlen = data len if data is set
169: * return: allocated root task if ok or NULL error
170: */
171: sched_root_task_t *schedInit(void ** __restrict data, size_t datlen);
1.1.1.1.2.2 misho 172: #define schedBegin() schedInit((void**) &schedRegisterHooks, 0)
1.1 misho 173: /*
174: * schedEnd() - End scheduler & free all resources
175: * @root = root task
176: * return: -1 error or 0 ok
177: */
1.1.1.1.2.4! misho 178: int schedEnd(sched_root_task_t ** __restrict root);
1.1 misho 179: /*
1.1.1.1.2.1 misho 180: * schedRegisterHooks() - Register IO handles and bind tasks to it
1.1 misho 181: * @root = root task
182: * return: -1 error or 0 ok
183: */
1.1.1.1.2.1 misho 184: int schedRegisterHooks(sched_root_task_t * __restrict root);
1.1 misho 185: /*
186: * schedCall() - Call task execution function
187: * @task = current task
188: * return: !=NULL error or =NULL ok
189: */
190: inline void *schedCall(sched_task_t * __restrict task);
191: /*
192: * schedFetch() - Fetch ready task
193: * @root = root task
194: * return: =NULL error or !=NULL ready task
195: */
196: inline void *schedFetch(sched_root_task_t * __restrict root);
197: /*
198: * schedRun() - Scheduler *run loop*
199: * @root = root task
200: * return: -1 error or 0 ok
201: */
202: int schedRun(sched_root_task_t * __restrict root);
203: /*
204: * schedCancel() - Cancel task from scheduler
205: * @task = task
206: * return: -1 error or 0 ok
207: */
208: int schedCancel(sched_task_t * __restrict task);
209: /*
210: * schedCancelby() - Cancel task from scheduler by criteria
211: * @root = root task
212: * @queue = cancel from queue, if =NULL cancel same task from all queues
213: * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV]
214: * @param = search parameter
215: * @hook = custom cleanup hook function, may be NULL
216: * return: -1 error or 0 ok
217: */
218: int schedCancelby(sched_root_task_t * __restrict root, sched_queue_t * __restrict queue,
219: u_char criteria, void *param, sched_hook_func_t hook);
220:
221:
222: /*
1.1.1.1.2.1 misho 223: * schedRead() - Add READ I/O task to scheduler queue
1.1 misho 224: * @root = root task
225: * @func = task execution function
226: * @arg = 1st func argument
1.1.1.1.2.1 misho 227: * @fd = fd handle
1.1 misho 228: * return: NULL error or !=NULL new queued task
229: */
1.1.1.1.2.1 misho 230: sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd);
1.1 misho 231: /*
1.1.1.1.2.1 misho 232: * schedWrite() - Add WRITE I/O task to scheduler queue
1.1 misho 233: * @root = root task
234: * @func = task execution function
235: * @arg = 1st func argument
1.1.1.1.2.1 misho 236: * @fd = fd handle
1.1 misho 237: * return: NULL error or !=NULL new queued task
238: */
1.1.1.1.2.1 misho 239: sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd);
1.1 misho 240: /*
241: * schedTimer() - Add TIMER task to scheduler queue
242: * @root = root task
243: * @func = task execution function
244: * @arg = 1st func argument
1.1.1.1.2.1 misho 245: * @ms = arguments in microSecs, define period 1sec == 1000000
1.1 misho 246: * return: NULL error or !=NULL new queued task
247: */
1.1.1.1.2.1 misho 248: sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned int ms);
1.1 misho 249: /*
250: * schedEvent() - Add EVENT task to scheduler queue
251: * @root = root task
252: * @func = task execution function
253: * @arg = 1st func argument
1.1.1.1.2.1 misho 254: * @val = additional func argument
1.1 misho 255: * return: NULL error or !=NULL new queued task
256: */
1.1.1.1.2.1 misho 257: sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);
1.1 misho 258: /*
259: * schedEventLo() - Add EVENT_Lo task to scheduler queue
260: * @root = root task
261: * @func = task execution function
262: * @arg = 1st func argument
1.1.1.1.2.1 misho 263: * @val = additional func argument
1.1 misho 264: * return: NULL error or !=NULL new queued task
265: */
1.1.1.1.2.1 misho 266: sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);
1.1 misho 267: /*
268: * schedCallOnce() - Call once from scheduler
269: * @root = root task
270: * @func = task execution function
271: * @arg = 1st func argument
1.1.1.1.2.1 misho 272: * @val = additional func argument
273: * return: return value from called func
1.1 misho 274: */
1.1.1.1.2.1 misho 275: sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);
1.1 misho 276:
277:
278: #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