1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2010 Lennart Poettering
16 #include "cgroup-util.h"
19 #include "ip-address-access.h"
21 #include "ratelimit.h"
23 struct libmnt_monitor
;
25 /* Enforce upper limit how many names we allow */
26 #define MANAGER_MAX_NAMES 131072 /* 128K */
28 typedef struct Manager Manager
;
30 typedef enum ManagerState
{
38 _MANAGER_STATE_INVALID
= -1
41 typedef enum ManagerExitCode
{
51 _MANAGER_EXIT_CODE_MAX
,
52 _MANAGER_EXIT_CODE_INVALID
= -1
55 typedef enum StatusType
{
56 STATUS_TYPE_EPHEMERAL
,
58 STATUS_TYPE_EMERGENCY
,
61 typedef enum ManagerTimestamp
{
62 MANAGER_TIMESTAMP_FIRMWARE
,
63 MANAGER_TIMESTAMP_LOADER
,
64 MANAGER_TIMESTAMP_KERNEL
,
65 MANAGER_TIMESTAMP_INITRD
,
66 MANAGER_TIMESTAMP_USERSPACE
,
67 MANAGER_TIMESTAMP_FINISH
,
69 MANAGER_TIMESTAMP_SECURITY_START
,
70 MANAGER_TIMESTAMP_SECURITY_FINISH
,
71 MANAGER_TIMESTAMP_GENERATORS_START
,
72 MANAGER_TIMESTAMP_GENERATORS_FINISH
,
73 MANAGER_TIMESTAMP_UNITS_LOAD_START
,
74 MANAGER_TIMESTAMP_UNITS_LOAD_FINISH
,
75 _MANAGER_TIMESTAMP_MAX
,
76 _MANAGER_TIMESTAMP_INVALID
= -1,
81 #include "path-lookup.h"
82 #include "show-status.h"
83 #include "unit-name.h"
86 /* 0 = run normally */
87 MANAGER_TEST_RUN_MINIMAL
= 1 << 1, /* create basic data structures */
88 MANAGER_TEST_RUN_BASIC
= 1 << 2, /* interact with the environment */
89 MANAGER_TEST_RUN_ENV_GENERATORS
= 1 << 3, /* also run env generators */
90 MANAGER_TEST_RUN_GENERATORS
= 1 << 4, /* also run unit generators */
91 MANAGER_TEST_FULL
= MANAGER_TEST_RUN_BASIC
| MANAGER_TEST_RUN_ENV_GENERATORS
| MANAGER_TEST_RUN_GENERATORS
,
93 assert_cc((MANAGER_TEST_FULL
& UINT8_MAX
) == MANAGER_TEST_FULL
);
96 /* Note that the set of units we know of is allowed to be
97 * inconsistent. However the subset of it that is loaded may
98 * not, and the list of jobs may neither. */
100 /* Active jobs and units */
101 Hashmap
*units
; /* name string => Unit object n:1 */
102 Hashmap
*units_by_invocation_id
;
103 Hashmap
*jobs
; /* job id => Job object 1:1 */
105 /* To make it easy to iterate through the units of a specific
106 * type we maintain a per type linked list */
107 LIST_HEAD(Unit
, units_by_type
[_UNIT_TYPE_MAX
]);
109 /* Units that need to be loaded */
110 LIST_HEAD(Unit
, load_queue
); /* this is actually more a stack than a queue, but uh. */
112 /* Jobs that need to be run */
113 LIST_HEAD(Job
, run_queue
); /* more a stack than a queue, too */
115 /* Units and jobs that have not yet been announced via
116 * D-Bus. When something about a job changes it is added here
117 * if it is not in there yet. This allows easy coalescing of
118 * D-Bus change signals. */
119 LIST_HEAD(Unit
, dbus_unit_queue
);
120 LIST_HEAD(Job
, dbus_job_queue
);
122 /* Units to remove */
123 LIST_HEAD(Unit
, cleanup_queue
);
125 /* Units and jobs to check when doing GC */
126 LIST_HEAD(Unit
, gc_unit_queue
);
127 LIST_HEAD(Job
, gc_job_queue
);
129 /* Units that should be realized */
130 LIST_HEAD(Unit
, cgroup_realize_queue
);
132 /* Units whose cgroup ran empty */
133 LIST_HEAD(Unit
, cgroup_empty_queue
);
135 /* Target units whose default target dependencies haven't been set yet */
136 LIST_HEAD(Unit
, target_deps_queue
);
140 /* This maps PIDs we care about to units that are interested in. We allow multiple units to he interested in
141 * the same PID and multiple PIDs to be relevant to the same unit. Since in most cases only a single unit will
142 * be interested in the same PID we use a somewhat special encoding here: the first unit interested in a PID is
143 * stored directly in the hashmap, keyed by the PID unmodified. If there are other units interested too they'll
144 * be stored in a NULL-terminated array, and keyed by the negative PID. This is safe as pid_t is signed and
145 * negative PIDs are not used for regular processes but process groups, which we don't care about in this
146 * context, but this allows us to use the negative range for our own purposes. */
147 Hashmap
*watch_pids
; /* pid => unit as well as -pid => array of units */
149 /* A set contains all units which cgroup should be refreshed after startup */
152 /* A set which contains all currently failed units */
155 sd_event_source
*run_queue_event_source
;
159 sd_event_source
*notify_event_source
;
161 int cgroups_agent_fd
;
162 sd_event_source
*cgroups_agent_event_source
;
165 sd_event_source
*signal_event_source
;
167 sd_event_source
*sigchld_event_source
;
170 sd_event_source
*time_change_event_source
;
172 sd_event_source
*jobs_in_progress_event_source
;
174 int user_lookup_fds
[2];
175 sd_event_source
*user_lookup_event_source
;
177 sd_event_source
*sync_bus_names_event_source
;
179 UnitFileScope unit_file_scope
;
180 LookupPaths lookup_paths
;
181 Set
*unit_path_cache
;
185 usec_t runtime_watchdog
;
186 usec_t shutdown_watchdog
;
188 dual_timestamp timestamps
[_MANAGER_TIMESTAMP_MAX
];
192 /* Data specific to the device subsystem */
193 struct udev_monitor
* udev_monitor
;
194 sd_event_source
*udev_event_source
;
195 Hashmap
*devices_by_sysfs
;
197 /* Data specific to the mount subsystem */
198 struct libmnt_monitor
*mount_monitor
;
199 sd_event_source
*mount_event_source
;
201 /* Data specific to the swap filesystem */
203 sd_event_source
*swap_event_source
;
204 Hashmap
*swaps_by_devnode
;
206 /* Data specific to the D-Bus subsystem */
207 sd_bus
*api_bus
, *system_bus
;
209 int private_listen_fd
;
210 sd_event_source
*private_listen_event_source
;
212 /* Contains all the clients that are subscribed to signals via
213 the API bus. Note that private bus connections are always
214 considered subscribes, since they last for very short only,
215 and it is much simpler that way. */
216 sd_bus_track
*subscribed
;
217 char **deserialized_subscribed
;
219 /* This is used during reloading: before the reload we queue
220 * the reply message here, and afterwards we send it */
221 sd_bus_message
*queued_message
;
223 Hashmap
*watch_bus
; /* D-Bus names => Unit object n:1 */
225 bool send_reloading_done
;
227 uint32_t current_job_id
;
228 uint32_t default_unit_job_id
;
230 /* Data specific to the Automount subsystem */
233 /* Data specific to the cgroup subsystem */
234 Hashmap
*cgroup_unit
;
235 CGroupMask cgroup_supported
;
238 /* Notifications from cgroups, when the unified hierarchy is used is done via inotify. */
239 int cgroup_inotify_fd
;
240 sd_event_source
*cgroup_inotify_event_source
;
241 Hashmap
*cgroup_inotify_wd_unit
;
243 /* A defer event for handling cgroup empty events and processing them after SIGCHLD in all cases. */
244 sd_event_source
*cgroup_empty_event_source
;
246 /* Make sure the user cannot accidentally unmount our cgroup
253 ManagerExitCode exit_code
:5;
255 bool dispatching_load_queue
:1;
256 bool dispatching_dbus_queue
:1;
260 /* Have we already sent out the READY=1 notification? */
263 /* Have we already printed the taint line if necessary? */
266 /* Have we ever changed the "kernel.pid_max" sysctl? */
267 bool sysctl_pid_max_changed
:1;
269 unsigned test_run_flags
:8;
271 /* If non-zero, exit with the following value when the systemd
272 * process terminate. Useful for containers: systemd-nspawn could get
273 * the return value. */
274 uint8_t return_value
;
276 ShowStatus show_status
;
278 bool no_console_output
;
279 bool service_watchdogs
;
281 ExecOutput default_std_output
, default_std_error
;
283 usec_t default_restart_usec
, default_timeout_start_usec
, default_timeout_stop_usec
;
285 usec_t default_start_limit_interval
;
286 unsigned default_start_limit_burst
;
288 bool default_cpu_accounting
;
289 bool default_memory_accounting
;
290 bool default_io_accounting
;
291 bool default_blockio_accounting
;
292 bool default_tasks_accounting
;
293 bool default_ip_accounting
;
295 uint64_t default_tasks_max
;
296 usec_t default_timer_accuracy_usec
;
298 struct rlimit
*rlimit
[_RLIMIT_MAX
];
300 /* non-zero if we are reloading or reexecuting, */
303 unsigned n_installed_jobs
;
304 unsigned n_failed_jobs
;
306 /* Jobs in progress watching */
307 unsigned n_running_jobs
;
308 unsigned n_on_console
;
309 unsigned jobs_in_progress_iteration
;
311 /* Do we have any outstanding password prompts? */
312 int have_ask_password
;
313 int ask_password_inotify_fd
;
314 sd_event_source
*ask_password_event_source
;
316 /* Type=idle pipes */
318 sd_event_source
*idle_pipe_event_source
;
321 char *switch_root_init
;
323 /* This maps all possible path prefixes to the units needing
324 * them. It's a hashmap with a path string as key and a Set as
325 * value where Unit objects are contained. */
326 Hashmap
*units_requiring_mounts_for
;
328 /* Used for processing polkit authorization responses */
329 Hashmap
*polkit_registry
;
331 /* Dynamic users/groups, indexed by their name */
332 Hashmap
*dynamic_users
;
334 /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
338 /* ExecRuntime, indexed by their owner unit id */
339 Hashmap
*exec_runtime_by_id
;
341 /* When the user hits C-A-D more than 7 times per 2s, do something immediately... */
342 RateLimit ctrl_alt_del_ratelimit
;
343 EmergencyAction cad_burst_action
;
345 const char *unit_log_field
;
346 const char *unit_log_format_string
;
348 const char *invocation_log_field
;
349 const char *invocation_log_format_string
;
351 int first_boot
; /* tri-state */
353 /* Prefixes of e.g. RuntimeDirectory= */
354 char *prefix
[_EXEC_DIRECTORY_TYPE_MAX
];
356 /* Used in the SIGCHLD and sd_notify() message invocation logic to avoid that we dispatch the same event
357 * multiple times on the same unit. */
362 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
363 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
365 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
367 #define MANAGER_IS_FINISHED(m) (dual_timestamp_is_set((m)->timestamps + MANAGER_TIMESTAMP_FINISH))
369 /* The exit code is set to OK as soon as we enter the main loop, and set otherwise as soon as we are done with it */
370 #define MANAGER_IS_RUNNING(m) ((m)->exit_code == MANAGER_OK)
372 int manager_new(UnitFileScope scope
, unsigned test_run_flags
, Manager
**m
);
373 Manager
* manager_free(Manager
*m
);
374 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager
*, manager_free
);
376 void manager_enumerate(Manager
*m
);
377 int manager_startup(Manager
*m
, FILE *serialization
, FDSet
*fds
);
379 Job
*manager_get_job(Manager
*m
, uint32_t id
);
380 Unit
*manager_get_unit(Manager
*m
, const char *name
);
382 int manager_get_job_from_dbus_path(Manager
*m
, const char *s
, Job
**_j
);
384 int manager_load_unit_prepare(Manager
*m
, const char *name
, const char *path
, sd_bus_error
*e
, Unit
**_ret
);
385 int manager_load_unit(Manager
*m
, const char *name
, const char *path
, sd_bus_error
*e
, Unit
**_ret
);
386 int manager_load_unit_from_dbus_path(Manager
*m
, const char *s
, sd_bus_error
*e
, Unit
**_u
);
388 int manager_add_job(Manager
*m
, JobType type
, Unit
*unit
, JobMode mode
, sd_bus_error
*e
, Job
**_ret
);
389 int manager_add_job_by_name(Manager
*m
, JobType type
, const char *name
, JobMode mode
, sd_bus_error
*e
, Job
**_ret
);
390 int manager_add_job_by_name_and_warn(Manager
*m
, JobType type
, const char *name
, JobMode mode
, Job
**ret
);
391 int manager_propagate_reload(Manager
*m
, Unit
*unit
, JobMode mode
, sd_bus_error
*e
);
393 void manager_dump_units(Manager
*s
, FILE *f
, const char *prefix
);
394 void manager_dump_jobs(Manager
*s
, FILE *f
, const char *prefix
);
395 void manager_dump(Manager
*s
, FILE *f
, const char *prefix
);
396 int manager_get_dump_string(Manager
*m
, char **ret
);
398 void manager_clear_jobs(Manager
*m
);
400 unsigned manager_dispatch_load_queue(Manager
*m
);
402 int manager_environment_add(Manager
*m
, char **minus
, char **plus
);
403 int manager_set_default_rlimits(Manager
*m
, struct rlimit
**default_rlimit
);
405 int manager_loop(Manager
*m
);
407 int manager_open_serialization(Manager
*m
, FILE **_f
);
409 int manager_serialize(Manager
*m
, FILE *f
, FDSet
*fds
, bool switching_root
);
410 int manager_deserialize(Manager
*m
, FILE *f
, FDSet
*fds
);
412 int manager_reload(Manager
*m
);
414 void manager_reset_failed(Manager
*m
);
416 void manager_send_unit_audit(Manager
*m
, Unit
*u
, int type
, bool success
);
417 void manager_send_unit_plymouth(Manager
*m
, Unit
*u
);
419 bool manager_unit_inactive_or_pending(Manager
*m
, const char *name
);
421 void manager_check_finished(Manager
*m
);
423 void manager_recheck_dbus(Manager
*m
);
424 void manager_recheck_journal(Manager
*m
);
426 void manager_set_show_status(Manager
*m
, ShowStatus mode
);
427 void manager_set_first_boot(Manager
*m
, bool b
);
429 void manager_status_printf(Manager
*m
, StatusType type
, const char *status
, const char *format
, ...) _printf_(4,5);
430 void manager_flip_auto_status(Manager
*m
, bool enable
);
432 Set
*manager_get_units_requiring_mounts_for(Manager
*m
, const char *path
);
434 ManagerState
manager_state(Manager
*m
);
436 int manager_update_failed_units(Manager
*m
, Unit
*u
, bool failed
);
438 void manager_unref_uid(Manager
*m
, uid_t uid
, bool destroy_now
);
439 int manager_ref_uid(Manager
*m
, uid_t uid
, bool clean_ipc
);
441 void manager_unref_gid(Manager
*m
, gid_t gid
, bool destroy_now
);
442 int manager_ref_gid(Manager
*m
, gid_t gid
, bool destroy_now
);
444 void manager_vacuum_uid_refs(Manager
*m
);
445 void manager_vacuum_gid_refs(Manager
*m
);
447 void manager_serialize_uid_refs(Manager
*m
, FILE *f
);
448 void manager_deserialize_uid_refs_one(Manager
*m
, const char *value
);
450 void manager_serialize_gid_refs(Manager
*m
, FILE *f
);
451 void manager_deserialize_gid_refs_one(Manager
*m
, const char *value
);
453 char *manager_taint_string(Manager
*m
);
455 void manager_ref_console(Manager
*m
);
456 void manager_unref_console(Manager
*m
);
458 const char *manager_state_to_string(ManagerState m
) _const_
;
459 ManagerState
manager_state_from_string(const char *s
) _pure_
;
461 const char *manager_get_confirm_spawn(Manager
*m
);
462 bool manager_is_confirm_spawn_disabled(Manager
*m
);
463 void manager_disable_confirm_spawn(void);
465 const char *manager_timestamp_to_string(ManagerTimestamp m
) _const_
;
466 ManagerTimestamp
manager_timestamp_from_string(const char *s
) _pure_
;