[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.4.2.2 and 1.9.2.3

version 1.4.2.2, 2012/01/08 02:52:29 version 1.9.2.3, 2012/05/31 21:36:40
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 51  SUCH DAMAGE. Line 51  SUCH DAMAGE.
 #include <sys/queue.h>  #include <sys/queue.h>
 #include <sys/uio.h>  #include <sys/uio.h>
 #include <stdint.h>  #include <stdint.h>
   #include <pthread.h>
   
   
 /* criteria type */  /* criteria type */
#define CRITERIA_CALL   0#define CRITERIA_ANY    0
#define CRITERIA_ARG    1#define CRITERIA_CALL   1
#define CRITERIA_FD     2#define CRITERIA_ARG    2
#define CRITERIA_VAL    3#define CRITERIA_FD     3
#define CRITERIA_TV       4#define CRITERIA_VAL    4
 #define CRITERIA_TS       5
 #define CRITERIA_DATA   6
   
   
 /* early declaration for root & task */  /* early declaration for root & task */
Line 69  typedef enum { Line 72  typedef enum {
         taskREAD = 0,          taskREAD = 0,
         taskWRITE,          taskWRITE,
         taskTIMER,          taskTIMER,
        taskEVENT,         taskALARM,
        taskEVENTLO,         taskNODE,
         taskPROC,
         taskUSER,
         taskSIGNAL,
         taskEVENT,
         taskEVENTLO,
         taskREADY,          taskREADY,
         taskUNUSE,          taskUNUSE,
         taskMAX          taskMAX
Line 84  struct sched_HooksTask { Line 92  struct sched_HooksTask {
                 sched_hook_func_t       read;                  sched_hook_func_t       read;
                 /* write(sched_task_t *task, NULL) -> int */                  /* write(sched_task_t *task, NULL) -> int */
                 sched_hook_func_t       write;                  sched_hook_func_t       write;
                   /* timer(sched_task_t *task, struct timespec *ts) -> int */
                   sched_hook_func_t       timer;
                   /* alarm(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       alarm;
                   /* node(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       node;
                   /* proc(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       proc;
                   /* user(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       user;
                   /* signal(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       signal;
                 /* event(sched_task_t *task, NULL) -> int */                  /* event(sched_task_t *task, NULL) -> int */
                 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;
                 /* timer(sched_task_t *task, struct timeval *tv) -> int */  
                 sched_hook_func_t       timer;  
         }       hook_add;          }       hook_add;
         struct {          struct {
                 /* cancel(sched_task_t *task, NULL) -> int */                  /* cancel(sched_task_t *task, NULL) -> int */
Line 100  struct sched_HooksTask { Line 118  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 116  typedef struct sched_HooksTask hooks_task_t; Line 136  typedef struct sched_HooksTask hooks_task_t;
 typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/);  typedef void *(*sched_task_func_t)(sched_task_t * /* current task data*/);
   
 /* task lock helpers */  /* task lock helpers */
#define TASK_LOCK(x)            ((x)->task_lock++)#define TASK_LOCK(x)            ((x)->task_lock = 42)
 #define TASK_UNLOCK(x)          ((x)->task_lock ^= (x)->task_lock)  #define TASK_UNLOCK(x)          ((x)->task_lock ^= (x)->task_lock)
 #define TASK_ISLOCKED(x)        ((x)->task_lock)  #define TASK_ISLOCKED(x)        ((x)->task_lock)
   
 /* task & queue */  /* task & queue */
 struct sched_Task {  struct sched_Task {
         volatile int                    task_lock;          volatile int                    task_lock;
        unsigned int                       task_id;        uintptr_t                       task_id;
 #define TASK_ID(x)      ((struct sched_Task*) (x)->task_id)
         sched_task_type_t               task_type;          sched_task_type_t               task_type;
 #define TASK_TYPE(x)    (x)->task_type  #define TASK_TYPE(x)    (x)->task_type
   
         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 {
                 unsigned long   v;                  unsigned long   v;
                 intptr_t        fd;                  intptr_t        fd;
                struct timeval     tv;                struct timespec    ts;
         }                               task_val;          }                               task_val;
 #define TASK_ARG(x)     (x)->task_arg  #define TASK_ARG(x)     (x)->task_arg
 #define TASK_VAL(x)     (x)->task_val.v  #define TASK_VAL(x)     (x)->task_val.v
 #define TASK_FD(x)      (x)->task_val.fd  #define TASK_FD(x)      (x)->task_val.fd
#define TASK_TV(x)     (x)->task_val.tv#define TASK_TS(x)     (x)->task_val.ts
   
         struct iovec                    task_data;          struct iovec                    task_data;
 #define TASK_DATA(x)    (x)->task_data.iov_base  #define TASK_DATA(x)    (x)->task_data.iov_base
Line 149  struct sched_Task { Line 171  struct sched_Task {
         TAILQ_ENTRY(sched_Task)         task_node;          TAILQ_ENTRY(sched_Task)         task_node;
 };  };
 typedef TAILQ_HEAD(, sched_Task) sched_queue_t;  typedef TAILQ_HEAD(, sched_Task) sched_queue_t;
   #define TASK_DATA_SET(x, _dp, _dl)      do { \
                                                   if ((x)) { \
                                                           (x)->task_data.iov_base = (_dp); \
                                                           (x)->task_data.iov_len = _dl; \
                                                   } \
                                           while (0)
   
 /* root task */  /* root task */
 struct sched_RootTask {  struct sched_RootTask {
         int             root_kq;          int             root_kq;
        struct timeval        root_wait;        struct timespec        root_wait;
         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_node;
           sched_queue_t   root_proc;
           sched_queue_t   root_user;
           sched_queue_t   root_signal;
         sched_queue_t   root_event;          sched_queue_t   root_event;
           sched_queue_t   root_eventlo;
         sched_queue_t   root_ready;          sched_queue_t   root_ready;
         sched_queue_t   root_unuse;          sched_queue_t   root_unuse;
         sched_queue_t   root_eventlo;  
         int             root_eventlo_miss;          int             root_eventlo_miss;
   
         hooks_task_t    root_hooks;          hooks_task_t    root_hooks;
Line 170  struct sched_RootTask { Line 206  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 178  inline const char *sched_GetError(); Line 215  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 186  sched_root_task_t *schedInit(void ** __restrict data,  Line 224  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
    *
    * @root = root task
    * @ts = timeout polling period, if ==NULL INFINIT timeout
    * @tsold = old timeout polling if !=NULL
    * return: -1 error or 0 ok
    */
   inline int schedPolling(sched_root_task_t * __restrict root, 
                   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_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_TS|CRITERIA_DATA]
  * @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 236  int schedCancelby(sched_root_task_t * __restrict root, Line 300  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
  * @fd = fd handle   * @fd = fd handle
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
sched_task_t *schedRead(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd);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);
 #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
  * @fd = fd handle   * @fd = fd handle
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
sched_task_t *schedWrite(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, int fd);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);
 #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)))
   /*
    * schedNode() - Add NODE task to scheduler queue
    *
    * @root = root task
    * @func = task execution function
    * @arg = 1st func argument
    * @fd = fd handle
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedNode(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   int fd, void *opt_data, size_t opt_dlen);
   #define schedNodeSelf(x)        schedNode(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   /*
    * schedProc() - Add PROC task to scheduler queue
    *
    * @root = root task
    * @func = task execution function
    * @arg = 1st func argument
    * @pid = PID
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedProc(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   unsigned long pid, void *opt_data, size_t opt_dlen);
   #define schedProcSelf(x)        schedProc(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   /*
    * schedSignal() - Add SIGNAL task to scheduler queue
    *
    * @root = root task
    * @func = task execution function
    * @arg = 1st func argument
    * @sig = Signal
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedSignal(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   unsigned long sig, void *opt_data, size_t opt_dlen);
   #define schedSignalSelf(x)      schedSignal(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   
   /*
    * schedUser() - Add trigger USER task to scheduler queue
    *
    * @root = root task
    * @func = task execution function
    * @arg = 1st func argument
    * @id = Trigger ID
    * @opt_data = Optional data
    * @opt_dlen = Optional user's trigger flags
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedUser(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   unsigned long id, void *opt_data, size_t opt_dlen);
   #define schedUserSelf(x)        schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   /*
    * schedTrigger() - Triggering USER task
    *
    * @task = task
    * return: -1 error or 0 ok
    */
   int schedTrigger(sched_task_t * __restrict task);
   
   /*
  * 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
 * @tv = timeout argument structure * @ts = timeout argument structure
  * @opt_data = Optional data
  * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
sched_task_t *schedTimer(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, struct timeval tv);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);
 #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
  * @val = additional func argument   * @val = additional func argument
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
sched_task_t *schedEvent(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);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);
 #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
  * @val = additional func argument   * @val = additional func argument
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
sched_task_t *schedEventLo(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);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);
 #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
  * @val = additional func argument   * @val = additional func argument
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
  * return: return value from called func   * return: return value from called func
  */   */
sched_task_t *schedCallOnce(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, unsigned long val);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);
 #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.4.2.2  
changed lines
  Added in v.1.9.2.3

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