[BACK]Return to aitsched.h CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / libaitsched / inc

Diff for /libaitsched/inc/aitsched.h between versions 1.5 and 1.9

version 1.5, 2012/01/24 21:59:46 version 1.9, 2012/05/30 08:52:45
Line 12  terms: Line 12  terms:
 All of the documentation and software included in the ELWIX and AITNET  All of the documentation and software included in the ELWIX and AITNET
 Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>  Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   
Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
         by Michael Pounov <misho@elwix.org>.  All rights reserved.          by Michael Pounov <misho@elwix.org>.  All rights reserved.
   
 Redistribution and use in source and binary forms, with or without  Redistribution and use in source and binary forms, with or without
Line 59  SUCH DAMAGE. Line 59  SUCH DAMAGE.
 #define CRITERIA_ARG    1  #define CRITERIA_ARG    1
 #define CRITERIA_FD     2  #define CRITERIA_FD     2
 #define CRITERIA_VAL    3  #define CRITERIA_VAL    3
#define CRITERIA_TV       4#define CRITERIA_TS       4
   
   
 /* early declaration for root & task */  /* early declaration for root & task */
Line 70  typedef enum { Line 70  typedef enum {
         taskREAD = 0,          taskREAD = 0,
         taskWRITE,          taskWRITE,
         taskTIMER,          taskTIMER,
        taskEVENT,         taskEVENT,
        taskEVENTLO,         taskEVENTLO,
         taskALARM,
         taskREADY,          taskREADY,
         taskUNUSE,          taskUNUSE,
         taskMAX          taskMAX
Line 89  struct sched_HooksTask { Line 90  struct sched_HooksTask {
                 sched_hook_func_t       event;                  sched_hook_func_t       event;
                 /* eventlo(sched_task_t *task, NULL) -> int */                  /* eventlo(sched_task_t *task, NULL) -> int */
                 sched_hook_func_t       eventlo;                  sched_hook_func_t       eventlo;
                   /* alarm(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       alarm;
                 /* timer(sched_task_t *task, struct timespec *ts) -> int */                  /* timer(sched_task_t *task, struct timespec *ts) -> int */
                 sched_hook_func_t       timer;                  sched_hook_func_t       timer;
         }       hook_add;          }       hook_add;
Line 101  struct sched_HooksTask { Line 104  struct sched_HooksTask {
                 sched_hook_func_t       fetch;                  sched_hook_func_t       fetch;
                 /* exception(sched_root_task_t *root, NULL) -> int */                  /* exception(sched_root_task_t *root, NULL) -> int */
                 sched_hook_func_t       exception;                  sched_hook_func_t       exception;
                   /* condition(sched_root_task_t *root, intptr_t *stopValue) -> int */
                   sched_hook_func_t       condition;
         }       hook_exec;          }       hook_exec;
         struct {          struct {
                 /* init(sched_root_task_t *root, void *data) -> int */                  /* init(sched_root_task_t *root, void *data) -> int */
Line 131  struct sched_Task { Line 136  struct sched_Task {
         sched_root_task_t               *task_root;          sched_root_task_t               *task_root;
 #define TASK_ROOT(x)    (x)->task_root  #define TASK_ROOT(x)    (x)->task_root
         sched_task_func_t               task_func;          sched_task_func_t               task_func;
   #define TASK_FUNC(x)    (x)->task_func
   
         void                            *task_arg;          void                            *task_arg;
         union {          union {
Line 162  struct sched_RootTask { Line 168  struct sched_RootTask {
         int             root_kq;          int             root_kq;
         struct timespec root_wait;          struct timespec root_wait;
         struct timespec root_poll;          struct timespec root_poll;
           intptr_t        root_cond;
   
         pthread_mutex_t root_mtx[taskMAX];          pthread_mutex_t root_mtx[taskMAX];
   
         sched_queue_t   root_read;          sched_queue_t   root_read;
         sched_queue_t   root_write;          sched_queue_t   root_write;
         sched_queue_t   root_timer;          sched_queue_t   root_timer;
           sched_queue_t   root_alarm;
         sched_queue_t   root_event;          sched_queue_t   root_event;
         sched_queue_t   root_ready;          sched_queue_t   root_ready;
         sched_queue_t   root_unuse;          sched_queue_t   root_unuse;
Line 178  struct sched_RootTask { Line 187  struct sched_RootTask {
 #define ROOT_DATA(x)    (x)->root_data.iov_base  #define ROOT_DATA(x)    (x)->root_data.iov_base
 #define ROOT_DATLEN(x)  (x)->root_data.iov_len  #define ROOT_DATLEN(x)  (x)->root_data.iov_len
 };  };
   #define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q))
   
   
 inline int sched_GetErrno();  inline int sched_GetErrno();
Line 186  inline const char *sched_GetError(); Line 196  inline const char *sched_GetError();
   
 /*  /*
  * schedInit() - Init scheduler   * schedInit() - Init scheduler
    *
  * @data = optional data if !=NULL   * @data = optional data if !=NULL
  * @datlen = data len if data is set   * @datlen = data len if data is set
  * return: allocated root task if ok or NULL error   * return: allocated root task if ok or NULL error
Line 194  sched_root_task_t *schedInit(void ** __restrict data,  Line 205  sched_root_task_t *schedInit(void ** __restrict data, 
 #define schedBegin()    schedInit((void**) &schedRegisterHooks, 0)  #define schedBegin()    schedInit((void**) &schedRegisterHooks, 0)
 /*  /*
  * schedEnd() - End scheduler & free all resources   * schedEnd() - End scheduler & free all resources
    *
  * @root = root task   * @root = root task
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 int schedEnd(sched_root_task_t ** __restrict root);  int schedEnd(sched_root_task_t ** __restrict root);
 /*  /*
  * schedRegisterHooks() - Register IO handles and bind tasks to it   * schedRegisterHooks() - Register IO handles and bind tasks to it
    *
  * @root = root task   * @root = root task
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 int schedRegisterHooks(sched_root_task_t * __restrict root);  int schedRegisterHooks(sched_root_task_t * __restrict root);
 /*  /*
  * schedPolling() - Polling timeout period if no timer task is present   * schedPolling() - Polling timeout period if no timer task is present
    *
  * @root = root task   * @root = root task
  * @ts = timeout polling period, if ==NULL INFINIT timeout   * @ts = timeout polling period, if ==NULL INFINIT timeout
  * @tsold = old timeout polling if !=NULL   * @tsold = old timeout polling if !=NULL
Line 214  int schedRegisterHooks(sched_root_task_t * __restrict  Line 228  int schedRegisterHooks(sched_root_task_t * __restrict 
 inline int schedPolling(sched_root_task_t * __restrict root,   inline int schedPolling(sched_root_task_t * __restrict root, 
                 struct timespec * __restrict ts, struct timespec * __restrict tsold);                  struct timespec * __restrict ts, struct timespec * __restrict tsold);
 /*  /*
    * schedTermCondition() - Activate hook for scheduler condition kill
    *
    * @root = root task
    * @condValue = condition value, kill schedRun() if condValue == killState
    * return: -1 error ok 0 ok
    */
   inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue);
   /*
  * schedCall() - Call task execution function   * schedCall() - Call task execution function
    *
  * @task = current task   * @task = current task
  * return: !=NULL error or =NULL ok   * return: !=NULL error or =NULL ok
  */   */
 inline void *schedCall(sched_task_t * __restrict task);  inline void *schedCall(sched_task_t * __restrict task);
 /*  /*
  * schedFetch() - Fetch ready task   * schedFetch() - Fetch ready task
    *
  * @root = root task   * @root = root task
  * return: =NULL error or !=NULL ready task   * return: =NULL error or !=NULL ready task
  */   */
 inline void *schedFetch(sched_root_task_t * __restrict root);  inline void *schedFetch(sched_root_task_t * __restrict root);
 /*  /*
  * schedRun() - Scheduler *run loop*   * schedRun() - Scheduler *run loop*
    *
  * @root = root task   * @root = root task
  * @killState = kill condition variable, if !=0 stop scheduler loop   * @killState = kill condition variable, if !=0 stop scheduler loop
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
int schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState);int schedRun(sched_root_task_t *root, volatile intptr_t * __restrict killState);
 /*  /*
  * schedCancel() - Cancel task from scheduler   * schedCancel() - Cancel task from scheduler
    *
  * @task = task   * @task = task
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 int schedCancel(sched_task_t * __restrict task);  int schedCancel(sched_task_t * __restrict task);
 /*  /*
  * schedCancelby() - Cancel task from scheduler by criteria   * schedCancelby() - Cancel task from scheduler by criteria
    *
  * @root = root task   * @root = root task
  * @type = cancel from queue type, if =taskMAX cancel same task from all queues   * @type = cancel from queue type, if =taskMAX cancel same task from all queues
 * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TV] * @criteria = find task by criteria [CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TS]
  * @param = search parameter   * @param = search parameter
  * @hook = custom cleanup hook function, may be NULL   * @hook = custom cleanup hook function, may be NULL
  * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok   * return: -1 error, -2 error in sub-stage cancel execution, -3 error from custom hook or 0 ok
Line 253  int schedCancelby(sched_root_task_t * __restrict root, Line 280  int schedCancelby(sched_root_task_t * __restrict root,
   
 /*  /*
  * schedRead() - Add READ I/O task to scheduler queue   * schedRead() - Add READ I/O task to scheduler queue
    *
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
Line 263  int schedCancelby(sched_root_task_t * __restrict root, Line 291  int schedCancelby(sched_root_task_t * __restrict root,
  */   */
 sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                 int fd, void *opt_data, size_t opt_dlen);                  int fd, void *opt_data, size_t opt_dlen);
   #define schedReadSelf(x)        schedRead(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
  * schedWrite() - Add WRITE I/O task to scheduler queue   * schedWrite() - Add WRITE I/O task to scheduler queue
    *
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
Line 275  sched_task_t *schedRead(sched_root_task_t * __restrict Line 306  sched_task_t *schedRead(sched_root_task_t * __restrict
  */   */
 sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                 int fd, void *opt_data, size_t opt_dlen);                  int fd, void *opt_data, size_t opt_dlen);
   #define schedWriteSelf(x)       schedWrite(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
    * schedAlarm() - Add ALARM task to scheduler queue
    *
    * @root = root task
    * @func = task execution function
    * @arg = 1st func argument
    * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedAlarm(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   struct timespec ts, void *opt_data, size_t opt_dlen);
   #define schedAlarmSelf(x)       schedAlarm(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   /*
  * schedTimer() - Add TIMER task to scheduler queue   * schedTimer() - Add TIMER task to scheduler queue
    *
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
Line 287  sched_task_t *schedWrite(sched_root_task_t * __restric Line 336  sched_task_t *schedWrite(sched_root_task_t * __restric
  */   */
 sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                 struct timespec ts, void *opt_data, size_t opt_dlen);                  struct timespec ts, void *opt_data, size_t opt_dlen);
   #define schedTimerSelf(x)       schedTimer(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
  * schedEvent() - Add EVENT task to scheduler queue   * schedEvent() - Add EVENT task to scheduler queue
    *
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
Line 299  sched_task_t *schedTimer(sched_root_task_t * __restric Line 351  sched_task_t *schedTimer(sched_root_task_t * __restric
  */   */
 sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                 unsigned long val, void *opt_data, size_t opt_dlen);                  unsigned long val, void *opt_data, size_t opt_dlen);
   #define schedEventSelf(x)       schedEvent(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
  * schedEventLo() - Add EVENT_Lo task to scheduler queue   * schedEventLo() - Add EVENT_Lo task to scheduler queue
    *
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
Line 311  sched_task_t *schedEvent(sched_root_task_t * __restric Line 366  sched_task_t *schedEvent(sched_root_task_t * __restric
  */   */
 sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                 unsigned long val, void *opt_data, size_t opt_dlen);                  unsigned long val, void *opt_data, size_t opt_dlen);
   #define schedEventLoSelf(x)     schedEventLo(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
  * schedCallOnce() - Call once from scheduler   * schedCallOnce() - Call once from scheduler
    *
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
Line 323  sched_task_t *schedEventLo(sched_root_task_t * __restr Line 381  sched_task_t *schedEventLo(sched_root_task_t * __restr
  */   */
 sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                 unsigned long val, void *opt_data, size_t opt_dlen);                  unsigned long val, void *opt_data, size_t opt_dlen);
   #define schedCallAgain(x)       schedCallOnce(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   
   
 #endif  #endif
Removed from v.1.5  
changed lines
  Added in v.1.9

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