]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/execute.h
core/execute: re-break function declaration of exec_spawn
[thirdparty/systemd.git] / src / core / execute.h
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
c2f1db8f 2#pragma once
5cb5a6ff
LP
3
4typedef struct ExecStatus ExecStatus;
5typedef struct ExecCommand ExecCommand;
6typedef struct ExecContext ExecContext;
e76506b7 7typedef struct ExecSharedRuntime ExecSharedRuntime;
15220772 8typedef struct DynamicCreds DynamicCreds;
28135da3 9typedef struct ExecRuntime ExecRuntime;
9fa95f85 10typedef struct ExecParameters ExecParameters;
e8a565cb 11typedef struct Manager Manager;
5cb5a6ff 12
71d35b6b 13#include <sched.h>
5cb5a6ff
LP
14#include <stdbool.h>
15#include <stdio.h>
71d35b6b 16#include <sys/capability.h>
5cb5a6ff 17
9ce93478 18#include "cgroup-util.h"
ad21e542 19#include "coredump-util.h"
0985c7c4 20#include "cpu-set-util.h"
b3d59367 21#include "exec-util.h"
613b411c 22#include "fdset.h"
71d35b6b 23#include "list.h"
e93672ee 24#include "missing_resource.h"
417116f2 25#include "namespace.h"
add00535 26#include "nsflags.h"
1808f768 27#include "numa-util.h"
cd48e23f 28#include "open-file.h"
74e12520 29#include "path-util.h"
170d978b 30#include "runtime-scope.h"
523ea123 31#include "set.h"
ca78ad1d 32#include "time-util.h"
5cb5a6ff 33
08f3be7a
LP
34#define EXEC_STDIN_DATA_MAX (64U*1024U*1024U)
35
023a4f67
LP
36typedef enum ExecUtmpMode {
37 EXEC_UTMP_INIT,
38 EXEC_UTMP_LOGIN,
39 EXEC_UTMP_USER,
40 _EXEC_UTMP_MODE_MAX,
2d93c20e 41 _EXEC_UTMP_MODE_INVALID = -EINVAL,
023a4f67
LP
42} ExecUtmpMode;
43
80876c20
LP
44typedef enum ExecInput {
45 EXEC_INPUT_NULL,
46 EXEC_INPUT_TTY,
47 EXEC_INPUT_TTY_FORCE,
48 EXEC_INPUT_TTY_FAIL,
4f2d528d 49 EXEC_INPUT_SOCKET,
52c239d7 50 EXEC_INPUT_NAMED_FD,
08f3be7a 51 EXEC_INPUT_DATA,
2038c3f5 52 EXEC_INPUT_FILE,
80876c20 53 _EXEC_INPUT_MAX,
2d93c20e 54 _EXEC_INPUT_INVALID = -EINVAL,
80876c20
LP
55} ExecInput;
56
071830ff 57typedef enum ExecOutput {
80876c20 58 EXEC_OUTPUT_INHERIT,
94f04347 59 EXEC_OUTPUT_NULL,
80876c20 60 EXEC_OUTPUT_TTY,
9a6bca7a 61 EXEC_OUTPUT_KMSG,
28dbc1e8 62 EXEC_OUTPUT_KMSG_AND_CONSOLE,
706343f4
LP
63 EXEC_OUTPUT_JOURNAL,
64 EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
4f2d528d 65 EXEC_OUTPUT_SOCKET,
52c239d7 66 EXEC_OUTPUT_NAMED_FD,
2038c3f5 67 EXEC_OUTPUT_FILE,
566b7d23 68 EXEC_OUTPUT_FILE_APPEND,
8d7dab1f 69 EXEC_OUTPUT_FILE_TRUNCATE,
94f04347 70 _EXEC_OUTPUT_MAX,
2d93c20e 71 _EXEC_OUTPUT_INVALID = -EINVAL,
071830ff
LP
72} ExecOutput;
73
53f47dfc
YW
74typedef enum ExecPreserveMode {
75 EXEC_PRESERVE_NO,
76 EXEC_PRESERVE_YES,
77 EXEC_PRESERVE_RESTART,
78 _EXEC_PRESERVE_MODE_MAX,
2d93c20e 79 _EXEC_PRESERVE_MODE_INVALID = -EINVAL,
53f47dfc
YW
80} ExecPreserveMode;
81
b1edf445
LP
82typedef enum ExecKeyringMode {
83 EXEC_KEYRING_INHERIT,
84 EXEC_KEYRING_PRIVATE,
85 EXEC_KEYRING_SHARED,
86 _EXEC_KEYRING_MODE_MAX,
2d93c20e 87 _EXEC_KEYRING_MODE_INVALID = -EINVAL,
b1edf445
LP
88} ExecKeyringMode;
89
42cb05d5 90/* Contains start and exit information about an executed command. */
5cb5a6ff 91struct ExecStatus {
63983207
LP
92 dual_timestamp start_timestamp;
93 dual_timestamp exit_timestamp;
3c1d1ca1 94 dual_timestamp handoff_timestamp;
0a6991e0 95 pid_t pid;
9152c765 96 int code; /* as in siginfo_t::si_code */
fcb7138c 97 int status; /* as in siginfo_t::si_status */
5cb5a6ff
LP
98};
99
42cb05d5 100/* Stores information about commands we execute. Covers both configuration settings as well as runtime data. */
5cb5a6ff
LP
101struct ExecCommand {
102 char *path;
103 char **argv;
b806a5d3 104 ExecStatus exec_status; /* Note that this is not serialized to sd-executor */
3ed0cd26 105 ExecCommandFlags flags;
034c6ed7 106 LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
5cb5a6ff
LP
107};
108
42cb05d5
LP
109/* Encapsulates certain aspects of the runtime environment that is to be shared between multiple otherwise separate
110 * invocations of commands. Specifically, this allows sharing of /tmp and /var/tmp data as well as network namespaces
111 * between invocations of commands. This is a reference counted object, with one reference taken by each currently
112 * active command invocation that wants to share this runtime. */
e76506b7 113struct ExecSharedRuntime {
cf4b2f99 114 unsigned n_ref;
613b411c 115
e8a565cb
YW
116 Manager *manager;
117
42cb05d5 118 char *id; /* Unit id of the owner */
e8a565cb 119
613b411c
LP
120 char *tmp_dir;
121 char *var_tmp_dir;
122
29206d46
LP
123 /* An AF_UNIX socket pair, that contains a datagram containing a file descriptor referring to the network
124 * namespace. */
613b411c 125 int netns_storage_socket[2];
a70581ff
XR
126
127 /* Like netns_storage_socket, but the file descriptor is referring to the IPC namespace. */
128 int ipcns_storage_socket[2];
613b411c
LP
129};
130
28135da3
DDM
131struct ExecRuntime {
132 ExecSharedRuntime *shared;
15220772 133 DynamicCreds *dynamic_creds;
9c0c6701
DDM
134
135 /* The path to the ephemeral snapshot of the root directory or root image if one was requested. */
136 char *ephemeral_copy;
137
138 /* An AF_UNIX socket pair that receives the locked file descriptor referring to the ephemeral copy of
139 * the root directory or root image. The lock prevents tmpfiles from removing the ephemeral snapshot
140 * until we're done using it. */
141 int ephemeral_storage_socket[2];
28135da3
DDM
142};
143
3536f49e 144typedef enum ExecDirectoryType {
d9e51371 145 EXEC_DIRECTORY_RUNTIME,
3536f49e
YW
146 EXEC_DIRECTORY_STATE,
147 EXEC_DIRECTORY_CACHE,
148 EXEC_DIRECTORY_LOGS,
149 EXEC_DIRECTORY_CONFIGURATION,
72fd1768 150 _EXEC_DIRECTORY_TYPE_MAX,
2d93c20e 151 _EXEC_DIRECTORY_TYPE_INVALID = -EINVAL,
3536f49e
YW
152} ExecDirectoryType;
153
211a3d87
LB
154typedef struct ExecDirectoryItem {
155 char *path;
156 char **symlinks;
a2ab603c 157 bool only_create;
211a3d87
LB
158} ExecDirectoryItem;
159
3536f49e 160typedef struct ExecDirectory {
3536f49e 161 mode_t mode;
211a3d87
LB
162 size_t n_items;
163 ExecDirectoryItem *items;
3536f49e
YW
164} ExecDirectory;
165
380dc8b0
LP
166typedef enum ExecCleanMask {
167 /* In case you wonder why the bitmask below doesn't use "directory" in its name: we want to keep this
168 * generic so that .timer timestamp files can nicely be covered by this too, and similar. */
169 EXEC_CLEAN_RUNTIME = 1U << EXEC_DIRECTORY_RUNTIME,
170 EXEC_CLEAN_STATE = 1U << EXEC_DIRECTORY_STATE,
171 EXEC_CLEAN_CACHE = 1U << EXEC_DIRECTORY_CACHE,
172 EXEC_CLEAN_LOGS = 1U << EXEC_DIRECTORY_LOGS,
173 EXEC_CLEAN_CONFIGURATION = 1U << EXEC_DIRECTORY_CONFIGURATION,
4fb8f1e8 174 EXEC_CLEAN_FDSTORE = 1U << _EXEC_DIRECTORY_TYPE_MAX,
380dc8b0 175 EXEC_CLEAN_NONE = 0,
4fb8f1e8 176 EXEC_CLEAN_ALL = (1U << (_EXEC_DIRECTORY_TYPE_MAX+1)) - 1,
2d93c20e 177 _EXEC_CLEAN_MASK_INVALID = -EINVAL,
380dc8b0
LP
178} ExecCleanMask;
179
42cb05d5
LP
180/* Encodes configuration parameters applied to invoked commands. Does not carry runtime data, but only configuration
181 * changes sourced from unit files and suchlike. ExecContext objects are usually embedded into Unit objects, and do not
182 * change after being loaded. */
5cb5a6ff
LP
183struct ExecContext {
184 char **environment;
8c7be95e 185 char **environment_files;
b4c14404 186 char **pass_environment;
00819cc1 187 char **unset_environment;
8c7be95e 188
517d56b1 189 struct rlimit *rlimit[_RLIMIT_MAX];
d4d55b0d
LB
190 char *working_directory, *root_directory, *root_image, *root_verity, *root_hash_path, *root_hash_sig_path;
191 void *root_hash, *root_hash_sig;
192 size_t root_hash_size, root_hash_sig_size;
18d73705 193 LIST_HEAD(MountOptions, root_image_options);
9c0c6701 194 bool root_ephemeral;
0a6991e0
LP
195 bool working_directory_missing_ok:1;
196 bool working_directory_home:1;
197
198 bool oom_score_adjust_set:1;
ad21e542 199 bool coredump_filter_set:1;
0a6991e0
LP
200 bool nice_set:1;
201 bool ioprio_set:1;
202 bool cpu_sched_set:1;
203
204 /* This is not exposed to the user but available internally. We need it to make sure that whenever we
205 * spawn /usr/bin/mount it is run in the same process group as us so that the autofs logic detects
206 * that it belongs to us and we don't enter a trigger loop. */
207 bool same_pgrp;
208
209 bool cpu_sched_reset_on_fork;
210 bool non_blocking;
9d58f1db
LP
211
212 mode_t umask;
dd6c17b1 213 int oom_score_adjust;
5cb5a6ff 214 int nice;
9eba9da4 215 int ioprio;
94f04347
LP
216 int cpu_sched_policy;
217 int cpu_sched_priority;
ad21e542 218 uint64_t coredump_filter;
9d58f1db 219
0985c7c4 220 CPUSet cpu_set;
b070c7c0 221 NUMAPolicy numa_policy;
e2b2fb7f 222 bool cpu_affinity_from_numa;
fb33a393 223
80876c20
LP
224 ExecInput std_input;
225 ExecOutput std_output;
226 ExecOutput std_error;
561c1529
LP
227
228 /* At least one of stdin/stdout/stderr was initialized from an fd passed in. This boolean survives
229 * the fds being closed. This only makes sense for transient units. */
0a6991e0 230 bool stdio_as_fds;
561c1529 231
52c239d7 232 char *stdio_fdname[3];
2038c3f5 233 char *stdio_file[3];
80876c20 234
08f3be7a
LP
235 void *stdin_data;
236 size_t stdin_data_size;
80876c20 237
d88a251b 238 nsec_t timer_slack_nsec;
071830ff 239
9d58f1db 240 char *tty_path;
5cb5a6ff 241
6ea832a2
LP
242 bool tty_reset;
243 bool tty_vhangup;
244 bool tty_vt_disallocate;
245
51462135
DDM
246 unsigned tty_rows;
247 unsigned tty_cols;
248
353e12c2
LP
249 bool ignore_sigpipe;
250
0a6991e0
LP
251 ExecKeyringMode keyring_mode;
252
61233823 253 /* Since resolving these names might involve socket
5cb5a6ff 254 * connections and we don't want to deadlock ourselves these
94f04347
LP
255 * names are resolved on execution only and in the child
256 * process. */
5cb5a6ff
LP
257 char *user;
258 char *group;
259 char **supplementary_groups;
9d58f1db 260
854eca4a
MY
261 int set_login_environment;
262
5b6319dc
LP
263 char *pam_name;
264
169c1bda 265 char *utmp_id;
023a4f67 266 ExecUtmpMode utmp_mode;
169c1bda 267
0a6991e0 268 bool no_new_privileges;
7b52a628 269
0a6991e0 270 bool selinux_context_ignore;
eef65bf3 271 bool apparmor_profile_ignore;
2ca620c4 272 bool smack_process_label_ignore;
2ca620c4 273
0a6991e0
LP
274 char *selinux_context;
275 char *apparmor_profile;
276 char *smack_process_label;
b1edf445 277
ddc155b2 278 char **read_write_paths, **read_only_paths, **inaccessible_paths, **exec_paths, **no_exec_paths;
8c35c10d 279 char **exec_search_path;
874cdcbc 280 unsigned long mount_propagation_flag;
d2d6c096 281 BindMount *bind_mounts;
da6053d0 282 size_t n_bind_mounts;
2abd4e38 283 TemporaryFileSystem *temporary_filesystems;
da6053d0 284 size_t n_temporary_filesystems;
b3d13314
LB
285 MountImage *mount_images;
286 size_t n_mount_images;
93f59701
LB
287 MountImage *extension_images;
288 size_t n_extension_images;
a07b9926 289 char **extension_directories;
15ae422b 290
a103496c 291 uint64_t capability_bounding_set;
755d4b67 292 uint64_t capability_ambient_set;
9d58f1db
LP
293 int secure_bits;
294
7fab9d01 295 int syslog_priority;
7fab9d01 296 bool syslog_level_prefix;
0a6991e0 297 char *syslog_identifier;
d3070fbd
LP
298
299 struct iovec* log_extra_fields;
300 size_t n_log_extra_fields;
523ea123
QD
301 Set *log_filter_allowed_patterns;
302 Set *log_filter_denied_patterns;
d3070fbd 303
5ac1530e
ZJS
304 usec_t log_ratelimit_interval_usec;
305 unsigned log_ratelimit_burst;
90fc172e 306
0a6991e0
LP
307 int log_level_max;
308
91dd5f7c
LP
309 char *log_namespace;
310
4e399953
LP
311 ProtectProc protect_proc; /* hidepid= */
312 ProcSubset proc_subset; /* subset= */
313
24002121 314 int private_mounts;
0afd4d21 315 int mount_apivfs;
85614c6e 316 int memory_ksm;
15ae422b 317 bool private_tmp;
ff01d048 318 bool private_network;
7f112f50 319 bool private_devices;
d251207d 320 bool private_users;
a70581ff 321 bool private_ipc;
59eeb84b 322 bool protect_kernel_tunables;
502d704e 323 bool protect_kernel_modules;
84703040 324 bool protect_kernel_logs;
fc64760d 325 bool protect_clock;
59eeb84b 326 bool protect_control_groups;
0a6991e0
LP
327 ProtectSystem protect_system;
328 ProtectHome protect_home;
329 bool protect_hostname;
9d58f1db 330
29206d46 331 bool dynamic_user;
00d9ef85 332 bool remove_ipc;
29206d46 333
0a6991e0
LP
334 bool memory_deny_write_execute;
335 bool restrict_realtime;
f69567cb 336 bool restrict_suid_sgid;
2e22afe9 337
78e864e5 338 bool lock_personality;
0a6991e0 339 unsigned long personality;
ac45f971 340
add00535
LP
341 unsigned long restrict_namespaces; /* The CLONE_NEWxyz flags permitted to the unit's processes */
342
b1994387
ILG
343 Set *restrict_filesystems;
344 bool restrict_filesystems_allow_list:1;
345
8cfa775f 346 Hashmap *syscall_filter;
57183d11 347 Set *syscall_archs;
17df7223 348 int syscall_errno;
6b000af4 349 bool syscall_allow_list:1;
8351ceae 350
9df2cdd8
TM
351 Hashmap *syscall_log;
352 bool syscall_log_allow_list:1; /* Log listed system calls */
353
6b000af4 354 bool address_families_allow_list:1;
0a6991e0 355 Set *address_families;
a8d08f39
LP
356
357 char *network_namespace_path;
a70581ff 358 char *ipc_namespace_path;
0a6991e0
LP
359
360 ExecDirectory directories[_EXEC_DIRECTORY_TYPE_MAX];
361 ExecPreserveMode runtime_directory_preserve_mode;
12213aed 362 usec_t timeout_clean_usec;
bb0c0d6f
LP
363
364 Hashmap *set_credentials; /* output id → ExecSetCredential */
43144be4 365 Hashmap *load_credentials; /* output id → ExecLoadCredential */
bbfb25f4 366 Set *import_credentials;
84be0c71
LP
367
368 ImagePolicy *root_image_policy, *mount_image_policy, *extension_image_policy;
5cb5a6ff
LP
369};
370
add00535
LP
371static inline bool exec_context_restrict_namespaces_set(const ExecContext *c) {
372 assert(c);
373
374 return (c->restrict_namespaces & NAMESPACE_FLAGS_ALL) != NAMESPACE_FLAGS_ALL;
375}
376
b1994387
ILG
377static inline bool exec_context_restrict_filesystems_set(const ExecContext *c) {
378 assert(c);
379
380 return c->restrict_filesystems_allow_list ||
381 !set_isempty(c->restrict_filesystems);
382}
383
74e12520
LP
384static inline bool exec_context_with_rootfs(const ExecContext *c) {
385 assert(c);
386
387 /* Checks if RootDirectory= or RootImage= are used */
388
389 return !empty_or_root(c->root_directory) || c->root_image;
390}
391
c39f1ce2 392typedef enum ExecFlags {
cfbf7538
MY
393 EXEC_APPLY_SANDBOXING = 1 << 0,
394 EXEC_APPLY_CHROOT = 1 << 1,
395 EXEC_APPLY_TTY_STDIN = 1 << 2,
396 EXEC_PASS_LOG_UNIT = 1 << 3, /* Whether to pass the unit name to the service's journal stream connection */
397 EXEC_CHOWN_DIRECTORIES = 1 << 4, /* chown() the runtime/state/cache/log directories to the user we run as, under all conditions */
398 EXEC_NSS_DYNAMIC_BYPASS = 1 << 5, /* Set the SYSTEMD_NSS_DYNAMIC_BYPASS environment variable, to disable nss-systemd blocking on PID 1, for use by dbus-daemon */
399 EXEC_CGROUP_DELEGATE = 1 << 6,
400 EXEC_IS_CONTROL = 1 << 7,
401 EXEC_CONTROL_CGROUP = 1 << 8, /* Place the process not in the indicated cgroup but in a subcgroup '/.control', but only EXEC_CGROUP_DELEGATE and EXEC_IS_CONTROL is set, too */
402 EXEC_SETUP_CREDENTIALS = 1 << 9, /* Set up the credential store logic */
403 EXEC_SETUP_CREDENTIALS_FRESH = 1 << 10, /* Set up a new credential store (disable reuse) */
c39f1ce2 404
9c1a61ad 405 /* The following are not used by execute.c, but by consumers internally */
cfbf7538
MY
406 EXEC_PASS_FDS = 1 << 11,
407 EXEC_SETENV_RESULT = 1 << 12,
408 EXEC_SET_WATCHDOG = 1 << 13,
409 EXEC_SETENV_MONITOR_RESULT = 1 << 14, /* Pass exit status to OnFailure= and OnSuccess= dependencies. */
c39f1ce2
LP
410} ExecFlags;
411
42cb05d5
LP
412/* Parameters for a specific invocation of a command. This structure is put together right before a command is
413 * executed. */
9fa95f85 414struct ExecParameters {
170d978b
LP
415 RuntimeScope runtime_scope;
416
a34ceba6 417 char **environment;
8dd4c05b
LP
418
419 int *fds;
420 char **fd_names;
da6053d0 421 size_t n_socket_fds;
25b583d7 422 size_t n_storage_fds;
8dd4c05b 423
c39f1ce2 424 ExecFlags flags;
a34ceba6 425 bool selinux_context_net:1;
8dd4c05b 426
efdb0237 427 CGroupMask cgroup_supported;
beb4ae87 428 char *cgroup_path;
b646fc32 429 uint64_t cgroup_id;
8dd4c05b 430
3536f49e 431 char **prefix;
beb4ae87
LB
432 char *received_credentials_directory;
433 char *received_encrypted_credentials_directory;
8dd4c05b 434
beb4ae87 435 char *confirm_spawn;
154eb43f 436 bool shall_confirm_spawn;
7d5ceb64 437
9fa95f85 438 usec_t watchdog_usec;
8dd4c05b 439
9fa95f85 440 int *idle_pipe;
8dd4c05b 441
a34ceba6
LP
442 int stdin_fd;
443 int stdout_fd;
444 int stderr_fd;
5686391b 445
3c1d1ca1 446 /* An fd that is closed by the execve(), and thus will result in EOF when the execve() is done. */
5686391b 447 int exec_fd;
3bdc25a4 448
beb4ae87 449 char *notify_socket;
cd48e23f
RP
450
451 LIST_HEAD(OpenFile, open_files);
154eb43f 452
beb4ae87 453 char *fallback_smack_process_label;
154eb43f
LB
454
455 char **files_env;
456 int user_lookup_fd;
12001b1b 457 int handoff_timestamp_fd;
352ec23c
LP
458
459 int bpf_restrict_fs_map_fd;
b646fc32
LB
460
461 /* Used for logging in the executor functions */
462 char *unit_id;
463 sd_id128_t invocation_id;
464 char invocation_id_string[SD_ID128_STRING_MAX];
9fa95f85
DM
465};
466
352ec23c
LP
467#define EXEC_PARAMETERS_INIT(_flags) \
468 (ExecParameters) { \
469 .flags = (_flags), \
470 .stdin_fd = -EBADF, \
471 .stdout_fd = -EBADF, \
472 .stderr_fd = -EBADF, \
473 .exec_fd = -EBADF, \
474 .bpf_restrict_fs_map_fd = -EBADF, \
475 .user_lookup_fd = -EBADF, \
12001b1b 476 .handoff_timestamp_fd = -EBADF, \
352ec23c 477 }
b646fc32 478
9ce93478 479#include "unit.h"
29206d46 480#include "dynamic-user.h"
9ce93478 481
dddc0602
MY
482int exec_spawn(
483 Unit *unit,
484 ExecCommand *command,
485 const ExecContext *context,
486 ExecParameters *exec_params,
487 ExecRuntime *runtime,
488 const CGroupContext *cgroup_context,
489 PidRef *ret);
5cb5a6ff 490
bb5232b6 491void exec_command_done(ExecCommand *c);
da6053d0 492void exec_command_done_array(ExecCommand *c, size_t n);
f09604b0
MY
493ExecCommand* exec_command_free(ExecCommand *c);
494DEFINE_TRIVIAL_CLEANUP_FUNC(ExecCommand*, exec_command_free);
f1acf85a 495ExecCommand* exec_command_free_list(ExecCommand *c);
da6053d0 496void exec_command_free_array(ExecCommand **c, size_t n);
6a1d4d9f
LP
497void exec_command_reset_status_array(ExecCommand *c, size_t n);
498void exec_command_reset_status_list_array(ExecCommand **c, size_t n);
f09604b0 499
b9e4d9ba 500void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
44d8db9e 501void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
a6a80b4f 502void exec_command_append_list(ExecCommand **l, ExecCommand *e);
7593c3ec
LP
503int exec_command_set(ExecCommand *c, const char *path, ...) _sentinel_;
504int exec_command_append(ExecCommand *c, const char *path, ...) _sentinel_;
44d8db9e 505
034c6ed7 506void exec_context_init(ExecContext *c);
613b411c 507void exec_context_done(ExecContext *c);
34cf6c43 508void exec_context_dump(const ExecContext *c, FILE* f, const char *prefix);
5cb5a6ff 509
34cf6c43 510int exec_context_destroy_runtime_directory(const ExecContext *c, const char *runtime_root);
b9f976fb 511int exec_context_destroy_mount_ns_dir(Unit *u);
e66cf1a3 512
52c239d7 513const char* exec_context_fdname(const ExecContext *c, int fd_index);
8c7be95e 514
34cf6c43
YW
515bool exec_context_may_touch_console(const ExecContext *c);
516bool exec_context_maintains_privileges(const ExecContext *c);
6ac8fdc9 517
34cf6c43 518int exec_context_get_effective_ioprio(const ExecContext *c);
5e98086d 519bool exec_context_get_effective_mount_apivfs(const ExecContext *c);
7f452159 520
d3070fbd
LP
521void exec_context_free_log_extra_fields(ExecContext *c);
522
6f765baf
LP
523void exec_context_revert_tty(ExecContext *c);
524
4c2f5842
LP
525int exec_context_get_clean_directories(ExecContext *c, char **prefix, ExecCleanMask mask, char ***ret);
526int exec_context_get_clean_mask(ExecContext *c, ExecCleanMask *ret);
527
75689fb2 528const char *exec_context_tty_path(const ExecContext *context);
d2b9e755 529int exec_context_apply_tty_size(const ExecContext *context, int tty_fd, const char *tty_path);
75689fb2
LB
530void exec_context_tty_reset(const ExecContext *context, const ExecParameters *p);
531
ef44aa83
DDM
532uint64_t exec_context_get_rlimit(const ExecContext *c, const char *name);
533int exec_context_get_oom_score_adjust(const ExecContext *c);
534uint64_t exec_context_get_coredump_filter(const ExecContext *c);
535int exec_context_get_nice(const ExecContext *c);
536int exec_context_get_cpu_sched_policy(const ExecContext *c);
537int exec_context_get_cpu_sched_priority(const ExecContext *c);
538uint64_t exec_context_get_timer_slack_nsec(const ExecContext *c);
d1a5be82 539bool exec_context_get_set_login_environment(const ExecContext *c);
ef44aa83
DDM
540char** exec_context_get_syscall_filter(const ExecContext *c);
541char** exec_context_get_syscall_archs(const ExecContext *c);
542char** exec_context_get_syscall_log(const ExecContext *c);
543char** exec_context_get_address_families(const ExecContext *c);
544char** exec_context_get_restrict_filesystems(const ExecContext *c);
545
7e0e6b50 546void exec_status_start(ExecStatus *s, pid_t pid, const dual_timestamp *ts);
34cf6c43 547void exec_status_exit(ExecStatus *s, const ExecContext *context, pid_t pid, int code, int status);
3c1d1ca1 548void exec_status_handoff(ExecStatus *s, const struct ucred *ucred, const dual_timestamp *ts);
34cf6c43 549void exec_status_dump(const ExecStatus *s, FILE *f, const char *prefix);
6a1d4d9f 550void exec_status_reset(ExecStatus *s);
5cb5a6ff 551
e76506b7 552int exec_shared_runtime_acquire(Manager *m, const ExecContext *c, const char *name, bool create, ExecSharedRuntime **ret);
e52a696a
DDM
553ExecSharedRuntime *exec_shared_runtime_destroy(ExecSharedRuntime *r);
554ExecSharedRuntime *exec_shared_runtime_unref(ExecSharedRuntime *r);
28135da3 555DEFINE_TRIVIAL_CLEANUP_FUNC(ExecSharedRuntime*, exec_shared_runtime_unref);
613b411c 556
e76506b7
DDM
557int exec_shared_runtime_serialize(const Manager *m, FILE *f, FDSet *fds);
558int exec_shared_runtime_deserialize_compat(Unit *u, const char *key, const char *value, FDSet *fds);
559int exec_shared_runtime_deserialize_one(Manager *m, const char *value, FDSet *fds);
bb5232b6 560void exec_shared_runtime_done(ExecSharedRuntime *rt);
e76506b7 561void exec_shared_runtime_vacuum(Manager *m);
613b411c 562
9c0c6701 563int exec_runtime_make(const Unit *unit, const ExecContext *context, ExecSharedRuntime *shared, DynamicCreds *creds, ExecRuntime **ret);
28135da3
DDM
564ExecRuntime* exec_runtime_free(ExecRuntime *rt);
565DEFINE_TRIVIAL_CLEANUP_FUNC(ExecRuntime*, exec_runtime_free);
566ExecRuntime* exec_runtime_destroy(ExecRuntime *rt);
bb5232b6 567void exec_runtime_clear(ExecRuntime *rt);
28135da3 568
75689fb2 569int exec_params_get_cgroup_path(const ExecParameters *params, const CGroupContext *c, char **ret);
fba173ff 570void exec_params_shallow_clear(ExecParameters *p);
97f53fec 571void exec_params_dump(const ExecParameters *p, FILE* f, const char *prefix);
fba173ff 572void exec_params_deep_clear(ExecParameters *p);
b9c04eaf 573
e2b2fb7f
MS
574bool exec_context_get_cpu_affinity_from_numa(const ExecContext *c);
575
211a3d87 576void exec_directory_done(ExecDirectory *d);
564e5c98 577int exec_directory_add(ExecDirectory *d, const char *path, const char *symlink);
a2ab603c 578void exec_directory_sort(ExecDirectory *d);
75689fb2 579bool exec_directory_is_private(const ExecContext *context, ExecDirectoryType type);
211a3d87 580
4fb8f1e8
LP
581ExecCleanMask exec_clean_mask_from_string(const char *s);
582
44a6b1b6
ZJS
583const char* exec_output_to_string(ExecOutput i) _const_;
584ExecOutput exec_output_from_string(const char *s) _pure_;
94f04347 585
44a6b1b6
ZJS
586const char* exec_input_to_string(ExecInput i) _const_;
587ExecInput exec_input_from_string(const char *s) _pure_;
023a4f67
LP
588
589const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_;
590ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_;
53f47dfc
YW
591
592const char* exec_preserve_mode_to_string(ExecPreserveMode i) _const_;
593ExecPreserveMode exec_preserve_mode_from_string(const char *s) _pure_;
3536f49e 594
b1edf445
LP
595const char* exec_keyring_mode_to_string(ExecKeyringMode i) _const_;
596ExecKeyringMode exec_keyring_mode_from_string(const char *s) _pure_;
597
3536f49e
YW
598const char* exec_directory_type_to_string(ExecDirectoryType i) _const_;
599ExecDirectoryType exec_directory_type_from_string(const char *s) _pure_;
6b7b2ed9 600
211a3d87
LB
601const char* exec_directory_type_symlink_to_string(ExecDirectoryType i) _const_;
602ExecDirectoryType exec_directory_type_symlink_from_string(const char *s) _pure_;
603
ef44aa83
DDM
604const char* exec_directory_type_mode_to_string(ExecDirectoryType i) _const_;
605ExecDirectoryType exec_directory_type_mode_from_string(const char *s) _pure_;
606
6b7b2ed9
LP
607const char* exec_resource_type_to_string(ExecDirectoryType i) _const_;
608ExecDirectoryType exec_resource_type_from_string(const char *s) _pure_;
5e8deb94 609
28135da3 610bool exec_needs_mount_namespace(const ExecContext *context, const ExecParameters *params, const ExecRuntime *runtime);
fbbb9697 611bool exec_needs_network_namespace(const ExecContext *context);
75689fb2 612bool exec_needs_ipc_namespace(const ExecContext *context);
b646fc32
LB
613
614/* These logging macros do the same logging as those in unit.h, but using ExecContext and ExecParameters
615 * instead of the unit object, so that it can be used in the sd-executor context (where the unit object is
616 * not available). */
617
618#define LOG_EXEC_ID_FIELD(ep) \
619 ((ep)->runtime_scope == RUNTIME_SCOPE_USER ? "USER_UNIT=" : "UNIT=")
620#define LOG_EXEC_ID_FIELD_FORMAT(ep) \
621 ((ep)->runtime_scope == RUNTIME_SCOPE_USER ? "USER_UNIT=%s" : "UNIT=%s")
622#define LOG_EXEC_INVOCATION_ID_FIELD(ep) \
623 ((ep)->runtime_scope == RUNTIME_SCOPE_USER ? "USER_INVOCATION_ID=" : "INVOCATION_ID=")
624#define LOG_EXEC_INVOCATION_ID_FIELD_FORMAT(ep) \
625 ((ep)->runtime_scope == RUNTIME_SCOPE_USER ? "USER_INVOCATION_ID=%s" : "INVOCATION_ID=%s")
626
210ca71c
MY
627/* Like LOG_MESSAGE(), but with the unit name prefixed. */
628#define LOG_EXEC_MESSAGE(ep, fmt, ...) LOG_MESSAGE("%s: " fmt, (ep)->unit_id, ##__VA_ARGS__)
629#define LOG_EXEC_ID(ep) LOG_EXEC_ID_FIELD_FORMAT(ep), (ep)->unit_id
630#define LOG_EXEC_INVOCATION_ID(ep) LOG_EXEC_INVOCATION_ID_FIELD_FORMAT(ep), (ep)->invocation_id_string
631
632#define log_exec_full_errno_zerook(ec, ep, level, error, ...) \
633 ({ \
634 const ExecContext *_c = (ec); \
635 const ExecParameters *_p = (ep); \
636 const int _l = (level); \
e85be498
ŁS
637 bool _do_log = _c->log_level_max < 0 || \
638 _c->log_level_max >= LOG_PRI(_l); \
210ca71c
MY
639 LOG_CONTEXT_PUSH_IOV(_c->log_extra_fields, \
640 _c->n_log_extra_fields); \
641 !_do_log ? -ERRNO_VALUE(error) : \
642 log_object_internal(_l, error, \
643 PROJECT_FILE, __LINE__, __func__, \
644 LOG_EXEC_ID(_p), \
645 LOG_EXEC_INVOCATION_ID(_p), \
646 ##__VA_ARGS__); \
b646fc32
LB
647 })
648
649#define log_exec_full_errno(ec, ep, level, error, ...) \
650 ({ \
651 int _error = (error); \
652 ASSERT_NON_ZERO(_error); \
653 log_exec_full_errno_zerook(ec, ep, level, _error, ##__VA_ARGS__); \
654 })
655
656#define log_exec_full(ec, ep, level, ...) (void) log_exec_full_errno_zerook(ec, ep, level, 0, __VA_ARGS__)
657
658#define log_exec_debug(ec, ep, ...) log_exec_full(ec, ep, LOG_DEBUG, __VA_ARGS__)
659#define log_exec_info(ec, ep, ...) log_exec_full(ec, ep, LOG_INFO, __VA_ARGS__)
660#define log_exec_notice(ec, ep, ...) log_exec_full(ec, ep, LOG_NOTICE, __VA_ARGS__)
661#define log_exec_warning(ec, ep, ...) log_exec_full(ec, ep, LOG_WARNING, __VA_ARGS__)
662#define log_exec_error(ec, ep, ...) log_exec_full(ec, ep, LOG_ERR, __VA_ARGS__)
663
664#define log_exec_debug_errno(ec, ep, error, ...) log_exec_full_errno(ec, ep, LOG_DEBUG, error, __VA_ARGS__)
665#define log_exec_info_errno(ec, ep, error, ...) log_exec_full_errno(ec, ep, LOG_INFO, error, __VA_ARGS__)
666#define log_exec_notice_errno(ec, ep, error, ...) log_exec_full_errno(ec, ep, LOG_NOTICE, error, __VA_ARGS__)
667#define log_exec_warning_errno(ec, ep, error, ...) log_exec_full_errno(ec, ep, LOG_WARNING, error, __VA_ARGS__)
668#define log_exec_error_errno(ec, ep, error, ...) log_exec_full_errno(ec, ep, LOG_ERR, error, __VA_ARGS__)
669
210ca71c
MY
670#define log_exec_struct_errno(ec, ep, level, error, ...) \
671 ({ \
672 const ExecContext *_c = (ec); \
673 const ExecParameters *_p = (ep); \
674 const int _l = (level); \
e85be498
ŁS
675 bool _do_log = _c->log_level_max < 0 || \
676 _c->log_level_max >= LOG_PRI(_l); \
210ca71c
MY
677 LOG_CONTEXT_PUSH_IOV(_c->log_extra_fields, \
678 _c->n_log_extra_fields); \
679 !_do_log ? -ERRNO_VALUE(error) : \
680 log_struct_errno(_l, error, \
681 LOG_EXEC_ID(_p), \
682 LOG_EXEC_INVOCATION_ID(_p), \
683 __VA_ARGS__); \
b646fc32
LB
684 })
685
686#define log_exec_struct(ec, ep, level, ...) log_exec_struct_errno(ec, ep, level, 0, __VA_ARGS__)
687
210ca71c
MY
688#define _LOG_CONTEXT_PUSH_EXEC(ec, ep, p, c) \
689 const ExecContext *c = (ec); \
690 const ExecParameters *p = (ep); \
b646fc32 691 LOG_CONTEXT_PUSH_KEY_VALUE(LOG_EXEC_ID_FIELD(p), p->unit_id); \
210ca71c 692 LOG_CONTEXT_PUSH_KEY_VALUE(LOG_EXEC_INVOCATION_ID_FIELD(p), p->invocation_id_string); \
b646fc32
LB
693 LOG_CONTEXT_PUSH_IOV(c->log_extra_fields, c->n_log_extra_fields)
694
695#define LOG_CONTEXT_PUSH_EXEC(ec, ep) \
696 _LOG_CONTEXT_PUSH_EXEC(ec, ep, UNIQ_T(p, UNIQ), UNIQ_T(c, UNIQ))