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