job.h 4.28 KB
Newer Older
Lennart Poettering's avatar
Lennart Poettering committed
1
2
3
4
5
/*-*- Mode: C; c-basic-offset: 8 -*-*/

#ifndef foojobhfoo
#define foojobhfoo

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/***
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

Lennart Poettering's avatar
Lennart Poettering committed
25
26
27
28
#include <stdbool.h>
#include <inttypes.h>

typedef struct Job Job;
29
typedef struct JobDependency JobDependency;
Lennart Poettering's avatar
Lennart Poettering committed
30
typedef enum JobType JobType;
31
typedef enum JobState JobState;
32
typedef enum JobMode JobMode;
Lennart Poettering's avatar
Lennart Poettering committed
33
34

#include "manager.h"
Lennart Poettering's avatar
Lennart Poettering committed
35
#include "unit.h"
Lennart Poettering's avatar
Lennart Poettering committed
36
37
38
39
#include "hashmap.h"
#include "list.h"

enum JobType {
Lennart Poettering's avatar
Lennart Poettering committed
40
        JOB_START,                  /* if a unit does not support being started, we'll just wait until it becomes active */
41
42
        JOB_VERIFY_ACTIVE,

Lennart Poettering's avatar
Lennart Poettering committed
43
        JOB_STOP,
44
45
46
47
48
49
50
51
52
53

        JOB_RELOAD,                 /* if running reload */
        JOB_RELOAD_OR_START,        /* if running reload, if not running start */

        /* Note that restarts are first treated like JOB_STOP, but
         * then instead of finishing are patched to become
         * JOB_START. */
        JOB_RESTART,                /* if running stop, then start unconditionally */
        JOB_TRY_RESTART,            /* if running stop and then start */

54
55
        _JOB_TYPE_MAX,
        _JOB_TYPE_INVALID = -1
Lennart Poettering's avatar
Lennart Poettering committed
56
57
};

58
enum JobState {
Lennart Poettering's avatar
Lennart Poettering committed
59
60
        JOB_WAITING,
        JOB_RUNNING,
61
62
        _JOB_STATE_MAX,
        _JOB_STATE_INVALID = -1
63
};
Lennart Poettering's avatar
Lennart Poettering committed
64
65
66
67

enum JobMode {
        JOB_FAIL,
        JOB_REPLACE,
68
        JOB_ISOLATE,
69
70
        _JOB_MODE_MAX,
        _JOB_MODE_INVALID = -1
Lennart Poettering's avatar
Lennart Poettering committed
71
72
};

73
74
75
76
77
78
struct JobDependency {
        /* Encodes that the 'subject' job needs the 'object' job in
         * some way. This structure is used only while building a transaction. */
        Job *subject;
        Job *object;

79
80
        LIST_FIELDS(JobDependency, subject);
        LIST_FIELDS(JobDependency, object);
81
82

        bool matters;
83
84
};

Lennart Poettering's avatar
Lennart Poettering committed
85
86
struct Job {
        Manager *manager;
Lennart Poettering's avatar
Lennart Poettering committed
87
        Unit *unit;
88

89
90
        LIST_FIELDS(Job, transaction);
        LIST_FIELDS(Job, run_queue);
91
        LIST_FIELDS(Job, dbus_queue);
92

Lennart Poettering's avatar
Lennart Poettering committed
93
94
        LIST_HEAD(JobDependency, subject_list);
        LIST_HEAD(JobDependency, object_list);
95

96
        /* Used for graph algs as a "I have been here" marker */
97
98
        Job* marker;
        unsigned generation;
99

100
101
102
103
104
        uint32_t id;

        JobType type;
        JobState state;

105
106
        Watch timer_watch;

107
108
109
110
        /* Note that this bus object is not ref counted here. */
        DBusConnection *bus;
        char *bus_client;

111
112
113
114
115
116
        bool installed:1;
        bool in_run_queue:1;
        bool matters_to_anchor:1;
        bool override:1;
        bool in_dbus_queue:1;
        bool sent_dbus_new_signal:1;
117
        bool failed:1;
Lennart Poettering's avatar
Lennart Poettering committed
118
119
};

Lennart Poettering's avatar
Lennart Poettering committed
120
Job* job_new(Manager *m, JobType type, Unit *unit);
Lennart Poettering's avatar
Lennart Poettering committed
121
void job_free(Job *job);
Lennart Poettering's avatar
Lennart Poettering committed
122
void job_dump(Job *j, FILE*f, const char *prefix);
Lennart Poettering's avatar
Lennart Poettering committed
123

124
125
126
127
128
129
130
131
JobDependency* job_dependency_new(Job *subject, Job *object, bool matters);
void job_dependency_free(JobDependency *l);
void job_dependency_delete(Job *subject, Job *object, bool *matters);

bool job_is_anchor(Job *j);

int job_merge(Job *j, Job *other);

Lennart Poettering's avatar
Lennart Poettering committed
132
int job_type_merge(JobType *a, JobType b);
133
bool job_type_is_mergeable(JobType a, JobType b);
Lennart Poettering's avatar
Lennart Poettering committed
134
bool job_type_is_superset(JobType a, JobType b);
135
bool job_type_is_conflicting(JobType a, JobType b);
136
bool job_type_is_redundant(JobType a, UnitActiveState b);
137

138
139
bool job_is_runnable(Job *j);

140
141
142
void job_add_to_run_queue(Job *j);
void job_add_to_dbus_queue(Job *j);

143
144
145
int job_start_timer(Job *j);
void job_timer_event(Job *j, uint64_t n_elapsed, Watch *w);

146
147
int job_run_and_invalidate(Job *j);
int job_finish_and_invalidate(Job *j, bool success);
Lennart Poettering's avatar
Lennart Poettering committed
148

149
150
char *job_dbus_path(Job *j);

151
152
153
154
155
156
const char* job_type_to_string(JobType t);
JobType job_type_from_string(const char *s);

const char* job_state_to_string(JobState t);
JobState job_state_from_string(const char *s);

157
158
159
const char* job_mode_to_string(JobMode t);
JobMode job_mode_from_string(const char *s);

Lennart Poettering's avatar
Lennart Poettering committed
160
#endif