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

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