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