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 (), pos->priority);
 610         }
 611       active_task = pos;
 612 #if PROFILE_DELAYS
 613       if (GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value >
 614           DELAY_THRESHOLD.rel_value)
 615         {
 616           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 617                       "Task %llu took %llums to be scheduled\n",
 618                       pos->id,
 619                       (unsigned long long) GNUNET_TIME_absolute_get_duration (pos->start_time).rel_value);
 620         }
 621 #endif
 622       tc.reason = pos->reason;
 623       tc.read_ready = (pos->read_set == NULL) ? rs : pos->read_set;
 624       if ( (pos->read_fd != -1) &&
 625            (0 != (pos->reason & GNUNET_SCHEDULER_REASON_READ_READY)) )
 626         GNUNET_NETWORK_fdset_set_native (rs,
 627                                          pos->read_fd);
 628       tc.write_ready = (pos->write_set == NULL) ? ws : pos->write_set;
 629       if ( (pos->write_fd != -1) &&
 630            (0 != (pos->reason & GNUNET_SCHEDULER_REASON_WRITE_READY)) )
 631         GNUNET_NETWORK_fdset_set_native (ws,
 632                                          pos->write_fd);
 633       if ( ( (tc.reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0) &&
 634            (pos->write_fd != -1) &&
 635            (! GNUNET_NETWORK_fdset_test_native (ws,
 636                                                 pos->write_fd)))
 637         abort (); // added to ready in previous select loop!
 638 #if DEBUG_TASKS
 639       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 640                   "Running task: %llu / %p\n", pos->id, pos->callback_cls);
 641 #endif
 642       pos->callback (pos->callback_cls, &tc);
 643 #if EXECINFO
 644       int i;
 645       for (i=0;i<pos->num_backtrace_strings;i++)
 646         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 647                     "Task %llu trace %d: %s\n",
 648                     pos->id,
 649                     i,
 650                     pos->backtrace_strings[i]);
 651 #endif
 652       active_task = NULL;
 653       destroy_task (pos);
 654       tasks_run++;
 655     }
 656   while ( (pending == NULL) || (p >= max_priority_added) );
 657 }
 658
 659 /**
 660  * Pipe used to communicate shutdown via signal.
 661  */
 662 static struct GNUNET_DISK_PipeHandle *shutdown_pipe_handle;
 663
 664 /**
 665  * Signal handler called for SIGPIPE.
 666  */
 667 #ifndef MINGW
 668 static void
 669 sighandler_pipe ()
 670 {
 671   return;
 672 }
 673 #endif
 674 /**
 675  * Signal handler called for signals that should cause us to shutdown.
 676  */
 677 static void
 678 sighandler_shutdown ()
 679 {
 680   static char c;
 681   int old_errno = errno; /* backup errno */
 682
 683   GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
 684                           (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_WRITE), &c,
 685                           sizeof (c));
 686   errno = old_errno;
 687 }
 688
 689
 690 /**
 691  * Initialize and run scheduler.  This function will return when all
 692  * tasks have completed.  On systems with signals, receiving a SIGTERM
 693  * (and other similar signals) will cause "GNUNET_SCHEDULER_shutdown"
 694  * to be run after the active task is complete.  As a result, SIGTERM
 695  * causes all active tasks to be scheduled with reason
 696  * "GNUNET_SCHEDULER_REASON_SHUTDOWN".  (However, tasks added
 697  * afterwards will execute normally!). Note that any particular signal
 698  * will only shut down one scheduler; applications should always only
 699  * create a single scheduler.
 700  *
 701  * @param task task to run immediately
 702  * @param task_cls closure of task
 703  */
 704 void
 705 GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_Task task, void *task_cls)
 706 {
 707   struct GNUNET_NETWORK_FDSet *rs;
 708   struct GNUNET_NETWORK_FDSet *ws;
 709   struct GNUNET_TIME_Relative timeout;
 710   int ret;
 711   struct GNUNET_SIGNAL_Context *shc_int;
 712   struct GNUNET_SIGNAL_Context *shc_term;
 713 #ifndef MINGW
 714   struct GNUNET_SIGNAL_Context *shc_quit;
 715   struct GNUNET_SIGNAL_Context *shc_hup;
 716   struct GNUNET_SIGNAL_Context *shc_pipe;
 717 #endif
 718   unsigned long long last_tr;
 719   unsigned int busy_wait_warning;
 720   const struct GNUNET_DISK_FileHandle *pr;
 721   char c;
 722
 723   GNUNET_assert (active_task == NULL);
 724   rs = GNUNET_NETWORK_fdset_create ();
 725   ws = GNUNET_NETWORK_fdset_create ();
 726   GNUNET_assert (shutdown_pipe_handle == NULL);
 727   shutdown_pipe_handle =  GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO);
 728   GNUNET_assert (shutdown_pipe_handle != NULL);
 729   pr = GNUNET_DISK_pipe_handle (shutdown_pipe_handle, GNUNET_DISK_PIPE_END_READ);
 730   GNUNET_assert (pr != NULL);
 731   shc_int = GNUNET_SIGNAL_handler_install (SIGINT, &sighandler_shutdown);
 732   shc_term = GNUNET_SIGNAL_handler_install (SIGTERM, &sighandler_shutdown);
 733 #ifndef MINGW
 734   shc_pipe = GNUNET_SIGNAL_handler_install (SIGPIPE, &sighandler_pipe);
 735   shc_quit = GNUNET_SIGNAL_handler_install (SIGQUIT, &sighandler_shutdown);
 736   shc_hup = GNUNET_SIGNAL_handler_install (SIGHUP, &sighandler_shutdown);
 737 #endif
 738   current_priority = GNUNET_SCHEDULER_PRIORITY_DEFAULT;
 739   GNUNET_SCHEDULER_add_continuation (task,
 740                                      task_cls,
 741                                      GNUNET_SCHEDULER_REASON_STARTUP);
 742   last_tr = 0;
 743   busy_wait_warning = 0;
 744   while ((pending != NULL) ||
 745          (pending_timeout != NULL) ||
 746          (ready_count > 0))
 747     {
 748       GNUNET_NETWORK_fdset_zero (rs);
 749       GNUNET_NETWORK_fdset_zero (ws);
 750       timeout = GNUNET_TIME_UNIT_FOREVER_REL;
 751       update_sets (rs, ws, &timeout);
 752       GNUNET_NETWORK_fdset_handle_set (rs, pr);
 753       if (ready_count > 0)
 754         {
 755           /* no blocking, more work already ready! */
 756           timeout = GNUNET_TIME_UNIT_ZERO;
 757         }
 758       ret = GNUNET_NETWORK_socket_select (rs, ws, NULL, timeout);
 759       if (ret == GNUNET_SYSERR)
 760         {
 761           if (errno == EINTR)
 762             continue;
 763
 764           GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "select");
 765 #ifndef MINGW
 766 #if USE_LSOF
 767           char lsof[512];
 768           snprintf (lsof, sizeof (lsof), "lsof -p %d", getpid());
 769           close (1);
 770           dup2 (2, 1);
 771           ret = system (lsof);
 772 #endif
 773 #endif
 774           abort ();
 775           break;
 776         }
 777       if ((ret == 0) && (timeout.rel_value == 0) && (busy_wait_warning > 16))
 778         {
 779           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 780                       _("Looks like we're busy waiting...\n"));
 781           sleep (1);            /* mitigate */
 782         }
 783       check_ready (rs, ws);
 784       run_ready (rs, ws);
 785       if (GNUNET_NETWORK_fdset_handle_isset (rs, pr))
 786         {
 787           /* consume the signal */
 788           GNUNET_DISK_file_read (pr, &c, sizeof (c));
 789           /* mark all active tasks as ready due to shutdown */
 790           GNUNET_SCHEDULER_shutdown ();
 791         }
 792       if (last_tr == tasks_run)
 793         {
 794           busy_wait_warning++;
 795         }
 796       else
 797         {
 798           last_tr = tasks_run;
 799           busy_wait_warning = 0;
 800         }
 801     }
 802   GNUNET_SIGNAL_handler_uninstall (shc_int);
 803   GNUNET_SIGNAL_handler_uninstall (shc_term);
 804 #ifndef MINGW
 805   GNUNET_SIGNAL_handler_uninstall (shc_pipe);
 806   GNUNET_SIGNAL_handler_uninstall (shc_quit);
 807   GNUNET_SIGNAL_handler_uninstall (shc_hup);
 808 #endif
 809   GNUNET_DISK_pipe_close (shutdown_pipe_handle);
 810   shutdown_pipe_handle = NULL;
 811   GNUNET_NETWORK_fdset_destroy (rs);
 812   GNUNET_NETWORK_fdset_destroy (ws);
 813 }
 814
 815
 816 /**
 817  * Obtain the reason code for why the current task was
 818  * started.  Will return the same value as
 819  * the GNUNET_SCHEDULER_TaskContext's reason field.
 820  *
 821  * @return reason(s) why the current task is run
 822  */
 823 enum GNUNET_SCHEDULER_Reason
 824 GNUNET_SCHEDULER_get_reason ()
 825 {
 826   GNUNET_assert (active_task != NULL);
 827   return active_task->reason;
 828 }
 829
 830
 831 /**
 832  * Get information about the current load of this scheduler.  Use this
 833  * function to determine if an elective task should be added or simply
 834  * dropped (if the decision should be made based on the number of
 835  * tasks ready to run).
 836  *
 837  * @param p priority level to look at
 838  * @return number of tasks pending right now
 839  */
 840 unsigned int
 841 GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p)
 842 {
 843   struct Task *pos;
 844   unsigned int ret;
 845
 846   GNUNET_assert (active_task != NULL);
 847   if (p == GNUNET_SCHEDULER_PRIORITY_COUNT)
 848     return ready_count;
 849   if (p == GNUNET_SCHEDULER_PRIORITY_KEEP)
 850     p = current_priority;
 851   ret = 0;
 852   pos = ready[check_priority (p)];
 853   while (pos != NULL)
 854     {
 855       pos = pos->next;
 856       ret++;
 857     }
 858   return ret;
 859 }
 860
 861
 862 /**
 863  * Cancel the task with the specified identifier.
 864  * The task must not yet have run.
 865  *
 866  * @param task id of the task to cancel
 867  * @return original closure of the task
 868  */
 869 void *
 870 GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task)
 871 {
 872   struct Task *t;
 873   struct Task *prev;
 874   enum GNUNET_SCHEDULER_Priority p;
 875   int to;
 876   void *ret;
 877
 878   GNUNET_assert (active_task != NULL);
 879   to = 0;
 880   prev = NULL;
 881   t = pending;
 882   while (t != NULL)
 883     {
 884       if (t->id == task)
 885         break;
 886       prev = t;
 887       t = t->next;
 888     }
 889   if (t == NULL)
 890     {
 891       prev = NULL;
 892       to = 1;
 893       t = pending_timeout;
 894       while (t != NULL)
 895         {
 896           if (t->id == task)
 897             break;
 898           prev = t;
 899           t = t->next;
 900         }
 901       if (pending_timeout_last == t)
 902         pending_timeout_last = NULL;
 903     }
 904   p = 0;
 905   while (t == NULL)
 906     {
 907       p++;
 908       GNUNET_assert (p < GNUNET_SCHEDULER_PRIORITY_COUNT);
 909       prev = NULL;
 910       t = ready[p];
 911       while (t != NULL)
 912         {
 913           if (t->id == task)
 914             {
 915               ready_count--;
 916               break;
 917             }
 918           prev = t;
 919           t = t->next;
 920         }
 921     }
 922   if (prev == NULL)
 923     {
 924       if (p == 0)
 925         {
 926           if (to == 0)
 927             {
 928               pending = t->next;
 929             }
 930           else
 931             {
 932               pending_timeout = t->next;
 933             }
 934         }
 935       else
 936         {
 937           ready[p] = t->next;
 938         }
 939     }
 940   else
 941     {
 942       prev->next = t->next;
 943     }
 944   ret = t->callback_cls;
 945 #if DEBUG_TASKS
 946   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 947               "Canceling task: %llu / %p\n", task, t->callback_cls);
 948 #endif
 949   destroy_task (t);
 950   return ret;
 951 }
 952
 953
 954 /**
 955  * Continue the current execution with the given function.  This is
 956  * similar to the other "add" functions except that there is no delay
 957  * and the reason code can be specified.
 958  *
 959  * @param task main function of the task
 960  * @param task_cls closure for 'main'
 961  * @param reason reason for task invocation
 962  */
 963 void
 964 GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task,
 965                                    void *task_cls,
 966                                    enum GNUNET_SCHEDULER_Reason reason)
 967 {
 968   struct Task *t;
 969 #if EXECINFO
 970   void *backtrace_array[50];
 971 #endif
 972
 973   GNUNET_assert ( (active_task != NULL) ||
 974                   (reason == GNUNET_SCHEDULER_REASON_STARTUP) );
 975   t = GNUNET_malloc (sizeof (struct Task));
 976 #if EXECINFO
 977   t->num_backtrace_strings = backtrace(backtrace_array, 50);
 978   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
 979 #endif
 980   t->read_fd = -1;
 981   t->write_fd = -1;
 982   t->callback = task;
 983   t->callback_cls = task_cls;
 984   t->id = ++last_id;
 985 #if PROFILE_DELAYS
 986   t->start_time = GNUNET_TIME_absolute_get ();
 987 #endif
 988   t->reason = reason;
 989   t->priority = current_priority;
 990 #if DEBUG_TASKS
 991   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 992               "Adding continuation task: %llu / %p\n",
 993               t->id, t->callback_cls);
 994 #endif
 995   queue_ready_task (t);
 996 }
 997
 998
 999
