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