src/include/gnunet_scheduler_lib.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2009, 2011 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 include/gnunet_scheduler_lib.h
  23  * @brief API to schedule computations using continuation passing style
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_SCHEDULER_LIB_H
  28 #define GNUNET_SCHEDULER_LIB_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 /**
  39  * Opaque reference to a task.
  40  */
  41 typedef unsigned long long GNUNET_SCHEDULER_TaskIdentifier;
  42
  43
  44 /**
  45  * Constant used to indicate that the scheduled
  46  * task has no others as prerequisites.
  47  */
  48 #define GNUNET_SCHEDULER_NO_TASK ((GNUNET_SCHEDULER_TaskIdentifier) 0)
  49
  50 /**
  51  * Reasons why the schedule may have triggered
  52  * the task now.
  53  */
  54 enum GNUNET_SCHEDULER_Reason
  55 {
  56   /**
  57    * This is the very first task run during startup.
  58    */
  59   GNUNET_SCHEDULER_REASON_STARTUP = 0,
  60
  61   /**
  62    * We are shutting down and are running all shutdown-related tasks
  63    * (regardless of timeout, etc.).
  64    */
  65   GNUNET_SCHEDULER_REASON_SHUTDOWN = 1,
  66
  67   /**
  68    * The specified timeout has expired.
  69    * (also set if the delay given was 0).
  70    */
  71   GNUNET_SCHEDULER_REASON_TIMEOUT = 2,
  72
  73   /**
  74    * The reading socket is ready.
  75    */
  76   GNUNET_SCHEDULER_REASON_READ_READY = 4,
  77
  78   /**
  79    * The writing socket is ready.
  80    */
  81   GNUNET_SCHEDULER_REASON_WRITE_READY = 8,
  82
  83   /**
  84    * The prerequisite task is done.
  85    */
  86   GNUNET_SCHEDULER_REASON_PREREQ_DONE = 16
  87 };
  88
  89
  90 /**
  91  * Valid task priorities.  Use these, do not
  92  * pass random integers!
  93  */
  94 enum GNUNET_SCHEDULER_Priority
  95 {
  96   /**
  97    * Run with the same priority as the current job.
  98    */
  99   GNUNET_SCHEDULER_PRIORITY_KEEP = 0,
 100
 101   /**
 102    * Run when otherwise idle.
 103    */
 104   GNUNET_SCHEDULER_PRIORITY_IDLE = 1,
 105
 106   /**
 107    * Run as background job (higher than idle,
 108    * lower than default).
 109    */
 110   GNUNET_SCHEDULER_PRIORITY_BACKGROUND = 2,
 111
 112   /**
 113    * Run with the default priority (normal
 114    * P2P operations).  Higher than BACKGROUND.
 115    */
 116   GNUNET_SCHEDULER_PRIORITY_DEFAULT = 3,
 117
 118   /**
 119    * Run with high priority (important requests).
 120    * Higher than DEFAULT.
 121    */
 122   GNUNET_SCHEDULER_PRIORITY_HIGH = 4,
 123
 124   /**
 125    * Run with priority for interactive tasks.
 126    * Higher than "HIGH".
 127    */
 128   GNUNET_SCHEDULER_PRIORITY_UI = 5,
 129
 130   /**
 131    * Run with priority for urgent tasks.  Use
 132    * for things like aborts and shutdowns that
 133    * need to preempt "UI"-level tasks.
 134    * Higher than "UI".
 135    */
 136   GNUNET_SCHEDULER_PRIORITY_URGENT = 6,
 137
 138   /**
 139    * This is an internal priority level that is only used for tasks
 140    * that are being triggered due to shutdown (they have automatically
 141    * highest priority).  User code must not use this priority level
 142    * directly.  Tasks run with this priority level that internally
 143    * schedule other tasks will see their original priority level
 144    * be inherited (unless otherwise specified).
 145    */
 146   GNUNET_SCHEDULER_PRIORITY_SHUTDOWN = 7,
 147
 148   /**
 149    * Number of priorities (must be the last priority).
 150    * This priority must not be used by clients.
 151    */
 152   GNUNET_SCHEDULER_PRIORITY_COUNT = 8
 153 };
 154
 155 #include "gnunet_time_lib.h"
 156 #include "gnunet_network_lib.h"
 157
 158
 159 /**
 160  * Context information passed to each scheduler task.
 161  */
 162 struct GNUNET_SCHEDULER_TaskContext
 163 {
 164   /**
 165    * Reason why the task is run now
 166    */
 167   enum GNUNET_SCHEDULER_Reason reason;
 168
 169   /**
 170    * Set of file descriptors ready for reading;
 171    * note that additional bits may be set
 172    * that were not in the original request
 173    */
 174   const struct GNUNET_NETWORK_FDSet *read_ready;
 175
 176   /**
 177    * Set of file descriptors ready for writing;
 178    * note that additional bits may be set
 179    * that were not in the original request.
 180    */
 181   const struct GNUNET_NETWORK_FDSet *write_ready;
 182
 183 };
 184
 185
 186 /**
 187  * Signature of the main function of a task.
 188  *
 189  * @param cls closure
 190  * @param tc context information (why was this task triggered now)
 191  */
 192 typedef void (*GNUNET_SCHEDULER_Task) (void *cls,
 193                                        const struct
 194                                        GNUNET_SCHEDULER_TaskContext * tc);
 195
 196
 197 /**
 198  * Signature of the select function used by the scheduler.
 199  * GNUNET_NETWORK_socket_select matches it.
 200  *
 201  * @param cls closure
 202  * @param rfds set of sockets to be checked for readability
 203  * @param wfds set of sockets to be checked for writability
 204  * @param efds set of sockets to be checked for exceptions
 205  * @param timeout relative value when to return
 206  * @return number of selected sockets, GNUNET_SYSERR on error
 207  */
 208 typedef int (*GNUNET_SCHEDULER_select) (void *cls,
 209                                         struct GNUNET_NETWORK_FDSet *rfds,
 210                                         struct GNUNET_NETWORK_FDSet *wfds,
 211                                         struct GNUNET_NETWORK_FDSet *efds,
 212                                         struct GNUNET_TIME_Relative timeout);
 213 /**
 214  * Initialize and run scheduler.  This function will return when all
 215  * tasks have completed.  On systems with signals, receiving a SIGTERM
 216  * (and other similar signals) will cause "GNUNET_SCHEDULER_shutdown"
 217  * to be run after the active task is complete.  As a result, SIGTERM
 218  * causes all active tasks to be scheduled with reason
 219  * "GNUNET_SCHEDULER_REASON_SHUTDOWN".  (However, tasks added
 220  * afterwards will execute normally!).  Note that any particular
 221  * signal will only shut down one scheduler; applications should
 222  * always only create a single scheduler.
 223  *
 224  * @param task task to run first (and immediately)
 225  * @param task_cls closure of task
 226  */
 227 void GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_Task task, void *task_cls);
 228
 229
 230 /**
 231  * Request the shutdown of a scheduler.  Marks all currently
 232  * pending tasks as ready because of shutdown.  This will
 233  * cause all tasks to run (as soon as possible, respecting
 234  * priorities and prerequisite tasks).  Note that tasks
 235  * scheduled AFTER this call may still be delayed arbitrarily.
 236  */
 237 void GNUNET_SCHEDULER_shutdown ();
 238
 239
 240 /**
 241  * Get information about the current load of this scheduler.  Use this
 242  * function to determine if an elective task should be added or simply
 243  * dropped (if the decision should be made based on the number of
 244  * tasks ready to run).
 245  *
 246  * * @param p priority-level to query, use KEEP to query the level
 247  *          of the current task, use COUNT to get the sum over
 248  *          all priority levels
 249  * @return number of tasks pending right now
 250  */
 251 unsigned int GNUNET_SCHEDULER_get_load (enum GNUNET_SCHEDULER_Priority p);
 252
 253
 254 /**
 255  * Obtain the reason code for why the current task was
 256  * started.  Will return the same value as
 257  * the GNUNET_SCHEDULER_TaskContext's reason field.
 258  *
 259  * * @return reason(s) why the current task is run
 260  */
 261 enum GNUNET_SCHEDULER_Reason
 262 GNUNET_SCHEDULER_get_reason ();
 263
 264
 265 /**
 266  * Cancel the task with the specified identifier.
 267  * The task must not yet have run.
 268  *
 269  * * @param task id of the task to cancel
 270  * @return the closure of the callback of the cancelled task
 271  */
 272 void *GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task);
 273
 274
 275 /**
 276  * Continue the current execution with the given function.  This is
 277  * similar to the other "add" functions except that there is no delay
 278  * and the reason code can be specified.
 279  *
 280  * * @param task main function of the task
 281  * @param task_cls closure of task
 282  * @param reason reason for task invocation
 283  */
 284 void
 285 GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task,
 286                                    void *task_cls,
 287                                    enum GNUNET_SCHEDULER_Reason reason);
 288
 289
 290 /**
 291  * Schedule a new task to be run after the specified prerequisite task
 292  * has completed. It will be run with the priority of the calling
 293  * task.
 294  *
 295  * * @param prerequisite_task run this task after the task with the given
 296  *        task identifier completes (and any of our other
 297  *        conditions, such as delay, read or write-readiness
 298  *        are satisfied).  Use  GNUNET_SCHEDULER_NO_TASK to not have any dependency
 299  *        on completion of other tasks (this will cause the task to run as
 300  *        soon as possible).
 301  * @param task main function of the task
 302  * @param task_cls closure of task
 303  * @return unique task identifier for the job
 304  *         only valid until "task" is started!
 305  */
 306 GNUNET_SCHEDULER_TaskIdentifier
 307 GNUNET_SCHEDULER_add_after (GNUNET_SCHEDULER_TaskIdentifier prerequisite_task,
 308                             GNUNET_SCHEDULER_Task task,
 309                             void *task_cls);
 310
 311
 312 /**
 313  * Schedule a new task to be run with a specified priority.
 314  *
 315  * * @param prio how important is the new task?
 316  * @param task main function of the task
 317  * @param task_cls closure of task
 318  * @return unique task identifier for the job
 319  *         only valid until "task" is started!
 320  */
 321 GNUNET_SCHEDULER_TaskIdentifier
 322 GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
 323                                     GNUNET_SCHEDULER_Task task,
 324                                     void *task_cls);
 325
 326
 327 /**
 328  * Schedule a new task to be run as soon as possible. The task
 329  * will be run with the priority of the calling task.
 330  *
 331  * * @param task main function of the task
 332  * @param task_cls closure of task
 333  * @return unique task identifier for the job
 334  *         only valid until "task" is started!
 335  */
 336 GNUNET_SCHEDULER_TaskIdentifier
 337 GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_Task task,
 338                           void *task_cls);
 339
 340
 341 /**
 342  * Schedule a new task to be run as soon as possible with the
 343  * (transitive) ignore-shutdown flag either explicitly set or
 344  * explicitly enabled.  This task (and all tasks created from it,
 345  * other than by another call to this function) will either count or
 346  * not count for the 'lifeness' of the process.  This API is only
 347  * useful in a few special cases.
 348  *
 349  * @param lifeness GNUNET_YES if the task counts for lifeness, GNUNET_NO if not.
 350  * @param task main function of the task
 351  * @param task_cls closure of task
 352  * @return unique task identifier for the job
 353  *         only valid until "task" is started!
 354  */
 355 GNUNET_SCHEDULER_TaskIdentifier
 356 GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
 357                                         GNUNET_SCHEDULER_Task task,
 358                                         void *task_cls);
 359
 360
 361 /**
 362  * Schedule a new task to be run with a specified delay.  The task
 363  * will be scheduled for execution once the delay has expired. It
 364  * will be run with the priority of the calling task.
 365  *
 366  * * @param delay when should this operation time out? Use
 367  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
 368  * @param task main function of the task
 369  * @param task_cls closure of task
 370  * @return unique task identifier for the job
 371  *         only valid until "task" is started!
 372  */
 373 GNUNET_SCHEDULER_TaskIdentifier
 374 GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
 375                               GNUNET_SCHEDULER_Task task,
 376                               void *task_cls);
 377
 378
 379 /**
 380  * Schedule a new task to be run with a specified delay or when the
 381  * specified file descriptor is ready for reading.  The delay can be
 382  * used as a timeout on the socket being ready.  The task will be
 383  * scheduled for execution once either the delay has expired or the
 384  * socket operation is ready.  It will be run with the priority of
 385  * the calling task.
 386  *
 387  * * @param delay when should this operation time out? Use
 388  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
 389  * @param rfd read file-descriptor
 390  * @param task main function of the task
 391  * @param task_cls closure of task
 392  * @return unique task identifier for the job
 393  *         only valid until "task" is started!
 394  */
 395 GNUNET_SCHEDULER_TaskIdentifier
 396 GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
 397                                struct GNUNET_NETWORK_Handle *rfd,
 398                                GNUNET_SCHEDULER_Task task,
 399                                void *task_cls);
 400
 401
 402 /**
 403  * Schedule a new task to be run with a specified delay or when the
 404  * specified file descriptor is ready for writing.  The delay can be
 405  * used as a timeout on the socket being ready.  The task will be
 406  * scheduled for execution once either the delay has expired or the
 407  * socket operation is ready.  It will be run with the priority of
 408  * the calling task.
 409  *
 410  * * @param delay when should this operation time out? Use
 411  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
 412  * @param wfd write file-descriptor
 413  * @param task main function of the task
 414  * @param task_cls closure of task
 415  * @return unique task identifier for the job
 416  *         only valid until "task" is started!
 417  */
 418 GNUNET_SCHEDULER_TaskIdentifier
 419 GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
 420                                 struct GNUNET_NETWORK_Handle *wfd,
 421                                 GNUNET_SCHEDULER_Task task,
 422                                 void *task_cls);
 423
 424
 425 /**
 426  * Schedule a new task to be run with a specified delay or when the
 427  * specified file descriptor is ready for reading.  The delay can be
 428  * used as a timeout on the socket being ready.  The task will be
 429  * scheduled for execution once either the delay has expired or the
 430  * socket operation is ready. It will be run with the priority of
 431  * the calling task.
 432  *
 433  * * @param delay when should this operation time out? Use
 434  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
 435  * @param rfd read file-descriptor
 436  * @param task main function of the task
 437  * @param task_cls closure of task
 438  * @return unique task identifier for the job
 439  *         only valid until "task" is started!
 440  */
 441 GNUNET_SCHEDULER_TaskIdentifier
 442 GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
 443                                 const struct GNUNET_DISK_FileHandle *rfd,
 444                                 GNUNET_SCHEDULER_Task task,
 445                                 void *task_cls);
 446
 447
 448 /**
 449  * Schedule a new task to be run with a specified delay or when the
 450  * specified file descriptor is ready for writing.  The delay can be
 451  * used as a timeout on the socket being ready.  The task will be
 452  * scheduled for execution once either the delay has expired or the
 453  * socket operation is ready. It will be run with the priority of
 454  * the calling task.
 455  *
 456  * * @param delay when should this operation time out? Use
 457  *        GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
 458  * @param wfd write file-descriptor
 459  * @param task main function of the task
 460  * @param task_cls closure of task
 461  * @return unique task identifier for the job
 462  *         only valid until "task" is started!
 463  */
 464 GNUNET_SCHEDULER_TaskIdentifier
 465 GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
 466                                  const struct GNUNET_DISK_FileHandle *wfd,
 467                                  GNUNET_SCHEDULER_Task task,
 468                                  void *task_cls);
 469
 470
 471 /**
 472  * Schedule a new task to be run with a specified delay or when any of
 473  * the specified file descriptor sets is ready.  The delay can be used
 474  * as a timeout on the socket(s) being ready.  The task will be
 475  * scheduled for execution once either the delay has expired or any of
 476  * the socket operations is ready.  This is the most general
 477  * function of the "add" family.  Note that the "prerequisite_task"
 478  * must be satisfied in addition to any of the other conditions.  In
 479  * other words, the task will be started when
 480  * <code>
 481  * (prerequisite-run)
 482  * && (delay-ready
 483  *     || any-rs-ready
 484  *     || any-ws-ready
 485  *     || shutdown-active)
 486  * </code>
 487  *
 488  * * @param prio how important is this task?
 489  * @param prerequisite_task run this task after the task with the given
 490  *        task identifier completes (and any of our other
 491  *        conditions, such as delay, read or write-readiness
 492  *        are satisfied).  Use GNUNET_SCHEDULER_NO_TASK to not have any dependency
 493  *        on completion of other tasks.
 494  * @param delay how long should we wait? Use GNUNET_TIME_UNIT_FOREVER_REL for "forever",
 495  *        which means that the task will only be run after we receive SIGTERM
 496  * @param rs set of file descriptors we want to read (can be NULL)
 497  * @param ws set of file descriptors we want to write (can be NULL)
 498  * @param task main function of the task
 499  * @param task_cls closure of task
 500  * @return unique task identifier for the job
 501  *         only valid until "task" is started!
 502  */
 503 GNUNET_SCHEDULER_TaskIdentifier
 504 GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
 505                              GNUNET_SCHEDULER_TaskIdentifier
 506                              prerequisite_task,
 507                              struct GNUNET_TIME_Relative delay,
 508                              const struct GNUNET_NETWORK_FDSet * rs,
 509                              const struct GNUNET_NETWORK_FDSet * ws,
 510                              GNUNET_SCHEDULER_Task task,
 511                              void *task_cls);
 512
 513 /**
 514  * Sets the select function to use in the scheduler (scheduler_select).
 515  *
 516  * @param new_select new select function to use (NULL to reset to default)
 517  * @param new_select_cls closure for 'new_select'
 518  */
 519 void
 520 GNUNET_SCHEDULER_set_select (GNUNET_SCHEDULER_select new_select,
 521                              void *new_select_cls);
 522
 523
 524 #if 0                           /* keep Emacsens' auto-indent happy */
 525 {
 526 #endif
 527 #ifdef __cplusplus
 528 }
 529 #endif
 530
 531 #endif