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