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 <linux/types.h>
  31 #include <sys/time.h>
  32 #include <sys/resource.h>
  33 #include <sys/capability.h>
  34 #include <stdbool.h>
  35 #include <stdio.h>
  36 #include <sched.h>
  37
  38 #include "list.h"
  39 #include "util.h"
  40 #include "set.h"
  41 #include "fdset.h"
  42 #include "missing.h"
  43 #include "namespace.h"
  44 #include "bus-endpoint.h"
  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
 100         struct rlimit *rlimit[_RLIMIT_MAX];
 101         char *working_directory, *root_directory;
 102
 103         mode_t umask;
 104         int oom_score_adjust;
 105         int nice;
 106         int ioprio;
 107         int cpu_sched_policy;
 108         int cpu_sched_priority;
 109
 110         cpu_set_t *cpuset;
 111         unsigned cpuset_ncpus;
 112
 113         ExecInput std_input;
 114         ExecOutput std_output;
 115         ExecOutput std_error;
 116
 117         nsec_t timer_slack_nsec;
 118
 119         char *tty_path;
 120
 121         bool tty_reset;
 122         bool tty_vhangup;
 123         bool tty_vt_disallocate;
 124
 125         bool ignore_sigpipe;
 126
 127         /* Since resolving these names might might involve socket
 128          * connections and we don't want to deadlock ourselves these
 129          * names are resolved on execution only and in the child
 130          * process. */
 131         char *user;
 132         char *group;
 133         char **supplementary_groups;
 134
 135         char *pam_name;
 136
 137         char *utmp_id;
 138
 139         bool selinux_context_ignore;
 140         char *selinux_context;
 141
 142         bool apparmor_profile_ignore;
 143         char *apparmor_profile;
 144
 145         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 146         unsigned long mount_flags;
 147
 148         uint64_t capability_bounding_set_drop;
 149
 150         cap_t capabilities;
 151         int secure_bits;
 152
 153         int syslog_priority;
 154         char *syslog_identifier;
 155         bool syslog_level_prefix;
 156
 157         bool cpu_sched_reset_on_fork;
 158         bool non_blocking;
 159         bool private_tmp;
 160         bool private_network;
 161         bool private_devices;
 162         ProtectSystem protect_system;
 163         ProtectHome protect_home;
 164
 165         bool no_new_privileges;
 166
 167         /* This is not exposed to the user but available
 168          * internally. We need it to make sure that whenever we spawn
 169          * /bin/mount it is run in the same process group as us so
 170          * that the autofs logic detects that it belongs to us and we
 171          * don't enter a trigger loop. */
 172         bool same_pgrp;
 173
 174         unsigned long personality;
 175
 176         Set *syscall_filter;
 177         Set *syscall_archs;
 178         int syscall_errno;
 179         bool syscall_whitelist:1;
 180
 181         Set *address_families;
 182         bool address_families_whitelist:1;
 183
 184         char **runtime_directory;
 185         mode_t runtime_directory_mode;
 186
 187         bool oom_score_adjust_set:1;
 188         bool nice_set:1;
 189         bool ioprio_set:1;
 190         bool cpu_sched_set:1;
 191         bool no_new_privileges_set:1;
 192
 193         /* custom dbus enpoint */
 194         BusEndpoint *bus_endpoint;
 195 };
 196
 197 #include "cgroup.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         CGroupControllerMask cgroup_supported;
 208         const char *cgroup_path;
 209         const char *runtime_prefix;
 210         const char *unit_id;
 211         usec_t watchdog_usec;
 212         int *idle_pipe;
 213         char *bus_endpoint_path;
 214         int bus_endpoint_fd;
 215 };
 216
 217 int exec_spawn(ExecCommand *command,
 218                const ExecContext *context,
 219                const ExecParameters *exec_params,
 220                ExecRuntime *runtime,
 221                pid_t *ret);
 222
 223 void exec_command_done(ExecCommand *c);
 224 void exec_command_done_array(ExecCommand *c, unsigned n);
 225
 226 void exec_command_free_list(ExecCommand *c);
 227 void exec_command_free_array(ExecCommand **c, unsigned n);
 228
 229 char *exec_command_line(char **argv);
 230
 231 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 232 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 233 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 234 int exec_command_set(ExecCommand *c, const char *path, ...);
 235
 236 void exec_context_init(ExecContext *c);
 237 void exec_context_done(ExecContext *c);
 238 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 239
 240 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 241
 242 int exec_context_load_environment(const ExecContext *c, char ***l);
 243
 244 bool exec_context_may_touch_console(ExecContext *c);
 245
 246 void exec_status_start(ExecStatus *s, pid_t pid);
 247 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 248 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 249
 250 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 251 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 252 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 253
 254 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 255 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 256
 257 void exec_runtime_destroy(ExecRuntime *rt);
 258
 259 const char* exec_output_to_string(ExecOutput i) _const_;
 260 ExecOutput exec_output_from_string(const char *s) _pure_;
 261
 262 const char* exec_input_to_string(ExecInput i) _const_;
 263 ExecInput exec_input_from_string(const char *s) _pure_;