src/util/scheduler.c

   1 /*
   2       This file is part of GNUnet
   3       (C) 2009 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 2, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file util/scheduler.c
  23  * @brief schedule computations using continuation passing style
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_common.h"
  28 #include "gnunet_os_lib.h"
  29 #include "gnunet_scheduler_lib.h"
  30 #include "gnunet_signal_lib.h"
  31 #include "gnunet_time_lib.h"
  32 #include "disk.h"
  33 #ifdef LINUX
  34 #include "execinfo.h"
  35
  36
  37 /**
  38  * Use lsof to generate file descriptor reports on select error?
  39  * (turn off for stable releases).
  40  */
  41 #define USE_LSOF GNUNET_YES
  42
  43 /**
  44  * Obtain trace information for all scheduler calls that schedule tasks.
  45  */
  46 #define EXECINFO GNUNET_NO
  47
  48 /**
  49  * Depth of the traces collected via EXECINFO.
  50  */
  51 #define MAX_TRACE_DEPTH 50
  52 #endif
  53
  54 #define DEBUG_TASKS GNUNET_NO
  55
  56 /**
  57  * Should we figure out which tasks are delayed for a while
  58  * before they are run? (Consider using in combination with EXECINFO).
  59  */
  60 #define PROFILE_DELAYS GNUNET_NO
  61
  62 /**
  63  * Task that were in the queue for longer than this are reported if
  64  * PROFILE_DELAYS is active.
  65  */
  66 #define DELAY_THRESHOLD GNUNET_TIME_UNIT_SECONDS
  67
  68 /**
  69  * Linked list of pending tasks.
  70  */
  71 struct Task
  72 {
  73   /**
  74    * This is a linked list.
  75    */
  76   struct Task *next;
  77
  78   /**
  79    * Function to run when ready.
  80    */
  81   GNUNET_SCHEDULER_Task callback;
  82
  83   /**
  84    * Closure for the callback.
  85    */
  86   void *callback_cls;
  87
  88   /**
  89    * Set of file descriptors this task is waiting
  90    * for for reading.  Once ready, this is updated
  91    * to reflect the set of file descriptors ready
  92    * for operation.
  93    */
  94   struct GNUNET_NETWORK_FDSet *read_set;
  95
  96   /**
  97    * Set of file descriptors this task is waiting for for writing.
  98    * Once ready, this is updated to reflect the set of file
  99    * descriptors ready for operation.
 100    */
 101   struct GNUNET_NETWORK_FDSet *write_set;
 102
 103   /**
 104    * Unique task identifier.
 105    */
 106   GNUNET_SCHEDULER_TaskIdentifier id;
 107
 108   /**
 109    * Identifier of a prerequisite task.
 110    */
 111   GNUNET_SCHEDULER_TaskIdentifier prereq_id;
 112
 113   /**
 114    * Absolute timeout value for the task, or
 115    * GNUNET_TIME_UNIT_FOREVER_ABS for "no timeout".
 116    */
 117   struct GNUNET_TIME_Absolute timeout;
 118
 119 #if PROFILE_DELAYS
 120   /**
 121    * When was the task scheduled?
 122    */
 123   struct GNUNET_TIME_Absolute start_time;
 124 #endif
 125
 126   /**
 127    * Why is the task ready?  Set after task is added to ready queue.
 128    * Initially set to zero.  All reasons that have already been
 129    * satisfied (i.e.  read or write ready) will be set over time.
 130    */
 131   enum GNUNET_SCHEDULER_Reason reason;
 132
 133   /**
 134    * Task priority.
 135    */
 136   enum GNUNET_SCHEDULER_Priority priority;
 137
 138   /**
 139    * Set if we only wait for reading from a single FD, otherwise -1.
 140    */
 141   int read_fd;
 142
 143   /**
 144    * Set if we only wait for writing to a single FD, otherwise -1.
 145    */
 146   int write_fd;
 147
 148 #if EXECINFO
 149   /**
 150    * Array of strings which make up a backtrace from the point when this
 151    * task was scheduled (essentially, who scheduled the task?)
 152    */
 153   char **backtrace_strings;
 154
 155   /**
 156    * Size of the backtrace_strings array
 157    */
 158   int num_backtrace_strings;
 159 #endif
 160
 161
 162 };
 163
 164
 165 /**
 166  * List of tasks waiting for an event.
 167  */
 168 static struct Task *pending;
 169
 170 /**
 171  * List of tasks waiting ONLY for a timeout event.
 172  * Sorted by timeout (earliest first).  Used so that
 173  * we do not traverse the list of these tasks when
 174  * building select sets (we just look at the head
 175  * to determine the respective timeout ONCE).
 176  */
 177 static struct Task *pending_timeout;
 178
 179 /**
 180  * Last inserted task waiting ONLY for a timeout event.
 181  * Used to (heuristically) speed up insertion.
 182  */
 183 static struct Task *pending_timeout_last;
 184
 185 /**
 186  * ID of the task that is running right now.
 187  */
 188 static struct Task *active_task;
 189
 190 /**
 191  * List of tasks ready to run right now,
 192  * grouped by importance.
 193  */
 194 static struct Task *ready[GNUNET_SCHEDULER_PRIORITY_COUNT];
 195
 196 /**
 197  * Identity of the last task queued.  Incremented for each task to
 198  * generate a unique task ID (it is virtually impossible to start
 199  * more than 2^64 tasks during the lifetime of a process).
 200  */
 201 static GNUNET_SCHEDULER_TaskIdentifier last_id;
 202
 203 /**
 204  * Highest number so that all tasks with smaller identifiers
 205  * have already completed.  Also the lowest number of a task
 206  * still waiting to be executed.
 207  */
 208 static GNUNET_SCHEDULER_TaskIdentifier lowest_pending_id;
 209
 210 /**
 211  * Number of tasks on the ready list.
 212  */
 213 static unsigned int ready_count;
 214
 215 /**
 216  * How many tasks have we run so far?
 217  */
 218 static unsigned long long tasks_run;
 219
 220 /**
 221  * Priority of the task running right now.  Only
 222  * valid while a task is running.
 223  */
 224 static enum GNUNET_SCHEDULER_Priority current_priority;
 225
 226 /**
 227  * Priority of the highest task added in the current select
 228  * iteration.
 229  */
 230 static enum GNUNET_SCHEDULER_Priority max_priority_added;
 231
 232
 233 /**
 234  * Check that the given priority is legal (and return it).
 235  *
 236  * @param p priority value to check
 237  * @return p on success, 0 on error
 238  */
 239 static enum GNUNET_SCHEDULER_Priority
 240 check_priority (enum GNUNET_SCHEDULER_Priority p)
 241 {
 242   if ((p >= 0) && (p < GNUNET_SCHEDULER_PRIORITY_COUNT))
 243     return p;
 244   GNUNET_assert (0);
 245   return 0;                     /* make compiler happy */
 246 }
 247
 248
 249 /**
 250  * Is a task with this identifier still pending?  Also updates
 251  * "lowest_pending_id" as a side-effect (for faster checks in the
 252  * future), but only if the return value is "GNUNET_NO" (and
 253  * the "lowest_pending_id" check failed).
 254  *
 255  * @param id which task are we checking for
 256  * @return GNUNET_YES if so, GNUNET_NO if not
 257  */
 258 static int
 259 is_pending (GNUNET_SCHEDULER_TaskIdentifier id)
 260 {
 261   struct Task *pos;
 262   enum GNUNET_SCHEDULER_Priority p;
 263   GNUNET_SCHEDULER_TaskIdentifier min;
 264
 265   if (id < lowest_pending_id)
 266     return GNUNET_NO;
 267   min = -1;                     /* maximum value */
 268   pos = pending;
 269   while (pos != NULL)
 270     {
 271       if (pos->id == id)
 272         return GNUNET_YES;
 273       if (pos->id < min)
 274         min = pos->id;
 275       pos = pos->next;
 276     }
 277   pos = pending_timeout;
 278   while (pos != NULL)
 279     {
 280       if (pos->id == id)
 281         return GNUNET_YES;
 282       if (pos->id < min)
 283         min = pos->id;
 284       pos = pos->next;
 285     }
 286   for (p = 0; p < GNUNET_SCHEDULER_PRIORITY_COUNT; p++)
 287     {
 288       pos = ready[p];
 289       while (pos != NULL)
 290         {
 291           if (pos->id == id)
 292             return GNUNET_YES;
 293           if (pos->id < min)
 294             min = pos->id;
 295           pos = pos->next;
 296         }
 297     }
 298   lowest_pending_id = min;
 299   return GNUNET_NO;
 300 }
 301
 302
 303 /**
 304  * Update all sets and timeout for select.
 305  *
 306  * @param rs read-set, set to all FDs we would like to read (updated)
 307  * @param ws write-set, set to all FDs we would like to write (updated)
 308  * @param timeout next timeout (updated)
 309  */
 310 static void
 311 update_sets (struct GNUNET_NETWORK_FDSet *rs,
 312              struct GNUNET_NETWORK_FDSet *ws,
 313              struct GNUNET_TIME_Relative *timeout)
 314 {
 315   struct Task *pos;
 316   struct GNUNET_TIME_Absolute now;
 317   struct GNUNET_TIME_Relative to;
 318
 319   now = GNUNET_TIME_absolute_get ();
 320   pos = pending_timeout;
 321   if (pos != NULL)
 322     {
 323       to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
 324       if (timeout->rel_value > to.rel_value)
 325         *timeout = to;
 326       if (pos->reason != 0)
 327         *timeout = GNUNET_TIME_UNIT_ZERO;
 328     }
 329   pos = pending;
 330   while (pos != NULL)
 331     {
 332       if ((pos->prereq_id != GNUNET_SCHEDULER_NO_TASK) &&
 333           (GNUNET_YES == is_pending (pos->prereq_id)))
 334         {
 335           pos = pos->next;
 336           continue;
 337         }
 338       if (pos->timeout.abs_value != GNUNET_TIME_UNIT_FOREVER_ABS.abs_value)
 339         {
 340           to = GNUNET_TIME_absolute_get_difference (now, pos->timeout);
 341           if (timeout->rel_value > to.rel_value)
 342             *timeout = to;
 343         }
 344       if (pos->read_fd != -1)
 345         GNUNET_NETWORK_fdset_set_native (rs, pos->read_fd);
 346       if (pos->write_fd != -1)
 347         GNUNET_NETWORK_fdset_set_native (ws, pos->write_fd);
 348       if (pos->read_set != NULL)
 349         GNUNET_NETWORK_fdset_add (rs, pos->read_set);
 350       if (pos->write_set != NULL)
 351         GNUNET_NETWORK_fdset_add (ws, pos->write_set);
 352       if (pos->reason != 0)
 353         *timeout = GNUNET_TIME_UNIT_ZERO;
 354       pos = pos->next;
 355     }
 356 }
 357
 358
 359 /**
 360  * Check if the ready set overlaps with the set we want to have ready.
 361  * If so, update the want set (set all FDs that are ready).  If not,
 362  * return GNUNET_NO.
 363  *
 364  * @param ready set that is ready
 365  * @param want set that we want to be ready
 366  * @return GNUNET_YES if there was some overlap
 367  */
 368 static int
 369 set_overlaps (const struct GNUNET_NETWORK_FDSet *ready,
 370               struct GNUNET_NETWORK_FDSet *want)
 371 {
 372   if ( (NULL == want) || (NULL == ready) )
 373     return GNUNET_NO;
 374   if (GNUNET_NETWORK_fdset_overlap (ready, want))
 375     {
 376       /* copy all over (yes, there maybe unrelated bits,
 377          but this should not hurt well-written clients) */
 378       GNUNET_NETWORK_fdset_copy (want, ready);
 379       return GNUNET_YES;
 380     }
 381   return GNUNET_NO;
 382 }
 383
 384
 385 /**
 386  * Check if the given task is eligible to run now.
 387  * Also set the reason why it is eligible.
 388  *
 389  * @param task task to check if it is ready
 390  * @param now the current time
 391  * @param rs set of FDs ready for reading
 392  * @param ws set of FDs ready for writing
 393  * @return GNUNET_YES if we can run it, GNUNET_NO if not.
 394  */
 395 static int
 396 is_ready (struct Task *task,
 397           struct GNUNET_TIME_Absolute now,
 398           const struct GNUNET_NETWORK_FDSet *rs,
 399           const struct GNUNET_NETWORK_FDSet *ws)
 400 {
 401   enum GNUNET_SCHEDULER_Reason reason;
 402
 403   reason = task->reason;
 404   if (now.abs_value >= task->timeout.abs_value)
 405     reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
 406   if ( (0 == (reason & GNUNET_SCHEDULER_REASON_READ_READY)) &&
 407        ( ( (task->read_fd != -1) &&
 408            (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (rs, task->read_fd)) ) ||
 409          (set_overlaps (rs, task->read_set) ) ) )
 410     reason |= GNUNET_SCHEDULER_REASON_READ_READY;
 411   if ((0 == (reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) &&
 412       ( ( (task->write_fd != -1) &&
 413           (GNUNET_YES == GNUNET_NETWORK_fdset_test_native (ws, task->write_fd)) ) ||
 414         (set_overlaps (ws, task->write_set) ) ) )
 415     reason |= GNUNET_SCHEDULER_REASON_WRITE_READY;
 416   if (reason == 0)
 417     return GNUNET_NO;           /* not ready */
 418   if (task->prereq_id != GNUNET_SCHEDULER_NO_TASK)
 419     {
 420       if (GNUNET_YES == is_pending (task->prereq_id))
 421         {
 422           task->reason = reason;
 423           return GNUNET_NO;       /* prereq waiting */
 424         }
 425       reason |= GNUNET_SCHEDULER_REASON_PREREQ_DONE;
 426     }
 427   task->reason = reason;
 428   return GNUNET_YES;
 429 }
 430
 431
 432 /**
 433  * Put a task that is ready for execution into the ready queue.
 434  *
 435  * @param task task ready for execution
 436  */
 437 static void
 438 queue_ready_task (struct Task *task)
 439 {
 440   enum GNUNET_SCHEDULER_Priority p = task->priority;
 441   if (0 != (task->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 442     p = GNUNET_SCHEDULER_PRIORITY_SHUTDOWN;
 443   task->next = ready[check_priority (p)];
 444   ready[check_priority (p)] = task;
 445   ready_count++;
 446 }
 447
 448
 449 /**
 450  * Check which tasks are ready and move them
 451  * to the respective ready queue.
 452  *
 453  * @param rs FDs ready for reading
 454  * @param ws FDs ready for writing
 455  */
 456 static void
 457 check_ready (const struct GNUNET_NETWORK_FDSet *rs,
 458              const struct GNUNET_NETWORK_FDSet *ws)
 459 {
 460   struct Task *pos;
 461   struct Task *prev;
 462   struct Task *next;
 463   struct GNUNET_TIME_Absolute now;
 464
 465   now = GNUNET_TIME_absolute_get ();
 466   prev = NULL;
 467   pos = pending_timeout;
 468   while (pos != NULL)
 469     {
 470       next = pos->next;
 471       if (now.abs_value >= pos->timeout.abs_value)
 472         pos->reason |= GNUNET_SCHEDULER_REASON_TIMEOUT;
 473       if (0 == pos->reason)
 474         break;
 475       pending_timeout = next;
 476       if (pending_timeout_last == pos)
 477         pending_timeout_last = NULL;
 478       queue_ready_task (pos);
 479       pos = next;
 480     }
 481   pos = pending;
 482   while (pos != NULL)
 483     {
 484 #if DEBUG_TASKS
 485       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 486                   "Checking readiness of task: %llu / %p\n",
 487                   pos->id, pos->callback_cls);
 488 #endif
 489       next = pos->next;
 490       if (GNUNET_YES == is_ready (pos, now, rs, ws))
 491         {
 492           if (prev == NULL)
 493             pending = next;
 494           else
 495             prev->next = next;
 496           queue_ready_task (pos);
 497           pos = next;
 498           continue;
 499         }
 500       prev = pos;
 501       pos = next;
 502     }
 503 }
 504
 505
 506 /**
 507  * Request the shutdown of a scheduler.  Marks all currently
 508  * pending tasks as ready because of shutdown.  This will
 509  * cause all tasks to run (as soon as possible, respecting
 510  * priorities and prerequisite tasks).  Note that tasks
 511  * scheduled AFTER this call may still be delayed arbitrarily.
 512  */
 513 void
 514 GNUNET_SCHEDULER_shutdown ()
 515 {
 516   struct Task *pos;
 517   int i;
 518
 519   pos = pending_timeout;
 520   while (pos != NULL)
 521     {
 522       pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
 523       /* we don't move the task into the ready queue yet; check_ready
 524          will do that later, possibly adding additional
 525          readiness-factors */
 526       pos = pos->next;
 527     }
 528   pos = pending;
 529   while (pos != NULL)
 530     {
 531       pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
 532       /* we don't move the task into the ready queue yet; check_ready
 533          will do that later, possibly adding additional
 534          readiness-factors */
 535       pos = pos->next;
 536     }
 537   for (i=0;i<GNUNET_SCHEDULER_PRIORITY_COUNT;i++)
 538     {
 539       pos = ready[i];
 540       while (pos != NULL)
 541         {
 542           pos->reason |= GNUNET_SCHEDULER_REASON_SHUTDOWN;
 543           /* we don't move the task into the ready queue yet; check_ready
 544              will do that later, possibly adding additional
 545              readiness-factors */
 546           pos = pos->next;
 547         }
 548     }
 549 }
 550
 551
 552 /**
 553  * Destroy a task (release associated resources)
 554  *
 555  * @param t task to destroy
 556  */
 557 static void
 558 destroy_task (struct Task *t)
 559 {
 560   if (NULL != t->read_set)
 561     GNUNET_NETWORK_fdset_destroy (t->read_set);
 562   if (NULL != t->write_set)
 563     GNUNET_NETWORK_fdset_destroy (t->write_set);
 564 #if EXECINFO
 565   GNUNET_free (t->backtrace_strings);
 566 #endif
 567   GNUNET_free (t);
 568 }
 569
 570
 571 /**
 572  * Run at least one task in the highest-priority queue that is not
 573  * empty.  Keep running tasks until we are either no longer running
 574  * "URGENT" tasks or until we have at least one "pending" task (which
 575  * may become ready, hence we should select on it).  Naturally, if
 576  * there are no more ready tasks, we also return.
 577  *
 578  * @param rs FDs ready for reading
 579  * @param ws FDs ready for writing
 580  */
 581 static void
 582 run_ready (struct GNUNET_NETWORK_FDSet *rs,
 583            struct GNUNET_NETWORK_FDSet *ws)
 584 {
 585   enum GNUNET_SCHEDULER_Priority p;
 586   struct Task *pos;
 587   struct GNUNET_SCHEDULER_TaskContext tc;
 588
 589   max_priority_added = GNUNET_SCHEDULER_PRIORITY_KEEP;
 590   do
 591     {
 592       if (ready_count == 0)
 593         return;
 594       GNUNET_assert (ready[GNUNET_SCHEDULER_PRIORITY_KEEP] == NULL);
 595       /* yes, p>0 is correct, 0 is "KEEP" which should
 596          always be an empty queue (see assertion)! */
 597       for (p = GNUNET_SCHEDULER_PRIORITY_COUNT - 1; p > 0; p--)
 598         {
 599           pos = ready[p];
 600           if (pos != NULL)
 601             break;
 602         }
 603       GNUNET_assert (pos != NULL);      /* ready_count wrong? */
 604       ready[p] = pos->next;
 605       ready_count--;
 606       if (current_priority != pos->priority)
 607         {
 608           current_priority = pos->priority;
 609           (void) GNUNET_OS_set_process_priority (GNUNET_OS_process_current (),
 610                                                  pos->priority);
 611         }
 612       active_task = pos;
 613 #if PROFILE_DELAYS
 614       if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value >
 615           DELAY_THRESHOLD.rel_value)
 616         {
 617           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 618                       "Task %llu took %llums to be scheduled\n",
 619                       pos->id,
 620                       (unsigned long long) GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value);
 621         }
 622 #endif
 623       tc.reason = pos->reason;
 624       tc.read_ready = (pos->read_set == NULL) ? rs : pos->read_set;
 625       if ( (pos->read_fd != -1) &&
 626            (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)) )
 627         GNUNET_NETWORK_fdset_set_native (rs,
 628                                          pos->read_fd);
 629       tc.write_ready = (pos->write_set == NULL) ? ws : pos->write_set;
 630       if ( (pos->write_fd != -1) &&
 631            (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) )
 632         GNUNET_NETWORK_fdset_set_native (ws,
 633                                          pos->write_fd);
 634       if ( ( (tc.reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0) &&
 635            (pos->write_fd != -1) &&
 636            (! GNUNET_NETWORK_fdset_test_native (ws,
 637                                                 pos->write_fd)))
 638         abort (); // added to ready in previous select loop!
 639 #if DEBUG_TASKS
 640       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 641                   "Running task: %llu / %p\n", pos->id, pos->callback_cls);
 642 #endif
 643       pos->callback (pos->callback_cls, &tc);
 644 #if EXECINFO
 645       int i;
 646       for (i=0;i<pos->num_backtrace_strings;i++)
 647         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 648                     "Task %llu trace %d: %s\n",
 649                     pos->id,
 650                     i,
 651                     pos->backtrace_strings[i]);
 652 #endif
 653       active_task = NULL;
 654       destroy_task (pos);
 655       tasks_run++;
 656     }
 657   while ( (pending == NULL) || (p >= max_priority_added) );
 658 }
 659
 660 /**
 661  * Pipe used to communicate shutdown via signal.
 662  */
 663 static struct GNUNET_DISK_PipeHandle *shutdown_pipe_handle;
 664
 665 /**
 666  * Signal handler called for SIGPIPE.
 667  */
 668 #ifndef MINGW
 669 static void
 670 sighandler_pipe ()
 671 {
 672   return;
 673 }
 674 #endif
 675 /**
 676  * Signal handler called for signals that should cause us to shutdown.
 677  */
 678 static void
 679 sighandler_shutdown ()
 680 {
 681   static char c;
 682   int old_errno = errno; /* backup errno */
 683
 684   GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
 685                           (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_WRITE), &c,
 686                           sizeof (c));
 687   errno = old_errno;
 688 }
 689
 690
 691 /**
 692  * Initialize and run scheduler.  This function will return when all
 693  * tasks have completed.  On systems with signals, receiving a SIGTERM
 694  * (and other similar signals) will cause "GNUNET_SCHEDULER_shutdown"
 695  * to be run after the active task is complete.  As a result, SIGTERM
 696  * causes all active tasks to be scheduled with reason
 697  * "GNUNET_SCHEDULER_REASON_SHUTDOWN".  (However, tasks added
 698  * afterwards will execute normally!). Note that any particular signal
 699  * will only shut down one scheduler; applications should always only
 700  * create a single scheduler.
 701  *
 702  * @param task task to run immediately
 703  * @param task_cls closure of task
 704  */
 705 void
 706 GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_Task task, void *task_cls)
 707 {
 708   struct GNUNET_NETWORK_FDSet *rs;
 709   struct GNUNET_NETWORK_FDSet *ws;
 710   struct GNUNET_TIME_Relative timeout;
 711   int ret;
 712   struct GNUNET_SIGNAL_Context *shc_int;
 713   struct GNUNET_SIGNAL_Context *shc_term;
 714 #ifndef MINGW
 715   struct GNUNET_SIGNAL_Context *shc_quit;
 716   struct GNUNET_SIGNAL_Context *shc_hup;
 717   struct GNUNET_SIGNAL_Context *shc_pipe;
 718 #endif
 719   unsigned long long last_tr;
 720   unsigned int busy_wait_warning;
 721   const struct GNUNET_DISK_FileHandle *pr;
 722   char c;
 723
 724   GNUNET_assert (active_task == NULL);
 725   rs = GNUNET_NETWORK_fdset_create ();
 726   ws = GNUNET_NETWORK_fdset_create ();
 727   GNUNET_assert (shutdown_pipe_handle == NULL);
 728   shutdown_pipe_handle =  GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO);
 729   GNUNET_assert (shutdown_pipe_handle != NULL);
 730   pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_READ);
 731   GNUNET_assert (pr != NULL);
 732   shc_int = GNUNET_SIGNAL_handler_install (SIGINT, &sighandler_shutdown);
 733   shc_term = GNUNET_SIGNAL_handler_install (SIGTERM, &sighandler_shutdown);
 734 #ifndef MINGW
 735   shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE, &sighandler_pipe);
 736   shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT, &sighandler_shutdown);
 737   shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP, &sighandler_shutdown);
 738 #endif
 739   current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
 740   GNUNET_SCHEDULER_add_continuation (task,
 741                                      task_cls,
 742                                      GNUNET_SCHEDULER_REASON_STARTUP);
 743 #if ENABLE_WINDOWS_WORKAROUNDS
 744   GNUNET_SCHEDULER_add_continuation (&GNUNET_OS_install_parent_control_handler,
 745                                      NULL, GNUNET_SCHEDULER_REASON_STARTUP);
 746 #endif
 747   last_tr = 0;
 748   busy_wait_warning = 0;
 749   while ((pending != NULL) ||
 750          (pending_timeout != NULL) ||
 751          (ready_count > 0))
 752     {
 753       GNUNET_NETWORK_fdset_zero (rs);
 754       GNUNET_NETWORK_fdset_zero (ws);
 755       timeout = GNUNET_TIME_UNIT_FOREVER_REL;
 756       update_sets (rs, ws, &timeout);
 757       GNUNET_NETWORK_fdset_handle_set (rs, pr);
 758       if (ready_count > 0)
 759         {
 760           /* no blocking, more work already ready! */
 761           timeout = GNUNET_TIME_UNIT_ZERO;
 762         }
 763       ret = GNUNET_NETWORK_socket_select (rs, ws, NULL, timeout);
 764       if (ret == GNUNET_SYSERR)
 765         {
 766           if (errno == EINTR)
 767             continue;
 768
 769           GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "select");
 770 #ifndef MINGW
 771 #if USE_LSOF
 772           char lsof[512];
 773           snprintf (lsof, sizeof (lsof), "lsof -p %d", getpid());
 774           close (1);
 775           dup2 (2, 1);
 776           ret = system (lsof);
 777 #endif
 778 #endif
 779           abort ();
 780           break;
 781         }
 782       if ((ret == 0) && (timeout.rel_value == 0) && (busy_wait_warning > 16))
 783         {
 784           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 785                       _("Looks like we're busy waiting...\n"));
 786           sleep (1);            /* mitigate */
 787         }
 788       check_ready (rs, ws);
 789       run_ready (rs, ws);
 790       if (GNUNET_NETWORK_fdset_handle_isset (rs, pr))
 791         {
 792           /* consume the signal */
 793           GNUNET_DISK_file_read (pr, &c, sizeof (c));
 794           /* mark all active tasks as ready due to shutdown */
 795           GNUNET_SCHEDULER_shutdown ();
 796         }
 797       if (last_tr == tasks_run)
 798         {
 799           busy_wait_warning++;
 800         }
 801       else
 802         {
 803           last_tr = tasks_run;
 804           busy_wait_warning = 0;
 805         }
 806     }
 807   GNUNET_SIGNAL_handler_uninstall (shc_int);
 808   GNUNET_SIGNAL_handler_uninstall (shc_term);
 809 #ifndef MINGW
 810   GNUNET_SIGNAL_handler_uninstall (shc_pipe);
 811   GNUNET_SIGNAL_handler_uninstall (shc_quit);
 812   GNUNET_SIGNAL_handler_uninstall (shc_hup);
 813 #endif
 814   GNUNET_DISK_pipe_close (shutdown_pipe_handle);
 815   shutdown_pipe_handle = NULL;
 816   GNUNET_NETWORK_fdset_destroy (rs);
 817   GNUNET_NETWORK_fdset_destroy (ws);
 818 }
 819
 820
 821 /**
 822  * Obtain the reason code for why the current task was
 823  * started.  Will return the same value as
 824  * the GNUNET_SCHEDULER_TaskContext's reason field.
 825  *
 826  * @return reason(s) why the current task is run
 827  */
 828 enum GNUNET_SCHEDULER_Reason
 829 GNUNET_SCHEDULER_get_reason ()
 830 {
 831   GNUNET_assert (active_task != NULL);
 832   return active_task->reason;
 833 }
 834
 835
 836 /**
 837  * Get information about the current load of this scheduler.  Use this
 838  * function to determine if an elective task should be added or simply
 839  * dropped (if the decision should be made based on the number of
 840  * tasks ready to run).
 841  *
 842  * @param p priority level to look at
 843  * @return number of tasks pending right now
 844  */
 845 unsigned int
 846 GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p)
 847 {
 848   struct Task *pos;
 849   unsigned int ret;
 850
 851   GNUNET_assert (active_task != NULL);
 852   if (p == GNUNET_SCHEDULER_PRIORITY_COUNT)
 853     return ready_count;
 854   if (p == GNUNET_SCHEDULER_PRIORITY_KEEP)
 855     p = current_priority;
 856   ret = 0;
 857   pos = ready[check_priority (p)];
 858   while (pos != NULL)
 859     {
 860       pos = pos->next;
 861       ret++;
 862     }
 863   return ret;
 864 }
 865
 866
 867 /**
 868  * Cancel the task with the specified identifier.
 869  * The task must not yet have run.
 870  *
 871  * @param task id of the task to cancel
 872  * @return original closure of the task
 873  */
 874 void *
 875 GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task)
 876 {
 877   struct Task *t;
 878   struct Task *prev;
 879   enum GNUNET_SCHEDULER_Priority p;
 880   int to;
 881   void *ret;
 882
 883   GNUNET_assert (active_task != NULL);
 884   to = 0;
 885   prev = NULL;
 886   t = pending;
 887   while (t != NULL)
 888     {
 889       if (t->id == task)
 890         break;
 891       prev = t;
 892       t = t->next;
 893     }
 894   if (t == NULL)
 895     {
 896       prev = NULL;
 897       to = 1;
 898       t = pending_timeout;
 899       while (t != NULL)
 900         {
 901           if (t->id == task)
 902             break;
 903           prev = t;
 904           t = t->next;
 905         }
 906       if (pending_timeout_last == t)
 907         pending_timeout_last = NULL;
 908     }
 909   p = 0;
 910   while (t == NULL)
 911     {
 912       p++;
 913       GNUNET_assert (p < GNUNET_SCHEDULER_PRIORITY_COUNT);
 914       prev = NULL;
 915       t = ready[p];
 916       while (t != NULL)
 917         {
 918           if (t->id == task)
 919             {
 920               ready_count--;
 921               break;
 922             }
 923           prev = t;
 924           t = t->next;
 925         }
 926     }
 927   if (prev == NULL)
 928     {
 929       if (p == 0)
 930         {
 931           if (to == 0)
 932             {
 933               pending = t->next;
 934             }
 935           else
 936             {
 937               pending_timeout = t->next;
 938             }
 939         }
 940       else
 941         {
 942           ready[p] = t->next;
 943         }
 944     }
 945   else
 946     {
 947       prev->next = t->next;
 948     }
 949   ret = t->callback_cls;
 950 #if DEBUG_TASKS
 951   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 952               "Canceling task: %llu / %p\n", task, t->callback_cls);
 953 #endif
 954   destroy_task (t);
 955   return ret;
 956 }
 957
 958
 959 /**
 960  * Continue the current execution with the given function.  This is
 961  * similar to the other "add" functions except that there is no delay
 962  * and the reason code can be specified.
 963  *
 964  * @param task main function of the task
 965  * @param task_cls closure for 'main'
 966  * @param reason reason for task invocation
 967  */
 968 void
 969 GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task,
 970                                    void *task_cls,
 971                                    enum GNUNET_SCHEDULER_Reason reason)
 972 {
 973   struct Task *t;
 974 #if EXECINFO
 975   void *backtrace_array[50];
 976 #endif
 977
 978   GNUNET_assert ( (active_task != NULL) ||
 979                   (reason == GNUNET_SCHEDULER_REASON_STARTUP) );
 980   t = GNUNET_malloc (sizeof (struct Task));
 981 #if EXECINFO
 982   t->num_backtrace_strings = backtrace(backtrace_array, 50);
 983   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
 984 #endif
 985   t->read_fd = -1;
 986   t->write_fd = -1;
 987   t->callback = task;
 988   t->callback_cls = task_cls;
 989   t->id = ++last_id;
 990 #if PROFILE_DELAYS
 991   t->start_time = GNUNET_TIME_absolute_get ();
 992 #endif
 993   t->reason = reason;
 994   t->priority = current_priority;
 995 #if DEBUG_TASKS
 996   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 997               "Adding continuation task: %llu / %p\n",
 998               t->id, t->callback_cls);
 999 #endif
