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 "fdset.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_NLIMITS];
  96         char *working_directory, *root_directory;
  97
  98         mode_t umask;
  99         int oom_score_adjust;
 100         int nice;
 101         int ioprio;
 102         int cpu_sched_policy;
 103         int cpu_sched_priority;
 104
 105         cpu_set_t *cpuset;
 106         unsigned cpuset_ncpus;
 107
 108         ExecInput std_input;
 109         ExecOutput std_output;
 110         ExecOutput std_error;
 111
 112         nsec_t timer_slack_nsec;
 113
 114         char *tcpwrap_name;
 115
 116         char *tty_path;
 117
 118         bool tty_reset;
 119         bool tty_vhangup;
 120         bool tty_vt_disallocate;
 121
 122         bool ignore_sigpipe;
 123
 124         /* Since resolving these names might might involve socket
 125          * connections and we don't want to deadlock ourselves these
 126          * names are resolved on execution only and in the child
 127          * process. */
 128         char *user;
 129         char *group;
 130         char **supplementary_groups;
 131
 132         char *pam_name;
 133
 134         char *utmp_id;
 135
 136         char **read_write_dirs, **read_only_dirs, **inaccessible_dirs;
 137         unsigned long mount_flags;
 138
 139         uint64_t capability_bounding_set_drop;
 140
 141         cap_t capabilities;
 142         int secure_bits;
 143
 144         int syslog_priority;
 145         char *syslog_identifier;
 146         bool syslog_level_prefix;
 147
 148         bool cpu_sched_reset_on_fork;
 149         bool non_blocking;
 150         bool private_tmp;
 151         bool private_network;
 152
 153         bool no_new_privileges;
 154
 155         /* This is not exposed to the user but available
 156          * internally. We need it to make sure that whenever we spawn
 157          * /bin/mount it is run in the same process group as us so
 158          * that the autofs logic detects that it belongs to us and we
 159          * don't enter a trigger loop. */
 160         bool same_pgrp;
 161
 162         uint32_t *syscall_filter;
 163
 164         bool oom_score_adjust_set:1;
 165         bool nice_set:1;
 166         bool ioprio_set:1;
 167         bool cpu_sched_set:1;
 168 };
 169
 170 #include "cgroup.h"
 171
 172 int exec_spawn(ExecCommand *command,
 173                char **argv,
 174                ExecContext *context,
 175                int fds[], unsigned n_fds,
 176                char **environment,
 177                bool apply_permissions,
 178                bool apply_chroot,
 179                bool apply_tty_stdin,
 180                bool confirm_spawn,
 181                CGroupControllerMask cgroup_mask,
 182                const char *cgroup_path,
 183                const char *unit_id,
 184                usec_t watchdog_usec,
 185                int pipe_fd[2],
 186                ExecRuntime *runtime,
 187                pid_t *ret);
 188
 189 void exec_command_done(ExecCommand *c);
 190 void exec_command_done_array(ExecCommand *c, unsigned n);
 191
 192 void exec_command_free_list(ExecCommand *c);
 193 void exec_command_free_array(ExecCommand **c, unsigned n);
 194
 195 char *exec_command_line(char **argv);
 196
 197 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 198 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 199 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 200 int exec_command_set(ExecCommand *c, const char *path, ...);
 201
 202 void exec_context_init(ExecContext *c);
 203 void exec_context_done(ExecContext *c);
 204 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 205
 206 int exec_context_load_environment(const ExecContext *c, char ***l);
 207
 208 bool exec_context_may_touch_console(ExecContext *c);
 209
 210 void exec_status_start(ExecStatus *s, pid_t pid);
 211 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 212 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 213
 214 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 215 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 216 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 217
 218 int exec_runtime_serialize(ExecRuntime *rt, Unit *u, FILE *f, FDSet *fds);
 219 int exec_runtime_deserialize_item(ExecRuntime **rt, Unit *u, const char *key, const char *value, FDSet *fds);
 220
 221 void exec_runtime_destroy(ExecRuntime *rt);
 222
 223 const char* exec_output_to_string(ExecOutput i) _const_;
 224 ExecOutput exec_output_from_string(const char *s) _pure_;
 225
 226 const char* exec_input_to_string(ExecInput i) _const_;
 227 ExecInput exec_input_from_string(const char *s) _pure_;