lib/silcutil/silcschedule.c

   1 /*
   2
   3   silcschedule.c
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1998 - 2005 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 /* $Id$ */
  20
  21 #include "silcincludes.h"
  22 #include "silcschedule_i.h"
  23
  24 /* Forward declarations */
  25 typedef struct SilcTaskQueueStruct *SilcTaskQueue;
  26
  27 /* System specific routines. Implemented under unix/, win32/ and such. */
  28
  29 /* System specific select(). Returns same values as normal select(). */
  30 int silc_select(SilcScheduleFd fds, SilcUInt32 fds_count,
  31                 struct timeval *timeout);
  32
  33 /* Initializes the platform specific scheduler.  This for example initializes
  34    the wakeup mechanism of the scheduler.  In multi-threaded environment
  35    the scheduler needs to be wakenup when tasks are added or removed from
  36    the task queues.  Returns context to the platform specific scheduler. */
  37 void *silc_schedule_internal_init(SilcSchedule schedule, void *context);
  38
  39 /* Uninitializes the platform specific scheduler context. */
  40 void silc_schedule_internal_uninit(void *context);
  41
  42 /* Wakes up the scheduler. This is platform specific routine */
  43 void silc_schedule_internal_wakeup(void *context);
  44
  45 /* Register signal */
  46 void silc_schedule_internal_signal_register(void *context,
  47                                             SilcUInt32 signal,
  48                                             SilcTaskCallback callback,
  49                                             void *callback_context);
  50
  51 /* Unregister signal */
  52 void silc_schedule_internal_signal_unregister(void *context,
  53                                               SilcUInt32 signal,
  54                                               SilcTaskCallback callback,
  55                                               void *callback_context);
  56
  57 /* Mark signal to be called later. */
  58 void silc_schedule_internal_signal_call(void *context, SilcUInt32 signal);
  59
  60 /* Call all signals */
  61 void silc_schedule_internal_signals_call(void *context,
  62                                          SilcSchedule schedule);
  63
  64 /* Block registered signals in scheduler. */
  65 void silc_schedule_internal_signals_block(void *context);
  66
  67 /* Unblock registered signals in schedule. */
  68 void silc_schedule_internal_signals_unblock(void *context);
  69
  70 /* Internal task management routines. */
  71
  72 static void silc_schedule_dispatch_timeout(SilcSchedule schedule,
  73                                            bool dispatch_all);
  74 static void silc_task_queue_alloc(SilcTaskQueue *queue);
  75 static void silc_task_queue_free(SilcTaskQueue queue);
  76 static SilcTask silc_task_find(SilcTaskQueue queue, SilcUInt32 fd);
  77 static SilcTask silc_task_add(SilcTaskQueue queue, SilcTask newtask,
  78                               SilcTaskPriority priority);
  79 static SilcTask silc_task_get_first(SilcTaskQueue queue, SilcTask first);
  80 static SilcTask silc_task_add_timeout(SilcTaskQueue queue, SilcTask newtask,
  81                                       SilcTaskPriority priority);
  82 static int silc_schedule_task_remove(SilcTaskQueue queue, SilcTask task);
  83 static void silc_task_del_by_context(SilcTaskQueue queue, void *context);
  84 static void silc_task_del_by_callback(SilcTaskQueue queue,
  85                                       SilcTaskCallback callback);
  86 static void silc_task_del_by_fd(SilcTaskQueue queue, SilcUInt32 fd);
  87
  88 /* Returns the task queue by task type */
  89 #define SILC_SCHEDULE_GET_QUEUE(type)                           \
  90   (type == SILC_TASK_FD ? schedule->fd_queue :                  \
  91    type == SILC_TASK_TIMEOUT ? schedule->timeout_queue :        \
  92    schedule->generic_queue)
  93
  94 /* Locks. These also blocks signals that we care about and thus guarantee
  95    that while we are in scheduler no signals can happen.  This way we can
  96    synchronise signals with SILC Scheduler. */
  97 #define SILC_SCHEDULE_LOCK(schedule)                            \
  98 do {                                                            \
  99   silc_schedule_internal_signals_block(schedule->internal);     \
 100   silc_mutex_lock(schedule->lock);                              \
 101 } while (0)
 102 #define SILC_SCHEDULE_UNLOCK(schedule)                          \
 103 do {                                                            \
 104   silc_mutex_unlock(schedule->lock);                            \
 105   silc_schedule_internal_signals_unblock(schedule->internal);   \
 106 } while (0)
 107
 108 /* SILC Task object. Represents one task in the scheduler. */
 109 struct SilcTaskStruct {
 110   SilcUInt32 fd;
 111   SilcTaskCallback callback;       /* Task callback */
 112   void *context;                   /* Task callback context */
 113   struct timeval timeout;          /* Set for timeout tasks */
 114   unsigned int valid : 1;          /* Set when task is valid */
 115   unsigned int priority : 2;       /* Priority of the task */
 116   unsigned int type : 5;           /* Type of the task */
 117
 118   /* Pointers forming doubly linked circular list */
 119   struct SilcTaskStruct *next;
 120   struct SilcTaskStruct *prev;
 121 };
 122
 123 /* SILC Task Queue object. The queue holds all the tasks in the scheduler.
 124    There are always three task queues in the scheduler. One for non-timeout
 125    tasks (fd tasks performing tasks over specified file descriptor),
 126    one for timeout tasks and one for generic tasks. */
 127 struct SilcTaskQueueStruct {
 128   SilcTask task;                /* Pointer to all tasks */
 129   struct timeval timeout;       /* Current timeout */
 130   SILC_MUTEX_DEFINE(lock);      /* Queue's lock */
 131 };
 132
 133 /*
 134    SILC Scheduler structure.
 135
 136    This is the actual schedule object in SILC. Both SILC client and server
 137    uses this same scheduler. Actually, this scheduler could be used by any
 138    program needing scheduling.
 139
 140    Following short description of the fields:
 141
 142    SilcTaskQueue fd_queue
 143
 144        Task queue hook for non-timeout tasks. Usually this means that these
 145        tasks perform different kind of I/O on file descriptors. File
 146        descriptors are usually network sockets but they actually can be
 147        any file descriptors. This hook is initialized in silc_schedule_init
 148        function. Timeout tasks should not be added to this queue because
 149        they will never expire.
 150
 151    SilcTaskQueue timeout_queue
 152
 153        Task queue hook for timeout tasks. This hook is reserved specificly
 154        for tasks with timeout. Non-timeout tasks should not be added to this
 155        queue because they will never get scheduled. This hook is also
 156        initialized in silc_schedule_init function.
 157
 158    SilcTaskQueue generic_queue
 159
 160        Task queue hook for generic tasks. This hook is reserved specificly
 161        for generic tasks, tasks that apply to all file descriptors, except
 162        to those that have specificly registered a non-timeout task. This hook
 163        is also initialized in silc_schedule_init function.
 164
 165    SilcScheduleFd fd_list
 166
 167        List of file descriptors the scheduler is supposed to be listenning.
 168        This is updated internally.
 169
 170    SilcUInt32 max_fd
 171    SilcUInt32 last_fd
 172
 173        Size of the fd_list list. There can be `max_fd' many tasks in
 174        the scheduler at once. The `last_fd' is the last valid entry
 175        in the fd_list.
 176
 177    struct timeval *timeout;
 178
 179        Pointer to the schedules next timeout. Value of this timeout is
 180        automatically updated in the silc_schedule function.
 181
 182    bool valid
 183
 184        Marks validity of the scheduler. This is a boolean value. When this
 185        is false the scheduler is terminated and the program will end. This
 186        set to true when the scheduler is initialized with silc_schedule_init
 187        function.
 188
 189    fd_set in
 190    fd_set out
 191
 192        File descriptor sets for select(). These are automatically managed
 193        by the scheduler and should not be touched otherwise.
 194
 195    void *internal
 196
 197        System specific scheduler context.
 198
 199    SILC_MUTEX_DEFINE(lock)
 200
 201        Scheduler lock.
 202
 203    bool signal_tasks
 204
 205        TRUE when tasks has been registered from signals.  Next round in
 206        scheduler will call the callbacks when this is TRUE.
 207
 208 */
 209 struct SilcScheduleStruct {
 210   void *app_context;            /* Application specific context */
 211   SilcTaskQueue fd_queue;
 212   SilcTaskQueue timeout_queue;
 213   SilcTaskQueue generic_queue;
 214   SilcScheduleFd fd_list;
 215   SilcUInt32 max_fd;
 216   SilcUInt32 last_fd;
 217   struct timeval *timeout;
 218   bool valid;
 219   void *internal;
 220   SILC_MUTEX_DEFINE(lock);
 221   bool is_locked;
 222   bool signal_tasks;
 223 };
 224
 225 /* Initializes the scheduler. This returns the scheduler context that
 226    is given as arugment usually to all silc_schedule_* functions.
 227    The `max_tasks' indicates the number of maximum tasks that the
 228    scheduler can handle. The `app_context' is application specific
 229    context that is delivered to task callbacks. */
 230
 231 SilcSchedule silc_schedule_init(int max_tasks, void *app_context)
 232 {
 233   SilcSchedule schedule;
 234
 235   SILC_LOG_DEBUG(("Initializing scheduler"));
 236
 237   schedule = silc_calloc(1, sizeof(*schedule));
 238
 239   /* Allocate three task queues, one for file descriptor based tasks,
 240      one for timeout tasks and one for generic tasks. */
 241   silc_task_queue_alloc(&schedule->fd_queue);
 242   silc_task_queue_alloc(&schedule->timeout_queue);
 243   silc_task_queue_alloc(&schedule->generic_queue);
 244
 245   if (!max_tasks)
 246     max_tasks = 200;
 247
 248   /* Initialize the scheduler */
 249   schedule->fd_list = silc_calloc(max_tasks, sizeof(*schedule->fd_list));
 250   schedule->max_fd = max_tasks;
 251   schedule->timeout = NULL;
 252   schedule->valid = TRUE;
 253   schedule->app_context = app_context;
 254
 255   /* Allocate scheduler lock */
 256   silc_mutex_alloc(&schedule->lock);
 257
 258   /* Initialize the platform specific scheduler. */
 259   schedule->internal = silc_schedule_internal_init(schedule, app_context);
 260
 261   return schedule;
 262 }
 263
 264 /* Uninitializes the schedule. This is called when the program is ready
 265    to end. This removes all tasks and task queues. Returns FALSE if the
 266    scheduler could not be uninitialized. This happens when the scheduler
 267    is still valid and silc_schedule_stop has not been called. */
 268
 269 bool silc_schedule_uninit(SilcSchedule schedule)
 270 {
 271   SILC_LOG_DEBUG(("Uninitializing scheduler"));
 272
 273   if (schedule->valid == TRUE)
 274     return FALSE;
 275
 276   /* Dispatch all timeouts before going away */
 277   SILC_SCHEDULE_LOCK(schedule);
 278   silc_mutex_lock(schedule->timeout_queue->lock);
 279   silc_schedule_dispatch_timeout(schedule, TRUE);
 280   silc_mutex_unlock(schedule->timeout_queue->lock);
 281   SILC_SCHEDULE_UNLOCK(schedule);
 282
 283   /* Deliver signals before going away */
 284   if (schedule->signal_tasks) {
 285     silc_schedule_internal_signals_call(schedule->internal, schedule);
 286     schedule->signal_tasks = FALSE;
 287   }
 288
 289   /* Unregister all tasks */
 290   silc_schedule_task_remove(schedule->fd_queue, SILC_ALL_TASKS);
 291   silc_schedule_task_remove(schedule->timeout_queue, SILC_ALL_TASKS);
 292   silc_schedule_task_remove(schedule->generic_queue, SILC_ALL_TASKS);
 293
 294   /* Unregister all task queues */
 295   silc_task_queue_free(schedule->fd_queue);
 296   silc_task_queue_free(schedule->timeout_queue);
 297   silc_task_queue_free(schedule->generic_queue);
 298
 299   silc_free(schedule->fd_list);
 300
 301   /* Uninit the platform specific scheduler. */
 302   silc_schedule_internal_uninit(schedule->internal);
 303
 304   silc_mutex_free(schedule->lock);
 305   silc_free(schedule);
 306
 307   return TRUE;
 308 }
 309
 310 /* Enlarge the capabilities of the scheduler to handle tasks to `max_tasks'. */
 311
 312 bool silc_schedule_reinit(SilcSchedule schedule, int max_tasks)
 313 {
 314   SILC_SCHEDULE_LOCK(schedule);
 315   if (schedule->max_fd <= max_tasks)
 316     return FALSE;
 317   schedule->fd_list = silc_realloc(schedule->fd_list,
 318                                    (sizeof(*schedule->fd_list) * max_tasks));
 319   schedule->max_fd = max_tasks;
 320   SILC_SCHEDULE_UNLOCK(schedule);
 321   return TRUE;
 322 }
 323
 324 /* Stops the schedule even if it is not supposed to be stopped yet.
 325    After calling this, one should call silc_schedule_uninit (after the
 326    silc_schedule has returned). */
 327
 328 void silc_schedule_stop(SilcSchedule schedule)
 329 {
 330   SILC_LOG_DEBUG(("Stopping scheduler"));
 331   SILC_SCHEDULE_LOCK(schedule);
 332   schedule->valid = FALSE;
 333   SILC_SCHEDULE_UNLOCK(schedule);
 334 }
 335
 336 /* Executes nontimeout tasks. It then checks whether any of ther fd tasks
 337    was signaled by the silc_select. If some task was not signaled then
 338    all generic tasks are executed for that task. The generic tasks are
 339    never executed for task that has explicit fd task set. */
 340 /* This holds the schedule->lock and the queue locks. */
 341
 342 static void silc_schedule_dispatch_nontimeout(SilcSchedule schedule)
 343 {
 344   SilcTask task;
 345   int i;
 346   SilcUInt32 fd, last_fd = schedule->last_fd;
 347   SilcUInt16 revents;
 348
 349   for (i = 0; i <= last_fd; i++) {
 350     if (schedule->fd_list[i].events == 0)
 351       continue;
 352
 353     /* First check whether this fd has task in the fd queue */
 354     silc_mutex_lock(schedule->fd_queue->lock);
 355     fd = schedule->fd_list[i].fd;
 356     task = silc_task_find(schedule->fd_queue, fd);
 357     revents = schedule->fd_list[i].revents;
 358
 359     /* If the task was found then execute its callbacks. If not then
 360        execute all generic tasks for that fd. */
 361     if (task) {
 362       /* Validity of the task is checked always before and after
 363          execution beacuse the task might have been unregistered
 364          in the callback function, ie. it is not valid anymore. */
 365
 366       /* Is the task ready for reading */
 367       if (task->valid && revents & SILC_TASK_READ) {
 368         silc_mutex_unlock(schedule->fd_queue->lock);
 369         SILC_SCHEDULE_UNLOCK(schedule);
 370         task->callback(schedule, schedule->app_context,
 371                        SILC_TASK_READ, task->fd, task->context);
 372         SILC_SCHEDULE_LOCK(schedule);
 373         silc_mutex_lock(schedule->fd_queue->lock);
 374       }
 375
 376       /* Is the task ready for writing */
 377       if (task->valid && revents & SILC_TASK_WRITE) {
 378         silc_mutex_unlock(schedule->fd_queue->lock);
 379         SILC_SCHEDULE_UNLOCK(schedule);
 380         task->callback(schedule, schedule->app_context,
 381                        SILC_TASK_WRITE, task->fd, task->context);
 382         SILC_SCHEDULE_LOCK(schedule);
 383         silc_mutex_lock(schedule->fd_queue->lock);
 384       }
 385
 386       if (!task->valid)
 387         silc_schedule_task_remove(schedule->fd_queue, task);
 388
 389       silc_mutex_unlock(schedule->fd_queue->lock);
 390     } else {
 391       /* Run generic tasks for this fd. */
 392
 393       silc_mutex_unlock(schedule->fd_queue->lock);
 394
 395       silc_mutex_lock(schedule->generic_queue->lock);
 396       if (!schedule->generic_queue->task) {
 397         silc_mutex_unlock(schedule->generic_queue->lock);
 398         continue;
 399       }
 400
 401       task = schedule->generic_queue->task;
 402       while(1) {
 403         /* Validity of the task and fd is checked always before and after
 404            execution beacuse the task might have been unregistered
 405            in the callback function, ie. it is not valid anymore. */
 406
 407         /* Is the task ready for reading */
 408         if (task->valid && revents & SILC_TASK_READ &&
 409             fd == schedule->fd_list[i].fd) {
 410           silc_mutex_unlock(schedule->generic_queue->lock);
 411           SILC_SCHEDULE_UNLOCK(schedule);
 412           task->callback(schedule, schedule->app_context,
 413                          SILC_TASK_READ, fd, task->context);
 414           SILC_SCHEDULE_LOCK(schedule);
 415           silc_mutex_lock(schedule->generic_queue->lock);
 416         }
 417
 418         /* Is the task ready for writing */
 419         if (task->valid && revents & SILC_TASK_WRITE &&
 420             fd == schedule->fd_list[i].fd) {
 421           silc_mutex_unlock(schedule->generic_queue->lock);
 422           SILC_SCHEDULE_UNLOCK(schedule);
 423           task->callback(schedule, schedule->app_context,
 424                          SILC_TASK_WRITE, fd, task->context);
 425           SILC_SCHEDULE_LOCK(schedule);
 426           silc_mutex_lock(schedule->generic_queue->lock);
 427         }
 428
 429         if (!task->valid) {
 430           /* Invalid (unregistered) tasks are removed from the
 431              task queue. */
 432           if (schedule->generic_queue->task == task->next) {
 433             silc_schedule_task_remove(schedule->generic_queue, task);
 434             silc_mutex_unlock(schedule->generic_queue->lock);
 435             break;
 436           }
 437
 438           task = task->next;
 439           silc_schedule_task_remove(schedule->generic_queue, task);
 440           continue;
 441         }
 442
 443         /* Break if there isn't more tasks in the queue */
 444         if (schedule->generic_queue->task == task->next)
 445           break;
 446
 447         task = task->next;
 448       }
 449
 450       silc_mutex_unlock(schedule->generic_queue->lock);
 451     }
 452   }
 453 }
 454
 455 /* Executes all tasks whose timeout has expired. The task is removed from
 456    the task queue after the callback function has returned. Also, invalid
 457    tasks are removed here. We don't have to care about priorities because
 458    tasks are already sorted in their priority order at the registration
 459    phase. */
 460 /* This holds the schedule->lock and the schedule->timeout_queue->lock */
 461
 462 static void silc_schedule_dispatch_timeout(SilcSchedule schedule,
 463                                            bool dispatch_all)
 464 {
 465   SilcTaskQueue queue = schedule->timeout_queue;
 466   SilcTask task;
 467   struct timeval curtime;
 468
 469   SILC_LOG_DEBUG(("Running timeout tasks"));
 470
 471   silc_gettimeofday(&curtime);
 472
 473   queue = schedule->timeout_queue;
 474   if (queue && queue->task) {
 475     task = queue->task;
 476
 477     /* Walk thorugh all tasks in the particular task queue and run all
 478        the expired tasks. */
 479     while(1) {
 480       /* Execute the task if the timeout has expired */
 481       if (dispatch_all ||
 482           silc_compare_timeval(&task->timeout, &curtime)) {
 483         if (task->valid) {
 484           silc_mutex_unlock(queue->lock);
 485           SILC_SCHEDULE_UNLOCK(schedule);
 486           task->callback(schedule, schedule->app_context,
 487                          SILC_TASK_EXPIRE, task->fd, task->context);
 488           SILC_SCHEDULE_LOCK(schedule);
 489           silc_mutex_lock(queue->lock);
 490         }
 491
 492         /* Break if there isn't more tasks in the queue */
 493         if (queue->task == task->next) {
 494           silc_schedule_task_remove(queue, task);
 495           break;
 496         }
 497
 498         task = task->next;
 499
 500         /* Remove the task from queue */
 501         silc_schedule_task_remove(queue, task->prev);
 502       } else {
 503         /* The timeout hasn't expired, check for next one */
 504
 505         /* Break if there isn't more tasks in the queue */
 506         if (queue->task == task->next)
 507           break;
 508
 509         task = task->next;
 510       }
 511     }
 512   }
 513 }
 514
 515 /* Calculates next timeout for select(). This is the timeout value
 516    when at earliest some of the timeout tasks expire. If this is in the
 517    past, they will be run now. */
 518 /* This holds the schedule->lock and the schedule->timeout_queue->lock */
 519
 520 static void silc_schedule_select_timeout(SilcSchedule schedule)
 521 {
 522   SilcTaskQueue queue = schedule->timeout_queue;
 523   SilcTask task;
 524   struct timeval curtime;
 525
 526   /* Get the current time */
 527   silc_gettimeofday(&curtime);
 528   schedule->timeout = NULL;
 529
 530   /* First task in the task queue has always the smallest timeout. */
 531   task = queue->task;
 532   while(1) {
 533     if (task && task->valid == TRUE) {
 534       /* If the timeout is in past, we will run the task and all other
 535          timeout tasks from the past. */
 536       if (silc_compare_timeval(&task->timeout, &curtime)) {
 537         silc_schedule_dispatch_timeout(schedule, FALSE);
 538
 539         /* The task(s) has expired and doesn't exist on the task queue
 540            anymore. We continue with new timeout. */
 541         queue = schedule->timeout_queue;
 542         task = queue->task;
 543         if (task == NULL || task->valid == FALSE)
 544           break;
 545       }
 546
 547       /* Calculate the next timeout for select() */
 548       queue->timeout.tv_sec = task->timeout.tv_sec - curtime.tv_sec;
 549       queue->timeout.tv_usec = task->timeout.tv_usec - curtime.tv_usec;
 550       if (queue->timeout.tv_sec < 0)
 551         queue->timeout.tv_sec = 0;
 552
 553       /* We wouldn't want to go under zero, check for it. */
 554       if (queue->timeout.tv_usec < 0) {
 555         queue->timeout.tv_sec -= 1;
 556         if (queue->timeout.tv_sec < 0)
 557           queue->timeout.tv_sec = 0;
 558         queue->timeout.tv_usec += 1000000L;
 559       }
 560
 561       /* We've got the timeout value */
 562       break;
 563     } else {
 564       /* Task is not valid, remove it and try next one. */
 565       silc_schedule_task_remove(queue, task);
 566       task = queue->task;
 567       if (queue->task == NULL)
 568         break;
 569     }
 570   }
 571
 572   /* Save the timeout */
 573   if (task) {
 574     schedule->timeout = &queue->timeout;
 575     SILC_LOG_DEBUG(("timeout: sec=%d, usec=%d", schedule->timeout->tv_sec,
 576                     schedule->timeout->tv_usec));
 577   }
 578 }
 579
 580 /* Runs the scheduler once and then returns. */
 581
 582 bool silc_schedule_one(SilcSchedule schedule, int timeout_usecs)
 583 {
 584   struct timeval timeout;
 585   int ret;
 586
 587   SILC_LOG_DEBUG(("In scheduler loop"));
 588
 589   if (!schedule->is_locked)
 590     SILC_SCHEDULE_LOCK(schedule);
 591
 592   /* Deliver signals if any has been set to be called */
 593   if (schedule->signal_tasks) {
 594     SILC_SCHEDULE_UNLOCK(schedule);
 595     silc_schedule_internal_signals_call(schedule->internal, schedule);
 596     schedule->signal_tasks = FALSE;
 597     SILC_SCHEDULE_LOCK(schedule);
 598   }
 599
 600   /* If the task queues aren't initialized or we aren't valid anymore
 601      we will return */
 602   if ((!schedule->fd_queue && !schedule->timeout_queue
 603        && !schedule->generic_queue) || schedule->valid == FALSE) {
 604     SILC_LOG_DEBUG(("Scheduler not valid anymore, exiting"));
 605     if (!schedule->is_locked)
 606       SILC_SCHEDULE_UNLOCK(schedule);
 607     return FALSE;
 608   }
 609
 610   /* If the task queues aren't initialized or we aren't valid anymore
 611      we will return */
 612   if ((!schedule->fd_queue && !schedule->timeout_queue
 613        && !schedule->generic_queue) || schedule->valid == FALSE) {
 614     SILC_LOG_DEBUG(("Scheduler not valid anymore, exiting"));
 615     if (!schedule->is_locked)
 616       SILC_SCHEDULE_UNLOCK(schedule);
 617     return FALSE;
 618   }
 619
 620   /* Calculate next timeout for silc_select(). This is the timeout value
 621      when at earliest some of the timeout tasks expire. */
 622   silc_mutex_lock(schedule->timeout_queue->lock);
 623   silc_schedule_select_timeout(schedule);
 624   silc_mutex_unlock(schedule->timeout_queue->lock);
 625
 626   if (timeout_usecs >= 0) {
 627     timeout.tv_sec = 0;
 628     timeout.tv_usec = timeout_usecs;
 629     schedule->timeout = &timeout;
 630   }
 631
 632   SILC_SCHEDULE_UNLOCK(schedule);
 633
 634   /* This is the main select(). The program blocks here until some
 635      of the selected file descriptors change status or the selected
 636      timeout expires. */
 637   SILC_LOG_DEBUG(("Select"));
 638   ret = silc_select(schedule->fd_list, schedule->last_fd + 1,
 639                     schedule->timeout);
 640
 641   SILC_SCHEDULE_LOCK(schedule);
 642
 643   switch (ret) {
 644   case -1:
 645     /* Error */
 646     if (errno == EINTR)
 647       break;
 648     SILC_LOG_ERROR(("Error in select(): %s", strerror(errno)));
 649     break;
 650   case 0:
 651     /* Timeout */
 652     silc_mutex_lock(schedule->timeout_queue->lock);
 653     silc_schedule_dispatch_timeout(schedule, FALSE);
 654     silc_mutex_unlock(schedule->timeout_queue->lock);
 655     break;
 656   default:
 657     /* There is some data available now */
 658     SILC_LOG_DEBUG(("Running non-timeout tasks"));
 659     silc_schedule_dispatch_nontimeout(schedule);
 660     break;
 661   }
 662
 663   if (!schedule->is_locked)
 664     SILC_SCHEDULE_UNLOCK(schedule);
 665
 666   return TRUE;
 667 }
 668
 669 /* The SILC scheduler. This is actually the main routine in SILC programs.
 670    When this returns the program is to be ended. Before this function can
 671    be called, one must call silc_schedule_init function. */
 672
 673 void silc_schedule(SilcSchedule schedule)
 674 {
 675   SILC_LOG_DEBUG(("Running scheduler"));
 676
 677   if (schedule->valid == FALSE) {
 678     SILC_LOG_ERROR(("Scheduler is not valid, stopping"));
 679     return;
 680   }
 681
 682   SILC_SCHEDULE_LOCK(schedule);
 683   schedule->is_locked = TRUE;
 684
 685   /* Start the scheduler loop */
 686   while (silc_schedule_one(schedule, -1))
 687     ;
 688
 689   SILC_SCHEDULE_UNLOCK(schedule);
 690 }
 691
 692 /* Wakes up the scheduler. This is used only in multi-threaded
 693    environments where threads may add new tasks or remove old tasks
 694    from task queues. This is called to wake up the scheduler in the
 695    main thread so that it detects the changes in the task queues.
 696    If threads support is not compiled in this function has no effect.
 697    Implementation of this function is platform specific. */
 698
 699 void silc_schedule_wakeup(SilcSchedule schedule)
 700 {
 701 #ifdef SILC_THREADS
 702   SILC_LOG_DEBUG(("Wakeup scheduler"));
 703   SILC_SCHEDULE_LOCK(schedule);
 704   silc_schedule_internal_wakeup(schedule->internal);
 705   SILC_SCHEDULE_UNLOCK(schedule);
 706 #endif
 707 }
 708
 709 /* Returns the application specific context that was saved into the
 710    scheduler in silc_schedule_init function.  The context is also
 711    returned to application in task callback functions, but this function
 712    may be used to get it as well if needed. */
 713
 714 void *silc_schedule_get_context(SilcSchedule schedule)
 715 {
 716   return schedule->app_context;
 717 }
 718
 719 /* Add new task to the scheduler */
 720
 721 SilcTask silc_schedule_task_add(SilcSchedule schedule, SilcUInt32 fd,
 722                                 SilcTaskCallback callback, void *context,
 723                                 long seconds, long useconds,
 724                                 SilcTaskType type,
 725                                 SilcTaskPriority priority)
 726 {
 727   SilcTask newtask;
 728   SilcTaskQueue queue;
 729   int timeout = FALSE;
 730
 731   if (!schedule->valid)
 732     return NULL;
 733
 734   queue = SILC_SCHEDULE_GET_QUEUE(type);
 735
 736   /* If the task is generic task, we check whether this task has already
 737      been registered. Generic tasks are registered only once and after that
 738      the same task applies to all file descriptors to be registered. */
 739   if (type == SILC_TASK_GENERIC) {
 740     silc_mutex_lock(queue->lock);
 741
 742     SILC_LOG_DEBUG(("Registering new task, fd=%d type=%d priority=%d", fd,
 743                     type, priority));
 744
 745     if (queue->task) {
 746       SilcTask task = queue->task;
 747       while(1) {
 748         if ((task->callback == callback) && (task->context == context)) {
 749           SILC_LOG_DEBUG(("Found matching generic task, using the match"));
 750
 751           silc_mutex_unlock(queue->lock);
 752
 753           /* Add the fd to be listened, the task found now applies to this
 754              fd as well. */
 755           silc_schedule_set_listen_fd(schedule, fd, SILC_TASK_READ, FALSE);
 756           return task;
 757         }
 758
 759         if (queue->task == task->next)
 760           break;
 761
 762         task = task->next;
 763       }
 764     }
 765
 766     silc_mutex_unlock(queue->lock);
 767   }
 768
 769   newtask = silc_calloc(1, sizeof(*newtask));
 770   if (!newtask)
 771     return NULL;
 772
 773   SILC_LOG_DEBUG(("Registering new task %p, fd=%d type=%d priority=%d",
 774                   newtask, fd, type, priority));
 775
 776   newtask->fd = fd;
 777   newtask->context = context;
 778   newtask->callback = callback;
 779   newtask->valid = TRUE;
 780   newtask->priority = priority;
 781   newtask->type = type;
 782   newtask->next = newtask;
 783   newtask->prev = newtask;
 784
 785   /* Create timeout if marked to be timeout task */
 786   if (((seconds + useconds) > 0) && (type == SILC_TASK_TIMEOUT)) {
 787     silc_gettimeofday(&newtask->timeout);
 788     newtask->timeout.tv_sec += seconds + (useconds / 1000000L);
 789     newtask->timeout.tv_usec += (useconds % 1000000L);
 790     if (newtask->timeout.tv_usec > 999999L) {
 791       newtask->timeout.tv_sec += 1;
 792       newtask->timeout.tv_usec -= 1000000L;
 793     }
 794     timeout = TRUE;
 795   }
 796
 797   /* If the task is non-timeout task we have to tell the scheduler that we
 798      would like to have these tasks scheduled at some odd distant future. */
 799   if (type != SILC_TASK_TIMEOUT)
 800     silc_schedule_set_listen_fd(schedule, fd, SILC_TASK_READ, FALSE);
 801
 802   silc_mutex_lock(queue->lock);
 803
 804   /* Is this first task of the queue? */
 805   if (queue->task == NULL) {
 806     queue->task = newtask;
 807     silc_mutex_unlock(queue->lock);
 808     return newtask;
 809   }
 810
 811   if (timeout)
 812     newtask = silc_task_add_timeout(queue, newtask, priority);
 813   else
 814     newtask = silc_task_add(queue, newtask, priority);
 815
 816   silc_mutex_unlock(queue->lock);
 817
 818   return newtask;
 819 }
 820
 821 /* Removes a task from the scheduler */
 822
 823 void silc_schedule_task_del(SilcSchedule schedule, SilcTask task)
 824 {
 825   SilcTaskQueue queue = SILC_SCHEDULE_GET_QUEUE(task->type);
 826
 827   /* Unregister all tasks */
 828   if (task == SILC_ALL_TASKS) {
 829     SilcTask next;
 830     SILC_LOG_DEBUG(("Unregistering all tasks at once"));
 831
 832     silc_mutex_lock(queue->lock);
 833
 834     if (!queue->task) {
 835       silc_mutex_unlock(queue->lock);
 836       return;
 837     }
 838
 839     next = queue->task;
 840
 841     while(1) {
 842       if (next->valid)
 843         next->valid = FALSE;
 844       if (queue->task == next->next)
 845         break;
 846       next = next->next;
 847     }
 848
 849     silc_mutex_unlock(queue->lock);
 850     return;
 851   }
 852
 853   SILC_LOG_DEBUG(("Unregistering task"));
 854
 855   silc_mutex_lock(queue->lock);
 856
 857   /* Unregister the specific task */
 858   if (task->valid)
 859     task->valid = FALSE;
 860
 861   silc_mutex_unlock(queue->lock);
 862 }
 863
 864 /* Remove task by fd */
 865
 866 void silc_schedule_task_del_by_fd(SilcSchedule schedule, SilcUInt32 fd)
 867 {
 868   SILC_LOG_DEBUG(("Unregister task by fd %d", fd));
 869
 870   silc_task_del_by_fd(schedule->timeout_queue, fd);
 871   silc_task_del_by_fd(schedule->fd_queue, fd);
 872 }
 873
 874 /* Remove task by task callback. */
 875
 876 void silc_schedule_task_del_by_callback(SilcSchedule schedule,
 877                                         SilcTaskCallback callback)
 878 {
 879   SILC_LOG_DEBUG(("Unregister task by callback"));
 880
 881   silc_task_del_by_callback(schedule->timeout_queue, callback);
 882   silc_task_del_by_callback(schedule->fd_queue, callback);
 883   silc_task_del_by_callback(schedule->generic_queue, callback);
 884 }
 885
 886 /* Remove task by context. */
 887
 888 void silc_schedule_task_del_by_context(SilcSchedule schedule, void *context)
 889 {
 890   SILC_LOG_DEBUG(("Unregister task by context"));
 891
 892   silc_task_del_by_context(schedule->timeout_queue, context);
 893   silc_task_del_by_context(schedule->fd_queue, context);
 894   silc_task_del_by_context(schedule->generic_queue, context);
 895 }
 896
 897 /* Sets a file descriptor to be listened by select() in scheduler. One can
 898    call this directly if wanted. This can be called multiple times for
 899    one file descriptor to set different iomasks. */
 900
 901 void silc_schedule_set_listen_fd(SilcSchedule schedule, SilcUInt32 fd,
 902                                  SilcTaskEvent mask, bool send_events)
 903 {
 904   int i;
 905   bool found = FALSE;
 906
 907   if (!schedule->valid)
 908     return;
 909
 910   SILC_SCHEDULE_LOCK(schedule);
 911
 912   for (i = 0; i < schedule->max_fd; i++)
 913     if (schedule->fd_list[i].fd == fd) {
 914       schedule->fd_list[i].fd = fd;
 915       schedule->fd_list[i].events = mask;
 916       schedule->fd_list[i].revents = 0;
 917       if (i > schedule->last_fd)
 918         schedule->last_fd = i;
 919       found = TRUE;
 920       if (send_events) {
 921         schedule->fd_list[i].revents = mask;
 922         silc_schedule_dispatch_nontimeout(schedule);
 923       }
 924       break;
 925     }
 926
 927   if (!found)
 928     for (i = 0; i < schedule->max_fd; i++)
 929       if (schedule->fd_list[i].events == 0) {
 930         schedule->fd_list[i].fd = fd;
 931         schedule->fd_list[i].events = mask;
 932         schedule->fd_list[i].revents = 0;
 933         if (i > schedule->last_fd)
 934           schedule->last_fd = i;
 935         if (send_events) {
 936           schedule->fd_list[i].revents = mask;
 937           silc_schedule_dispatch_nontimeout(schedule);
 938         }
 939         break;
 940       }
 941
 942   SILC_SCHEDULE_UNLOCK(schedule);
 943 }
 944
 945 /* Removes a file descriptor from listen list. */
 946
 947 void silc_schedule_unset_listen_fd(SilcSchedule schedule, SilcUInt32 fd)
 948 {
 949   int i;
 950
 951   SILC_SCHEDULE_LOCK(schedule);
 952
 953   SILC_LOG_DEBUG(("Unset listen fd %d", fd));
 954
 955   for (i = 0; i < schedule->max_fd; i++)
 956     if (schedule->fd_list[i].fd == fd) {
 957       schedule->fd_list[i].fd = 0;
 958       schedule->fd_list[i].events = 0;
 959       schedule->fd_list[i].revents = 0;
 960       if (schedule->last_fd == i && i > 0)
 961         schedule->last_fd = i - 1;
 962       break;
 963     }
 964
 965   SILC_SCHEDULE_UNLOCK(schedule);
 966 }
 967
 968 /* Register a new signal */
 969
 970 void silc_schedule_signal_register(SilcSchedule schedule, SilcUInt32 signal,
 971                                    SilcTaskCallback callback, void *context)
 972 {
 973   silc_schedule_internal_signal_register(schedule->internal, signal,
 974                                          callback, context);
 975 }
 976
 977 /* Unregister a new signal */
 978
 979 void silc_schedule_signal_unregister(SilcSchedule schedule, SilcUInt32 signal,
 980                                      SilcTaskCallback callback, void *context)
 981 {
 982   silc_schedule_internal_signal_unregister(schedule->internal, signal,
 983                                            callback, context);
 984 }
 985
 986 /* Call signal indicated by `signal'. */
 987
 988 void silc_schedule_signal_call(SilcSchedule schedule, SilcUInt32 signal)
 989 {
 990   /* Mark that signals needs to be delivered later. */
 991   silc_schedule_internal_signal_call(schedule->internal, signal);
 992   schedule->signal_tasks = TRUE;
 993 }
 994
 995 /* Allocates a newtask task queue into the scheduler */
 996
 997 static void silc_task_queue_alloc(SilcTaskQueue *queue)
 998 {
 999   *queue = silc_calloc(1, sizeof(**queue));
1000   silc_mutex_alloc(&(*queue)->lock);
1001 }
1002
1003 /* Free's a task queue. */
1004
1005 static void silc_task_queue_free(SilcTaskQueue queue)
1006 {
1007   silc_mutex_free(queue->lock);
1008   memset(queue, 'F', sizeof(*queue));
1009   silc_free(queue);
1010 }
1011
1012 /* Return task by its fd. */
1013
1014 static SilcTask silc_task_find(SilcTaskQueue queue, SilcUInt32 fd)
1015 {
1016   SilcTask next;
1017
1018   if (!queue->task)
1019     return NULL;
1020
1021   next = queue->task;
1022
1023   while (1) {
1024     if (next->fd == fd)
1025       return next;
1026     if (queue->task == next->next)
1027       return NULL;
1028     next = next->next;
1029   }
1030
1031   return NULL;
1032 }
1033
1034 /* Adds a non-timeout task into the task queue. This function is used
1035    by silc_task_register function. Returns a pointer to the registered
1036    task. */
1037
1038 static SilcTask silc_task_add(SilcTaskQueue queue, SilcTask newtask,
1039                               SilcTaskPriority priority)
1040 {
1041   SilcTask task, next, prev;
1042
1043   /* Take the first task in the queue */
1044   task = queue->task;
1045
1046   switch(priority) {
1047   case SILC_TASK_PRI_LOW:
1048     /* Lowest priority. The task is added at the end of the list. */
1049     prev = task->prev;
1050     newtask->prev = prev;
1051     newtask->next = task;
1052     prev->next = newtask;
1053     task->prev = newtask;
1054     break;
1055   case SILC_TASK_PRI_NORMAL:
1056     /* Normal priority. The task is added before lower priority tasks
1057        but after tasks with higher priority. */
1058     prev = task->prev;
1059     while(prev != task) {
1060       if (prev->priority > SILC_TASK_PRI_LOW)
1061         break;
1062       prev = prev->prev;
1063     }
1064     if (prev == task) {
1065       /* There are only lower priorities in the list, we will
1066          sit before them and become the first task in the queue. */
1067       prev = task->prev;
1068       newtask->prev = prev;
1069       newtask->next = task;
1070       task->prev = newtask;
1071       prev->next = newtask;
1072
1073       /* We are now the first task in queue */
1074       queue->task = newtask;
1075     } else {
1076       /* Found a spot from the list, add the task to the list. */
1077       next = prev->next;
1078       newtask->prev = prev;
1079       newtask->next = next;
1080       prev->next = newtask;
1081       next->prev = newtask;
1082     }
1083     break;
1084   default:
1085     silc_free(newtask);
1086     return NULL;
1087   }
1088
1089   return newtask;
1090 }
1091
1092 /* Return the timeout task with smallest timeout. */
1093
1094 static SilcTask silc_task_get_first(SilcTaskQueue queue, SilcTask first)
1095 {
1096   SilcTask prev, task;
1097
1098   prev = first->prev;
1099
1100   if (first == prev)
1101     return first;
1102
1103   task = first;
1104   while (1) {
1105     if (first == prev)
1106       break;
1107
1108     if (silc_compare_timeval(&prev->timeout, &task->timeout))
1109       task = prev;
1110
1111     prev = prev->prev;
1112   }
1113
1114   return task;
1115 }
1116
1117 /* Adds a timeout task into the task queue. This function is used by
1118    silc_task_register function. Returns a pointer to the registered
1119    task. Timeout tasks are sorted by their timeout value in ascending
1120    order. The priority matters if there are more than one task with
1121    same timeout. */
1122
1123 static SilcTask silc_task_add_timeout(SilcTaskQueue queue, SilcTask newtask,
1124                                       SilcTaskPriority priority)
1125 {
1126   SilcTask task, prev, next;
1127
1128   /* Take the first task in the queue */
1129   task = queue->task;
1130
1131   /* Take last task from the list */
1132   prev = task->prev;
1133
1134   switch(priority) {
1135   case SILC_TASK_PRI_LOW:
1136     /* Lowest priority. The task is added at the end of the list. */
1137     while(prev != task) {
1138
1139       /* If we have longer timeout than with the task head of us
1140          we have found our spot. */
1141       if (silc_compare_timeval(&prev->timeout, &newtask->timeout))
1142         break;
1143
1144       /* If we are equal size of timeout we will be after it. */
1145       if (!silc_compare_timeval(&newtask->timeout, &prev->timeout))
1146         break;
1147
1148       /* We have shorter timeout, compare to next one. */
1149       prev = prev->prev;
1150     }
1151     /* Found a spot from the list, add the task to the list. */
1152     next = prev->next;
1153     newtask->prev = prev;
1154     newtask->next = next;
1155     prev->next = newtask;
1156     next->prev = newtask;
1157
1158     if (prev == task) {
1159       /* Check if we are going to be the first task in the queue */
1160       if (silc_compare_timeval(&prev->timeout, &newtask->timeout))
1161         break;
1162       if (!silc_compare_timeval(&newtask->timeout, &prev->timeout))
1163         break;
1164
1165       /* We are now the first task in queue */
1166       queue->task = newtask;
1167     }
1168     break;
1169   case SILC_TASK_PRI_NORMAL:
1170     /* Normal priority. The task is added before lower priority tasks
1171        but after tasks with higher priority. */
1172     while(prev != task) {
1173
1174       /* If we have longer timeout than with the task head of us
1175          we have found our spot. */
1176       if (silc_compare_timeval(&prev->timeout, &newtask->timeout))
1177         break;
1178
1179       /* If we are equal size of timeout, priority kicks in place. */
1180       if (!silc_compare_timeval(&newtask->timeout, &prev->timeout))
1181         if (prev->priority >= SILC_TASK_PRI_NORMAL)
1182           break;
1183
1184       /* We have shorter timeout or higher priority, compare to next one. */
1185       prev = prev->prev;
1186     }
1187     /* Found a spot from the list, add the task to the list. */
1188     next = prev->next;
1189     newtask->prev = prev;
1190     newtask->next = next;
1191     prev->next = newtask;
1192     next->prev = newtask;
1193
1194     if (prev == task) {
1195       /* Check if we are going to be the first task in the queue */
1196       if (silc_compare_timeval(&prev->timeout, &newtask->timeout))
1197         break;
1198       if (!silc_compare_timeval(&newtask->timeout, &prev->timeout))
1199         if (prev->priority >= SILC_TASK_PRI_NORMAL)
1200           break;
1201
1202       /* We are now the first task in queue */
1203       queue->task = newtask;
1204     }
1205     break;
1206   default:
1207     silc_free(newtask);
1208     return NULL;
1209   }
1210
1211   return newtask;
1212 }
1213
1214 /* Removes (unregisters) a task from particular task queue. This function
1215    is used internally by scheduler. This must be called holding the
1216    queue->lock. */
1217
1218 static int silc_schedule_task_remove(SilcTaskQueue queue, SilcTask task)
1219 {
1220   SilcTask first, old, next;
1221
1222   if (!queue || !task)
1223     return FALSE;
1224
1225   if (!queue->task) {
1226     return FALSE;
1227   }
1228
1229   first = queue->task;
1230
1231   /* Unregister all tasks in queue */
1232   if (task == SILC_ALL_TASKS) {
1233     SILC_LOG_DEBUG(("Removing all tasks at once"));
1234     next = first;
1235
1236     while(1) {
1237       old = next->next;
1238       silc_free(next);
1239       if (old == first)
1240         break;
1241       next = old;
1242     }
1243
1244     queue->task = NULL;
1245     return TRUE;
1246   }
1247
1248   SILC_LOG_DEBUG(("Removing task %p", task));
1249
1250   /* Unregister the task */
1251   old = first;
1252   while(1) {
1253     if (old == task) {
1254       SilcTask prev, next;
1255
1256       prev = old->prev;
1257       next = old->next;
1258       prev->next = next;
1259       next->prev = prev;
1260
1261       if (prev == old && next == old)
1262         queue->task = NULL;
1263       if (queue->task == old)
1264         queue->task = silc_task_get_first(queue, next);
1265
1266       silc_free(old);
1267       return TRUE;
1268     }
1269     old = old->prev;
1270
1271     if (old == first) {
1272       return FALSE;
1273     }
1274   }
1275 }
1276
1277 static void silc_task_del_by_fd(SilcTaskQueue queue, SilcUInt32 fd)
1278 {
1279   SilcTask next;
1280
1281   silc_mutex_lock(queue->lock);
1282
1283   if (!queue->task) {
1284     silc_mutex_unlock(queue->lock);
1285     return;
1286   }
1287
1288   next = queue->task;
1289
1290   while(1) {
1291     if (next->fd == fd)
1292       next->valid = FALSE;
1293     if (queue->task == next->next)
1294       break;
1295     next = next->next;
1296   }
1297
1298   silc_mutex_unlock(queue->lock);
1299 }
1300
1301 static void silc_task_del_by_callback(SilcTaskQueue queue,
1302                                       SilcTaskCallback callback)
1303 {
1304   SilcTask next;
1305
1306   silc_mutex_lock(queue->lock);
1307
1308   if (!queue->task) {
1309     silc_mutex_unlock(queue->lock);
1310     return;
1311   }
1312
1313   next = queue->task;
1314
1315   while(1) {
1316     if (next->callback == callback)
1317       next->valid = FALSE;
1318     if (queue->task == next->next)
1319       break;
1320     next = next->next;
1321   }
1322
1323   silc_mutex_unlock(queue->lock);
1324 }
1325
1326 static void silc_task_del_by_context(SilcTaskQueue queue, void *context)
1327 {
1328   SilcTask next;
1329
1330   silc_mutex_lock(queue->lock);
1331
1332   if (!queue->task) {
1333     silc_mutex_unlock(queue->lock);
1334     return;
1335   }
1336
1337   next = queue->task;
1338
1339   while(1) {
1340     if (next->context == context)
1341       next->valid = FALSE;
1342     if (queue->task == next->next)
1343       break;
1344     next = next->next;
1345   }
1346
1347   silc_mutex_unlock(queue->lock);
1348 }