File:  [ELWIX - Embedded LightWeight unIX -] / libaitsched / src / aitsched.c
Revision 1.2.2.1: download - view: text, annotated - select for diffs - revision graph
Tue Oct 4 13:29:00 2011 UTC (13 years, 1 month ago) by misho
Branches: sched1_1
Diff to: branchpoint 1.2: preferred, unified
added exception default hook

    1: /*************************************************************************
    2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
    3: *  by Michael Pounov <misho@openbsd-bg.org>
    4: *
    5: * $Author: misho $
    6: * $Id: aitsched.c,v 1.2.2.1 2011/10/04 13:29:00 misho Exp $
    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: #include "global.h"
   47: #include "hooks.h"
   48: 
   49: 
   50: #pragma GCC visibility push(hidden)
   51: 
   52: int sched_Errno;
   53: char sched_Error[STRSIZ];
   54: 
   55: #pragma GCC visibility pop
   56: 
   57: 
   58: // sched_GetErrno() Get error code of last operation
   59: inline int
   60: sched_GetErrno()
   61: {
   62: 	return sched_Errno;
   63: }
   64: 
   65: // sched_GetError() Get error text of last operation
   66: inline const char *
   67: sched_GetError()
   68: {
   69: 	return sched_Error;
   70: }
   71: 
   72: // sched_SetErr() Set error to variables for internal use!!!
   73: inline void
   74: sched_SetErr(int eno, char *estr, ...)
   75: {
   76: 	va_list lst;
   77: 
   78: 	sched_Errno = eno;
   79: 	memset(sched_Error, 0, sizeof sched_Error);
   80: 	va_start(lst, estr);
   81: 	vsnprintf(sched_Error, sizeof sched_Error, estr, lst);
   82: 	va_end(lst);
   83: }
   84: 
   85: /* Init and prepare scheduler functions */
   86: 
   87: /*
   88:  * schedRegisterHooks() - Register IO handles and bind tasks to it
   89:  * @root = root task
   90:  * return: -1 error or 0 ok
   91:  */
   92: int
   93: schedRegisterHooks(sched_root_task_t * __restrict root)
   94: {
   95: 	if (!root || (root->root_data.iov_base && root->root_data.iov_len))
   96: 		return -1;
   97: 
   98: 	if (root->root_hooks.hook_root.fini)
   99: 		root->root_hooks.hook_root.fini(root, NULL);
  100: 	memset(&root->root_hooks, 0, sizeof root->root_hooks);
  101: 
  102: 	root->root_hooks.hook_add.read = sched_hook_read;
  103: 	root->root_hooks.hook_add.write = sched_hook_write;
  104: 
  105: 	root->root_hooks.hook_exec.cancel = sched_hook_cancel;
  106: 	root->root_hooks.hook_exec.fetch = sched_hook_fetch;
  107: 	root->root_hooks.hook_exec.exception = sched_hook_exception;
  108: 
  109: 	root->root_hooks.hook_root.init = sched_hook_init;
  110: 	root->root_hooks.hook_root.fini = sched_hook_fini;
  111: 	return 0;
  112: }
  113: 
  114: /*
  115:  * schedInit() - Init scheduler
  116:  * @data = optional data if !=NULL
  117:  * @datlen = data len if data is set
  118:  * return: allocated root task if ok or NULL error
  119:  */
  120: sched_root_task_t *
  121: schedInit(void ** __restrict data, size_t datlen)
  122: {
  123: 	sched_root_task_t *root = NULL;
  124: 	int (*func)(sched_root_task_t *);
  125: 
  126: 	root = malloc(sizeof(sched_root_task_t));
  127: 	if (!root) {
  128: 		LOGERR;
  129: 	} else {
  130: 		memset(root, 0, sizeof(sched_root_task_t));
  131: 		TAILQ_INIT(&root->root_read);
  132: 		TAILQ_INIT(&root->root_write);
  133: 		TAILQ_INIT(&root->root_timer);
  134: 		TAILQ_INIT(&root->root_event);
  135: 		TAILQ_INIT(&root->root_eventlo);
  136: 		TAILQ_INIT(&root->root_ready);
  137: 		TAILQ_INIT(&root->root_unuse);
  138: 
  139: 		if (data && *data) {
  140: 			if (datlen) {
  141: 				root->root_data.iov_base = *data;
  142: 				root->root_data.iov_len = datlen;
  143: 			} else {
  144: 				func = (int(*)(sched_root_task_t*)) data;
  145: 				func(root);
  146: 			}
  147: 		}
  148: 
  149: 		if (root->root_hooks.hook_root.init)
  150: 			root->root_hooks.hook_root.init(root, NULL);
  151: 	}
  152: 
  153: 	return root;
  154: }
  155: 
  156: /*
  157:  * schedEnd() - End scheduler & free all resources
  158:  * @root = root task
  159:  * return: -1 error or 0 ok
  160:  */
  161: int
  162: schedEnd(sched_root_task_t ** __restrict root)
  163: {
  164: 	sched_task_t *task;
  165: 
  166: 	if (!root || !*root)
  167: 		return -1;
  168: 
  169: 	TAILQ_FOREACH(task, &(*root)->root_read, task_node) {
  170: 		schedCancel(task);
  171: 	}
  172: 	TAILQ_FOREACH(task, &(*root)->root_write, task_node) {
  173: 		schedCancel(task);
  174: 	}
  175: 	TAILQ_FOREACH(task, &(*root)->root_timer, task_node) {
  176: 		schedCancel(task);
  177: 	}
  178: 	TAILQ_FOREACH(task, &(*root)->root_event, task_node) {
  179: 		schedCancel(task);
  180: 	}
  181: 	TAILQ_FOREACH(task, &(*root)->root_ready, task_node) {
  182: 		schedCancel(task);
  183: 	}
  184: 
  185: 	while ((task = TAILQ_FIRST(&(*root)->root_unuse))) {
  186: 		TAILQ_REMOVE(&(*root)->root_unuse, task, task_node);
  187: 		free(task);
  188: 	}
  189: 
  190: 	if ((*root)->root_hooks.hook_root.fini)
  191: 		(*root)->root_hooks.hook_root.fini(*root, NULL);
  192: 
  193: 	free(*root);
  194: 	*root = NULL;
  195: 	return 0;
  196: }
  197: 
  198: /*
  199:  * schedCall() - Call task execution function
  200:  * @task = current task
  201:  * return: !=NULL error or =NULL ok
  202:  */
  203: inline void *
  204: schedCall(sched_task_t * __restrict task)
  205: {
  206: 	if (!task)
  207: 		return (void*) -1;
  208: 
  209: 	task->task_id++;
  210: 	return task->task_func(task);
  211: }
  212: 
  213: /*
  214:  * schedFetch() - Fetch ready task
  215:  * @root = root task
  216:  * return: =NULL error or !=NULL ready task
  217:  */
  218: inline void *
  219: schedFetch(sched_root_task_t * __restrict root)
  220: {
  221: 	void *ptr;
  222: 
  223: 	if (!root)
  224: 		return NULL;
  225: 
  226: 	if (root->root_hooks.hook_exec.fetch)
  227: 		ptr = root->root_hooks.hook_exec.fetch(root, NULL);
  228: 	else
  229: 		ptr = NULL;
  230: 
  231: 	return ptr;
  232: }
  233: 
  234: /*
  235:  * schedCancel() - Cancel task from scheduler
  236:  * @task = task
  237:  * return: -1 error or 0 ok
  238:  */
  239: int
  240: schedCancel(sched_task_t * __restrict task)
  241: {
  242: 	sched_queue_t *queue;
  243: 
  244: 	if (!task || !task->task_root)
  245: 		return -1;
  246: 
  247: 	if (task->task_root->root_hooks.hook_exec.cancel)
  248: 		if (task->task_root->root_hooks.hook_exec.cancel(task, NULL))
  249: 			return -1;
  250: 
  251: 	switch (task->task_type) {
  252: 		case taskREAD:
  253: 			queue = &task->task_root->root_read;
  254: 			break;
  255: 		case taskWRITE:
  256: 			queue = &task->task_root->root_write;
  257: 			break;
  258: 		case taskTIMER:
  259: 			queue = &task->task_root->root_timer;
  260: 			break;
  261: 		case taskEVENT:
  262: 			queue = &task->task_root->root_event;
  263: 			break;
  264: 		case taskREADY:
  265: 			queue = &task->task_root->root_ready;
  266: 			break;
  267: 		default:
  268: 			queue = NULL;
  269: 	}
  270: 	if (queue)
  271: 		TAILQ_REMOVE(queue, task, task_node);
  272: 	if (task->task_type != taskUNUSE) {
  273: 		task->task_type = taskUNUSE;
  274: 		TAILQ_INSERT_TAIL(&task->task_root->root_unuse, task, task_node);
  275: 	}
  276: 
  277: 	return 0;
  278: }
  279: 
  280: /*
  281:  * schedCancelby() - Cancel task from scheduler by criteria
  282:  * @root = root task
  283:  * @queue = cancel from queue, if =NULL cancel same task from all queues
  284:  * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV]
  285:  * @param = search parameter
  286:  * @hook = custom cleanup hook function, may be NULL
  287:  * return: -1 error or 0 ok
  288:  */
  289: int
  290: schedCancelby(sched_root_task_t * __restrict root, sched_queue_t * __restrict queue, 
  291: 		u_char criteria, void *param, sched_hook_func_t hook)
  292: {
  293: 	sched_task_t *task;
  294: 	int flg = 0;
  295: 
  296: 	if (!root)
  297: 		return -1;
  298: 	if (!queue) {
  299: 		if (schedCancelby(root, &root->root_read, criteria, param, hook))
  300: 			return -2;
  301: 		if (schedCancelby(root, &root->root_write, criteria, param, hook))
  302: 			return -2;
  303: 		if (schedCancelby(root, &root->root_timer, criteria, param, hook))
  304: 			return -2;
  305: 		if (schedCancelby(root, &root->root_event, criteria, param, hook))
  306: 			return -2;
  307: 		if (schedCancelby(root, &root->root_ready, criteria, param, hook))
  308: 			return -2;
  309: 		if (schedCancelby(root, &root->root_read, criteria, param, hook))
  310: 			return -2;
  311: 		return 0;
  312: 	}
  313: 
  314: 	TAILQ_FOREACH(task, queue, task_node)
  315: 		if (criteria == CRITERIA_CALL) {
  316: 			if (task->task_func == (sched_task_func_t) param) {
  317: 				flg++;
  318: 				break;
  319: 			}
  320: 		} else if (criteria == CRITERIA_ARG) {
  321: 			if (task->task_arg == param) {
  322: 				flg++;
  323: 				break;
  324: 			}
  325: 		} else if (criteria == CRITERIA_FD) {
  326: 			if (TASK_FD(task) == (int) param) {
  327: 				flg++;
  328: 				break;
  329: 			}
  330: 		} else if (criteria == CRITERIA_VAL) {
  331: 			if (TASK_VAL(task) == (u_long) param) {
  332: 				flg++;
  333: 				break;
  334: 			}
  335: 		} else if (criteria == CRITERIA_TV) {
  336: 			if (&TASK_TV(task) == (struct timeval*) param) {
  337: 				flg++;
  338: 				break;
  339: 			}
  340: 		} else {
  341: 			sched_SetErr(EINVAL, "Invalid parameter criteria %d", criteria);
  342: 			return -1;
  343: 		}
  344: 	if (!flg || !task)	/* task not found */
  345: 		return 0;
  346: 
  347: 	if (task->task_root->root_hooks.hook_exec.cancel)
  348: 		if (task->task_root->root_hooks.hook_exec.cancel(task, NULL))
  349: 			return -1;
  350: 	if (hook)
  351: 		if (hook(task, NULL))
  352: 			return -3;
  353: 
  354: 	TAILQ_REMOVE(queue, task, task_node);
  355: 
  356: 	if (task->task_type != taskUNUSE) {
  357: 		task->task_type = taskUNUSE;
  358: 		TAILQ_INSERT_TAIL(&task->task_root->root_unuse, task, task_node);
  359: 	}
  360: 	return 0;
  361: }
  362: 
  363: /*
  364:  * schedRun() - Scheduler *run loop*
  365:  * @root = root task
  366:  * @killState = kill condition variable, if !=0 stop scheduler loop
  367:  * return: -1 error or 0 ok
  368:  */
  369: int
  370: schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState)
  371: {
  372: 	sched_task_t *task;
  373: 
  374: 	if (!root)
  375: 		return -1;
  376: 
  377: 	if (root->root_hooks.hook_exec.run)
  378: 		if (root->root_hooks.hook_exec.run(root, NULL))
  379: 			return -1;
  380: 	if (root->root_hooks.hook_exec.fetch) {
  381: 		if (killState)
  382: 			while (!*killState && (task = root->root_hooks.hook_exec.fetch(root, NULL)))
  383: 				schedCall(task);
  384: 		else
  385: 			while ((task = root->root_hooks.hook_exec.fetch(root, NULL)))
  386: 				schedCall(task);
  387: 	}
  388: 
  389: 	return 0;
  390: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>