Annotation of libaitsched/src/hooks.c, revision 1.2.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.2.2.4 ! misho       6: * $Id: hooks.c,v 1.2.2.3 2011/10/04 14:04:35 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: /*
                     51:  * sched_hook_init() - Default INIT hook
                     52:  * @root = root task
                     53:  * @data = optional data if !=NULL
                     54:  * return: <0 errors and 0 ok
                     55:  */
                     56: void *
                     57: sched_hook_init(void *root, void *data)
                     58: {
                     59:        sched_root_task_t *r = root;
                     60: 
                     61:        if (!r || r->root_data.iov_base || r->root_data.iov_len)
                     62:                return (void*) -1;
                     63: 
                     64:        r->root_data.iov_base = malloc(sizeof(struct sched_IO));
                     65:        if (!r->root_data.iov_base) {
                     66:                LOGERR;
                     67:                return (void*) -1;
                     68:        } else {
                     69:                r->root_data.iov_len = sizeof(struct sched_IO);
                     70:                memset(r->root_data.iov_base, 0, r->root_data.iov_len);
                     71:        }
                     72: 
                     73:        r->root_kq = kqueue();
                     74:        if (r->root_kq == -1) {
                     75:                LOGERR;
                     76:                return (void*) -1;
                     77:        }
                     78: 
                     79:        return NULL;
                     80: }
                     81: 
                     82: /*
                     83:  * sched_hook_fini() - Default FINI hook
                     84:  * @root = root task
                     85:  * @arg = unused
                     86:  * return: <0 errors and 0 ok
                     87:  */
                     88: void *
                     89: sched_hook_fini(void *root, void *arg __unused)
                     90: {
                     91:        sched_root_task_t *r = root;
                     92: 
                     93:        if (!r)
                     94:                return (void*) -1;
                     95: 
                     96:        if (r->root_kq > 2) {
                     97:                close(r->root_kq);
                     98:                r->root_kq = 0;
                     99:        }
                    100: 
                    101:        if (r->root_data.iov_base && r->root_data.iov_len) {
                    102:                free(r->root_data.iov_base);
                    103:                r->root_data.iov_base = NULL;
                    104:                r->root_data.iov_len = 0;
                    105:        }
                    106: 
                    107:        return NULL;
                    108: }
                    109: 
                    110: /*
                    111:  * sched_hook_cancel() - Default CANCEL hook
                    112:  * @task = current task
                    113:  * @arg = unused
                    114:  * return: <0 errors and 0 ok
                    115:  */
                    116: void *
                    117: sched_hook_cancel(void *task, void *arg __unused)
                    118: {
                    119:        struct sched_IO *io;
                    120:        sched_task_t *t = task;
                    121:        struct kevent chg[1];
1.2       misho     122:        struct timespec timeout = { 0, 0 };
1.1       misho     123: 
                    124:        if (!t || !t->task_root || !ROOT_DATA(t->task_root) || !ROOT_DATLEN(t->task_root))
                    125:                return (void*) -1;
                    126:        else
                    127:                io = ROOT_DATA(t->task_root);
                    128: 
                    129:        switch (t->task_type) {
                    130:                case taskREAD:
1.2       misho     131: #ifdef __NetBSD__
                    132:                        EV_SET(&chg[0], TASK_FD(t), EVFILT_READ, EV_DELETE, 0, 0, (intptr_t) TASK_FD(t));
                    133: #else
                    134:                        EV_SET(&chg[0], TASK_FD(t), EVFILT_READ, EV_DELETE, 0, 0, (void*) TASK_FD(t));
                    135: #endif
1.1       misho     136:                        kevent(t->task_root->root_kq, chg, 1, NULL, 0, &timeout);
                    137:                        FD_CLR(TASK_FD(t), &io->rfd);
                    138:                        break;
                    139:                case taskWRITE:
1.2       misho     140: #ifdef __NetBSD__
                    141:                        EV_SET(&chg[0], TASK_FD(t), EVFILT_WRITE, EV_DELETE, 0, 0, (intptr_t) TASK_FD(t));
                    142: #else
                    143:                        EV_SET(&chg[0], TASK_FD(t), EVFILT_WRITE, EV_DELETE, 0, 0, (void*) TASK_FD(t));
                    144: #endif
1.1       misho     145:                        kevent(t->task_root->root_kq, chg, 1, NULL, 0, &timeout);
                    146:                        FD_CLR(TASK_FD(t), &io->wfd);
                    147:                        break;
                    148:                default:
                    149:                        break;
                    150:        }
                    151: 
                    152:        return NULL;
                    153: }
                    154: 
                    155: /*
                    156:  * sched_hook_read() - Default READ hook
                    157:  * @task = current task
                    158:  * @arg = unused
                    159:  * return: <0 errors and 0 ok
                    160:  */
                    161: void *
                    162: sched_hook_read(void *task, void *arg __unused)
                    163: {
                    164:        struct sched_IO *io;
                    165:        sched_task_t *t = task;
                    166:        struct kevent chg[1];
1.2       misho     167:        struct timespec timeout = { 0, 0 };
1.1       misho     168: 
                    169:        if (!t || !t->task_root || !ROOT_DATA(t->task_root) || !ROOT_DATLEN(t->task_root))
                    170:                return (void*) -1;
                    171:        else
                    172:                io = ROOT_DATA(t->task_root);
                    173: 
                    174:        if (FD_ISSET(TASK_FD(t), &io->rfd))
                    175:                return NULL;
                    176:        else
                    177:                FD_SET(TASK_FD(t), &io->rfd);
                    178: 
1.2       misho     179: #ifdef __NetBSD__
                    180:        EV_SET(&chg[0], TASK_FD(t), EVFILT_READ, EV_ADD, 0, 0, (intptr_t) TASK_FD(t));
                    181: #else
                    182:        EV_SET(&chg[0], TASK_FD(t), EVFILT_READ, EV_ADD, 0, 0, (void*) TASK_FD(t));
                    183: #endif
1.1       misho     184:        if (kevent(t->task_root->root_kq, chg, 1, NULL, 0, &timeout) == -1) {
1.2.2.1   misho     185:                if (t->task_root->root_hooks.hook_exec.exception)
                    186:                        t->task_root->root_hooks.hook_exec.exception(t->task_root, NULL);
1.2.2.2   misho     187:                else
                    188:                        LOGERR;
1.1       misho     189:                return (void*) -1;
                    190:        }
                    191: 
                    192:        return NULL;
                    193: }
                    194: 
                    195: /*
                    196:  * sched_hook_write() - Default WRITE hook
                    197:  * @task = current task
                    198:  * @arg = unused
                    199:  * return: <0 errors and 0 ok
                    200:  */
                    201: void *
                    202: sched_hook_write(void *task, void *arg __unused)
                    203: {
                    204:        struct sched_IO *io;
                    205:        sched_task_t *t = task;
                    206:        struct kevent chg[1];
1.2       misho     207:        struct timespec timeout = { 0, 0 };
1.1       misho     208: 
                    209:        if (!t || !t->task_root || !ROOT_DATA(t->task_root) || !ROOT_DATLEN(t->task_root))
                    210:                return (void*) -1;
                    211:        else
                    212:                io = ROOT_DATA(t->task_root);
                    213: 
                    214:        if (FD_ISSET(TASK_FD(t), &io->wfd))
                    215:                return NULL;
                    216:        else
                    217:                FD_SET(TASK_FD(t), &io->wfd);
                    218: 
1.2       misho     219: #ifdef __NetBSD__
                    220:        EV_SET(&chg[0], TASK_FD(t), EVFILT_WRITE, EV_ADD, 0, 0, (intptr_t) TASK_FD(t));
                    221: #else
                    222:        EV_SET(&chg[0], TASK_FD(t), EVFILT_WRITE, EV_ADD, 0, 0, (void*) TASK_FD(t));
                    223: #endif
1.1       misho     224:        if (kevent(t->task_root->root_kq, chg, 1, NULL, 0, &timeout) == -1) {
1.2.2.1   misho     225:                if (t->task_root->root_hooks.hook_exec.exception)
                    226:                        t->task_root->root_hooks.hook_exec.exception(t->task_root, NULL);
1.2.2.2   misho     227:                else
                    228:                        LOGERR;
1.1       misho     229:                return (void*) -1;
                    230:        }
                    231: 
                    232:        return NULL;
                    233: }
                    234: 
                    235: /*
                    236:  * sched_hook_fetch() - Default FETCH hook
                    237:  * @root = root task
                    238:  * @arg = unused
                    239:  * return: NULL error or !=NULL fetched task
                    240:  */
                    241: void *
                    242: sched_hook_fetch(void *root, void *arg __unused)
                    243: {
                    244:        struct sched_IO *io;
                    245:        sched_root_task_t *r = root;
                    246:        sched_task_t *task;
                    247:        struct timeval now, m, mtmp;
                    248:        struct timespec nw, *timeout;
                    249:        struct kevent evt[1], res[KQ_EVENTS];
                    250:        register int i;
                    251:        int en;
                    252: 
                    253:        if (!r || !ROOT_DATA(r) || !ROOT_DATLEN(r))
                    254:                return NULL;
                    255: 
                    256:        /* get new task by queue priority */
                    257: retry:
                    258:        while ((task = TAILQ_FIRST(&r->root_event))) {
                    259:                TAILQ_REMOVE(&r->root_event, task, task_node);
                    260:                task->task_type = taskUNUSE;
                    261:                TAILQ_INSERT_TAIL(&r->root_unuse, task, task_node);
                    262:                return task;
                    263:        }
                    264:        while ((task = TAILQ_FIRST(&r->root_ready))) {
                    265:                TAILQ_REMOVE(&r->root_ready, task, task_node);
                    266:                task->task_type = taskUNUSE;
                    267:                TAILQ_INSERT_TAIL(&r->root_unuse, task, task_node);
                    268:                return task;
                    269:        }
                    270: 
                    271: #ifdef TIMER_WITHOUT_SORT
                    272:        clock_gettime(CLOCK_MONOTONIC, &nw);
                    273:        now.tv_sec = nw.tv_sec;
                    274:        now.tv_usec = nw.tv_nsec / 1000;
                    275: 
                    276:        timerclear(&r->root_wait);
                    277:        TAILQ_FOREACH(task, &r->root_timer, task_node) {
                    278:                if (!timerisset(&r->root_wait))
                    279:                        r->root_wait = TASK_TV(task);
                    280:                else if (timercmp(&TASK_TV(task), &r->root_wait, -) < 0)
                    281:                        r->root_wait = TASK_TV(task);
                    282:        }
                    283: 
                    284:        if (TAILQ_FIRST(&r->root_timer)) {
                    285:                m = r->root_wait;
                    286:                timersub(&m, &now, &mtmp);
                    287:                r->root_wait = mtmp;
                    288:        } else {
                    289:                /* set wait INFTIM */
                    290:                r->root_wait.tv_sec = r->root_wait.tv_usec = -1;
                    291:        }
                    292: #else
                    293:        if (!TAILQ_FIRST(&r->root_eventlo) && (task = TAILQ_FIRST(&r->root_timer))) {
                    294:                clock_gettime(CLOCK_MONOTONIC, &nw);
                    295:                now.tv_sec = nw.tv_sec;
                    296:                now.tv_usec = nw.tv_nsec / 1000;
                    297: 
                    298:                m = TASK_TV(task);
                    299:                timersub(&m, &now, &mtmp);
                    300:                r->root_wait = mtmp;
                    301:        } else {
                    302:                /* set wait INFTIM */
                    303:                r->root_wait.tv_sec = r->root_wait.tv_usec = -1;
                    304:        }
                    305: #endif
                    306:        /* if present member of eventLo, set NOWAIT */
                    307:        if (TAILQ_FIRST(&r->root_eventlo))
                    308:                timerclear(&r->root_wait);
                    309: 
                    310:        if (r->root_wait.tv_sec != -1 && r->root_wait.tv_usec != -1) {
                    311:                nw.tv_sec = r->root_wait.tv_sec;
                    312:                nw.tv_nsec = r->root_wait.tv_usec * 1000;
                    313:                timeout = &nw;
                    314:        } else  /* wait INFTIM */
                    315:                timeout = NULL;
                    316:        if ((en = kevent(r->root_kq, NULL, 0, res, KQ_EVENTS, timeout)) == -1) {
1.2.2.2   misho     317:                if (r->root_hooks.hook_exec.exception) {
1.2.2.1   misho     318:                        if (r->root_hooks.hook_exec.exception(r, NULL))
1.2.2.3   misho     319:                                return NULL;
1.2.2.2   misho     320:                } else
                    321:                        LOGERR;
1.2       misho     322: #ifdef NDEBUG
                    323:                /* kevent no exit by error, if non-debug version */
1.1       misho     324:                goto retry;
1.2       misho     325: #else
                    326:                /* diagnostic exit from scheduler if kevent error occur */
                    327:                return NULL;
                    328: #endif
1.1       misho     329:        }
                    330: 
1.2       misho     331:        nw.tv_sec = nw.tv_nsec = 0;
1.1       misho     332:        /* Go and catch the cat into pipes ... */
                    333:        for (i = 0; i < en; i++) {
                    334:                memcpy(evt, &res[i], sizeof evt);
                    335:                evt->flags = EV_DELETE;
                    336:                /* Put read/write task to ready queue */
                    337:                switch (res[i].filter) {
                    338:                        case EVFILT_READ:
                    339:                                TAILQ_FOREACH(task, &r->root_read, task_node) {
1.2.2.4 ! misho     340:                                        if (TASK_FD(task) != ((intptr_t) res[i].udata))
1.1       misho     341:                                                continue;
                    342:                                        /* remove read handle */
                    343:                                        io = ROOT_DATA(task->task_root);
                    344:                                        FD_CLR(TASK_FD(task), &io->rfd);
                    345: 
                    346:                                        TAILQ_REMOVE(&r->root_read, task, task_node);
1.2.2.1   misho     347:                                        if (r->root_hooks.hook_exec.exception && res[i].flags & EV_EOF) {
                    348:                                                if (r->root_hooks.hook_exec.exception(r, (void*) EV_EOF)) {
                    349:                                                        task->task_type = taskUNUSE;
                    350:                                                        TAILQ_INSERT_TAIL(&r->root_unuse, task, task_node);
                    351:                                                } else {
                    352:                                                        task->task_type = taskREADY;
                    353:                                                        TAILQ_INSERT_TAIL(&r->root_ready, task, task_node);
                    354:                                                }
                    355:                                        } else {
1.2       misho     356:                                                task->task_type = taskREADY;
                    357:                                                TAILQ_INSERT_TAIL(&r->root_ready, task, task_node);
1.2.2.1   misho     358:                                        }
1.1       misho     359:                                        break;
                    360:                                }
                    361:                                break;
                    362:                        case EVFILT_WRITE:
                    363:                                TAILQ_FOREACH(task, &r->root_write, task_node) {
1.2.2.4 ! misho     364:                                        if (TASK_FD(task) != ((intptr_t) res[i].udata))
1.1       misho     365:                                                continue;
                    366:                                        /* remove write handle */
                    367:                                        io = ROOT_DATA(task->task_root);
                    368:                                        FD_CLR(TASK_FD(task), &io->wfd);
                    369: 
                    370:                                        TAILQ_REMOVE(&r->root_write, task, task_node);
1.2.2.1   misho     371:                                        if (r->root_hooks.hook_exec.exception && res[i].flags & EV_EOF) {
                    372:                                                if (r->root_hooks.hook_exec.exception(r, (void*) EV_EOF)) {
                    373:                                                        task->task_type = taskUNUSE;
                    374:                                                        TAILQ_INSERT_TAIL(&r->root_unuse, task, task_node);
                    375:                                                } else {
                    376:                                                        task->task_type = taskREADY;
                    377:                                                        TAILQ_INSERT_TAIL(&r->root_ready, task, task_node);
                    378:                                                }
                    379:                                        } else {
1.2       misho     380:                                                task->task_type = taskREADY;
                    381:                                                TAILQ_INSERT_TAIL(&r->root_ready, task, task_node);
1.2.2.1   misho     382:                                        }
1.1       misho     383:                                        break;
                    384:                                }
                    385:                                break;
                    386:                }
1.2.2.2   misho     387:                if (kevent(r->root_kq, evt, 1, NULL, 0, &nw) == -1) {
                    388:                        if (r->root_hooks.hook_exec.exception) {
1.2.2.1   misho     389:                                if (r->root_hooks.hook_exec.exception(r, NULL))
1.2.2.3   misho     390:                                        return NULL;
1.2.2.2   misho     391:                        } else
                    392:                                LOGERR;
                    393:                }
1.1       misho     394:        }
                    395: 
1.2       misho     396:        /* timer update & put in ready queue */
1.1       misho     397:        clock_gettime(CLOCK_MONOTONIC, &nw);
                    398:        now.tv_sec = nw.tv_sec;
                    399:        now.tv_usec = nw.tv_nsec / 1000;
                    400: 
                    401:        TAILQ_FOREACH(task, &r->root_timer, task_node)
                    402:                if (timercmp(&now, &TASK_TV(task), -) >= 0) {
                    403:                        TAILQ_REMOVE(&r->root_timer, task, task_node);
                    404:                        task->task_type = taskREADY;
                    405:                        TAILQ_INSERT_TAIL(&r->root_ready, task, task_node);
                    406:                }
                    407: 
                    408:        /* put eventlo priority task to ready queue, if there is no ready task or 
                    409:                reach max missed fetch-rotate */
                    410:        if ((task = TAILQ_FIRST(&r->root_eventlo))) {
                    411:                if (!TAILQ_FIRST(&r->root_ready) || r->root_eventlo_miss > MAX_EVENTLO_MISS) {
                    412:                        r->root_eventlo_miss = 0;
                    413: 
                    414:                        TAILQ_REMOVE(&r->root_eventlo, task, task_node);
                    415:                        task->task_type = taskREADY;
                    416:                        TAILQ_INSERT_TAIL(&r->root_ready, task, task_node);
                    417:                } else
                    418:                        r->root_eventlo_miss++;
                    419:        } else
                    420:                r->root_eventlo_miss = 0;
                    421: 
                    422:        /* OK, lets get ready task !!! */
                    423:        if (!(task = TAILQ_FIRST(&r->root_ready)))
                    424:                goto retry;
                    425:        TAILQ_REMOVE(&r->root_ready, task, task_node);
                    426:        task->task_type = taskUNUSE;
                    427:        TAILQ_INSERT_TAIL(&r->root_unuse, task, task_node);
                    428:        return task;
                    429: }
