Return to hooks.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitsched / inc

version 6.6

    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: hooks.h,v 1.12 2019/01/14 15:58:50 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 - 2018
   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 __HOOKS_H
   47: #define __HOOKS_H
   48: 
   49: 
   50: /*
   51:  * sched_hook_init() - Default INIT hook
   52:  * @root = root task
   53:  * @arg = unused
   54:  * return: <0 errors and 0 ok
   55:  */
   56: void *sched_hook_init(void *root, void *arg __unused);
   57: 
   58: /*
   59:  * sched_hook_fini() - Default FINI hook
   60:  * @root = root task
   61:  * @arg = unused
   62:  * return: <0 errors and 0 ok
   63:  */
   64: void *sched_hook_fini(void *root, void *arg __unused);
   65: 
   66: /*
   67:  * sched_hook_fetch() - Default FETCH hook
   68:  * @root = root task
   69:  * @arg = unused
   70:  * return: NULL error or !=NULL fetched task
   71:  */
   72: void *sched_hook_fetch(void *root, void *arg __unused);
   73: 
   74: /*
   75:  * sched_hook_cancel() - Default CANCEL hook
   76:  * @task = current task
   77:  * @arg = unused
   78:  * return: <0 errors and 0 ok
   79:  */
   80: void *sched_hook_cancel(void *task, void *arg __unused);
   81: 
   82: /*
   83:  * sched_hook_thread() - Default THREAD hook
   84:  *
   85:  * @task = current task
   86:  * @arg = pthread attributes
   87:  * return: <0 errors and 0 ok
   88:  */
   89: void *sched_hook_thread(void *task, void *arg);
   90: 
   91: /*
   92:  * sched_hook_read() - Default READ hook
   93:  * @task = current task
   94:  * @arg = unused
   95:  * return: <0 errors and 0 ok
   96:  */
   97: void *sched_hook_read(void *task, void *arg __unused);
   98: 
   99: /*
  100:  * sched_hook_write() - Default WRITE hook
  101:  * @task = current task
  102:  * @arg = unused
  103:  * return: <0 errors and 0 ok
  104:  */
  105: void *sched_hook_write(void *task, void *arg __unused);
  106: 
  107: /*
  108:  * sched_hook_alarm() - Default ALARM hook
  109:  *
  110:  * @task = current task
  111:  * @arg = unused
  112:  * return: <0 errors and 0 ok
  113:  */
  114: void *sched_hook_alarm(void *task, void *arg __unused);
  115: 
  116: /*
  117:  * sched_hook_node() - Default NODE hook
  118:  *
  119:  * @task = current task
  120:  * @arg = if arg == 42 then waiting for all events
  121:  * return: <0 errors and 0 ok
  122:  */
  123: void *sched_hook_node(void *task, void *arg);
  124: 
  125: /*
  126:  * sched_hook_proc() - Default PROC hook
  127:  *
  128:  * @task = current task
  129:  * @arg = unused
  130:  * return: <0 errors and 0 ok
  131:  */
  132: void *sched_hook_proc(void *task, void *arg __unused);
  133: 
  134: /*
  135:  * sched_hook_signal() - Default SIGNAL hook
  136:  *
  137:  * @task = current task
  138:  * @arg = unused
  139:  * return: <0 errors and 0 ok
  140:  */
  141: void *sched_hook_signal(void *task, void *arg __unused);
  142: 
  143: /*
  144:  * sched_hook_user() - Default USER hook
  145:  *
  146:  * @task = current task
  147:  * @arg = unused
  148:  * return: <0 errors and 0 ok
  149:  */
  150: #ifdef EVFILT_USER
  151: void *sched_hook_user(void *task, void *arg __unused);
  152: #endif
  153: 
  154: /*
  155:  * sched_hook_exception() - Default EXCEPTION hook
  156:  * @root = root task
  157:  * @arg = custom handling: if arg == EV_EOF or other value; default: arg == NULL log errno
  158:  * return: <0 errors and 0 ok
  159:  */
  160: void *sched_hook_exception(void *root, void *arg);
  161: 
  162: /*
  163:  * sched_hook_condition() - Default CONDITION hook
  164:  *
  165:  * @root = root task
  166:  * @arg = killState from schedRun()
  167:  * return: NULL kill scheduler loop or !=NULL ok
  168:  */
  169: void *sched_hook_condition(void *root, void *arg);
  170: 
  171: /*
  172:  * sched_hook_rtc() - Default RTC hook
  173:  *
  174:  * @task = current task
  175:  * @arg = unused
  176:  * return: <0 errors and 0 ok
  177:  */
  178: #if defined(HAVE_TIMER_CREATE) && defined(HAVE_TIMER_SETTIME)
  179: void *sched_hook_rtc(void *task, void *arg __unused);
  180: #endif
  181: 
  182: 
  183: #endif