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
  45 typedef enum ExecInput {
  46         EXEC_INPUT_NULL,
  47         EXEC_INPUT_TTY,
  48         EXEC_INPUT_TTY_FORCE,
  49         EXEC_INPUT_TTY_FAIL,
  50         EXEC_INPUT_SOCKET,
  51         _EXEC_INPUT_MAX,
  52         _EXEC_INPUT_INVALID = -1
  53 } ExecInput;
  54
  55 typedef enum ExecOutput {
  56         EXEC_OUTPUT_INHERIT,
  57         EXEC_OUTPUT_NULL,
  58         EXEC_OUTPUT_TTY,
  59         EXEC_OUTPUT_SYSLOG,
  60         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  61         EXEC_OUTPUT_KMSG,
  62         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  63         EXEC_OUTPUT_JOURNAL,
  64         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  65         EXEC_OUTPUT_SOCKET,
  66         _EXEC_OUTPUT_MAX,
  67         _EXEC_OUTPUT_INVALID = -1
  68 } ExecOutput;
  69
  70 struct ExecStatus {
  71         dual_timestamp start_timestamp;
  72         dual_timestamp exit_timestamp;
  73         pid_t pid;
  74         int code;     /* as in siginfo_t::si_code */
  75         int status;   /* as in sigingo_t::si_status */
  76 };
  77
  78 struct ExecCommand {
  79         char *path;
  80         char **argv;
  81         ExecStatus exec_status;
  82         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  83         bool ignore;
  84 };
  85
  86 struct ExecRuntime {
  87         int n_ref;
  88
  89         char *tmp_dir;
  90         char *var_tmp_dir;
  91
  92         int netns_storage_socket[2];
  93 };
  94
  95 struct ExecContext {
  96         char **environment;
  97         char **environment_files;
  98
  99         struct rlimit *rlimit[_RLIMIT_MAX];
 100         char *working_directory, *root_directory;
 101
 102         mode_t umask;
 103         int oom_score_adjust;
 104         int nice;
 105         int ioprio;
 106         int cpu_sched_policy;
 107         int cpu_sched_priority;
 108
 109         cpu_set_t *cpuset;
 110         unsigned cpuset_ncpus;
 111
 112         ExecInput std_input;
 113         ExecOutput std_output;
 114         ExecOutput std_error;
 115
 116         nsec_t timer_slack_nsec;
 117
 118         char *tty_path;
 119
 120         bool tty_reset;
 121         bool tty_vhangup;
 122         bool tty_vt_disallocate;
 123
 124         bool ignore_sigpipe;
 125
 126         /* Since resolving these names might might involve socket
 127          * connections and we don't want to deadlock ourselves these
 128          * names are resolved on execution only and in the child
 129          * process. */
 130         char *user;
 131         char *group;
 132         char **supplementary_groups;
 133
 134         char *pam_name;
 135
 136         char *utmp_id;
 137
 138         bool selinux_context_ignore;
 139         char *selinux_context;
 140
 141         bool apparmor_profile_ignore;
 142         char *apparmor_profile;
 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
 193 #include "cgroup.h"
 194
 195 struct ExecParameters {
 196         char **argv;
 197         int *fds; unsigned n_fds;
 198         char **environment;
 199         bool apply_permissions;
 200         bool apply_chroot;
 201         bool apply_tty_stdin;
 202         bool confirm_spawn;
 203         CGroupControllerMask cgroup_supported;
 204         const char *cgroup_path;
 205         const char *runtime_prefix;
 206         const char *unit_id;
 207         usec_t watchdog_usec;
 208         int *idle_pipe;
 209 };
 210
 211 int exec_spawn(ExecCommand *command,
 212                const ExecContext *context,
 213                const ExecParameters *exec_params,
 214                ExecRuntime *runtime,
 215                pid_t *ret);
 216
 217 void exec_command_done(ExecCommand *c);
 218 void exec_command_done_array(ExecCommand *c, unsigned n);
 219
 220 void exec_command_free_list(ExecCommand *c);
 221 void exec_command_free_array(ExecCommand **c, unsigned n);
 222
 223 char *exec_command_line(char **argv);
 224
 225 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 226 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 227 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 228 int exec_command_set(ExecCommand *c, const char *path, ...);
 229
 230 void exec_context_init(ExecContext *c);
 231 void exec_context_done(ExecContext *c);
 232 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 233
 234 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 235
 236 int exec_context_load_environment(const ExecContext *c, char ***l);
 237
 238 bool exec_context_may_touch_console(ExecContext *c);
 239
 240 void exec_status_start(ExecStatus *s, pid_t pid);
 241 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 242 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 243
 244 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 245 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 246 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 247
 248 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 249 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 250
 251 void exec_runtime_destroy(ExecRuntime *rt);
 252
 253 const char* exec_output_to_string(ExecOutput i) _const_;
 254 ExecOutput exec_output_from_string(const char *s) _pure_;
 255
 256 const char* exec_input_to_string(ExecInput i) _const_;
 257 ExecInput exec_input_from_string(const char *s) _pure_;