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