File:  [ELWIX - Embedded LightWeight unIX -] / libaitsched / src / aitsched.c
Revision 1.4.2.1: download - view: text, annotated - select for diffs - revision graph
Sun Jan 8 02:01:41 2012 UTC (12 years, 8 months ago) by misho
Branches: sched1_3
Diff to: branchpoint 1.4: preferred, unified
add mutexes init/destroy

    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.4.2.1 2012/01/08 02:01:41 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: #ifdef HAVE_LIBPTHREAD
  126: 	register int i;
  127: #endif
  128: 
  129: 	root = malloc(sizeof(sched_root_task_t));
  130: 	if (!root) {
  131: 		LOGERR;
  132: 	} else {
  133: 		memset(root, 0, sizeof(sched_root_task_t));
  134: 
  135: #ifdef HAVE_LIBPTHREAD
  136: 		for (i = 0; i < taskMAX; i++)
  137: 			if (pthread_mutex_init(&root->root_mtx[i], NULL)) {
  138: 				LOGERR;
  139: 				while (i)
  140: 					pthread_mutex_destroy(&root->root_mtx[--i]);
  141: 				free(root);
  142: 				return NULL;
  143: 			}
  144: 
  145: 		for (i = 0; i < taskMAX; i++)
  146: 			ROOT_QLOCK(root, i);
  147: #endif
  148: 
  149: 		TAILQ_INIT(&root->root_read);
  150: 		TAILQ_INIT(&root->root_write);
  151: 		TAILQ_INIT(&root->root_timer);
  152: 		TAILQ_INIT(&root->root_event);
  153: 		TAILQ_INIT(&root->root_eventlo);
  154: 		TAILQ_INIT(&root->root_ready);
  155: 		TAILQ_INIT(&root->root_unuse);
  156: 
  157: #ifdef HAVE_LIBPTHREAD
  158: 		for (i = 0; i < taskMAX; i++)
  159: 			ROOT_QUNLOCK(root, i);
  160: #endif
  161: 
  162: 		if (data && *data) {
  163: 			if (datlen) {
  164: 				root->root_data.iov_base = *data;
  165: 				root->root_data.iov_len = datlen;
  166: 			} else { /* if datlen == 0, switch to callbacks init mode */
  167: 				 /* little hack :) for correct initialization of scheduler */
  168: 				func = (int(*)(sched_root_task_t*)) data;
  169: 				func(root);
  170: 			}
  171: 		}
  172: 
  173: 		if (root->root_hooks.hook_root.init)
  174: 			root->root_hooks.hook_root.init(root, NULL);
  175: 	}
  176: 
  177: 	return root;
  178: }
  179: 
  180: /*
  181:  * schedEnd() - End scheduler & free all resources
  182:  * @root = root task
  183:  * return: -1 error or 0 ok
  184:  */
  185: int
  186: schedEnd(sched_root_task_t ** __restrict root)
  187: {
  188: 	sched_task_t *task;
  189: #ifdef HAVE_LIBPTHREAD
  190: 	register int i;
  191: #endif
  192: 
  193: 	if (!root || !*root)
  194: 		return -1;
  195: 
  196: #ifdef HAVE_LIBPTHREAD
  197: 	for (i = 0; i < taskMAX; i++)
  198: 		ROOT_QLOCK(*root, i);
  199: #endif
  200: 	TAILQ_FOREACH(task, &(*root)->root_read, task_node) {
  201: 		schedCancel(task);
  202: 	}
  203: 	TAILQ_FOREACH(task, &(*root)->root_write, task_node) {
  204: 		schedCancel(task);
  205: 	}
  206: 	TAILQ_FOREACH(task, &(*root)->root_timer, task_node) {
  207: 		schedCancel(task);
  208: 	}
  209: 	TAILQ_FOREACH(task, &(*root)->root_event, task_node) {
  210: 		schedCancel(task);
  211: 	}
  212: 	TAILQ_FOREACH(task, &(*root)->root_ready, task_node) {
  213: 		schedCancel(task);
  214: 	}
  215: 
  216: 	while ((task = TAILQ_FIRST(&(*root)->root_unuse))) {
  217: 		TAILQ_REMOVE(&(*root)->root_unuse, task, task_node);
  218: 		free(task);
  219: 	}
  220: #ifdef HAVE_LIBPTHREAD
  221: 	for (i = 0; i < taskMAX; i++)
  222: 		ROOT_QUNLOCK(*root, i);
  223: #endif
  224: 
  225: 	if ((*root)->root_hooks.hook_root.fini)
  226: 		(*root)->root_hooks.hook_root.fini(*root, NULL);
  227: 
  228: #ifdef HAVE_LIBPTHREAD
  229: 	for (i = 0; i < taskMAX; i++)
  230: 		pthread_mutex_destroy(&(*root)->root_mtx[i]);
  231: #endif
  232: 
  233: 	free(*root);
  234: 	*root = NULL;
  235: 	return 0;
  236: }
  237: 
  238: /*
  239:  * schedCall() - Call task execution function
  240:  * @task = current task
  241:  * return: !=NULL error or =NULL ok
  242:  */
  243: inline void *
  244: schedCall(sched_task_t * __restrict task)
  245: {
  246: 	void *ptr = (void*) -1;
  247: 
  248: 	if (!task)
  249: 		return ptr;
  250: 
  251: 	if (!TASK_ISLOCKED(task))
  252: 		TASK_LOCK(task);
  253: 
  254: 	task->task_id++;
  255: 	ptr = task->task_func(task);
  256: 
  257: 	TASK_UNLOCK(task);
  258: 	return ptr;
  259: }
  260: 
  261: /*
  262:  * schedFetch() - Fetch ready task
  263:  * @root = root task
  264:  * return: =NULL error or !=NULL ready task
  265:  */
  266: inline void *
  267: schedFetch(sched_root_task_t * __restrict root)
  268: {
  269: 	void *ptr;
  270: 
  271: 	if (!root)
  272: 		return NULL;
  273: 
  274: 	if (root->root_hooks.hook_exec.fetch)
  275: 		ptr = root->root_hooks.hook_exec.fetch(root, NULL);
  276: 	else
  277: 		ptr = NULL;
  278: 
  279: 	return ptr;
  280: }
  281: 
  282: /*
  283:  * schedCancel() - Cancel task from scheduler
  284:  * @task = task
  285:  * return: -1 error or 0 ok
  286:  */
  287: int
  288: schedCancel(sched_task_t * __restrict task)
  289: {
  290: 	sched_queue_t *queue;
  291: 
  292: 	if (!task || !task->task_root)
  293: 		return -1;
  294: 
  295: 	if (task->task_root->root_hooks.hook_exec.cancel)
  296: 		if (task->task_root->root_hooks.hook_exec.cancel(task, NULL))
  297: 			return -1;
  298: 
  299: 	switch (task->task_type) {
  300: 		case taskREAD:
  301: 			queue = &task->task_root->root_read;
  302: 			break;
  303: 		case taskWRITE:
  304: 			queue = &task->task_root->root_write;
  305: 			break;
  306: 		case taskTIMER:
  307: 			queue = &task->task_root->root_timer;
  308: 			break;
  309: 		case taskEVENT:
  310: 			queue = &task->task_root->root_event;
  311: 			break;
  312: 		case taskREADY:
  313: 			queue = &task->task_root->root_ready;
  314: 			break;
  315: 		default:
  316: 			queue = NULL;
  317: 	}
  318: 	if (queue)
  319: 		TAILQ_REMOVE(queue, task, task_node);
  320: 	if (task->task_type != taskUNUSE)
  321: 		_sched_unuseTask(task);
  322: 
  323: 	return 0;
  324: }
  325: 
  326: /*
  327:  * schedCancelby() - Cancel task from scheduler by criteria
  328:  * @root = root task
  329:  * @queue = cancel from queue, if =NULL cancel same task from all queues
  330:  * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV]
  331:  * @param = search parameter
  332:  * @hook = custom cleanup hook function, may be NULL
  333:  * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
  334:  */
  335: int
  336: schedCancelby(sched_root_task_t * __restrict root, sched_queue_t * __restrict queue, 
  337: 		u_char criteria, void *param, sched_hook_func_t hook)
  338: {
  339: 	sched_task_t *task;
  340: 	int flg = 0;
  341: 
  342: 	if (!root)
  343: 		return -1;
  344: 	if (!queue) {
  345: 		if (schedCancelby(root, &root->root_read, criteria, param, hook))
  346: 			return -2;
  347: 		if (schedCancelby(root, &root->root_write, criteria, param, hook))
  348: 			return -2;
  349: 		if (schedCancelby(root, &root->root_timer, criteria, param, hook))
  350: 			return -2;
  351: 		if (schedCancelby(root, &root->root_event, criteria, param, hook))
  352: 			return -2;
  353: 		if (schedCancelby(root, &root->root_ready, criteria, param, hook))
  354: 			return -2;
  355: 		if (schedCancelby(root, &root->root_read, criteria, param, hook))
  356: 			return -2;
  357: 		return 0;
  358: 	}
  359: 
  360: 	TAILQ_FOREACH(task, queue, task_node)
  361: 		if (criteria == CRITERIA_CALL) {
  362: 			if (task->task_func == (sched_task_func_t) param) {
  363: 				flg++;
  364: 				break;
  365: 			}
  366: 		} else if (criteria == CRITERIA_ARG) {
  367: 			if (task->task_arg == param) {
  368: 				flg++;
  369: 				break;
  370: 			}
  371: 		} else if (criteria == CRITERIA_FD) {
  372: 			if (TASK_FD(task) == (intptr_t) param) {
  373: 				flg++;
  374: 				break;
  375: 			}
  376: 		} else if (criteria == CRITERIA_VAL) {
  377: 			if (TASK_VAL(task) == (u_long) param) {
  378: 				flg++;
  379: 				break;
  380: 			}
  381: 		} else if (criteria == CRITERIA_TV) {
  382: 			if (!timercmp(&TASK_TV(task), (struct timeval*) param, -)) {
  383: 				flg++;
  384: 				break;
  385: 			}
  386: 		} else {
  387: 			sched_SetErr(EINVAL, "Invalid parameter criteria %d", criteria);
  388: 			return -1;
  389: 		}
  390: 	if (!flg || !task)	/* task not found */
  391: 		return 0;
  392: 
  393: 	if (task->task_root->root_hooks.hook_exec.cancel)
  394: 		if (task->task_root->root_hooks.hook_exec.cancel(task, NULL))
  395: 			return -1;
  396: 	if (hook)
  397: 		if (hook(task, NULL))
  398: 			return -3;
  399: 
  400: 	TAILQ_REMOVE(queue, task, task_node);
  401: 
  402: 	if (task->task_type != taskUNUSE)
  403: 		_sched_unuseTask(task);
  404: 	return 0;
  405: }
  406: 
  407: /*
  408:  * schedRun() - Scheduler *run loop*
  409:  * @root = root task
  410:  * @killState = kill condition variable, if !=0 stop scheduler loop
  411:  * return: -1 error or 0 ok
  412:  */
  413: int
  414: schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState)
  415: {
  416: 	sched_task_t *task;
  417: 
  418: 	if (!root)
  419: 		return -1;
  420: 
  421: 	if (root->root_hooks.hook_exec.run)
  422: 		if (root->root_hooks.hook_exec.run(root, NULL))
  423: 			return -1;
  424: 	if (root->root_hooks.hook_exec.fetch) {
  425: 		if (killState)
  426: 			while (!*killState) {
  427: 				if ((task = root->root_hooks.hook_exec.fetch(root, NULL)))
  428: 					schedCall(task);
  429: 			}
  430: 		else
  431: 			while ((task = root->root_hooks.hook_exec.fetch(root, NULL)))
  432: 				schedCall(task);
  433: 	}
  434: 
  435: 	return 0;
  436: }

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