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 #include "service.h"
  32
  33 typedef enum SocketState {
  34         SOCKET_DEAD,
  35         SOCKET_START_PRE,
  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_POST,
  53         SOCKET_EXEC_STOP_PRE,
  54         SOCKET_EXEC_STOP_POST,
  55         _SOCKET_EXEC_COMMAND_MAX,
  56         _SOCKET_EXEC_COMMAND_INVALID = -1
  57 } SocketExecCommand;
  58
  59 typedef enum SocketType {
  60         SOCKET_SOCKET,
  61         SOCKET_FIFO,
  62         SOCKET_SPECIAL,
  63         SOCKET_MQUEUE,
  64         _SOCKET_FIFO_MAX,
  65         _SOCKET_FIFO_INVALID = -1
  66 } SocketType;
  67
  68 typedef struct SocketPort {
  69         SocketType type;
  70         int fd;
  71
  72         SocketAddress address;
  73         char *path;
  74         Watch fd_watch;
  75
  76         LIST_FIELDS(struct SocketPort, port);
  77 } SocketPort;
  78
  79 struct Socket {
  80         Meta meta;
  81
  82         LIST_HEAD(SocketPort, ports);
  83
  84         unsigned n_accepted;
  85         unsigned n_connections;
  86         unsigned max_connections;
  87
  88         unsigned backlog;
  89         usec_t timeout_usec;
  90
  91         ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
  92         ExecContext exec_context;
  93
  94         /* For Accept=no sockets refers to the one service we'll
  95         activate. For Accept=yes sockets is either NULL, or filled
  96         when the next service we spawn. */
  97         UnitRef service;
  98
  99         SocketState state, deserialized_state;
 100
 101         Watch timer_watch;
 102
 103         ExecCommand* control_command;
 104         SocketExecCommand control_command_id;
 105         pid_t control_pid;
 106
 107         mode_t directory_mode;
 108         mode_t socket_mode;
 109
 110         bool failure;
 111
 112         bool accept;
 113
 114         /* Socket options */
 115         bool keep_alive;
 116         bool free_bind;
 117         bool transparent;
 118         bool broadcast;
 119         bool pass_cred;
 120         int priority;
 121         int mark;
 122         size_t receive_buffer;
 123         size_t send_buffer;
 124         int ip_tos;
 125         int ip_ttl;
 126         size_t pipe_size;
 127         char *bind_to_device;
 128         char *tcp_congestion;
 129         long mq_maxmsg;
 130         long mq_msgsize;
 131
 132         /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
 133         SocketAddressBindIPv6Only bind_ipv6_only;
 134 };
 135
 136 /* Called from the service code when collecting fds */
 137 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds);
 138
 139 /* Called from the service when it shut down */
 140 void socket_notify_service_dead(Socket *s);
 141
 142 /* Called from the mount code figure out if a mount is a dependency of
 143  * any of the sockets of this socket */
 144 int socket_add_one_mount_link(Socket *s, Mount *m);
 145
 146 /* Called from the service code when a per-connection service ended */
 147 void socket_connection_unref(Socket *s);
 148
 149 extern const UnitVTable socket_vtable;
 150
 151 const char* socket_state_to_string(SocketState i);
 152 SocketState socket_state_from_string(const char *s);
 153
 154 const char* socket_exec_command_to_string(SocketExecCommand i);
 155 SocketExecCommand socket_exec_command_from_string(const char *s);
 156
 157 #endif