1.2.2.1   misho     430: 
                    431: /*
                    432:  * sched_hook_exception() - Default EXCEPTION hook
                    433:  * @root = root task
1.2.2.2   misho     434:  * @arg = custom handling: if arg == EV_EOF or other value; default: arg == NULL log errno
1.2.2.1   misho     435:  * return: <0 errors and 0 ok
                    436:  */
                    437: void *
                    438: sched_hook_exception(void *root, void *arg)
                    439: {
                    440:        sched_root_task_t *r = root;
                    441: 
                    442:        if (!r || !ROOT_DATA(r) || !ROOT_DATLEN(r))
                    443:                return NULL;
                    444: 
1.2.2.2   misho     445:        /* custom exception handling ... */
1.2.2.1   misho     446:        if (arg) {
                    447:                if (arg == (void*) EV_EOF)
                    448:                        return NULL;
1.2.2.2   misho     449:                return (void*) -1;      /* raise scheduler error!!! */
                    450:        }
1.2.2.1   misho     451: 
1.2.2.2   misho     452:        /* if error hook exists */
                    453:        if (r->root_hooks.hook_root.error)
1.2.2.4 ! misho     454:                return (r->root_hooks.hook_root.error(root, (void*) ((intptr_t) errno)));
1.2.2.1   misho     455: 
1.2.2.2   misho     456:        /* default case! */
                    457:        LOGERR;
1.2.2.1   misho     458:        return NULL;
                    459: }

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