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
  28 #include <linux/types.h>
  29 #include <sys/time.h>
  30 #include <sys/resource.h>
  31 #include <sys/capability.h>
  32 #include <stdbool.h>
  33 #include <stdio.h>
  34 #include <sched.h>
  35
  36 struct CGroupBonding;
  37 struct CGroupAttribute;
  38
  39 #include "list.h"
  40 #include "util.h"
  41
  42 typedef enum KillMode {
  43         KILL_CONTROL_GROUP = 0,
  44         KILL_PROCESS,
  45         KILL_NONE,
  46         _KILL_MODE_MAX,
  47         _KILL_MODE_INVALID = -1
  48 } KillMode;
  49
  50 typedef enum KillWho {
  51         KILL_MAIN,
  52         KILL_CONTROL,
  53         KILL_ALL,
  54         _KILL_WHO_MAX,
  55         _KILL_WHO_INVALID = -1
  56 } KillWho;
  57
  58 typedef enum ExecInput {
  59         EXEC_INPUT_NULL,
  60         EXEC_INPUT_TTY,
  61         EXEC_INPUT_TTY_FORCE,
  62         EXEC_INPUT_TTY_FAIL,
  63         EXEC_INPUT_SOCKET,
  64         _EXEC_INPUT_MAX,
  65         _EXEC_INPUT_INVALID = -1
  66 } ExecInput;
  67
  68 typedef enum ExecOutput {
  69         EXEC_OUTPUT_INHERIT,
  70         EXEC_OUTPUT_NULL,
  71         EXEC_OUTPUT_TTY,
  72         EXEC_OUTPUT_SYSLOG,
  73         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  74         EXEC_OUTPUT_KMSG,
  75         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  76         EXEC_OUTPUT_JOURNAL,
  77         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  78         EXEC_OUTPUT_SOCKET,
  79         _EXEC_OUTPUT_MAX,
  80         _EXEC_OUTPUT_INVALID = -1
  81 } ExecOutput;
  82
  83 struct ExecStatus {
  84         dual_timestamp start_timestamp;
  85         dual_timestamp exit_timestamp;
  86         pid_t pid;
  87         int code;     /* as in siginfo_t::si_code */
  88         int status;   /* as in sigingo_t::si_status */
  89 };
  90
  91 struct ExecCommand {
  92         char *path;
  93         char **argv;
  94         ExecStatus exec_status;
  95         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  96         bool ignore;
  97 };
  98
  99 struct ExecContext {
 100         char **environment;
 101         char **environment_files;
 102
 103         struct rlimit *rlimit[RLIMIT_NLIMITS];
 104         char *working_directory, *root_directory;
 105
 106         mode_t umask;
 107         int oom_score_adjust;
 108         int nice;
 109         int ioprio;
 110         int cpu_sched_policy;
 111         int cpu_sched_priority;
 112
 113         cpu_set_t *cpuset;
 114         unsigned cpuset_ncpus;
 115
 116         ExecInput std_input;
 117         ExecOutput std_output;
 118         ExecOutput std_error;
 119
 120         nsec_t timer_slack_nsec;
 121
 122         char *tcpwrap_name;
 123
 124         char *tty_path;
 125
 126         bool tty_reset;
 127         bool tty_vhangup;
 128         bool tty_vt_disallocate;
 129
 130         bool ignore_sigpipe;
 131
 132         /* Since resolving these names might might involve socket
 133          * connections and we don't want to deadlock ourselves these
 134          * names are resolved on execution only and in the child
 135          * process. */
 136         char *user;
 137         char *group;
 138         char **supplementary_groups;
 139
 140         char *pam_name;
 141
 142         char *utmp_id;
 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         /* Not relevant for spawning processes, just for killing */
 150         KillMode kill_mode;
 151         int kill_signal;
 152         bool send_sigkill;
 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
 166         bool no_new_privileges;
 167
 168         bool control_group_modify;
 169         int control_group_persistent;
 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         uint32_t *syscall_filter;
 179
 180         bool oom_score_adjust_set:1;
 181         bool nice_set:1;
 182         bool ioprio_set:1;
 183         bool cpu_sched_set:1;
 184 };
 185
 186 int exec_spawn(ExecCommand *command,
 187                char **argv,
 188                const ExecContext *context,
 189                int fds[], unsigned n_fds,
 190                char **environment,
 191                bool apply_permissions,
 192                bool apply_chroot,
 193                bool apply_tty_stdin,
 194                bool confirm_spawn,
 195                struct CGroupBonding *cgroup_bondings,
 196                struct CGroupAttribute *cgroup_attributes,
 197                const char *cgroup_suffix,
 198                const char *unit_id,
 199                int pipe_fd[2],
 200                pid_t *ret);
 201
 202 void exec_command_done(ExecCommand *c);
 203 void exec_command_done_array(ExecCommand *c, unsigned n);
 204
 205 void exec_command_free_list(ExecCommand *c);
 206 void exec_command_free_array(ExecCommand **c, unsigned n);
 207
 208 char *exec_command_line(char **argv);
 209
 210 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 211 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 212 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 213 int exec_command_set(ExecCommand *c, const char *path, ...);
 214
 215 void exec_context_init(ExecContext *c);
 216 void exec_context_done(ExecContext *c);
 217 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 218 void exec_context_tty_reset(const ExecContext *context);
 219
 220 int exec_context_load_environment(const ExecContext *c, char ***l);
 221
 222 void exec_status_start(ExecStatus *s, pid_t pid);
 223 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 224 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 225
 226 const char* exec_output_to_string(ExecOutput i);
 227 ExecOutput exec_output_from_string(const char *s);
 228
 229 const char* exec_input_to_string(ExecInput i);
 230 ExecInput exec_input_from_string(const char *s);
 231
 232 const char *kill_mode_to_string(KillMode k);
 233 KillMode kill_mode_from_string(const char *s);
 234
 235 const char *kill_who_to_string(KillWho k);
 236 KillWho kill_who_from_string(const char *s);