job.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef foojobhfoo
   4 #define foojobhfoo
   5
   6 #include <stdbool.h>
   7 #include <inttypes.h>
   8
   9 typedef struct Job Job;
  10 typedef struct JobDependency JobDependency;
  11 typedef enum JobType JobType;
  12 typedef enum JobState JobState;
  13 typedef enum JobMode JobMode;
  14
  15 #include "manager.h"
  16 #include "name.h"
  17 #include "hashmap.h"
  18 #include "list.h"
  19
  20 enum JobType {
  21         JOB_START,                  /* if a name does not support being started, we'll just wait until it becomes active */
  22         JOB_VERIFY_ACTIVE,
  23
  24         JOB_STOP,
  25
  26         JOB_RELOAD,                 /* if running reload */
  27         JOB_RELOAD_OR_START,        /* if running reload, if not running start */
  28
  29         /* Note that restarts are first treated like JOB_STOP, but
  30          * then instead of finishing are patched to become
  31          * JOB_START. */
  32         JOB_RESTART,                /* if running stop, then start unconditionally */
  33         JOB_TRY_RESTART,            /* if running stop and then start */
  34
  35         _JOB_TYPE_MAX,
  36         _JOB_TYPE_INVALID = -1
  37 };
  38
  39 enum JobState {
  40         JOB_WAITING,
  41         JOB_RUNNING,
  42         _JOB_STATE_MAX
  43 };
  44
  45 enum JobMode {
  46         JOB_FAIL,
  47         JOB_REPLACE,
  48         _JOB_MODE_MAX
  49 };
  50
  51 struct JobDependency {
  52         /* Encodes that the 'subject' job needs the 'object' job in
  53          * some way. This structure is used only while building a transaction. */
  54         Job *subject;
  55         Job *object;
  56
  57         bool matters;
  58
  59         LIST_FIELDS(JobDependency, subject);
  60         LIST_FIELDS(JobDependency, object);
  61 };
  62
  63 struct Job {
  64         Manager *manager;
  65         uint32_t id;
  66
  67         Name *name;
  68
  69         JobType type;
  70         JobState state;
  71
  72         bool linked:1;
  73         bool in_run_queue:1;
  74         bool matters_to_anchor:1;
  75         bool forced:1;
  76
  77         LIST_FIELDS(Job, transaction);
  78         LIST_FIELDS(Job, run_queue);
  79
  80         JobDependency *subject_list;
  81         JobDependency *object_list;
  82
  83         /* Used for graph algs as a "I have been here" marker */
  84         Job* marker;
  85         unsigned generation;
  86
  87 };
  88
  89 Job* job_new(Manager *m, JobType type, Name *name);
  90 void job_free(Job *job);
  91 void job_dump(Job *j, FILE*f, const char *prefix);
  92
  93 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters);
  94 void job_dependency_free(JobDependency *l);
  95 void job_dependency_delete(Job *subject, Job *object, bool *matters);
  96
  97 bool job_is_anchor(Job *j);
  98
  99 int job_merge(Job *j, Job *other);
 100
 101 const char* job_type_to_string(JobType t);
 102 int job_type_merge(JobType *a, JobType b);
 103 bool job_type_is_mergeable(JobType a, JobType b);
 104 bool job_type_is_superset(JobType a, JobType b);
 105 bool job_type_is_conflicting(JobType a, JobType b);
 106
 107 void job_schedule_run(Job *j);
 108 int job_run_and_invalidate(Job *j);
 109 int job_finish_and_invalidate(Job *j, bool success);
 110
 111 #endif