1000 /**
1001  * Schedule a new task to be run after the specified prerequisite task
1002  * has completed. It will be run with the priority of the calling
1003  * task.
1004  *
1005  * @param prerequisite_task run this task after the task with the given
1006  *        task identifier completes (and any of our other
1007  *        conditions, such as delay, read or write-readiness
1008  *        are satisfied).  Use  GNUNET_SCHEDULER_NO_TASK to not have any dependency
1009  *        on completion of other tasks (this will cause the task to run as
1010  *        soon as possible).
1011  * @param task main function of the task
1012  * @param task_cls closure of task
1013  * @return unique task identifier for the job
1014  *         only valid until "task" is started!
1015  */
1016 GNUNET_SCHEDULER_TaskIdentifier
1017 GNUNET_SCHEDULER_add_after (GNUNET_SCHEDULER_TaskIdentifier prerequisite_task,
1018                             GNUNET_SCHEDULER_Task task, void *task_cls)
1019 {
1020   return GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_KEEP,
1021                                       prerequisite_task,
1022                                       GNUNET_TIME_UNIT_ZERO,
1023                                       NULL, NULL, task, task_cls);
1024 }
1025
1026
1027 /**
1028  * Schedule a new task to be run with a specified priority.
1029  *
1030  * @param prio how important is the new task?
1031  * @param task main function of the task
1032  * @param task_cls closure of task
1033  * @return unique task identifier for the job
1034  *         only valid until "task" is started!
1035  */
1036 GNUNET_SCHEDULER_TaskIdentifier
1037 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
1038                                     GNUNET_SCHEDULER_Task task,
1039                                     void *task_cls)
1040 {
1041   return GNUNET_SCHEDULER_add_select (prio,
1042                                       GNUNET_SCHEDULER_NO_TASK,
1043                                       GNUNET_TIME_UNIT_ZERO,
1044                                       NULL, NULL, task, task_cls);
1045 }
1046
1047
1048
1049 /**
1050  * Schedule a new task to be run with a specified delay.  The task
1051  * will be scheduled for execution once the delay has expired. It
1052  * will be run with the priority of the calling task.
1053  *
1054  * @param delay when should this operation time out? Use
1055  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1056  * @param task main function of the task
1057  * @param task_cls closure of task
1058  * @return unique task identifier for the job
1059  *         only valid until "task" is started!
1060  */
1061 GNUNET_SCHEDULER_TaskIdentifier
1062 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
1063                               GNUNET_SCHEDULER_Task task, void *task_cls)
1064 {
1065 #if 1
1066   /* new, optimized version */
1067   struct Task *t;
1068   struct Task *pos;
1069   struct Task *prev;
1070 #if EXECINFO
1071   void *backtrace_array[MAX_TRACE_DEPTH];
1072 #endif
1073
1074   GNUNET_assert (active_task != NULL);
1075   GNUNET_assert (NULL != task);
1076   t = GNUNET_malloc (sizeof (struct Task));
1077   t->callback = task;
1078   t->callback_cls = task_cls;
1079 #if EXECINFO
1080   t->num_backtrace_strings = backtrace(backtrace_array, MAX_TRACE_DEPTH);
1081   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
1082 #endif
1083   t->read_fd = -1;
1084   t->write_fd = -1;
1085   t->id = ++last_id;
1086 #if PROFILE_DELAYS
1087   t->start_time = GNUNET_TIME_absolute_get ();
1088 #endif
1089   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1090   t->priority = current_priority;
1091   /* try tail first (optimization in case we are
1092      appending to a long list of tasks with timeouts) */
1093   prev = pending_timeout_last;
1094   if (prev != NULL)
1095     {
1096       if (prev->timeout.abs_value > t->timeout.abs_value)
1097         prev = NULL;
1098       else
1099         pos = prev->next; /* heuristic success! */
1100     }
1101   if (prev == NULL)
1102     {
1103       /* heuristic failed, do traversal of timeout list */
1104       pos = pending_timeout;
1105     }
1106   while ( (pos != NULL) &&
1107           ( (pos->timeout.abs_value <= t->timeout.abs_value) ||
1108             (pos->reason != 0) ) )
1109     {
1110       prev = pos;
1111       pos = pos->next;
1112     }
1113   if (prev == NULL)
1114     pending_timeout = t;
1115   else
1116     prev->next = t;
1117   t->next = pos;
1118   /* hyper-optimization... */
1119   pending_timeout_last = t;
1120
1121 #if DEBUG_TASKS
1122   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1123               "Adding task: %llu / %p\n", t->id, t->callback_cls);
1124 #endif
1125 #if EXECINFO
1126   int i;
1127
1128   for (i=0;i<t->num_backtrace_strings;i++)
1129       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1130                   "Task %llu trace %d: %s\n",
1131                   t->id,
1132                   i,
1133                   t->backtrace_strings[i]);
1134 #endif
1135   return t->id;
1136
1137 #else
1138   /* unoptimized version */
1139   return GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_KEEP,
1140                                       GNUNET_SCHEDULER_NO_TASK, delay,
1141                                       NULL, NULL, task, task_cls);
1142 #endif
1143 }
1144
1145
1146
1147 /**
1148  * Schedule a new task to be run as soon as possible. The task
1149  * will be run with the priority of the calling task.
1150  *
1151  * @param task main function of the task
1152  * @param task_cls closure of task
1153  * @return unique task identifier for the job
1154  *         only valid until "task" is started!
1155  */
1156 GNUNET_SCHEDULER_TaskIdentifier
1157 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_Task task,
1158                                                   void *task_cls)
1159 {
1160   return GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_KEEP,
1161                                       GNUNET_SCHEDULER_NO_TASK,
1162                                       GNUNET_TIME_UNIT_ZERO,
1163                                       NULL, NULL, task, task_cls);
1164 }
1165
1166
1167
1168
1169 /**
1170  * Schedule a new task to be run with a specified delay or when any of
1171  * the specified file descriptor sets is ready.  The delay can be used
1172  * as a timeout on the socket(s) being ready.  The task will be
1173  * scheduled for execution once either the delay has expired or any of
1174  * the socket operations is ready.  This is the most general
1175  * function of the "add" family.  Note that the "prerequisite_task"
1176  * must be satisfied in addition to any of the other conditions.  In
1177  * other words, the task will be started when
1178  * <code>
1179  * (prerequisite-run)
1180  * && (delay-ready
1181  *     || any-rs-ready
1182  *     || any-ws-ready
1183  *     || shutdown-active )
1184  * </code>
1185  *
1186  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1187  *        which means that the task will only be run after we receive SIGTERM
1188  * @param rfd file descriptor we want to read (can be -1)
1189  * @param wfd file descriptors we want to write (can be -1)
1190  * @param task main function of the task
1191  * @param task_cls closure of task
1192  * @return unique task identifier for the job
1193  *         only valid until "task" is started!
1194  */
1195 #ifndef MINGW
1196 GNUNET_SCHEDULER_TaskIdentifier
1197 add_without_sets (struct GNUNET_TIME_Relative delay,
1198                   int rfd,
1199                   int wfd,
1200                   GNUNET_SCHEDULER_Task task, void *task_cls)
1201 {
1202   struct Task *t;
1203 #if EXECINFO
1204   void *backtrace_array[MAX_TRACE_DEPTH];
1205 #endif
1206
1207   GNUNET_assert (active_task != NULL);
1208   GNUNET_assert (NULL != task);
1209   t = GNUNET_malloc (sizeof (struct Task));
1210   t->callback = task;
1211   t->callback_cls = task_cls;
1212 #if EXECINFO
1213   t->num_backtrace_strings = backtrace(backtrace_array, MAX_TRACE_DEPTH);
1214   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
1215 #endif
1216   t->read_fd = rfd;
1217   t->write_fd = wfd;
1218   t->id = ++last_id;
1219 #if PROFILE_DELAYS
1220   t->start_time = GNUNET_TIME_absolute_get ();
1221 #endif
1222   t->prereq_id = GNUNET_SCHEDULER_NO_TASK;
1223   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1224   t->priority = check_priority (current_priority);
1225   t->next = pending;
1226   pending = t;
1227   max_priority_added = GNUNET_MAX (max_priority_added,
1228                                           t->priority);
1229 #if DEBUG_TASKS
1230   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1231               "Adding task: %llu / %p\n", t->id, t->callback_cls);
1232 #endif
1233 #if EXECINFO
1234   int i;
1235
1236   for (i=0;i<t->num_backtrace_strings;i++)
1237       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1238                   "Task %llu trace %d: %s\n",
1239                   t->id,
1240                   i,
1241                   t->backtrace_strings[i]);
1242 #endif
1243   return t->id;
1244 }
1245 #endif
1246
1247
1248
1249 /**
1250  * Schedule a new task to be run with a specified delay or when the
1251  * specified file descriptor is ready for reading.  The delay can be
1252  * used as a timeout on the socket being ready.  The task will be
1253  * scheduled for execution once either the delay has expired or the
1254  * socket operation is ready.  It will be run with the priority of
1255  * the calling task.
1256  *
1257  * @param delay when should this operation time out? Use
1258  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1259  * @param rfd read file-descriptor
1260  * @param task main function of the task
1261  * @param task_cls closure of task
1262  * @return unique task identifier for the job
1263  *         only valid until "task" is started!
1264  */
1265 GNUNET_SCHEDULER_TaskIdentifier
1266 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
1267                                struct GNUNET_NETWORK_Handle * rfd,
1268                                GNUNET_SCHEDULER_Task task, void *task_cls)
1269 {
1270 #if MINGW
1271   struct GNUNET_NETWORK_FDSet *rs;
1272   GNUNET_SCHEDULER_TaskIdentifier ret;
1273
1274   GNUNET_assert (rfd != NULL);
1275   rs = GNUNET_NETWORK_fdset_create ();
1276   GNUNET_NETWORK_fdset_set (rs, rfd);
1277   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1278                                      GNUNET_SCHEDULER_NO_TASK, delay,
1279                                      rs, NULL, task, task_cls);
1280   GNUNET_NETWORK_fdset_destroy (rs);
1281   return ret;
1282 #else
1283   return add_without_sets (delay,
1284                            GNUNET_NETWORK_get_fd (rfd),
1285                            -1,
1286                            task,
1287                            task_cls);
1288 #endif
1289 }
1290
1291
1292 /**
1293  * Schedule a new task to be run with a specified delay or when the
1294  * specified file descriptor is ready for writing.  The delay can be
1295  * used as a timeout on the socket being ready.  The task will be
1296  * scheduled for execution once either the delay has expired or the
1297  * socket operation is ready.  It will be run with the priority of
1298  * the calling task.
1299  *
1300  * @param delay when should this operation time out? Use
1301  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1302  * @param wfd write file-descriptor
1303  * @param task main function of the task
1304  * @param task_cls closure of task
1305  * @return unique task identifier for the job
1306  *         only valid until "task" is started!
1307  */
1308 GNUNET_SCHEDULER_TaskIdentifier
1309 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
1310                                 struct GNUNET_NETWORK_Handle * wfd,
1311                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1312 {
1313 #if MINGW
1314   struct GNUNET_NETWORK_FDSet *ws;
1315   GNUNET_SCHEDULER_TaskIdentifier ret;
1316
1317   GNUNET_assert (wfd != NULL);
1318   ws = GNUNET_NETWORK_fdset_create ();
1319   GNUNET_NETWORK_fdset_set (ws, wfd);
1320   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1321                                      GNUNET_SCHEDULER_NO_TASK, delay,
1322                                      NULL, ws, task, task_cls);
1323   GNUNET_NETWORK_fdset_destroy (ws);
1324   return ret;
1325 #else
1326   return add_without_sets (delay,
1327                            -1,
1328                            GNUNET_NETWORK_get_fd (wfd),
1329                            task,
1330                            task_cls);
1331 #endif
1332 }
1333
1334
1335 /**
1336  * Schedule a new task to be run with a specified delay or when the
1337  * specified file descriptor is ready for reading.  The delay can be
1338  * used as a timeout on the socket being ready.  The task will be
1339  * scheduled for execution once either the delay has expired or the
1340  * socket operation is ready. It will be run with the priority of
1341  * the calling task.
1342  *
1343  * @param delay when should this operation time out? Use
1344  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1345  * @param rfd read file-descriptor
1346  * @param task main function of the task
1347  * @param task_cls closure of task
1348  * @return unique task identifier for the job
1349  *         only valid until "task" is started!
1350  */
1351 GNUNET_SCHEDULER_TaskIdentifier
1352 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
1353                                 const struct GNUNET_DISK_FileHandle * rfd,
1354                                 GNUNET_SCHEDULER_Task task, void *task_cls)
1355 {
1356 #if MINGW
1357   struct GNUNET_NETWORK_FDSet *rs;
1358   GNUNET_SCHEDULER_TaskIdentifier ret;
1359
1360   GNUNET_assert (rfd != NULL);
1361   rs = GNUNET_NETWORK_fdset_create ();
1362   GNUNET_NETWORK_fdset_handle_set (rs, rfd);
1363   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1364                                      GNUNET_SCHEDULER_NO_TASK, delay,
1365                                      rs, NULL, task, task_cls);
1366   GNUNET_NETWORK_fdset_destroy (rs);
1367   return ret;
1368 #else
1369   int fd;
1370
1371   GNUNET_DISK_internal_file_handle_ (rfd, &fd, sizeof (int));
1372   return add_without_sets (delay,
1373                            fd,
1374                            -1,
1375                            task,
1376                            task_cls);
1377
1378 #endif
1379 }
1380
1381
1382 /**
1383  * Schedule a new task to be run with a specified delay or when the
1384  * specified file descriptor is ready for writing.  The delay can be
1385  * used as a timeout on the socket being ready.  The task will be
1386  * scheduled for execution once either the delay has expired or the
1387  * socket operation is ready. It will be run with the priority of
1388  * the calling task.
1389  *
1390  * @param delay when should this operation time out? Use
1391  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
1392  * @param wfd write file-descriptor
1393  * @param task main function of the task
1394  * @param task_cls closure of task
1395  * @return unique task identifier for the job
1396  *         only valid until "task" is started!
1397  */
1398 GNUNET_SCHEDULER_TaskIdentifier
1399 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
1400                                  const struct GNUNET_DISK_FileHandle * wfd,
1401                                  GNUNET_SCHEDULER_Task task, void *task_cls)
1402 {
1403 #if MINGW
1404   struct GNUNET_NETWORK_FDSet *ws;
1405   GNUNET_SCHEDULER_TaskIdentifier ret;
1406
1407   GNUNET_assert (wfd != NULL);
1408   ws = GNUNET_NETWORK_fdset_create ();
1409   GNUNET_NETWORK_fdset_handle_set (ws, wfd);
1410   ret = GNUNET_SCHEDULER_add_select (check_priority (current_priority),
1411                                      GNUNET_SCHEDULER_NO_TASK,
1412                                      delay, NULL, ws, task, task_cls);
1413   GNUNET_NETWORK_fdset_destroy (ws);
1414   return ret;
1415 #else
1416   int fd;
1417
1418   GNUNET_DISK_internal_file_handle_ (wfd, &fd, sizeof (int));
1419   return add_without_sets (delay,
1420                            -1,
1421                            fd,
1422                            task,
1423                            task_cls);
1424
1425 #endif
1426 }
1427
1428
1429
1430 /**
1431  * Schedule a new task to be run with a specified delay or when any of
1432  * the specified file descriptor sets is ready.  The delay can be used
1433  * as a timeout on the socket(s) being ready.  The task will be
1434  * scheduled for execution once either the delay has expired or any of
1435  * the socket operations is ready.  This is the most general
1436  * function of the "add" family.  Note that the "prerequisite_task"
1437  * must be satisfied in addition to any of the other conditions.  In
1438  * other words, the task will be started when
1439  * <code>
1440  * (prerequisite-run)
1441  * && (delay-ready
1442  *     || any-rs-ready
1443  *     || any-ws-ready
1444  *     || (shutdown-active && run-on-shutdown) )
1445  * </code>
1446  *
1447  * @param prio how important is this task?
1448  * @param prerequisite_task run this task after the task with the given
1449  *        task identifier completes (and any of our other
1450  *        conditions, such as delay, read or write-readiness
1451  *        are satisfied).  Use GNUNET_SCHEDULER_NO_TASK to not have any dependency
1452  *        on completion of other tasks.
1453  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
1454  *        which means that the task will only be run after we receive SIGTERM
1455  * @param rs set of file descriptors we want to read (can be NULL)
1456  * @param ws set of file descriptors we want to write (can be NULL)
1457  * @param task main function of the task
1458  * @param task_cls closure of task
1459  * @return unique task identifier for the job
1460  *         only valid until "task" is started!
1461  */
1462 GNUNET_SCHEDULER_TaskIdentifier
1463 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
1464                              GNUNET_SCHEDULER_TaskIdentifier
1465                              prerequisite_task,
1466                              struct GNUNET_TIME_Relative delay,
1467                              const struct GNUNET_NETWORK_FDSet * rs,
1468                              const struct GNUNET_NETWORK_FDSet * ws,
1469                              GNUNET_SCHEDULER_Task task, void *task_cls)
1470 {
1471   struct Task *t;
1472 #if EXECINFO
1473   void *backtrace_array[MAX_TRACE_DEPTH];
1474 #endif
1475
1476   GNUNET_assert (active_task != NULL);
1477   GNUNET_assert (NULL != task);
1478   t = GNUNET_malloc (sizeof (struct Task));
1479   t->callback = task;
1480   t->callback_cls = task_cls;
1481 #if EXECINFO
1482   t->num_backtrace_strings = backtrace(backtrace_array, MAX_TRACE_DEPTH);
1483   t->backtrace_strings = backtrace_symbols(backtrace_array, t->num_backtrace_strings);
1484 #endif
1485   t->read_fd = -1;
1486   t->write_fd = -1;
1487   if (rs != NULL)
1488     {
1489       t->read_set = GNUNET_NETWORK_fdset_create ();
1490       GNUNET_NETWORK_fdset_copy (t->read_set, rs);
1491     }
1492   if (ws != NULL)
1493     {
1494       t->write_set = GNUNET_NETWORK_fdset_create ();
1495       GNUNET_NETWORK_fdset_copy (t->write_set, ws);
1496     }
1497   t->id = ++last_id;
1498 #if PROFILE_DELAYS
1499   t->start_time = GNUNET_TIME_absolute_get ();
1500 #endif
1501   t->prereq_id = prerequisite_task;
1502   t->timeout = GNUNET_TIME_relative_to_absolute (delay);
1503   t->priority =
1504     check_priority ((prio ==
1505                      GNUNET_SCHEDULER_PRIORITY_KEEP) ? current_priority
1506                     : prio);
1507   t->next = pending;
1508   pending = t;
1509   max_priority_added = GNUNET_MAX (max_priority_added,
1510                                           t->priority);
1511 #if DEBUG_TASKS
1512   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1513               "Adding task: %llu / %p\n", t->id, t->callback_cls);
1514 #endif
1515 #if EXECINFO
1516   int i;
1517
1518   for (i=0;i<t->num_backtrace_strings;i++)
1519       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1520                   "Task %llu trace %d: %s\n",
1521                   t->id,
1522                   i,
1523                   t->backtrace_strings[i]);
1524 #endif
1525   return t->id;
1526 }
1527
1528 /* end of scheduler.c */