src/core/execute.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 typedef struct ExecStatus ExecStatus;
  23 typedef struct ExecCommand ExecCommand;
  24 typedef struct ExecContext ExecContext;
  25 typedef struct ExecRuntime ExecRuntime;
  26 typedef struct ExecParameters ExecParameters;
  27
  28 #include <sched.h>
  29 #include <stdbool.h>
  30 #include <stdio.h>
  31 #include <sys/capability.h>
  32
  33 #include "fdset.h"
  34 #include "list.h"
  35 #include "missing.h"
  36 #include "namespace.h"
  37
  38 typedef enum ExecUtmpMode {
  39         EXEC_UTMP_INIT,
  40         EXEC_UTMP_LOGIN,
  41         EXEC_UTMP_USER,
  42         _EXEC_UTMP_MODE_MAX,
  43         _EXEC_UTMP_MODE_INVALID = -1
  44 } ExecUtmpMode;
  45
  46 typedef enum ExecInput {
  47         EXEC_INPUT_NULL,
  48         EXEC_INPUT_TTY,
  49         EXEC_INPUT_TTY_FORCE,
  50         EXEC_INPUT_TTY_FAIL,
  51         EXEC_INPUT_SOCKET,
  52         _EXEC_INPUT_MAX,
  53         _EXEC_INPUT_INVALID = -1
  54 } ExecInput;
  55
  56 typedef enum ExecOutput {
  57         EXEC_OUTPUT_INHERIT,
  58         EXEC_OUTPUT_NULL,
  59         EXEC_OUTPUT_TTY,
  60         EXEC_OUTPUT_SYSLOG,
  61         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  62         EXEC_OUTPUT_KMSG,
  63         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  64         EXEC_OUTPUT_JOURNAL,
  65         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  66         EXEC_OUTPUT_SOCKET,
  67         _EXEC_OUTPUT_MAX,
  68         _EXEC_OUTPUT_INVALID = -1
  69 } ExecOutput;
  70
  71 struct ExecStatus {
  72         dual_timestamp start_timestamp;
  73         dual_timestamp exit_timestamp;
  74         pid_t pid;
  75         int code;     /* as in siginfo_t::si_code */
  76         int status;   /* as in sigingo_t::si_status */
  77 };
  78
  79 struct ExecCommand {
  80         char *path;
  81         char **argv;
  82         ExecStatus exec_status;
  83         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  84         bool ignore;
  85 };
  86
  87 struct ExecRuntime {
  88         int n_ref;
  89
  90         char *tmp_dir;
  91         char *var_tmp_dir;
  92
  93         int netns_storage_socket[2];
  94 };
  95
  96 struct ExecContext {
  97         char **environment;
  98         char **environment_files;
  99         char **pass_environment;
 100
 101         struct rlimit *rlimit[_RLIMIT_MAX];
 102         char *working_directory, *root_directory;
 103         bool working_directory_missing_ok;
 104         bool working_directory_home;
 105
 106         mode_t umask;
 107         int oom_score_adjust;
 108         int nice;
 109         int ioprio;
 110         int cpu_sched_policy;
 111         int cpu_sched_priority;
 112
 113         cpu_set_t *cpuset;
 114         unsigned cpuset_ncpus;
 115
 116         ExecInput std_input;
 117         ExecOutput std_output;
 118         ExecOutput std_error;
 119
 120         nsec_t timer_slack_nsec;
 121
 122         bool stdio_as_fds;
 123
 124         char *tty_path;
 125
 126         bool tty_reset;
 127         bool tty_vhangup;
 128         bool tty_vt_disallocate;
 129
 130         bool ignore_sigpipe;
 131
 132         /* Since resolving these names might might involve socket
 133          * connections and we don't want to deadlock ourselves these
 134          * names are resolved on execution only and in the child
 135          * process. */
 136         char *user;
 137         char *group;
 138         char **supplementary_groups;
 139
 140         char *pam_name;
 141
 142         char *utmp_id;
 143         ExecUtmpMode utmp_mode;
 144
 145         bool selinux_context_ignore;
 146         char *selinux_context;
 147
 148         bool apparmor_profile_ignore;
 149         char *apparmor_profile;
 150
 151         bool smack_process_label_ignore;
 152         char *smack_process_label;
 153
 154         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 155         unsigned long mount_flags;
 156
 157         uint64_t capability_bounding_set;
 158         uint64_t capability_ambient_set;
 159         int secure_bits;
 160
 161         int syslog_priority;
 162         char *syslog_identifier;
 163         bool syslog_level_prefix;
 164
 165         bool cpu_sched_reset_on_fork;
 166         bool non_blocking;
 167         bool private_tmp;
 168         bool private_network;
 169         bool private_devices;
 170         ProtectSystem protect_system;
 171         ProtectHome protect_home;
 172
 173         bool no_new_privileges;
 174
 175         /* This is not exposed to the user but available
 176          * internally. We need it to make sure that whenever we spawn
 177          * /usr/bin/mount it is run in the same process group as us so
 178          * that the autofs logic detects that it belongs to us and we
 179          * don't enter a trigger loop. */
 180         bool same_pgrp;
 181
 182         unsigned long personality;
 183
 184         Set *syscall_filter;
 185         Set *syscall_archs;
 186         int syscall_errno;
 187         bool syscall_whitelist:1;
 188
 189         Set *address_families;
 190         bool address_families_whitelist:1;
 191
 192         char **runtime_directory;
 193         mode_t runtime_directory_mode;
 194
 195         bool oom_score_adjust_set:1;
 196         bool nice_set:1;
 197         bool ioprio_set:1;
 198         bool cpu_sched_set:1;
 199         bool no_new_privileges_set:1;
 200 };
 201
 202 #include "cgroup-util.h"
 203 #include "cgroup.h"
 204
 205 struct ExecParameters {
 206         char **argv;
 207         char **environment;
 208
 209         int *fds;
 210         char **fd_names;
 211         unsigned n_fds;
 212
 213         bool apply_permissions:1;
 214         bool apply_chroot:1;
 215         bool apply_tty_stdin:1;
 216
 217         bool confirm_spawn:1;
 218         bool selinux_context_net:1;
 219
 220         bool cgroup_delegate:1;
 221         CGroupMask cgroup_supported;
 222         const char *cgroup_path;
 223
 224         const char *runtime_prefix;
 225
 226         usec_t watchdog_usec;
 227
 228         int *idle_pipe;
 229
 230         int stdin_fd;
 231         int stdout_fd;
 232         int stderr_fd;
 233 };
 234
 235 int exec_spawn(Unit *unit,
 236                ExecCommand *command,
 237                const ExecContext *context,
 238                const ExecParameters *exec_params,
 239                ExecRuntime *runtime,
 240                pid_t *ret);
 241
 242 void exec_command_done(ExecCommand *c);
 243 void exec_command_done_array(ExecCommand *c, unsigned n);
 244
 245 ExecCommand* exec_command_free_list(ExecCommand *c);
 246 void exec_command_free_array(ExecCommand **c, unsigned n);
 247
 248 char *exec_command_line(char **argv);
 249
 250 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 251 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 252 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 253 int exec_command_set(ExecCommand *c, const char *path, ...);
 254 int exec_command_append(ExecCommand *c, const char *path, ...);
 255
 256 void exec_context_init(ExecContext *c);
 257 void exec_context_done(ExecContext *c);
 258 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 259
 260 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 261
 262 int exec_context_load_environment(Unit *unit, const ExecContext *c, char ***l);
 263
 264 bool exec_context_may_touch_console(ExecContext *c);
 265 bool exec_context_maintains_privileges(ExecContext *c);
 266
 267 void exec_status_start(ExecStatus *s, pid_t pid);
 268 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 269 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 270
 271 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 272 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 273 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 274
 275 int exec_runtime_serialize(Unit *unit, ExecRuntime *rt, FILE *f, FDSet *fds);
 276 int exec_runtime_deserialize_item(Unit *unit, ExecRuntime **rt, const char *key, const char *value, FDSet *fds);
 277
 278 void exec_runtime_destroy(ExecRuntime *rt);
 279
 280 const char* exec_output_to_string(ExecOutput i) _const_;
 281 ExecOutput exec_output_from_string(const char *s) _pure_;
 282
 283 const char* exec_input_to_string(ExecInput i) _const_;
 284 ExecInput exec_input_from_string(const char *s) _pure_;
 285
 286 const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_;
 287 ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_;