]> git.proxmox.com Git - systemd.git/blob - src/core/socket.h
Merge tag 'upstream/229'
[systemd.git] / src / core / socket.h
1 #pragma once
2
3 /***
4 This file is part of systemd.
5
6 Copyright 2010 Lennart Poettering
7
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
12
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20 ***/
21
22 typedef struct Socket Socket;
23
24 #include "mount.h"
25 #include "service.h"
26 #include "socket-util.h"
27
28 typedef enum SocketExecCommand {
29 SOCKET_EXEC_START_PRE,
30 SOCKET_EXEC_START_CHOWN,
31 SOCKET_EXEC_START_POST,
32 SOCKET_EXEC_STOP_PRE,
33 SOCKET_EXEC_STOP_POST,
34 _SOCKET_EXEC_COMMAND_MAX,
35 _SOCKET_EXEC_COMMAND_INVALID = -1
36 } SocketExecCommand;
37
38 typedef enum SocketType {
39 SOCKET_SOCKET,
40 SOCKET_FIFO,
41 SOCKET_SPECIAL,
42 SOCKET_MQUEUE,
43 SOCKET_USB_FUNCTION,
44 _SOCKET_FIFO_MAX,
45 _SOCKET_FIFO_INVALID = -1
46 } SocketType;
47
48 typedef enum SocketResult {
49 SOCKET_SUCCESS,
50 SOCKET_FAILURE_RESOURCES,
51 SOCKET_FAILURE_TIMEOUT,
52 SOCKET_FAILURE_EXIT_CODE,
53 SOCKET_FAILURE_SIGNAL,
54 SOCKET_FAILURE_CORE_DUMP,
55 SOCKET_FAILURE_SERVICE_START_LIMIT_HIT,
56 _SOCKET_RESULT_MAX,
57 _SOCKET_RESULT_INVALID = -1
58 } SocketResult;
59
60 typedef struct SocketPort {
61 Socket *socket;
62
63 SocketType type;
64 int fd;
65 int *auxiliary_fds;
66 int n_auxiliary_fds;
67
68 SocketAddress address;
69 char *path;
70 sd_event_source *event_source;
71
72 LIST_FIELDS(struct SocketPort, port);
73 } SocketPort;
74
75 struct Socket {
76 Unit meta;
77
78 LIST_HEAD(SocketPort, ports);
79
80 unsigned n_accepted;
81 unsigned n_connections;
82 unsigned max_connections;
83
84 unsigned backlog;
85 unsigned keep_alive_cnt;
86 usec_t timeout_usec;
87 usec_t keep_alive_time;
88 usec_t keep_alive_interval;
89 usec_t defer_accept;
90
91 ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
92 ExecContext exec_context;
93 KillContext kill_context;
94 CGroupContext cgroup_context;
95 ExecRuntime *exec_runtime;
96
97 /* For Accept=no sockets refers to the one service we'll
98 activate. For Accept=yes sockets is either NULL, or filled
99 when the next service we spawn. */
100 UnitRef service;
101
102 SocketState state, deserialized_state;
103
104 sd_event_source *timer_event_source;
105
106 ExecCommand* control_command;
107 SocketExecCommand control_command_id;
108 pid_t control_pid;
109
110 mode_t directory_mode;
111 mode_t socket_mode;
112
113 SocketResult result;
114
115 char **symlinks;
116
117 bool accept;
118 bool remove_on_stop;
119 bool writable;
120
121 int socket_protocol;
122
123 /* Socket options */
124 bool keep_alive;
125 bool no_delay;
126 bool free_bind;
127 bool transparent;
128 bool broadcast;
129 bool pass_cred;
130 bool pass_sec;
131
132 /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
133 SocketAddressBindIPv6Only bind_ipv6_only;
134
135 int priority;
136 int mark;
137 size_t receive_buffer;
138 size_t send_buffer;
139 int ip_tos;
140 int ip_ttl;
141 size_t pipe_size;
142 char *bind_to_device;
143 char *tcp_congestion;
144 bool reuse_port;
145 long mq_maxmsg;
146 long mq_msgsize;
147
148 char *smack;
149 char *smack_ip_in;
150 char *smack_ip_out;
151
152 bool selinux_context_from_net;
153
154 char *user, *group;
155
156 bool reset_cpu_usage:1;
157
158 char *fdname;
159 };
160
161 /* Called from the service code when collecting fds */
162 int socket_collect_fds(Socket *s, int **fds);
163
164 /* Called from the service code when a per-connection service ended */
165 void socket_connection_unref(Socket *s);
166
167 void socket_free_ports(Socket *s);
168
169 int socket_instantiate_service(Socket *s);
170
171 char *socket_fdname(Socket *s);
172
173 extern const UnitVTable socket_vtable;
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_;