1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 typedef union Unit Unit
;
29 typedef struct Meta Meta
;
30 typedef struct UnitVTable UnitVTable
;
31 typedef enum UnitType UnitType
;
32 typedef enum UnitLoadState UnitLoadState
;
33 typedef enum UnitActiveState UnitActiveState
;
34 typedef enum UnitDependency UnitDependency
;
39 #include "socket-util.h"
42 #define UNIT_NAME_MAX 128
43 #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC)
44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
56 _UNIT_TYPE_INVALID
= -1,
64 _UNIT_LOAD_STATE_INVALID
= -1
67 enum UnitActiveState
{
69 UNIT_ACTIVE_RELOADING
,
73 _UNIT_ACTIVE_STATE_MAX
,
74 _UNIT_ACTIVE_STATE_INVALID
= -1
77 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
78 return t
== UNIT_ACTIVE
|| t
== UNIT_ACTIVE_RELOADING
;
81 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
82 return t
== UNIT_ACTIVE
|| t
== UNIT_ACTIVATING
|| t
== UNIT_ACTIVE_RELOADING
;
85 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
86 return t
== UNIT_INACTIVE
|| t
== UNIT_DEACTIVATING
;
90 /* Positive dependencies */
97 /* Inverse of the above */
98 UNIT_REQUIRED_BY
, /* inverse of 'requires' and 'requisite' is 'required_by' */
99 UNIT_SOFT_REQUIRED_BY
, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
100 UNIT_WANTED_BY
, /* inverse of 'wants' */
102 /* Negative dependencies */
103 UNIT_CONFLICTS
, /* inverse of 'conflicts' is 'conflicts' */
106 UNIT_BEFORE
, /* inverse of before is after and vice versa */
109 _UNIT_DEPENDENCY_MAX
,
110 _UNIT_DEPENDENCY_INVALID
= -1
120 UnitLoadState load_state
;
122 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
125 Set
*dependencies
[_UNIT_DEPENDENCY_MAX
];
128 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
130 /* If there is something to do with this unit, then this is
134 bool in_load_queue
:1;
135 bool in_dbus_queue
:1;
136 bool sent_dbus_new_signal
:1;
138 /* If we go down, pull down everything that depends on us, too */
141 /* Garbage collect us we nobody wants or requires us anymore */
142 bool stop_when_unneeded
;
144 usec_t active_enter_timestamp
;
145 usec_t active_exit_timestamp
;
147 /* Counterparts in the cgroup filesystem */
148 CGroupBonding
*cgroup_bondings
;
151 LIST_FIELDS(Meta
, load_queue
);
154 LIST_FIELDS(Meta
, units_per_type
);
157 LIST_FIELDS(Meta
, dbus_queue
);
166 #include "automount.h"
167 #include "snapshot.h"
184 int (*init
)(Unit
*u
);
185 void (*done
)(Unit
*u
);
186 int (*coldplug
)(Unit
*u
);
188 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
190 int (*start
)(Unit
*u
);
191 int (*stop
)(Unit
*u
);
192 int (*reload
)(Unit
*u
);
194 bool (*can_reload
)(Unit
*u
);
196 /* Boils down the more complex internal state of this unit to
197 * a simpler one that the engine can understand */
198 UnitActiveState (*active_state
)(Unit
*u
);
200 void (*fd_event
)(Unit
*u
, int fd
, uint32_t events
, Watch
*w
);
201 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
202 void (*timer_event
)(Unit
*u
, uint64_t n_elapsed
, Watch
*w
);
204 void (*cgroup_notify_empty
)(Unit
*u
);
206 /* This is called for each unit type and should be used to
207 * enumerate existing devices and load them. However,
208 * everything that is loaded here should still stay in
209 * inactive state. It is the job of the coldplug() call above
210 * to put the units into the initial state. */
211 int (*enumerate
)(Manager
*m
);
213 /* Type specific cleanups. */
214 void (*shutdown
)(Manager
*m
);
217 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
219 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
221 /* For casting a unit into the various unit types */
222 #define DEFINE_CAST(UPPERCASE, MixedCase) \
223 static inline MixedCase* UPPERCASE(Unit *u) { \
224 if (!u || u->meta.type != UNIT_##UPPERCASE) \
227 return (MixedCase*) u; \
230 /* For casting the various unit types into a unit */
231 #define UNIT(u) ((Unit*) (u))
233 DEFINE_CAST(SOCKET
, Socket
);
234 DEFINE_CAST(TIMER
, Timer
);
235 DEFINE_CAST(SERVICE
, Service
);
236 DEFINE_CAST(TARGET
, Target
);
237 DEFINE_CAST(DEVICE
, Device
);
238 DEFINE_CAST(MOUNT
, Mount
);
239 DEFINE_CAST(AUTOMOUNT
, Automount
);
240 DEFINE_CAST(SNAPSHOT
, Snapshot
);
242 UnitType
unit_name_to_type(const char *n
);
243 bool unit_name_is_valid(const char *n
);
244 char *unit_name_change_suffix(const char *n
, const char *suffix
);
246 Unit
*unit_new(Manager
*m
);
247 void unit_free(Unit
*u
);
249 int unit_add_name(Unit
*u
, const char *name
);
250 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
);
251 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
);
252 int unit_add_dependency_by_name_inverse(Unit
*u
, UnitDependency d
, const char *name
);
254 int unit_add_cgroup(Unit
*u
, CGroupBonding
*b
);
255 int unit_add_cgroup_from_text(Unit
*u
, const char *name
);
256 int unit_add_default_cgroup(Unit
*u
);
257 CGroupBonding
* unit_get_default_cgroup(Unit
*u
);
259 int unit_choose_id(Unit
*u
, const char *name
);
260 int unit_set_description(Unit
*u
, const char *description
);
262 void unit_add_to_load_queue(Unit
*u
);
263 void unit_add_to_dbus_queue(Unit
*u
);
265 int unit_merge(Unit
*u
, Unit
*other
);
267 int unit_load_fragment_and_dropin(Unit
*u
);
268 int unit_load(Unit
*unit
);
270 const char* unit_id(Unit
*u
);
271 const char *unit_description(Unit
*u
);
273 UnitActiveState
unit_active_state(Unit
*u
);
275 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
277 bool unit_can_reload(Unit
*u
);
278 bool unit_can_start(Unit
*u
);
280 int unit_start(Unit
*u
);
281 int unit_stop(Unit
*u
);
282 int unit_reload(Unit
*u
);
284 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
);
286 int unit_watch_fd(Unit
*u
, int fd
, uint32_t events
, Watch
*w
);
287 void unit_unwatch_fd(Unit
*u
, Watch
*w
);
289 int unit_watch_pid(Unit
*u
, pid_t pid
);
290 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
292 int unit_watch_timer(Unit
*u
, usec_t delay
, Watch
*w
);
293 void unit_unwatch_timer(Unit
*u
, Watch
*w
);
295 bool unit_job_is_applicable(Unit
*u
, JobType j
);
297 int set_unit_path(const char *p
);
299 char *unit_name_escape_path(const char *path
, const char *suffix
);
301 const char *unit_type_to_string(UnitType i
);
302 UnitType
unit_type_from_string(const char *s
);
304 const char *unit_load_state_to_string(UnitLoadState i
);
305 UnitLoadState
unit_load_state_from_string(const char *s
);
307 const char *unit_active_state_to_string(UnitActiveState i
);
308 UnitActiveState
unit_active_state_from_string(const char *s
);
310 const char *unit_dependency_to_string(UnitDependency i
);
311 UnitDependency
unit_dependency_from_string(const char *s
);
313 char *unit_dbus_path(Unit
*u
);