src/core/socket.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 Socket Socket;
  25
  26 #include "manager.h"
  27 #include "unit.h"
  28 #include "socket-util.h"
  29 #include "mount.h"
  30 #include "service.h"
  31
  32 typedef enum SocketState {
  33         SOCKET_DEAD,
  34         SOCKET_START_PRE,
  35         SOCKET_START_CHOWN,
  36         SOCKET_START_POST,
  37         SOCKET_LISTENING,
  38         SOCKET_RUNNING,
  39         SOCKET_STOP_PRE,
  40         SOCKET_STOP_PRE_SIGTERM,
  41         SOCKET_STOP_PRE_SIGKILL,
  42         SOCKET_STOP_POST,
  43         SOCKET_FINAL_SIGTERM,
  44         SOCKET_FINAL_SIGKILL,
  45         SOCKET_FAILED,
  46         _SOCKET_STATE_MAX,
  47         _SOCKET_STATE_INVALID = -1
  48 } SocketState;
  49
  50 typedef enum SocketExecCommand {
  51         SOCKET_EXEC_START_PRE,
  52         SOCKET_EXEC_START_CHOWN,
  53         SOCKET_EXEC_START_POST,
  54         SOCKET_EXEC_STOP_PRE,
  55         SOCKET_EXEC_STOP_POST,
  56         _SOCKET_EXEC_COMMAND_MAX,
  57         _SOCKET_EXEC_COMMAND_INVALID = -1
  58 } SocketExecCommand;
  59
  60 typedef enum SocketType {
  61         SOCKET_SOCKET,
  62         SOCKET_FIFO,
  63         SOCKET_SPECIAL,
  64         SOCKET_MQUEUE,
  65         _SOCKET_FIFO_MAX,
  66         _SOCKET_FIFO_INVALID = -1
  67 } SocketType;
  68
  69 typedef enum SocketResult {
  70         SOCKET_SUCCESS,
  71         SOCKET_FAILURE_RESOURCES,
  72         SOCKET_FAILURE_TIMEOUT,
  73         SOCKET_FAILURE_EXIT_CODE,
  74         SOCKET_FAILURE_SIGNAL,
  75         SOCKET_FAILURE_CORE_DUMP,
  76         SOCKET_FAILURE_SERVICE_FAILED_PERMANENT,
  77         _SOCKET_RESULT_MAX,
  78         _SOCKET_RESULT_INVALID = -1
  79 } SocketResult;
  80
  81 typedef struct SocketPort {
  82         Socket *socket;
  83
  84         SocketType type;
  85         int fd;
  86
  87         SocketAddress address;
  88         char *path;
  89         sd_event_source *event_source;
  90
  91         LIST_FIELDS(struct SocketPort, port);
  92 } SocketPort;
  93
  94 struct Socket {
  95         Unit meta;
  96
  97         LIST_HEAD(SocketPort, ports);
  98
  99         unsigned n_accepted;
 100         unsigned n_connections;
 101         unsigned max_connections;
 102
 103         unsigned backlog;
 104         usec_t timeout_usec;
 105
 106         ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
 107         ExecContext exec_context;
 108         KillContext kill_context;
 109         CGroupContext cgroup_context;
 110         ExecRuntime *exec_runtime;
 111
 112         /* For Accept=no sockets refers to the one service we'll
 113         activate. For Accept=yes sockets is either NULL, or filled
 114         when the next service we spawn. */
 115         UnitRef service;
 116
 117         SocketState state, deserialized_state;
 118
 119         sd_event_source *timer_event_source;
 120
 121         ExecCommand* control_command;
 122         SocketExecCommand control_command_id;
 123         pid_t control_pid;
 124
 125         mode_t directory_mode;
 126         mode_t socket_mode;
 127
 128         SocketResult result;
 129
 130         char **symlinks;
 131
 132         bool accept;
 133         bool remove_on_stop;
 134
 135         /* Socket options */
 136         bool keep_alive;
 137         bool no_delay;
 138         bool free_bind;
 139         bool transparent;
 140         bool broadcast;
 141         bool pass_cred;
 142         bool pass_sec;
 143
 144         /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
 145         SocketAddressBindIPv6Only bind_ipv6_only;
 146
 147         int priority;
 148         int mark;
 149         size_t receive_buffer;
 150         size_t send_buffer;
 151         int ip_tos;
 152         int ip_ttl;
 153         size_t pipe_size;
 154         char *bind_to_device;
 155         char *tcp_congestion;
 156         bool reuse_port;
 157         long mq_maxmsg;
 158         long mq_msgsize;
 159
 160         char *smack;
 161         char *smack_ip_in;
 162         char *smack_ip_out;
 163
 164         char *user, *group;
 165 };
 166
 167 /* Called from the service code when collecting fds */
 168 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds);
 169
 170 /* Called from the service code when a per-connection service ended */
 171 void socket_connection_unref(Socket *s);
 172
 173 void socket_free_ports(Socket *s);
 174
 175 extern const UnitVTable socket_vtable;
 176
 177 const char* socket_state_to_string(SocketState i) _const_;
 178 SocketState socket_state_from_string(const char *s) _pure_;
 179
 180 const char* socket_exec_command_to_string(SocketExecCommand i) _const_;
 181 SocketExecCommand socket_exec_command_from_string(const char *s) _pure_;
 182
 183 const char* socket_result_to_string(SocketResult i) _const_;
 184 SocketResult socket_result_from_string(const char *s) _pure_;
 185
 186 const char* socket_port_type_to_string(SocketPort *p) _pure_;
 187
 188 int socket_instantiate_service(Socket *s);