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 ExecInput {
  42         EXEC_INPUT_NULL,
  43         EXEC_INPUT_TTY,
  44         EXEC_INPUT_TTY_FORCE,
  45         EXEC_INPUT_TTY_FAIL,
  46         EXEC_INPUT_SOCKET,
  47         _EXEC_INPUT_MAX,
  48         _EXEC_INPUT_INVALID = -1
  49 } ExecInput;
  50
  51 typedef enum ExecOutput {
  52         EXEC_OUTPUT_INHERIT,
  53         EXEC_OUTPUT_NULL,
  54         EXEC_OUTPUT_TTY,
  55         EXEC_OUTPUT_SYSLOG,
  56         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  57         EXEC_OUTPUT_KMSG,
  58         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  59         EXEC_OUTPUT_JOURNAL,
  60         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  61         EXEC_OUTPUT_SOCKET,
  62         _EXEC_OUTPUT_MAX,
  63         _EXEC_OUTPUT_INVALID = -1
  64 } ExecOutput;
  65
  66 struct ExecStatus {
  67         dual_timestamp start_timestamp;
  68         dual_timestamp exit_timestamp;
  69         pid_t pid;
  70         int code;     /* as in siginfo_t::si_code */
  71         int status;   /* as in sigingo_t::si_status */
  72 };
  73
  74 struct ExecCommand {
  75         char *path;
  76         char **argv;
  77         ExecStatus exec_status;
  78         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  79         bool ignore;
  80 };
  81
  82 struct ExecRuntime {
  83         int n_ref;
  84
  85         char *tmp_dir;
  86         char *var_tmp_dir;
  87
  88         int netns_storage_socket[2];
  89 };
  90
  91 struct ExecContext {
  92         char **environment;
  93         char **environment_files;
  94
  95         struct rlimit *rlimit[_RLIMIT_MAX];
  96         char *working_directory, *root_directory;
  97         bool working_directory_missing_ok;
  98
  99         mode_t umask;
 100         int oom_score_adjust;
 101         int nice;
 102         int ioprio;
 103         int cpu_sched_policy;
 104         int cpu_sched_priority;
 105
 106         cpu_set_t *cpuset;
 107         unsigned cpuset_ncpus;
 108
 109         ExecInput std_input;
 110         ExecOutput std_output;
 111         ExecOutput std_error;
 112
 113         nsec_t timer_slack_nsec;
 114
 115         char *tty_path;
 116
 117         bool tty_reset;
 118         bool tty_vhangup;
 119         bool tty_vt_disallocate;
 120
 121         bool ignore_sigpipe;
 122
 123         /* Since resolving these names might might involve socket
 124          * connections and we don't want to deadlock ourselves these
 125          * names are resolved on execution only and in the child
 126          * process. */
 127         char *user;
 128         char *group;
 129         char **supplementary_groups;
 130
 131         char *pam_name;
 132
 133         char *utmp_id;
 134
 135         bool selinux_context_ignore;
 136         char *selinux_context;
 137
 138         bool apparmor_profile_ignore;
 139         char *apparmor_profile;
 140
 141         bool smack_process_label_ignore;
 142         char *smack_process_label;
 143
 144         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 145         unsigned long mount_flags;
 146
 147         uint64_t capability_bounding_set_drop;
 148
 149         cap_t capabilities;
 150         int secure_bits;
 151
 152         int syslog_priority;
 153         char *syslog_identifier;
 154         bool syslog_level_prefix;
 155
 156         bool cpu_sched_reset_on_fork;
 157         bool non_blocking;
 158         bool private_tmp;
 159         bool private_network;
 160         bool private_devices;
 161         ProtectSystem protect_system;
 162         ProtectHome protect_home;
 163
 164         bool no_new_privileges;
 165
 166         /* This is not exposed to the user but available
 167          * internally. We need it to make sure that whenever we spawn
 168          * /bin/mount it is run in the same process group as us so
 169          * that the autofs logic detects that it belongs to us and we
 170          * don't enter a trigger loop. */
 171         bool same_pgrp;
 172
 173         unsigned long personality;
 174
 175         Set *syscall_filter;
 176         Set *syscall_archs;
 177         int syscall_errno;
 178         bool syscall_whitelist:1;
 179
 180         Set *address_families;
 181         bool address_families_whitelist:1;
 182
 183         char **runtime_directory;
 184         mode_t runtime_directory_mode;
 185
 186         bool oom_score_adjust_set:1;
 187         bool nice_set:1;
 188         bool ioprio_set:1;
 189         bool cpu_sched_set:1;
 190         bool no_new_privileges_set:1;
 191
 192         /* custom dbus enpoint */
 193         BusEndpoint *bus_endpoint;
 194 };
 195
 196 #include "cgroup.h"
 197 #include "cgroup-util.h"
 198
 199 struct ExecParameters {
 200         char **argv;
 201         int *fds; unsigned n_fds;
 202         char **environment;
 203         bool apply_permissions;
 204         bool apply_chroot;
 205         bool apply_tty_stdin;
 206         bool confirm_spawn;
 207         bool selinux_context_net;
 208         CGroupControllerMask cgroup_supported;
 209         const char *cgroup_path;
 210         bool cgroup_delegate;
 211         const char *runtime_prefix;
 212         const char *unit_id;
 213         usec_t watchdog_usec;
 214         int *idle_pipe;
 215         char *bus_endpoint_path;
 216         int bus_endpoint_fd;
 217 };
 218
 219 int exec_spawn(ExecCommand *command,
 220                const ExecContext *context,
 221                const ExecParameters *exec_params,
 222                ExecRuntime *runtime,
 223                pid_t *ret);
 224
 225 void exec_command_done(ExecCommand *c);
 226 void exec_command_done_array(ExecCommand *c, unsigned n);
 227
 228 ExecCommand* exec_command_free_list(ExecCommand *c);
 229 void exec_command_free_array(ExecCommand **c, unsigned n);
 230
 231 char *exec_command_line(char **argv);
 232
 233 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 234 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 235 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 236 int exec_command_set(ExecCommand *c, const char *path, ...);
 237 int exec_command_append(ExecCommand *c, const char *path, ...);
 238
 239 void exec_context_init(ExecContext *c);
 240 void exec_context_done(ExecContext *c);
 241 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 242
 243 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 244
 245 int exec_context_load_environment(const ExecContext *c, const char *unit_id, char ***l);
 246
 247 bool exec_context_may_touch_console(ExecContext *c);
 248 bool exec_context_maintains_privileges(ExecContext *c);
 249
 250 void exec_status_start(ExecStatus *s, pid_t pid);
 251 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 252 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 253
 254 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 255 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 256 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 257
 258 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 259 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 260
 261 void exec_runtime_destroy(ExecRuntime *rt);
 262
 263 const char* exec_output_to_string(ExecOutput i) _const_;
 264 ExecOutput exec_output_from_string(const char *s) _pure_;
 265
 266 const char* exec_input_to_string(ExecInput i) _const_;
 267 ExecInput exec_input_from_string(const char *s) _pure_;