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