lib/silcutil/silcschedule_i.h

   1 /*
   2
   3   silcschedule_i.h.
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2001 - 2007 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 #ifndef SILCSCHEDULE_I_H
  21 #define SILCSCHEDULE_I_H
  22
  23 #ifndef SILCSCHEDULE_H
  24 #error "Do not include this header directly"
  25 #endif
  26
  27 #include "silchashtable.h"
  28 #include "silclist.h"
  29
  30 /* Task types */
  31 typedef enum {
  32   /* File descriptor task that performs some event over file descriptors.
  33      These tasks are for example network connections. */
  34   SILC_TASK_FD           = 0,
  35
  36   /* Timeout tasks are tasks that are executed after the specified
  37      time has elapsed. After the task is executed the task is removed
  38      automatically from the scheduler. It is safe to re-register the
  39      task in task callback. It is also safe to unregister a task in
  40      the task callback. */
  41   SILC_TASK_TIMEOUT,
  42
  43   /* Platform specific process signal task.  On Unix systems this is one of
  44      the signals described in signal(7).  On other platforms this may not
  45      be available at all.  Only one callback per signal may be added. */
  46   SILC_TASK_SIGNAL
  47 } SilcTaskType;
  48
  49 /* Task header */
  50 struct SilcTaskStruct {
  51   struct SilcTaskStruct *next;
  52   SilcTaskCallback callback;
  53   void *context;
  54   unsigned int type    : 1;     /* 0 = fd, 1 = timeout */
  55   unsigned int valid   : 1;     /* Set if task is valid */
  56 };
  57
  58 /* Timeout task */
  59 typedef struct SilcTaskTimeoutStruct {
  60   struct SilcTaskStruct header;
  61   struct timeval timeout;
  62 } *SilcTaskTimeout;
  63
  64 /* Fd task */
  65 typedef struct SilcTaskFdStruct {
  66   struct SilcTaskStruct header;
  67   unsigned int scheduled  : 1;
  68   unsigned int events     : 14;
  69   unsigned int revents    : 15;
  70   SilcUInt32 fd;
  71 } *SilcTaskFd;
  72
  73 /* Scheduler context */
  74 struct SilcScheduleStruct {
  75   void *internal;
  76   void *app_context;               /* Application specific context */
  77   SilcHashTable fd_queue;          /* FD task queue */
  78   SilcList fd_dispatch;            /* Dispatched FDs */
  79   SilcList timeout_queue;          /* Timeout queue */
  80   SilcList free_tasks;             /* Timeout task freelist */
  81   SilcMutex lock;                  /* Scheduler lock */
  82   struct timeval timeout;          /* Current timeout */
  83   unsigned int max_tasks     : 29; /* Max FD tasks */
  84   unsigned int has_timeout   : 1;  /* Set if timeout is set */
  85   unsigned int valid         : 1;  /* Set if scheduler is valid */
  86   unsigned int signal_tasks  : 1;  /* Set if to dispatch signals */
  87 };
  88
  89 /* Locks. These also blocks signals that we care about and thus guarantee
  90    that while we are in scheduler no signals can happen.  This way we can
  91    synchronise signals with SILC Scheduler. */
  92 #define SILC_SCHEDULE_LOCK(schedule)                            \
  93 do {                                                            \
  94   silc_mutex_lock(schedule->lock);                              \
  95   schedule_ops.signals_block(schedule, schedule->internal);     \
  96 } while (0)
  97 #define SILC_SCHEDULE_UNLOCK(schedule)                          \
  98 do {                                                            \
  99   schedule_ops.signals_unblock(schedule, schedule->internal);   \
 100   silc_mutex_unlock(schedule->lock);                            \
 101 } while (0)
 102
 103 /* Platform specific scheduler operations */
 104 typedef struct {
 105   /* Initializes the platform specific scheduler.  This for example initializes
 106      the wakeup mechanism of the scheduler.  In multi-threaded environment
 107      the scheduler needs to be wakenup when tasks are added or removed from
 108      the task queues.  Returns context to the platform specific scheduler.
 109      If this returns NULL the scheduler initialization will fail. */
 110   void *(*init)(SilcSchedule schedule, void *app_context);
 111
 112   /* Uninitializes the platform specific scheduler context. */
 113   void (*uninit)(SilcSchedule schedule, void *context);
 114
 115   /* System specific waiter. This must fill the schedule->fd_dispatch queue
 116      with valid tasks that has something to dispatch, when this returns. */
 117   int (*schedule)(SilcSchedule schedule, void *context);
 118
 119   /* Schedule `task' with events `event_mask'. Zero `event_mask'
 120      unschedules the task. */
 121   SilcBool (*schedule_fd)(SilcSchedule schedule, void *context,
 122                           SilcTaskFd task, SilcTaskEvent event_mask);
 123
 124   /* Wakes up the scheduler. This is platform specific routine */
 125   void (*wakeup)(SilcSchedule schedule, void *context);
 126
 127   /* Register signal */
 128   void (*signal_register)(SilcSchedule schedule, void *context,
 129                           SilcUInt32 signal, SilcTaskCallback callback,
 130                           void *callback_context);
 131
 132   /* Unregister signal */
 133   void (*signal_unregister)(SilcSchedule schedule, void *context,
 134                             SilcUInt32 signal);
 135
 136   /* Call all signals */
 137   void (*signals_call)(SilcSchedule schedule, void *context);
 138
 139   /* Block registered signals in scheduler. */
 140   void (*signals_block)(SilcSchedule schedule, void *context);
 141
 142   /* Unblock registered signals in schedule. */
 143   void (*signals_unblock)(SilcSchedule schedule, void *context);
 144 } SilcScheduleOps;
 145
 146 /* The generic function to add any type of task to the scheduler.  This
 147    used to be exported as is to application, but now they should use the
 148    macro wrappers defined in silcschedule.h.  For Fd task the timeout must
 149    be zero, for timeout task the timeout must not be zero, for signal task
 150    the fd argument is the signal. */
 151 SilcTask silc_schedule_task_add(SilcSchedule schedule, SilcUInt32 fd,
 152                                 SilcTaskCallback callback, void *context,
 153                                 long seconds, long useconds,
 154                                 SilcTaskType type);
 155
 156 #ifdef SILC_DIST_INPLACE
 157 /* Print scheduler statistics to stdout. */
 158 void silc_schedule_stats(SilcSchedule schedule);
 159 #endif /* SILC_DIST_INPLACE */
 160
 161 #endif /* SILCSCHEDULE_I_H */