execute.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef fooexecutehfoo
   4 #define fooexecutehfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 typedef struct ExecStatus ExecStatus;
  26 typedef struct ExecCommand ExecCommand;
  27 typedef struct ExecContext ExecContext;
  28
  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
  38 #include "list.h"
  39 #include "util.h"
  40
  41 /* Abstract namespace! */
  42 #define LOGGER_SOCKET "/org/freedesktop/systemd1/logger"
  43
  44 typedef enum ExecOutput {
  45         EXEC_OUTPUT_CONSOLE,
  46         EXEC_OUTPUT_NULL,
  47         EXEC_OUTPUT_SYSLOG,
  48         EXEC_OUTPUT_KERNEL,
  49         _EXEC_OUTPUT_MAX,
  50         _EXEC_OUTPUT_INVALID = -1
  51 } ExecOutput;
  52
  53 typedef enum ExecInput {
  54         EXEC_INPUT_NULL,
  55         EXEC_INPUT_CONSOLE,
  56         _EXEC_INPUT_MAX,
  57         _EXEC_INPUT_INVALID = -1
  58 } ExecInput;
  59
  60 struct ExecStatus {
  61         pid_t pid;
  62         usec_t start_timestamp;
  63         usec_t exit_timestamp;
  64         int code;     /* as in siginfo_t::si_code */
  65         int status;   /* as in sigingo_t::si_status */
  66 };
  67
  68 struct ExecCommand {
  69         char *path;
  70         char **argv;
  71         ExecStatus exec_status;
  72         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  73 };
  74
  75 struct ExecContext {
  76         char **environment;
  77         mode_t umask;
  78         struct rlimit *rlimit[RLIMIT_NLIMITS];
  79         char *working_directory, *root_directory;
  80         int oom_adjust;
  81         int nice;
  82         int ioprio;
  83         int cpu_sched_policy;
  84         int cpu_sched_priority;
  85         cpu_set_t cpu_affinity;
  86         unsigned long timer_slack_ns;
  87
  88         bool oom_adjust_set:1;
  89         bool nice_set:1;
  90         bool ioprio_set:1;
  91         bool cpu_sched_set:1;
  92         bool cpu_affinity_set:1;
  93         bool timer_slack_ns_set:1;
  94
  95         bool cpu_sched_reset_on_fork;
  96         bool non_blocking;
  97         bool new_session;
  98
  99         ExecInput input;
 100         ExecOutput output;
 101         int syslog_priority;
 102         char *syslog_identifier;
 103
 104         cap_t capabilities;
 105         int secure_bits;
 106         uint64_t capability_bounding_set_drop;
 107
 108         /* Since resolving these names might might involve socket
 109          * connections and we don't want to deadlock ourselves these
 110          * names are resolved on execution only and in the child
 111          * process. */
 112         char *user;
 113         char *group;
 114         char **supplementary_groups;
 115 };
 116
 117 typedef enum ExitStatus {
 118         /* EXIT_SUCCESS defined by libc */
 119         /* EXIT_FAILURE defined by libc */
 120         EXIT_INVALIDARGUMENT = 2,
 121         EXIT_NOTIMPLEMENTED = 3,
 122         EXIT_NOPERMISSION = 4,
 123         EXIT_NOTINSTALLED = 5,
 124         EXIT_NOTCONFIGURED = 6,
 125         EXIT_NOTRUNNING = 7,
 126
 127         /* The LSB suggests that error codes >= 200 are "reserved". We
 128          * use them here under the assumption that they hence are
 129          * unused by init scripts.
 130          *
 131          * http://refspecs.freestandards.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html */
 132
 133         EXIT_CHDIR = 200,
 134         EXIT_NICE,
 135         EXIT_FDS,
 136         EXIT_EXEC,
 137         EXIT_MEMORY,
 138         EXIT_LIMITS,
 139         EXIT_OOM_ADJUST,
 140         EXIT_SIGNAL_MASK,
 141         EXIT_INPUT,
 142         EXIT_OUTPUT,
 143         EXIT_CHROOT,   /* 210 */
 144         EXIT_PGID,
 145         EXIT_IOPRIO,
 146         EXIT_TIMERSLACK,
 147         EXIT_SECUREBITS,
 148         EXIT_SETSCHEDULER,
 149         EXIT_CPUAFFINITY,
 150         EXIT_GROUP,
 151         EXIT_USER,
 152         EXIT_CAPABILITIES,
 153         EXIT_CGROUP,   /* 220 */
 154         EXIT_SETSID
 155 } ExitStatus;
 156
 157 int exec_spawn(ExecCommand *command,
 158                const ExecContext *context,
 159                int *fds, unsigned n_fds,
 160                bool apply_permissions,
 161                bool apply_chroot,
 162                struct CGroupBonding *cgroup_bondings,
 163                pid_t *ret);
 164
 165 void exec_command_free_list(ExecCommand *c);
 166 void exec_command_free_array(ExecCommand **c, unsigned n);
 167
 168 char *exec_command_line(ExecCommand *c);
 169 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 170 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 171 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 172
 173 void exec_context_init(ExecContext *c);
 174 void exec_context_done(ExecContext *c);
 175 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 176
 177 void exec_status_fill(ExecStatus *s, pid_t pid, int code, int status);
 178 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 179
 180 const char* exec_output_to_string(ExecOutput i);
 181 int exec_output_from_string(const char *s);
 182
 183 const char* exec_input_to_string(ExecInput i);
 184 int exec_input_from_string(const char *s);
 185
 186 #endif