1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 Copyright 2010 Lennart Poettering
14 #include "cgroup-util.h"
17 #include "ip-address-access.h"
19 #include "ratelimit.h"
21 struct libmnt_monitor
;
22 typedef struct Unit Unit
;
24 /* Enforce upper limit how many names we allow */
25 #define MANAGER_MAX_NAMES 131072 /* 128K */
27 typedef struct Manager Manager
;
29 typedef enum ManagerState
{
37 _MANAGER_STATE_INVALID
= -1
40 typedef enum ManagerExitCode
{
50 _MANAGER_EXIT_CODE_MAX
,
51 _MANAGER_EXIT_CODE_INVALID
= -1
54 typedef enum StatusType
{
55 STATUS_TYPE_EPHEMERAL
,
57 STATUS_TYPE_EMERGENCY
,
60 typedef enum ManagerTimestamp
{
61 MANAGER_TIMESTAMP_FIRMWARE
,
62 MANAGER_TIMESTAMP_LOADER
,
63 MANAGER_TIMESTAMP_KERNEL
,
64 MANAGER_TIMESTAMP_INITRD
,
65 MANAGER_TIMESTAMP_USERSPACE
,
66 MANAGER_TIMESTAMP_FINISH
,
68 MANAGER_TIMESTAMP_SECURITY_START
,
69 MANAGER_TIMESTAMP_SECURITY_FINISH
,
70 MANAGER_TIMESTAMP_GENERATORS_START
,
71 MANAGER_TIMESTAMP_GENERATORS_FINISH
,
72 MANAGER_TIMESTAMP_UNITS_LOAD_START
,
73 MANAGER_TIMESTAMP_UNITS_LOAD_FINISH
,
74 _MANAGER_TIMESTAMP_MAX
,
75 _MANAGER_TIMESTAMP_INVALID
= -1,
80 #include "path-lookup.h"
81 #include "show-status.h"
82 #include "unit-name.h"
85 /* 0 = run normally */
86 MANAGER_TEST_RUN_MINIMAL
= 1 << 1, /* create basic data structures */
87 MANAGER_TEST_RUN_BASIC
= 1 << 2, /* interact with the environment */
88 MANAGER_TEST_RUN_ENV_GENERATORS
= 1 << 3, /* also run env generators */
89 MANAGER_TEST_RUN_GENERATORS
= 1 << 4, /* also run unit generators */
90 MANAGER_TEST_FULL
= MANAGER_TEST_RUN_BASIC
| MANAGER_TEST_RUN_ENV_GENERATORS
| MANAGER_TEST_RUN_GENERATORS
,
92 assert_cc((MANAGER_TEST_FULL
& UINT8_MAX
) == MANAGER_TEST_FULL
);
95 /* Note that the set of units we know of is allowed to be
96 * inconsistent. However the subset of it that is loaded may
97 * not, and the list of jobs may neither. */
99 /* Active jobs and units */
100 Hashmap
*units
; /* name string => Unit object n:1 */
101 Hashmap
*units_by_invocation_id
;
102 Hashmap
*jobs
; /* job id => Job object 1:1 */
104 /* To make it easy to iterate through the units of a specific
105 * type we maintain a per type linked list */
106 LIST_HEAD(Unit
, units_by_type
[_UNIT_TYPE_MAX
]);
108 /* Units that need to be loaded */
109 LIST_HEAD(Unit
, load_queue
); /* this is actually more a stack than a queue, but uh. */
111 /* Jobs that need to be run */
112 LIST_HEAD(Job
, run_queue
); /* more a stack than a queue, too */
114 /* Units and jobs that have not yet been announced via
115 * D-Bus. When something about a job changes it is added here
116 * if it is not in there yet. This allows easy coalescing of
117 * D-Bus change signals. */
118 LIST_HEAD(Unit
, dbus_unit_queue
);
119 LIST_HEAD(Job
, dbus_job_queue
);
121 /* Units to remove */
122 LIST_HEAD(Unit
, cleanup_queue
);
124 /* Units and jobs to check when doing GC */
125 LIST_HEAD(Unit
, gc_unit_queue
);
126 LIST_HEAD(Job
, gc_job_queue
);
128 /* Units that should be realized */
129 LIST_HEAD(Unit
, cgroup_realize_queue
);
131 /* Units whose cgroup ran empty */
132 LIST_HEAD(Unit
, cgroup_empty_queue
);
134 /* Target units whose default target dependencies haven't been set yet */
135 LIST_HEAD(Unit
, target_deps_queue
);
139 /* This maps PIDs we care about to units that are interested in. We allow multiple units to he interested in
140 * the same PID and multiple PIDs to be relevant to the same unit. Since in most cases only a single unit will
141 * be interested in the same PID we use a somewhat special encoding here: the first unit interested in a PID is
142 * stored directly in the hashmap, keyed by the PID unmodified. If there are other units interested too they'll
143 * be stored in a NULL-terminated array, and keyed by the negative PID. This is safe as pid_t is signed and
144 * negative PIDs are not used for regular processes but process groups, which we don't care about in this
145 * context, but this allows us to use the negative range for our own purposes. */
146 Hashmap
*watch_pids
; /* pid => unit as well as -pid => array of units */
148 /* A set contains all units which cgroup should be refreshed after startup */
151 /* A set which contains all currently failed units */
154 sd_event_source
*run_queue_event_source
;
158 sd_event_source
*notify_event_source
;
160 int cgroups_agent_fd
;
161 sd_event_source
*cgroups_agent_event_source
;
164 sd_event_source
*signal_event_source
;
166 sd_event_source
*sigchld_event_source
;
169 sd_event_source
*time_change_event_source
;
171 sd_event_source
*timezone_change_event_source
;
173 sd_event_source
*jobs_in_progress_event_source
;
175 int user_lookup_fds
[2];
176 sd_event_source
*user_lookup_event_source
;
178 sd_event_source
*sync_bus_names_event_source
;
180 UnitFileScope unit_file_scope
;
181 LookupPaths lookup_paths
;
182 Set
*unit_path_cache
;
186 usec_t runtime_watchdog
;
187 usec_t shutdown_watchdog
;
189 dual_timestamp timestamps
[_MANAGER_TIMESTAMP_MAX
];
193 /* Data specific to the device subsystem */
194 struct udev_monitor
* udev_monitor
;
195 sd_event_source
*udev_event_source
;
196 Hashmap
*devices_by_sysfs
;
198 /* Data specific to the mount subsystem */
199 struct libmnt_monitor
*mount_monitor
;
200 sd_event_source
*mount_event_source
;
202 /* Data specific to the swap filesystem */
204 sd_event_source
*swap_event_source
;
205 Hashmap
*swaps_by_devnode
;
207 /* Data specific to the D-Bus subsystem */
208 sd_bus
*api_bus
, *system_bus
;
210 int private_listen_fd
;
211 sd_event_source
*private_listen_event_source
;
213 /* Contains all the clients that are subscribed to signals via
214 the API bus. Note that private bus connections are always
215 considered subscribes, since they last for very short only,
216 and it is much simpler that way. */
217 sd_bus_track
*subscribed
;
218 char **deserialized_subscribed
;
220 /* This is used during reloading: before the reload we queue
221 * the reply message here, and afterwards we send it */
222 sd_bus_message
*queued_message
;
224 Hashmap
*watch_bus
; /* D-Bus names => Unit object n:1 */
226 bool send_reloading_done
;
228 uint32_t current_job_id
;
229 uint32_t default_unit_job_id
;
231 /* Data specific to the Automount subsystem */
234 /* Data specific to the cgroup subsystem */
235 Hashmap
*cgroup_unit
;
236 CGroupMask cgroup_supported
;
239 /* Notifications from cgroups, when the unified hierarchy is used is done via inotify. */
240 int cgroup_inotify_fd
;
241 sd_event_source
*cgroup_inotify_event_source
;
242 Hashmap
*cgroup_inotify_wd_unit
;
244 /* A defer event for handling cgroup empty events and processing them after SIGCHLD in all cases. */
245 sd_event_source
*cgroup_empty_event_source
;
247 /* Make sure the user cannot accidentally unmount our cgroup
253 /* The stat() data the last time we saw /etc/localtime */
254 usec_t etc_localtime_mtime
;
255 bool etc_localtime_accessible
:1;
258 ManagerExitCode exit_code
:5;
260 bool dispatching_load_queue
:1;
261 bool dispatching_dbus_queue
:1;
265 /* Have we already sent out the READY=1 notification? */
268 /* Have we already printed the taint line if necessary? */
271 /* Have we ever changed the "kernel.pid_max" sysctl? */
272 bool sysctl_pid_max_changed
:1;
274 unsigned test_run_flags
:8;
276 /* If non-zero, exit with the following value when the systemd
277 * process terminate. Useful for containers: systemd-nspawn could get
278 * the return value. */
279 uint8_t return_value
;
281 ShowStatus show_status
;
283 bool no_console_output
;
284 bool service_watchdogs
;
286 ExecOutput default_std_output
, default_std_error
;
288 usec_t default_restart_usec
, default_timeout_start_usec
, default_timeout_stop_usec
;
290 usec_t default_start_limit_interval
;
291 unsigned default_start_limit_burst
;
293 bool default_cpu_accounting
;
294 bool default_memory_accounting
;
295 bool default_io_accounting
;
296 bool default_blockio_accounting
;
297 bool default_tasks_accounting
;
298 bool default_ip_accounting
;
300 uint64_t default_tasks_max
;
301 usec_t default_timer_accuracy_usec
;
303 int original_log_level
;
304 LogTarget original_log_target
;
305 bool log_level_overridden
:1;
306 bool log_target_overridden
:1;
308 struct rlimit
*rlimit
[_RLIMIT_MAX
];
310 /* non-zero if we are reloading or reexecuting, */
312 /* A set which contains all jobs that started before reload and finished
314 Set
*pending_finished_jobs
;
316 unsigned n_installed_jobs
;
317 unsigned n_failed_jobs
;
319 /* Jobs in progress watching */
320 unsigned n_running_jobs
;
321 unsigned n_on_console
;
322 unsigned jobs_in_progress_iteration
;
324 /* Do we have any outstanding password prompts? */
325 int have_ask_password
;
326 int ask_password_inotify_fd
;
327 sd_event_source
*ask_password_event_source
;
329 /* Type=idle pipes */
331 sd_event_source
*idle_pipe_event_source
;
334 char *switch_root_init
;
336 /* This maps all possible path prefixes to the units needing
337 * them. It's a hashmap with a path string as key and a Set as
338 * value where Unit objects are contained. */
339 Hashmap
*units_requiring_mounts_for
;
341 /* Used for processing polkit authorization responses */
342 Hashmap
*polkit_registry
;
344 /* Dynamic users/groups, indexed by their name */
345 Hashmap
*dynamic_users
;
347 /* Keep track of all UIDs and GIDs any of our services currently use. This is useful for the RemoveIPC= logic. */
351 /* ExecRuntime, indexed by their owner unit id */
352 Hashmap
*exec_runtime_by_id
;
354 /* When the user hits C-A-D more than 7 times per 2s, do something immediately... */
355 RateLimit ctrl_alt_del_ratelimit
;
356 EmergencyAction cad_burst_action
;
358 const char *unit_log_field
;
359 const char *unit_log_format_string
;
361 const char *invocation_log_field
;
362 const char *invocation_log_format_string
;
364 int first_boot
; /* tri-state */
366 /* Prefixes of e.g. RuntimeDirectory= */
367 char *prefix
[_EXEC_DIRECTORY_TYPE_MAX
];
369 /* Used in the SIGCHLD and sd_notify() message invocation logic to avoid that we dispatch the same event
370 * multiple times on the same unit. */
375 #define MANAGER_IS_SYSTEM(m) ((m)->unit_file_scope == UNIT_FILE_SYSTEM)
376 #define MANAGER_IS_USER(m) ((m)->unit_file_scope != UNIT_FILE_SYSTEM)
378 #define MANAGER_IS_RELOADING(m) ((m)->n_reloading > 0)
380 #define MANAGER_IS_FINISHED(m) (dual_timestamp_is_set((m)->timestamps + MANAGER_TIMESTAMP_FINISH))
382 /* 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 */
383 #define MANAGER_IS_RUNNING(m) ((m)->exit_code == MANAGER_OK)
385 int manager_new(UnitFileScope scope
, unsigned test_run_flags
, Manager
**m
);
386 Manager
* manager_free(Manager
*m
);
387 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager
*, manager_free
);
389 int manager_startup(Manager
*m
, FILE *serialization
, FDSet
*fds
);
391 Job
*manager_get_job(Manager
*m
, uint32_t id
);
392 Unit
*manager_get_unit(Manager
*m
, const char *name
);
394 int manager_get_job_from_dbus_path(Manager
*m
, const char *s
, Job
**_j
);
396 int manager_load_unit_prepare(Manager
*m
, const char *name
, const char *path
, sd_bus_error
*e
, Unit
**_ret
);
397 int manager_load_unit(Manager
*m
, const char *name
, const char *path
, sd_bus_error
*e
, Unit
**_ret
);
398 int manager_load_startable_unit_or_warn(Manager
*m
, const char *name
, const char *path
, Unit
**ret
);
399 int manager_load_unit_from_dbus_path(Manager
*m
, const char *s
, sd_bus_error
*e
, Unit
**_u
);
401 int manager_add_job(Manager
*m
, JobType type
, Unit
*unit
, JobMode mode
, sd_bus_error
*e
, Job
**_ret
);
402 int manager_add_job_by_name(Manager
*m
, JobType type
, const char *name
, JobMode mode
, sd_bus_error
*e
, Job
**_ret
);
403 int manager_add_job_by_name_and_warn(Manager
*m
, JobType type
, const char *name
, JobMode mode
, Job
**ret
);
404 int manager_propagate_reload(Manager
*m
, Unit
*unit
, JobMode mode
, sd_bus_error
*e
);
406 void manager_dump_units(Manager
*s
, FILE *f
, const char *prefix
);
407 void manager_dump_jobs(Manager
*s
, FILE *f
, const char *prefix
);
408 void manager_dump(Manager
*s
, FILE *f
, const char *prefix
);
409 int manager_get_dump_string(Manager
*m
, char **ret
);
411 void manager_clear_jobs(Manager
*m
);
413 unsigned manager_dispatch_load_queue(Manager
*m
);
415 int manager_environment_add(Manager
*m
, char **minus
, char **plus
);
416 int manager_set_default_rlimits(Manager
*m
, struct rlimit
**default_rlimit
);
418 int manager_loop(Manager
*m
);
420 int manager_open_serialization(Manager
*m
, FILE **_f
);
422 int manager_serialize(Manager
*m
, FILE *f
, FDSet
*fds
, bool switching_root
);
423 int manager_deserialize(Manager
*m
, FILE *f
, FDSet
*fds
);
425 int manager_reload(Manager
*m
);
427 void manager_reset_failed(Manager
*m
);
429 void manager_send_unit_audit(Manager
*m
, Unit
*u
, int type
, bool success
);
430 void manager_send_unit_plymouth(Manager
*m
, Unit
*u
);
432 bool manager_unit_inactive_or_pending(Manager
*m
, const char *name
);
434 void manager_check_finished(Manager
*m
);
436 void manager_recheck_dbus(Manager
*m
);
437 void manager_recheck_journal(Manager
*m
);
439 void manager_set_show_status(Manager
*m
, ShowStatus mode
);
440 void manager_set_first_boot(Manager
*m
, bool b
);
442 void manager_status_printf(Manager
*m
, StatusType type
, const char *status
, const char *format
, ...) _printf_(4,5);
443 void manager_flip_auto_status(Manager
*m
, bool enable
);
445 Set
*manager_get_units_requiring_mounts_for(Manager
*m
, const char *path
);
447 ManagerState
manager_state(Manager
*m
);
449 int manager_update_failed_units(Manager
*m
, Unit
*u
, bool failed
);
451 void manager_unref_uid(Manager
*m
, uid_t uid
, bool destroy_now
);
452 int manager_ref_uid(Manager
*m
, uid_t uid
, bool clean_ipc
);
454 void manager_unref_gid(Manager
*m
, gid_t gid
, bool destroy_now
);
455 int manager_ref_gid(Manager
*m
, gid_t gid
, bool destroy_now
);
457 void manager_vacuum_uid_refs(Manager
*m
);
458 void manager_vacuum_gid_refs(Manager
*m
);
460 void manager_serialize_uid_refs(Manager
*m
, FILE *f
);
461 void manager_deserialize_uid_refs_one(Manager
*m
, const char *value
);
463 void manager_serialize_gid_refs(Manager
*m
, FILE *f
);
464 void manager_deserialize_gid_refs_one(Manager
*m
, const char *value
);
466 char *manager_taint_string(Manager
*m
);
468 void manager_ref_console(Manager
*m
);
469 void manager_unref_console(Manager
*m
);
471 void manager_override_log_level(Manager
*m
, int level
);
472 void manager_restore_original_log_level(Manager
*m
);
474 void manager_override_log_target(Manager
*m
, LogTarget target
);
475 void manager_restore_original_log_target(Manager
*m
);
477 const char *manager_state_to_string(ManagerState m
) _const_
;
478 ManagerState
manager_state_from_string(const char *s
) _pure_
;
480 const char *manager_get_confirm_spawn(Manager
*m
);
481 bool manager_is_confirm_spawn_disabled(Manager
*m
);
482 void manager_disable_confirm_spawn(void);
484 const char *manager_timestamp_to_string(ManagerTimestamp m
) _const_
;
485 ManagerTimestamp
manager_timestamp_from_string(const char *s
) _pure_
;