Diff for /libaitsched/inc/aitsched.h between versions 1.7.2.2 and 1.11.2.2

version 1.7.2.2, 2012/05/15 15:47:12 version 1.11.2.2, 2012/08/01 12:49:26
Line 55  SUCH DAMAGE. Line 55  SUCH DAMAGE.
   
   
 /* 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_TS     4#define CRITERIA_VAL    4
 #define CRITERIA_TS     5
 #define CRITERIA_DATA   6
 #define CRITERIA_ID     7
   
   
 /* early declaration for root & task */  /* early declaration for root & task */
Line 70  typedef enum { Line 73  typedef enum {
         taskREAD = 0,          taskREAD = 0,
         taskWRITE,          taskWRITE,
         taskTIMER,          taskTIMER,
        taskEVENT,         taskALARM,
        taskEVENTLO,         taskNODE,
         taskPROC,
         taskSIGNAL,
         taskAIO,
         taskUSER,
         taskEVENT,
         taskEVENTLO,
         taskSUSPEND, 
         taskREADY,          taskREADY,
         taskUNUSE,          taskUNUSE,
         taskMAX          taskMAX
Line 85  struct sched_HooksTask { Line 95  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;
                   /* signal(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       signal;
                   /* aio(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       aio;
                   /* user(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       user;
                 /* 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 timespec *ts) -> int */                /* suspend(sched_task_t *task, NULL) -> int */
                sched_hook_func_t       timer;                sched_hook_func_t       suspend;
         }       hook_add;          }       hook_add;
         struct {          struct {
                 /* cancel(sched_task_t *task, NULL) -> int */                  /* cancel(sched_task_t *task, NULL) -> int */
                 sched_hook_func_t       cancel;                  sched_hook_func_t       cancel;
                   /* resume(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       resume;
                 /* run(sched_root_task_t *root, NULL) -> int */                  /* run(sched_root_task_t *root, NULL) -> int */
                 sched_hook_func_t       run;                  sched_hook_func_t       run;
                 /* fetch(sched_root_task_t *root, NULL) -> sched_task_t* */                  /* fetch(sched_root_task_t *root, NULL) -> sched_task_t* */
Line 119  typedef struct sched_HooksTask hooks_task_t; Line 145  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
   
Line 166  struct sched_RootTask { Line 193  struct sched_RootTask {
         struct timespec root_wait;          struct timespec root_wait;
         struct timespec root_poll;          struct timespec root_poll;
         intptr_t        root_cond;          intptr_t        root_cond;
           void            *root_ret;
   
         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_signal;
           sched_queue_t   root_aio;
           sched_queue_t   root_user;
         sched_queue_t   root_event;          sched_queue_t   root_event;
           sched_queue_t   root_eventlo;
           sched_queue_t   root_suspend;
         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 184  struct sched_RootTask { Line 219  struct sched_RootTask {
 #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))  #define ROOT_QUEUE_EMPTY(x, _q) TAILQ_EMPTY(&((x)->root_##_q))
   #define ROOT_RETURN(x)  (x)->root_ret
   
   
 inline int sched_GetErrno();  inline int sched_GetErrno();
Line 265  int schedCancel(sched_task_t * __restrict task); Line 301  int schedCancel(sched_task_t * __restrict task);
  *   *
  * @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_TS] * @criteria = find task by criteria 
  *       [CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_ID|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 305  sched_task_t *schedWrite(sched_root_task_t * __restric Line 342  sched_task_t *schedWrite(sched_root_task_t * __restric
 #define schedWriteSelf(x)       schedWrite(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \  #define schedWriteSelf(x)       schedWrite(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                 TASK_FD((x)), TASK_DATA((x)), TASK_DATLEN((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)))
   
   /*
    * schedAIO() - Add AIO task to scheduler queue
    *
    * @root = root task
    * @func = task execution function
    * @arg = 1st func argument
    * @acb = AIO cb structure address
    * @opt_data = Optional data
    * @opt_dlen = Optional data length
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedAIO(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   unsigned long acb, void *opt_data, size_t opt_dlen);
   #define schedAIOSelf(x) schedAIO(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
Line 349  sched_task_t *schedEventLo(sched_root_task_t * __restr Line 486  sched_task_t *schedEventLo(sched_root_task_t * __restr
                 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)), \  #define schedEventLoSelf(x)     schedEventLo(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                 TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))                  TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   /*
    * schedSuspend() - Add Suspended 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 *schedSuspend(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   unsigned long id, void *opt_data, size_t opt_dlen);
   #define schedSuspendSelf(x)     schedUser(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                   TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))
   /*
    * schedResumeby() - Resume suspended task
    *
    * @root = root task
    * @criteria = find task by criteria 
    *      [CRITERIA_ANY|CRITERIA_ID|CRITERIA_DATA]
    * @param = search parameter (sched_task_t *task| u_long id)
    * return: -1 error or 0 resumed ok
    */
   int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param);
   
 /*  /*
  * schedCallOnce() - Call once from scheduler   * schedCallOnce() - Call once from scheduler
  *   *

Removed from v.1.7.2.2  
changed lines
  Added in v.1.11.2.2


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