src/core/execute.h

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