[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.3 and 1.6

version 1.3, 2011/12/08 08:02:23 version 1.6, 2012/03/13 10:01:59
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 */
Line 70  typedef enum { Line 71  typedef enum {
         taskWRITE,          taskWRITE,
         taskTIMER,          taskTIMER,
         taskEVENT,           taskEVENT, 
           taskEVENTLO, 
         taskREADY,          taskREADY,
         taskUNUSE,          taskUNUSE,
         taskMAX          taskMAX
Line 87  struct sched_HooksTask { Line 89  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;
                /* timer(sched_task_t *task, struct timeval *tv) -> int */                /* timer(sched_task_t *task, struct timespec *ts) -> int */
                 sched_hook_func_t       timer;                  sched_hook_func_t       timer;
         }       hook_add;          }       hook_add;
         struct {          struct {
Line 99  struct sched_HooksTask { Line 101  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 114  typedef struct sched_HooksTask hooks_task_t; Line 118  typedef struct sched_HooksTask hooks_task_t;
 /* task callback, like pthread callback! */  /* task callback, like pthread callback! */
 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 */
   #define TASK_LOCK(x)            ((x)->task_lock++)
   #define TASK_UNLOCK(x)          ((x)->task_lock ^= (x)->task_lock)
   #define TASK_ISLOCKED(x)        ((x)->task_lock)
   
 /* task & queue */  /* task & queue */
 struct sched_Task {  struct sched_Task {
           volatile int                    task_lock;
         unsigned int                    task_id;          unsigned int                    task_id;
         sched_task_type_t               task_type;          sched_task_type_t               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
Line 127  struct sched_Task { Line 138  struct sched_Task {
         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 141  struct sched_Task { Line 152  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];
   
         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;
Line 169  inline const char *sched_GetError(); Line 190  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 177  sched_root_task_t *schedInit(void ** __restrict data,  Line 199  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
Line 208  inline void *schedFetch(sched_root_task_t * __restrict Line 253  inline void *schedFetch(sched_root_task_t * __restrict
 int schedRun(sched_root_task_t * __restrict root, volatile intptr_t * __restrict killState);  int schedRun(sched_root_task_t * __restrict 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
 * @queue = cancel from queue, if =NULL 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_TV]
  * @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
  */   */
int schedCancelby(sched_root_task_t * __restrict root, sched_queue_t * __restrict queue, int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type, 
                 u_char criteria, void *param, sched_hook_func_t hook);                  u_char criteria, void *param, sched_hook_func_t hook);
   
   
 /*  /*
  * 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);
 /*  /*
  * 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);
 /*  /*
  * 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);
 /*  /*
  * 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);
 /*  /*
  * 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);
 /*  /*
  * 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);
   
   
 #endif  #endif
Removed from v.1.3  
changed lines
  Added in v.1.6

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