]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
c2f1db8f | 2 | #pragma once |
5cb5a6ff LP |
3 | |
4 | typedef struct Socket Socket; | |
9d565427 | 5 | typedef struct SocketPeer SocketPeer; |
5cb5a6ff | 6 | |
6e2ef85b | 7 | #include "mount.h" |
71d35b6b | 8 | #include "socket-util.h" |
57b7a260 | 9 | #include "unit.h" |
5cb5a6ff | 10 | |
5cb5a6ff LP |
11 | typedef enum SocketExecCommand { |
12 | SOCKET_EXEC_START_PRE, | |
3900e5fd | 13 | SOCKET_EXEC_START_CHOWN, |
5cb5a6ff LP |
14 | SOCKET_EXEC_START_POST, |
15 | SOCKET_EXEC_STOP_PRE, | |
16 | SOCKET_EXEC_STOP_POST, | |
e537352b | 17 | _SOCKET_EXEC_COMMAND_MAX, |
2d93c20e | 18 | _SOCKET_EXEC_COMMAND_INVALID = -EINVAL, |
5cb5a6ff LP |
19 | } SocketExecCommand; |
20 | ||
542563ba LP |
21 | typedef enum SocketType { |
22 | SOCKET_SOCKET, | |
e537352b | 23 | SOCKET_FIFO, |
b0a3f2bc | 24 | SOCKET_SPECIAL, |
916abb21 | 25 | SOCKET_MQUEUE, |
60252446 | 26 | SOCKET_USB_FUNCTION, |
038ed5a4 | 27 | _SOCKET_TYPE_MAX, |
2d93c20e | 28 | _SOCKET_TYPE_INVALID = -EINVAL, |
542563ba LP |
29 | } SocketType; |
30 | ||
cfc4eb4c LP |
31 | typedef enum SocketResult { |
32 | SOCKET_SUCCESS, | |
33 | SOCKET_FAILURE_RESOURCES, | |
34 | SOCKET_FAILURE_TIMEOUT, | |
35 | SOCKET_FAILURE_EXIT_CODE, | |
36 | SOCKET_FAILURE_SIGNAL, | |
37 | SOCKET_FAILURE_CORE_DUMP, | |
07299350 | 38 | SOCKET_FAILURE_START_LIMIT_HIT, |
8b26cdbd | 39 | SOCKET_FAILURE_TRIGGER_LIMIT_HIT, |
6bf0f408 | 40 | SOCKET_FAILURE_SERVICE_START_LIMIT_HIT, |
cfc4eb4c | 41 | _SOCKET_RESULT_MAX, |
2d93c20e | 42 | _SOCKET_RESULT_INVALID = -EINVAL, |
cfc4eb4c LP |
43 | } SocketResult; |
44 | ||
01f78473 | 45 | typedef struct SocketPort { |
718db961 LP |
46 | Socket *socket; |
47 | ||
542563ba | 48 | SocketType type; |
9d58f1db | 49 | int fd; |
15087cdb | 50 | int *auxiliary_fds; |
da6053d0 | 51 | size_t n_auxiliary_fds; |
542563ba LP |
52 | |
53 | SocketAddress address; | |
54 | char *path; | |
718db961 | 55 | sd_event_source *event_source; |
542563ba | 56 | |
01f78473 LP |
57 | LIST_FIELDS(struct SocketPort, port); |
58 | } SocketPort; | |
542563ba | 59 | |
9b191525 LP |
60 | typedef enum SocketTimestamping { |
61 | SOCKET_TIMESTAMPING_OFF, | |
62 | SOCKET_TIMESTAMPING_US, /* SO_TIMESTAMP */ | |
63 | SOCKET_TIMESTAMPING_NS, /* SO_TIMESTAMPNS */ | |
64 | _SOCKET_TIMESTAMPING_MAX, | |
2d93c20e | 65 | _SOCKET_TIMESTAMPING_INVALID = -EINVAL, |
9b191525 LP |
66 | } SocketTimestamping; |
67 | ||
5cb5a6ff | 68 | struct Socket { |
ac155bb8 | 69 | Unit meta; |
5cb5a6ff | 70 | |
542563ba LP |
71 | LIST_HEAD(SocketPort, ports); |
72 | ||
9a73653c | 73 | Set *peers_by_address; |
9d565427 | 74 | |
7fab9d01 LP |
75 | unsigned n_accepted; |
76 | unsigned n_connections; | |
a98f7575 | 77 | unsigned n_refused; |
7fab9d01 | 78 | unsigned max_connections; |
9d565427 | 79 | unsigned max_connections_per_source; |
7fab9d01 | 80 | |
542563ba | 81 | unsigned backlog; |
209e9dcd | 82 | unsigned keep_alive_cnt; |
034c6ed7 | 83 | usec_t timeout_usec; |
209e9dcd SS |
84 | usec_t keep_alive_time; |
85 | usec_t keep_alive_interval; | |
cc567c9b | 86 | usec_t defer_accept; |
034c6ed7 | 87 | |
e537352b | 88 | ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX]; |
5cb5a6ff | 89 | ExecContext exec_context; |
4819ff03 | 90 | KillContext kill_context; |
4ad49000 | 91 | CGroupContext cgroup_context; |
29206d46 | 92 | |
613b411c | 93 | ExecRuntime *exec_runtime; |
29206d46 | 94 | DynamicCreds dynamic_creds; |
5cb5a6ff | 95 | |
b15bdda8 | 96 | /* For Accept=no sockets refers to the one service we'll |
f2f725e5 ZJS |
97 | * activate. For Accept=yes sockets is either NULL, or filled |
98 | * to refer to the next service we spawn. */ | |
57020a3a | 99 | UnitRef service; |
034c6ed7 | 100 | |
a16e1123 | 101 | SocketState state, deserialized_state; |
034c6ed7 | 102 | |
718db961 | 103 | sd_event_source *timer_event_source; |
7fab9d01 | 104 | |
034c6ed7 | 105 | ExecCommand* control_command; |
a16e1123 | 106 | SocketExecCommand control_command_id; |
5cb5a6ff LP |
107 | pid_t control_pid; |
108 | ||
7fab9d01 LP |
109 | mode_t directory_mode; |
110 | mode_t socket_mode; | |
4f2d528d | 111 | |
cfc4eb4c | 112 | SocketResult result; |
c968d76a | 113 | SocketResult clean_result; |
7fab9d01 | 114 | |
811ba7a0 LP |
115 | char **symlinks; |
116 | ||
7fab9d01 | 117 | bool accept; |
bd1fe7c7 | 118 | bool remove_on_stop; |
55301ec0 | 119 | bool writable; |
3e5f04bf | 120 | bool flush_pending; |
4fd5948e | 121 | |
74bb646e SS |
122 | int socket_protocol; |
123 | ||
4fd5948e LP |
124 | /* Socket options */ |
125 | bool keep_alive; | |
4427c3f4 | 126 | bool no_delay; |
7fab9d01 | 127 | bool free_bind; |
6b6d2dee | 128 | bool transparent; |
ec6370a2 | 129 | bool broadcast; |
d68af586 | 130 | bool pass_cred; |
54ecda32 | 131 | bool pass_sec; |
a3d19f5d | 132 | bool pass_pktinfo; |
9b191525 | 133 | SocketTimestamping timestamping; |
68667801 ZJS |
134 | |
135 | /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */ | |
136 | SocketAddressBindIPv6Only bind_ipv6_only; | |
137 | ||
4fd5948e | 138 | int priority; |
7fab9d01 | 139 | int mark; |
4fd5948e LP |
140 | size_t receive_buffer; |
141 | size_t send_buffer; | |
142 | int ip_tos; | |
143 | int ip_ttl; | |
144 | size_t pipe_size; | |
4fd5948e | 145 | char *bind_to_device; |
cebf8b20 | 146 | char *tcp_congestion; |
718db961 | 147 | bool reuse_port; |
916abb21 LP |
148 | long mq_maxmsg; |
149 | long mq_msgsize; | |
57020a3a | 150 | |
0eb59ccf AK |
151 | char *smack; |
152 | char *smack_ip_in; | |
153 | char *smack_ip_out; | |
3900e5fd | 154 | |
16115b0a MS |
155 | bool selinux_context_from_net; |
156 | ||
3900e5fd | 157 | char *user, *group; |
5ad096b3 | 158 | |
8dd4c05b | 159 | char *fdname; |
8b26cdbd LP |
160 | |
161 | RateLimit trigger_limit; | |
5cb5a6ff LP |
162 | }; |
163 | ||
9d565427 SS |
164 | SocketPeer *socket_peer_ref(SocketPeer *p); |
165 | SocketPeer *socket_peer_unref(SocketPeer *p); | |
3ebcd323 | 166 | int socket_acquire_peer(Socket *s, int fd, SocketPeer **p); |
9d565427 SS |
167 | |
168 | DEFINE_TRIVIAL_CLEANUP_FUNC(SocketPeer*, socket_peer_unref); | |
169 | ||
44d8db9e | 170 | /* Called from the service code when collecting fds */ |
79c7626d | 171 | int socket_collect_fds(Socket *s, int **fds); |
44d8db9e | 172 | |
6cf6bbc2 LP |
173 | /* Called from the service code when a per-connection service ended */ |
174 | void socket_connection_unref(Socket *s); | |
175 | ||
74051b9b LP |
176 | void socket_free_ports(Socket *s); |
177 | ||
934ef6a5 | 178 | int socket_load_service_unit(Socket *s, int cfd, Unit **ret); |
8dd4c05b LP |
179 | |
180 | char *socket_fdname(Socket *s); | |
181 | ||
87f0e418 | 182 | extern const UnitVTable socket_vtable; |
5cb5a6ff | 183 | |
44a6b1b6 ZJS |
184 | const char* socket_exec_command_to_string(SocketExecCommand i) _const_; |
185 | SocketExecCommand socket_exec_command_from_string(const char *s) _pure_; | |
a16e1123 | 186 | |
44a6b1b6 ZJS |
187 | const char* socket_result_to_string(SocketResult i) _const_; |
188 | SocketResult socket_result_from_string(const char *s) _pure_; | |
67419600 | 189 | |
44a6b1b6 | 190 | const char* socket_port_type_to_string(SocketPort *p) _pure_; |
038ed5a4 | 191 | SocketType socket_port_type_from_string(const char *p) _pure_; |
57b7a260 | 192 | |
9b191525 LP |
193 | const char* socket_timestamping_to_string(SocketTimestamping p) _const_; |
194 | SocketTimestamping socket_timestamping_from_string(const char *p) _pure_; | |
195 | SocketTimestamping socket_timestamping_from_string_harder(const char *p) _pure_; | |
196 | ||
57b7a260 | 197 | DEFINE_CAST(SOCKET, Socket); |