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
 159         uint64_t capability_ambient_set;
 160
 161         cap_t capabilities;
 162         int secure_bits;
 163
 164         int syslog_priority;
 165         char *syslog_identifier;
 166         bool syslog_level_prefix;
 167
 168         bool cpu_sched_reset_on_fork;
 169         bool non_blocking;
 170         bool private_tmp;
 171         bool private_network;
 172         bool private_devices;
 173         ProtectSystem protect_system;
 174         ProtectHome protect_home;
 175
 176         bool no_new_privileges;
 177
 178         /* This is not exposed to the user but available
 179          * internally. We need it to make sure that whenever we spawn
 180          * /usr/bin/mount it is run in the same process group as us so
 181          * that the autofs logic detects that it belongs to us and we
 182          * don't enter a trigger loop. */
 183         bool same_pgrp;
 184
 185         unsigned long personality;
 186
 187         Set *syscall_filter;
 188         Set *syscall_archs;
 189         int syscall_errno;
 190         bool syscall_whitelist:1;
 191
 192         Set *address_families;
 193         bool address_families_whitelist:1;
 194
 195         char **runtime_directory;
 196         mode_t runtime_directory_mode;
 197
 198         bool oom_score_adjust_set:1;
 199         bool nice_set:1;
 200         bool ioprio_set:1;
 201         bool cpu_sched_set:1;
 202         bool no_new_privileges_set:1;
 203 };
 204
 205 #include "cgroup-util.h"
 206 #include "cgroup.h"
 207
 208 struct ExecParameters {
 209         char **argv;
 210         char **environment;
 211
 212         int *fds;
 213         char **fd_names;
 214         unsigned n_fds;
 215
 216         bool apply_permissions:1;
 217         bool apply_chroot:1;
 218         bool apply_tty_stdin:1;
 219
 220         bool confirm_spawn:1;
 221         bool selinux_context_net:1;
 222
 223         bool cgroup_delegate:1;
 224         CGroupMask cgroup_supported;
 225         const char *cgroup_path;
 226
 227         const char *runtime_prefix;
 228
 229         usec_t watchdog_usec;
 230
 231         int *idle_pipe;
 232
 233         int stdin_fd;
 234         int stdout_fd;
 235         int stderr_fd;
 236 };
 237
 238 int exec_spawn(Unit *unit,
 239                ExecCommand *command,
 240                const ExecContext *context,
 241                const ExecParameters *exec_params,
 242                ExecRuntime *runtime,
 243                pid_t *ret);
 244
 245 void exec_command_done(ExecCommand *c);
 246 void exec_command_done_array(ExecCommand *c, unsigned n);
 247
 248 ExecCommand* exec_command_free_list(ExecCommand *c);
 249 void exec_command_free_array(ExecCommand **c, unsigned n);
 250
 251 char *exec_command_line(char **argv);
 252
 253 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 254 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 255 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 256 int exec_command_set(ExecCommand *c, const char *path, ...);
 257 int exec_command_append(ExecCommand *c, const char *path, ...);
 258
 259 void exec_context_init(ExecContext *c);
 260 void exec_context_done(ExecContext *c);
 261 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 262
 263 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 264
 265 int exec_context_load_environment(Unit *unit, const ExecContext *c, char ***l);
 266
 267 bool exec_context_may_touch_console(ExecContext *c);
 268 bool exec_context_maintains_privileges(ExecContext *c);
 269
 270 void exec_status_start(ExecStatus *s, pid_t pid);
 271 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 272 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 273
 274 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 275 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 276 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 277
 278 int exec_runtime_serialize(Unit *unit, ExecRuntime *rt, FILE *f, FDSet *fds);
 279 int exec_runtime_deserialize_item(Unit *unit, ExecRuntime **rt, const char *key, const char *value, FDSet *fds);
 280
 281 void exec_runtime_destroy(ExecRuntime *rt);
 282
 283 const char* exec_output_to_string(ExecOutput i) _const_;
 284 ExecOutput exec_output_from_string(const char *s) _pure_;
 285
 286 const char* exec_input_to_string(ExecInput i) _const_;
 287 ExecInput exec_input_from_string(const char *s) _pure_;
 288
 289 const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_;
 290 ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_;