1000   queue_ready_task (t);
1001 }
1002
1003
1004
1005 /**
1006  * Schedule a new task to be run after the specified prerequisite task
1007  * has completed. It will be run with the priority of the calling
1008  * task.
1009  *
1010  * @param prerequisite_task run this task after the task with the given
1011  *        task identifier completes (and any of our other
1012  *        conditions, such as delay, read or write-readiness
1013  *        are satisfied).  Use  GNUNET_SCHEDULER_NO_TASK to not have any dependency
1014  *        on completion of other tasks (this will cause the task to run as
1015  *        soon as possible).
1016  * @param task main function of the task
1017  * @param task_cls closure of task
1018  * @return unique task identifier for the job
1019  *         only valid until "task" is started!
1020  */
1021 GNUNET_SCHEDULER_TaskIdentifier
1022 GNUNET_SCHEDULER_add_after (GNUNET_SCHEDULER_TaskIdentifier prerequisite_task,
1023                             GNUNET_SCHEDULER_Task task, void *task_cls)
1024 {
1025   return GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_KEEP,
1026                                       prerequisite_task,
1027                                       GNUNET_TIME_UNIT_ZERO,
1028                                       NULL, NULL, task, task_cls);
1029 }
1030
1031
1032 /**
1033  * Schedule a new task to be run with a specified priority.
1034  *
1035  * @param prio how important is the new task?
1036  * @param task main function of the task
1037  * @param task_cls closure of task
1038  * @return unique task identifier for the job
1039  *         only valid until "task" is started!
1040  */
1041 GNUNET_SCHEDULER_TaskIdentifier
1042 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
1043                                     GNUNET_SCHEDULER_Task task,
1044                                     void *task_cls)
1045 {
1046   return GNUNET_SCHEDULER_add_select (prio,
1047                                       GNUNET_SCHEDULER_NO_TASK,
1048                                       GNUNET_TIME_UNIT_ZERO,
1049                                       NULL, NULL, task, task_cls);
1050 }
1051
1052
1053
1054 /**
1055  * Schedule a new task to be run with a specified delay.  The task
1056  * will be scheduled for execution once the delay has expired. It
1057  * will be run with the priority of the calling task.
1058  *
1059  * @param delay when should this operation time out? Use
1060  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1061  * @param task main function of the task
1062  * @param task_cls closure of task
1063  * @return unique task identifier for the job
1064  *         only valid until "task" is started!
1065  */
1066 GNUNET_SCHEDULER_TaskIdentifier
1067 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
1068                               GNUNET_SCHEDULER_Task task, void *task_cls)
1069 {
1070 #if 1
1071   /* new, optimized version */
1072   struct Task *t;
1073   struct Task *pos;
1074   struct Task *prev;
1075 #if EXECINFO
1076   void *backtrace_array[MAX_TRACE_DEPTH];
1077 #endif
1078
1079   GNUNET_assert (active_task != NULL);
1080   GNUNET_assert (NULL != task);
1081   t = GNUNET_malloc (sizeof (struct Task));
1082   t->callback = task;
1083   t->callback_cls = task_cls;
1084 #if EXECINFO
1085   t->num_backtrace_strings = backtrace(backtrace_array, MAX_TRACE_DEPTH);
1086   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
1087 #endif
1088   t->read_fd = -1;
1089   t->write_fd = -1;
1090   t->id = ++last_id;
1091 #if PROFILE_DELAYS
1092   t->start_time = GNUNET_TIME_absolute_get ();
1093 #endif
1094   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1095   t->priority = current_priority;
1096   /* try tail first (optimization in case we are
1097      appending to a long list of tasks with timeouts) */
1098   prev = pending_timeout_last;
1099   if (prev != NULL)
1100     {
1101       if (prev->timeout.abs_value > t->timeout.abs_value)
1102         prev = NULL;
1103       else
1104         pos = prev->next; /* heuristic success! */
1105     }
1106   if (prev == NULL)
1107     {
1108       /* heuristic failed, do traversal of timeout list */
1109       pos = pending_timeout;
1110     }
1111   while ( (pos != NULL) &&
1112           ( (pos->timeout.abs_value <= t->timeout.abs_value) ||
1113             (pos->reason != 0) ) )
1114     {
1115       prev = pos;
1116       pos = pos->next;
1117     }
1118   if (prev == NULL)
1119     pending_timeout = t;
1120   else
1121     prev->next = t;
1122   t->next = pos;
1123   /* hyper-optimization... */
1124   pending_timeout_last = t;
1125
1126 #if DEBUG_TASKS
1127   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1128               "Adding task: %llu / %p\n", t->id, t->callback_cls);
1129 #endif
1130 #if EXECINFO
1131   int i;
1132
1133   for (i=0;i<t->num_backtrace_strings;i++)
1134       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1135                   "Task %llu trace %d: %s\n",
1136                   t->id,
1137                   i,
1138                   t->backtrace_strings[i]);
1139 #endif
1140   return t->id;
1141
1142 #else
1143   /* unoptimized version */
1144   return GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_KEEP,
1145                                       GNUNET_SCHEDULER_NO_TASK, delay,
1146                                       NULL, NULL, task, task_cls);
1147 #endif
1148 }
1149
1150
1151
1152 /**
1153  * Schedule a new task to be run as soon as possible. The task
1154  * will be run with the priority of the calling task.
1155  *
1156  * @param task main function of the task
1157  * @param task_cls closure of task
1158  * @return unique task identifier for the job
1159  *         only valid until "task" is started!
1160  */
1161 GNUNET_SCHEDULER_TaskIdentifier
1162 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_Task task,
1163                                                   void *task_cls)
1164 {
1165   return GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_KEEP,
1166                                       GNUNET_SCHEDULER_NO_TASK,
1167                                       GNUNET_TIME_UNIT_ZERO,
1168                                       NULL, NULL, task, task_cls);
1169 }
1170
1171
1172
1173
1174 /**
1175  * Schedule a new task to be run with a specified delay or when any of
1176  * the specified file descriptor sets is ready.  The delay can be used
1177  * as a timeout on the socket(s) being ready.  The task will be
1178  * scheduled for execution once either the delay has expired or any of
1179  * the socket operations is ready.  This is the most general
1180  * function of the "add" family.  Note that the "prerequisite_task"
1181  * must be satisfied in addition to any of the other conditions.  In
1182  * other words, the task will be started when
1183  * <code>
1184  * (prerequisite-run)
1185  * && (delay-ready
1186  *     || any-rs-ready
1187  *     || any-ws-ready
1188  *     || shutdown-active )
1189  * </code>
1190  *
1191  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1192  *        which means that the task will only be run after we receive SIGTERM
1193  * @param rfd file descriptor we want to read (can be -1)
1194  * @param wfd file descriptors we want to write (can be -1)
1195  * @param task main function of the task
1196  * @param task_cls closure of task
1197  * @return unique task identifier for the job
1198  *         only valid until "task" is started!
1199  */
1200 #ifndef MINGW
1201 GNUNET_SCHEDULER_TaskIdentifier
1202 add_without_sets (struct GNUNET_TIME_Relative delay,
1203                   int rfd,
1204                   int wfd,
1205                   GNUNET_SCHEDULER_Task task, void *task_cls)
1206 {
1207   struct Task *t;
1208 #if EXECINFO
1209   void *backtrace_array[MAX_TRACE_DEPTH];
1210 #endif
1211
1212   GNUNET_assert (active_task != NULL);
1213   GNUNET_assert (NULL != task);
1214   t = GNUNET_malloc (sizeof (struct Task));
1215   t->callback = task;
1216   t->callback_cls = task_cls;
1217 #if EXECINFO
1218   t->num_backtrace_strings = backtrace(backtrace_array, MAX_TRACE_DEPTH);
1219   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
1220 #endif
1221   t->read_fd = rfd;
1222   t->write_fd = wfd;
1223   t->id = ++last_id;
1224 #if PROFILE_DELAYS
1225   t->start_time = GNUNET_TIME_absolute_get ();
1226 #endif
1227   t->prereq_id = GNUNET_SCHEDULER_NO_TASK;
1228   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1229   t->priority = check_priority (current_priority);
1230   t->next = pending;
1231   pending = t;
1232   max_priority_added = GNUNET_MAX (max_priority_added,
1233                                           t->priority);
1234 #if DEBUG_TASKS
1235   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1236               "Adding task: %llu / %p\n", t->id, t->callback_cls);
1237 #endif
1238 #if EXECINFO
1239   int i;
1240
1241   for (i=0;i<t->num_backtrace_strings;i++)
1242       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1243                   "Task %llu trace %d: %s\n",
1244                   t->id,
1245                   i,
1246                   t->backtrace_strings[i]);
1247 #endif
1248   return t->id;
1249 }
1250 #endif
1251
1252
1253
1254 /**
1255  * Schedule a new task to be run with a specified delay or when the
1256  * specified file descriptor is ready for reading.  The delay can be
1257  * used as a timeout on the socket being ready.  The task will be
1258  * scheduled for execution once either the delay has expired or the
1259  * socket operation is ready.  It will be run with the priority of
1260  * the calling task.
1261  *
1262  * @param delay when should this operation time out? Use
1263  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1264  * @param rfd read file-descriptor
1265  * @param task main function of the task
1266  * @param task_cls closure of task
1267  * @return unique task identifier for the job
1268  *         only valid until "task" is started!
1269  */
1270 GNUNET_SCHEDULER_TaskIdentifier
1271 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
1272                                struct GNUNET_NETWORK_Handle * rfd,
1273                                GNUNET_SCHEDULER_Task task, void *task_cls)
1274 {
1275 #if MINGW
1276   struct GNUNET_NETWORK_FDSet *rs;
1277   GNUNET_SCHEDULER_TaskIdentifier ret;
1278
1279   GNUNET_assert (rfd != NULL);
1280   rs = GNUNET_NETWORK_fdset_create ();
1281   GNUNET_NETWORK_fdset_set (rs, rfd);
1282   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1283                                      GNUNET_SCHEDULER_NO_TASK, delay,
1284                                      rs, NULL, task, task_cls);
1285   GNUNET_NETWORK_fdset_destroy (rs);
1286   return ret;
1287 #else
1288   return add_without_sets (delay,
1289                            GNUNET_NETWORK_get_fd (rfd),
1290                            -1,
1291                            task,
1292                            task_cls);
1293 #endif
1294 }
1295
1296
1297 /**
1298  * Schedule a new task to be run with a specified delay or when the
1299  * specified file descriptor is ready for writing.  The delay can be
1300  * used as a timeout on the socket being ready.  The task will be
1301  * scheduled for execution once either the delay has expired or the
1302  * socket operation is ready.  It will be run with the priority of
1303  * the calling task.
1304  *
1305  * @param delay when should this operation time out? Use
1306  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1307  * @param wfd write file-descriptor
1308  * @param task main function of the task
1309  * @param task_cls closure of task
1310  * @return unique task identifier for the job
1311  *         only valid until "task" is started!
1312  */
1313 GNUNET_SCHEDULER_TaskIdentifier
1314 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
1315                                 struct GNUNET_NETWORK_Handle * wfd,
1316                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1317 {
1318 #if MINGW
1319   struct GNUNET_NETWORK_FDSet *ws;
1320   GNUNET_SCHEDULER_TaskIdentifier ret;
1321
1322   GNUNET_assert (wfd != NULL);
1323   ws = GNUNET_NETWORK_fdset_create ();
1324   GNUNET_NETWORK_fdset_set (ws, wfd);
1325   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1326                                      GNUNET_SCHEDULER_NO_TASK, delay,
1327                                      NULL, ws, task, task_cls);
1328   GNUNET_NETWORK_fdset_destroy (ws);
1329   return ret;
1330 #else
1331   return add_without_sets (delay,
1332                            -1,
1333                            GNUNET_NETWORK_get_fd (wfd),
1334                            task,
1335                            task_cls);
1336 #endif
1337 }
1338
1339
1340 /**
1341  * Schedule a new task to be run with a specified delay or when the
1342  * specified file descriptor is ready for reading.  The delay can be
1343  * used as a timeout on the socket being ready.  The task will be
1344  * scheduled for execution once either the delay has expired or the
1345  * socket operation is ready. It will be run with the priority of
1346  * the calling task.
1347  *
1348  * @param delay when should this operation time out? Use
1349  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1350  * @param rfd read file-descriptor
1351  * @param task main function of the task
1352  * @param task_cls closure of task
1353  * @return unique task identifier for the job
1354  *         only valid until "task" is started!
1355  */
1356 GNUNET_SCHEDULER_TaskIdentifier
1357 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
1358                                 const struct GNUNET_DISK_FileHandle * rfd,
1359                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1360 {
1361 #if MINGW
1362   struct GNUNET_NETWORK_FDSet *rs;
1363   GNUNET_SCHEDULER_TaskIdentifier ret;
1364
1365   GNUNET_assert (rfd != NULL);
1366   rs = GNUNET_NETWORK_fdset_create ();
1367   GNUNET_NETWORK_fdset_handle_set (rs, rfd);
1368   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1369                                      GNUNET_SCHEDULER_NO_TASK, delay,
1370                                      rs, NULL, task, task_cls);
1371   GNUNET_NETWORK_fdset_destroy (rs);
1372   return ret;
1373 #else
1374   int fd;
1375
1376   GNUNET_DISK_internal_file_handle_ (rfd, &fd, sizeof (int));
1377   return add_without_sets (delay,
1378                            fd,
1379                            -1,
1380                            task,
1381                            task_cls);
1382
1383 #endif
1384 }
1385
1386
1387 /**
1388  * Schedule a new task to be run with a specified delay or when the
1389  * specified file descriptor is ready for writing.  The delay can be
1390  * used as a timeout on the socket being ready.  The task will be
1391  * scheduled for execution once either the delay has expired or the
1392  * socket operation is ready. It will be run with the priority of
1393  * the calling task.
1394  *
1395  * @param delay when should this operation time out? Use
1396  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1397  * @param wfd write file-descriptor
1398  * @param task main function of the task
1399  * @param task_cls closure of task
1400  * @return unique task identifier for the job
1401  *         only valid until "task" is started!
1402  */
1403 GNUNET_SCHEDULER_TaskIdentifier
1404 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
1405                                  const struct GNUNET_DISK_FileHandle * wfd,
1406                                  GNUNET_SCHEDULER_Task task, void *task_cls)
1407 {
1408 #if MINGW
1409   struct GNUNET_NETWORK_FDSet *ws;
1410   GNUNET_SCHEDULER_TaskIdentifier ret;
1411
1412   GNUNET_assert (wfd != NULL);
1413   ws = GNUNET_NETWORK_fdset_create ();
1414   GNUNET_NETWORK_fdset_handle_set (ws, wfd);
1415   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1416                                      GNUNET_SCHEDULER_NO_TASK,
1417                                      delay, NULL, ws, task, task_cls);
1418   GNUNET_NETWORK_fdset_destroy (ws);
1419   return ret;
1420 #else
1421   int fd;
1422
1423   GNUNET_DISK_internal_file_handle_ (wfd, &fd, sizeof (int));
1424   return add_without_sets (delay,
1425                            -1,
1426                            fd,
1427                            task,
1428                            task_cls);
1429
1430 #endif
1431 }
1432
1433
1434
1435 /**
1436  * Schedule a new task to be run with a specified delay or when any of
1437  * the specified file descriptor sets is ready.  The delay can be used
1438  * as a timeout on the socket(s) being ready.  The task will be
1439  * scheduled for execution once either the delay has expired or any of
1440  * the socket operations is ready.  This is the most general
1441  * function of the "add" family.  Note that the "prerequisite_task"
1442  * must be satisfied in addition to any of the other conditions.  In
1443  * other words, the task will be started when
1444  * <code>
1445  * (prerequisite-run)
1446  * && (delay-ready
1447  *     || any-rs-ready
1448  *     || any-ws-ready
1449  *     || (shutdown-active && run-on-shutdown) )
1450  * </code>
1451  *
1452  * @param prio how important is this task?
1453  * @param prerequisite_task run this task after the task with the given
1454  *        task identifier completes (and any of our other
1455  *        conditions, such as delay, read or write-readiness
1456  *        are satisfied).  Use GNUNET_SCHEDULER_NO_TASK to not have any dependency
1457  *        on completion of other tasks.
1458  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1459  *        which means that the task will only be run after we receive SIGTERM
1460  * @param rs set of file descriptors we want to read (can be NULL)
1461  * @param ws set of file descriptors we want to write (can be NULL)
1462  * @param task main function of the task
1463  * @param task_cls closure of task
1464  * @return unique task identifier for the job
1465  *         only valid until "task" is started!
1466  */
1467 GNUNET_SCHEDULER_TaskIdentifier
1468 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
1469                              GNUNET_SCHEDULER_TaskIdentifier
1470                              prerequisite_task,
1471                              struct GNUNET_TIME_Relative delay,
1472                              const struct GNUNET_NETWORK_FDSet * rs,
1473                              const struct GNUNET_NETWORK_FDSet * ws,
1474                              GNUNET_SCHEDULER_Task task, void *task_cls)
1475 {
1476   struct Task *t;
1477 #if EXECINFO
1478   void *backtrace_array[MAX_TRACE_DEPTH];
1479 #endif
1480
1481   GNUNET_assert (active_task != NULL);
1482   GNUNET_assert (NULL != task);
1483   t = GNUNET_malloc (sizeof (struct Task));
1484   t->callback = task;
1485   t->callback_cls = task_cls;
1486 #if EXECINFO
1487   t->num_backtrace_strings = backtrace(backtrace_array, MAX_TRACE_DEPTH);
1488   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
1489 #endif
1490   t->read_fd = -1;
1491   t->write_fd = -1;
1492   if (rs != NULL)
1493     {
1494       t->read_set = GNUNET_NETWORK_fdset_create ();
1495       GNUNET_NETWORK_fdset_copy (t->read_set, rs);
1496     }
1497   if (ws != NULL)
1498     {
1499       t->write_set = GNUNET_NETWORK_fdset_create ();
1500       GNUNET_NETWORK_fdset_copy (t->write_set, ws);
1501     }
1502   t->id = ++last_id;
1503 #if PROFILE_DELAYS
1504   t->start_time = GNUNET_TIME_absolute_get ();
1505 #endif
1506   t->prereq_id = prerequisite_task;
1507   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1508   t->priority =
1509     check_priority ((prio ==
1510                      GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority
1511                     : prio);
1512   t->next = pending;
1513   pending = t;
1514   max_priority_added = GNUNET_MAX (max_priority_added,
1515                                           t->priority);
1516 #if DEBUG_TASKS
1517   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1518               "Adding task: %llu / %p\n", t->id, t->callback_cls);
1519 #endif
1520 #if EXECINFO
1521   int i;
1522
1523   for (i=0;i<t->num_backtrace_strings;i++)
1524       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1525                   "Task %llu trace %d: %s\n",
1526                   t->id,
1527                   i,
1528                   t->backtrace_strings[i]);
1529 #endif
1530   return t->id;
1531 }
1532
1533 /* end of scheduler.c */