[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.15 and 1.23

version 1.15, 2012/08/21 12:54:39 version 1.23, 2013/10/21 13:38:05
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, 2011, 2012Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
         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 91  typedef enum { Line 91  typedef enum {
         taskREADY,          taskREADY,
         taskUNUSE,          taskUNUSE,
         taskTHREAD,           taskTHREAD, 
           taskRTC,
         taskMAX          taskMAX
 } sched_task_type_t;  } sched_task_type_t;
   
Line 126  struct sched_HooksTask { Line 127  struct sched_HooksTask {
                 sched_hook_func_t       suspend;                  sched_hook_func_t       suspend;
                 /* thread(sched_task_t *task, NULL) -> int */                  /* thread(sched_task_t *task, NULL) -> int */
                 sched_hook_func_t       thread;                  sched_hook_func_t       thread;
                   /* rtc(sched_task_t *task, NULL) -> int */
                   sched_hook_func_t       rtc;
         }       hook_add;          }       hook_add;
         struct {          struct {
                 /* exit(sched_task_t *task, void *exitValue) -> int */                  /* exit(sched_task_t *task, void *exitValue) -> int */
Line 176  struct sched_Task { Line 179  struct sched_Task {
 #define TASK_FUNC(x)    (x)->task_func  #define TASK_FUNC(x)    (x)->task_func
         intptr_t                        task_ret;          intptr_t                        task_ret;
 #define TASK_RET(x)     (x)->task_ret  #define TASK_RET(x)     (x)->task_ret
        unsigned int                        task_flag;        unsigned long                        task_flag;
 #define TASK_FLAG(x)    (x)->task_flag  #define TASK_FLAG(x)    (x)->task_flag
   
         void                            *task_arg;          void                            *task_arg;
Line 231  struct sched_RootTask { Line 234  struct sched_RootTask {
         sched_queue_t   root_ready;          sched_queue_t   root_ready;
         sched_queue_t   root_unuse;          sched_queue_t   root_unuse;
         sched_queue_t   root_thread;          sched_queue_t   root_thread;
           sched_queue_t   root_rtc;
   
         hooks_task_t    root_hooks;          hooks_task_t    root_hooks;
         struct iovec    root_data;          struct iovec    root_data;
Line 241  struct sched_RootTask { Line 245  struct sched_RootTask {
 #define ROOT_RETURN(x)  (x)->root_ret  #define ROOT_RETURN(x)  (x)->root_ret
   
   
inline int sched_GetErrno();int sched_GetErrno();
inline const char *sched_GetError();const char *sched_GetError();
   
   
 /*  /*
Line 274  int schedRegisterHooks(sched_root_task_t * __restrict  Line 278  int schedRegisterHooks(sched_root_task_t * __restrict 
  * @root = root task   * @root = root task
  * return: NULL error or !=NULL prepared task   * return: NULL error or !=NULL prepared task
  */   */
inline sched_task_t *sched_useTask(sched_root_task_t * __restrict root);sched_task_t *sched_useTask(sched_root_task_t * __restrict root);
 /*  /*
  * sched_unuseTask() - Unlock and put task to unuse queue   * sched_unuseTask() - Unlock and put task to unuse queue
  *   *
  * @task = task   * @task = task
  * return: always is NULL   * return: always is NULL
  */   */
inline sched_task_t *sched_unuseTask(sched_task_t * __restrict task);sched_task_t *sched_unuseTask(sched_task_t * __restrict task);
 /*  /*
  * schedPolling() - Polling timeout period if no timer task is present   * schedPolling() - Polling timeout period if no timer task is present
  *   *
Line 290  inline sched_task_t *sched_unuseTask(sched_task_t * __ Line 294  inline sched_task_t *sched_unuseTask(sched_task_t * __
  * @tsold = old timeout polling if !=NULL   * @tsold = old timeout polling if !=NULL
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
inline int schedPolling(sched_root_task_t * __restrict root, 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   * schedTermCondition() - Activate hook for scheduler condition kill
Line 299  inline int schedPolling(sched_root_task_t * __restrict Line 303  inline int schedPolling(sched_root_task_t * __restrict
  * @condValue = condition value, kill schedRun() if condValue == killState   * @condValue = condition value, kill schedRun() if condValue == killState
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
inline int schedTermCondition(sched_root_task_t * __restrict root, intptr_t condValue);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);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);void *schedFetch(sched_root_task_t * __restrict root);
 /*  /*
  * schedRun() - Scheduler *run loop*   * schedRun() - Scheduler *run loop*
  *   *
Line 335  int schedCancel(sched_task_t * __restrict task); Line 339  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 = find task by criteria 
 *      [CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA] *      [ 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
  */   */
 int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type,   int schedCancelby(sched_root_task_t * __restrict root, sched_task_type_t type, 
                u_char criteria, void *param, sched_hook_func_t hook);                unsigned char criteria, void *param, sched_hook_func_t hook);
 /*
  * schedQuery() - Query task in scheduler
  *
  * @task = task
  * return: -1 error, 0 found  and 1 not found
  */
 int schedQuery(sched_task_t * __restrict task);
 /*
  * schedQueryby() - Query task in scheduler by criteria
  *
  * @root = root task
  * @type = query from queue type, if =taskMAX query same task from all queues
  * @criteria = find task by criteria 
  *      [ CRITERIA_ANY|CRITERIA_CALL|CRITERIA_ARG|CRITERIA_FD|CRITERIA_VAL|
  *              CRITERIA_ID|CRITERIA_TS|CRITERIA_DATA ]
  * @param = search parameter
  * return: -1 error, 0 found or 1 not found
  */
 int schedQueryby(sched_root_task_t * __restrict root, sched_task_type_t type, 
                 unsigned char criteria, void *param);
   
   
 /*  /*
Line 381  sched_task_t *schedWrite(sched_root_task_t * __restric Line 406  sched_task_t *schedWrite(sched_root_task_t * __restric
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
  * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!   * @ts = timeout argument structure, minimum alarm timer resolution is 1msec!
 * @opt_data = Optional data * @opt_data = Alarm timer ID
  * @opt_dlen = Optional data length   * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
Line 390  sched_task_t *schedAlarm(sched_root_task_t * __restric Line 415  sched_task_t *schedAlarm(sched_root_task_t * __restric
 #define schedAlarmSelf(x)       schedAlarm(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \  #define schedAlarmSelf(x)       schedAlarm(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                 TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))                  TASK_TS((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
    * schedRTC() - Add RTC 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 RTC ID
    * @opt_dlen = Optional data length
    * return: NULL error or !=NULL new queued task
    */
   sched_task_t *schedRTC(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                   struct timespec ts, void *opt_data, size_t opt_dlen);
   #define schedRTCSelf(x)         schedRTC(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   * schedNode() - Add NODE task to scheduler queue
  *   *
  * @root = root task   * @root = root task
Line 461  sched_task_t *schedAIO(sched_root_task_t * __restrict  Line 501  sched_task_t *schedAIO(sched_root_task_t * __restrict 
  * @offset = Offset from start of file, if =-1 from current position   * @offset = Offset from start of file, if =-1 from current position
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
inline sched_task_t *schedAIORead(sched_root_task_t * __restrict root, sched_task_func_t func, sched_task_t *schedAIORead(sched_root_task_t * __restrict root, sched_task_func_t func, 
                 void *arg, int fd, void *buffer, size_t buflen, off_t offset);                  void *arg, int fd, void *buffer, size_t buflen, off_t offset);
 /*  /*
  * schedAIOWrite() - Add AIO write task to scheduler queue   * schedAIOWrite() - Add AIO write task to scheduler queue
Line 475  inline sched_task_t *schedAIORead(sched_root_task_t *  Line 515  inline sched_task_t *schedAIORead(sched_root_task_t * 
  * @offset = Offset from start of file, if =-1 from current position   * @offset = Offset from start of file, if =-1 from current position
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
inline sched_task_t *schedAIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func, sched_task_t *schedAIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func, 
                 void *arg, int fd, void *buffer, size_t buflen, off_t offset);                  void *arg, int fd, void *buffer, size_t buflen, off_t offset);
   
 /*  /*
Line 503  sched_task_t *schedLIO(sched_root_task_t * __restrict  Line 543  sched_task_t *schedLIO(sched_root_task_t * __restrict 
  * @offset = Offset from start of file, if =-1 from current position   * @offset = Offset from start of file, if =-1 from current position
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
inline sched_task_t *schedLIORead(sched_root_task_t * __restrict root, sched_task_func_t func, sched_task_t *schedLIORead(sched_root_task_t * __restrict root, sched_task_func_t func, 
                 void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);                  void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);
 /*  /*
  * schedLIOWrite() - Add list of AIO write tasks to scheduler queue   * schedLIOWrite() - Add list of AIO write tasks to scheduler queue
Line 517  inline sched_task_t *schedLIORead(sched_root_task_t *  Line 557  inline sched_task_t *schedLIORead(sched_root_task_t * 
  * @offset = Offset from start of file, if =-1 from current position   * @offset = Offset from start of file, if =-1 from current position
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
inline sched_task_t *schedLIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func, sched_task_t *schedLIOWrite(sched_root_task_t * __restrict root, sched_task_func_t func, 
                 void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);                  void *arg, int fd, struct iovec *bufs, size_t nbufs, off_t offset);
 #endif  /* EVFILT_LIO */  #endif  /* EVFILT_LIO */
   
Line 557  int schedTrigger(sched_task_t * __restrict task); Line 597  int schedTrigger(sched_task_t * __restrict task);
  */   */
 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
  *   *
Line 610  sched_task_t *schedSuspend(sched_root_task_t * __restr Line 648  sched_task_t *schedSuspend(sched_root_task_t * __restr
  * @root = root task   * @root = root task
  * @criteria = find task by criteria    * @criteria = find task by criteria 
  *      [CRITERIA_ANY|CRITERIA_ID|CRITERIA_DATA]   *      [CRITERIA_ANY|CRITERIA_ID|CRITERIA_DATA]
 * @param = search parameter (sched_task_t *task| u_long id) * @param = search parameter (sched_task_t *task| unsigned long id)
  * return: -1 error or 0 resumed ok   * return: -1 error or 0 resumed ok
  */   */
 int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param);  int schedResumeby(sched_root_task_t * __restrict root, unsigned char criteria, void *param);
Line 637  sched_task_t *schedCallOnce(sched_root_task_t * __rest Line 675  sched_task_t *schedCallOnce(sched_root_task_t * __rest
  * @root = root task   * @root = root task
  * @func = task execution function   * @func = task execution function
  * @arg = 1st func argument   * @arg = 1st func argument
 * @detach = Detach thread from scheduler, if !=0 * @ss = stack size
  * @opt_data = Optional data   * @opt_data = Optional data
  * @opt_dlen = Optional data length   * @opt_dlen = Optional data length
  * return: NULL error or !=NULL new queued task   * return: NULL error or !=NULL new queued task
  */   */
 sched_task_t *schedThread(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg,   sched_task_t *schedThread(sched_root_task_t * __restrict root, sched_task_func_t func, void *arg, 
                int detach, void *opt_data, size_t opt_dlen);                size_t ss, void *opt_data, size_t opt_dlen);
 #define schedThreadSelf(x)      schedThread(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \  #define schedThreadSelf(x)      schedThread(TASK_ROOT((x)), TASK_FUNC((x)), TASK_ARG((x)), \
                TASK_VAL((x)), TASK_DATA((x)), TASK_DATLEN((x)))                (size_t) TASK_FLAG((x)), TASK_DATA((x)), TASK_DATLEN((x)))
 /*  /*
 * taskExit() - Exit routine for scheduler task * sched_taskExit() - Exit routine for scheduler task, explicit required for thread tasks
  *   *
    * @task = current task
    * @retcode = return code
    * return: return code
    */
   void *sched_taskExit(sched_task_t *task, intptr_t retcode);
   /*
    * taskExit() - Exit helper for scheduler task
    *
  * @t = current executed task   * @t = current executed task
  * @x = exit value for task   * @x = exit value for task
  * return: none   * return: none
  */   */
#define taskExit(t, x)  do { assert((t) && TASK_ROOT(t)); \#define taskExit(t, x)          return sched_taskExit((t), (intptr_t) (x))
                                if (TASK_ROOT(t)->root_hooks.hook_exec.exit) \ 
                                        TASK_ROOT(t)->root_hooks.hook_exec.exit((t), \ 
                                                        (void*) (x)); \ 
                                TASK_ROOT(t)->root_ret = (void*) (x); \ 
                                if (TASK_TYPE(t) == taskTHREAD) { \ 
                                        sched_unuseTask(t); \ 
                                        pthread_exit((void*) (x)); \ 
                                } else \ 
                                        return ((void*) (x)); \ 
} while (0) 
   
   
 #endif  #endif
Removed from v.1.15  
changed lines
  Added in v.1.23

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