src/socket.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosockethfoo
   4 #define foosockethfoo
   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 Socket Socket;
  26
  27 #include "manager.h"
  28 #include "unit.h"
  29 #include "socket-util.h"
  30 #include "mount.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_FIFO_MAX,
  63         _SOCKET_FIFO_INVALID = -1
  64 } SocketType;
  65
  66 typedef struct SocketPort {
  67         SocketType type;
  68         int fd;
  69
  70         SocketAddress address;
  71         char *path;
  72         Watch fd_watch;
  73
  74         LIST_FIELDS(struct SocketPort, port);
  75 } SocketPort;
  76
  77 struct Socket {
  78         Meta meta;
  79
  80         LIST_HEAD(SocketPort, ports);
  81
  82         unsigned n_accepted;
  83         unsigned n_connections;
  84         unsigned max_connections;
  85
  86         unsigned backlog;
  87         usec_t timeout_usec;
  88
  89         ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
  90         ExecContext exec_context;
  91
  92         /* For Accept=no sockets refers to the one service we'll
  93         activate. For Accept=yes sockets is either NULL, or filled
  94         when the next service we spawn. */
  95         Service *service;
  96
  97         SocketState state, deserialized_state;
  98
  99         Watch timer_watch;
 100
 101         ExecCommand* control_command;
 102         SocketExecCommand control_command_id;
 103         pid_t control_pid;
 104
 105         /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
 106         SocketAddressBindIPv6Only bind_ipv6_only;
 107
 108         mode_t directory_mode;
 109         mode_t socket_mode;
 110
 111         bool failure;
 112
 113         bool accept;
 114
 115         /* Socket options */
 116         bool keep_alive;
 117         bool free_bind;
 118         int priority;
 119         int mark;
 120         size_t receive_buffer;
 121         size_t send_buffer;
 122         int ip_tos;
 123         int ip_ttl;
 124         size_t pipe_size;
 125         char *bind_to_device;
 126         char *tcp_congestion;
 127 };
 128
 129 /* Called from the service code when collecting fds */
 130 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds);
 131
 132 /* Called from the service when it shut down */
 133 void socket_notify_service_dead(Socket *s);
 134
 135 /* Called from the mount code figure out if a mount is a dependency of
 136  * any of the sockets of this socket */
 137 int socket_add_one_mount_link(Socket *s, Mount *m);
 138
 139 /* Called from the service code when a per-connection service ended */
 140 void socket_connection_unref(Socket *s);
 141
 142 extern const UnitVTable socket_vtable;
 143
 144 const char* socket_state_to_string(SocketState i);
 145 SocketState socket_state_from_string(const char *s);
 146
 147 const char* socket_exec_command_to_string(SocketExecCommand i);
 148 SocketExecCommand socket_exec_command_from_string(const char *s);
 149
 150 #endif