1 /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
2 *
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to
5 * deal in the Software without restriction, including without limitation the
6 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 * sell copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
9 *
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
12 *
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19 * IN THE SOFTWARE.
20 */
21
22 #ifndef UV_UNIX_INTERNAL_H_
23 #define UV_UNIX_INTERNAL_H_
24
25 #include "uv-common.h"
26
27 #include <assert.h>
28 #include <limits.h> /* _POSIX_PATH_MAX, PATH_MAX */
29 #include <stdlib.h> /* abort */
30 #include <string.h> /* strrchr */
31 #include <fcntl.h> /* O_CLOEXEC and O_NONBLOCK, if supported. */
32 #include <stdio.h>
33 #include <errno.h>
34 #include <sys/socket.h>
35
36 #if defined(__STRICT_ANSI__)
37 # define inline __inline
38 #endif
39
40 #if defined(__linux__)
41 # include "linux-syscalls.h"
42 #endif /* __linux__ */
43
44 #if defined(__MVS__)
45 # include "os390-syscalls.h"
46 #endif /* __MVS__ */
47
48 #if defined(__sun)
49 # include <sys/port.h>
50 # include <port.h>
51 #endif /* __sun */
52
53 #if defined(_AIX)
54 # define reqevents events
55 # define rtnevents revents
56 # include <sys/poll.h>
57 #else
58 # include <poll.h>
59 #endif /* _AIX */
60
61 #if defined(__APPLE__) && !TARGET_OS_IPHONE
62 # include <AvailabilityMacros.h>
63 #endif
64
65 #if defined(_POSIX_PATH_MAX)
66 # define UV__PATH_MAX _POSIX_PATH_MAX
67 #elif defined(PATH_MAX)
68 # define UV__PATH_MAX PATH_MAX
69 #else
70 # define UV__PATH_MAX 8192
71 #endif
72
73 #if defined(__ANDROID__)
74 int uv__pthread_sigmask(int how, const sigset_t* set, sigset_t* oset);
75 # ifdef pthread_sigmask
76 # undef pthread_sigmask
77 # endif
78 # define pthread_sigmask(how, set, oldset) uv__pthread_sigmask(how, set, oldset)
79 #endif
80
81 #define ACCESS_ONCE(type, var) \
82 (*(volatile type*) &(var))
83
84 #define ROUND_UP(a, b) \
85 ((a) % (b) ? ((a) + (b)) - ((a) % (b)) : (a))
86
87 #define UNREACHABLE() \
88 do { \
89 assert(0 && "unreachable code"); \
90 abort(); \
91 } \
92 while (0)
93
94 #define SAVE_ERRNO(block) \
95 do { \
96 int _saved_errno = errno; \
97 do { block; } while (0); \
98 errno = _saved_errno; \
99 } \
100 while (0)
101
102 /* The __clang__ and __INTEL_COMPILER checks are superfluous because they
103 * define __GNUC__. They are here to convey to you, dear reader, that these
104 * macros are enabled when compiling with clang or icc.
105 */
106 #if defined(__clang__) || \
107 defined(__GNUC__) || \
108 defined(__INTEL_COMPILER)
109 # define UV_DESTRUCTOR(declaration) __attribute__((destructor)) declaration
110 # define UV_UNUSED(declaration) __attribute__((unused)) declaration
111 #else
112 # define UV_DESTRUCTOR(declaration) declaration
113 # define UV_UNUSED(declaration) declaration
114 #endif
115
116 /* Leans on the fact that, on Linux, POLLRDHUP == EPOLLRDHUP. */
117 #ifdef POLLRDHUP
118 # define UV__POLLRDHUP POLLRDHUP
119 #else
120 # define UV__POLLRDHUP 0x2000
121 #endif
122
123 #ifdef POLLPRI
124 # define UV__POLLPRI POLLPRI
125 #else
126 # define UV__POLLPRI 0
127 #endif
128
129 #if !defined(O_CLOEXEC) && defined(__FreeBSD__)
130 /*
131 * It may be that we are just missing `__POSIX_VISIBLE >= 200809`.
132 * Try using fixed value const and give up, if it doesn't work
133 */
134 # define O_CLOEXEC 0x00100000
135 #endif
136
137 typedef struct uv__stream_queued_fds_s uv__stream_queued_fds_t;
138
139 /* loop flags */
140 enum {
141 UV_LOOP_BLOCK_SIGPROF = 1
142 };
143
144 /* flags of excluding ifaddr */
145 enum {
146 UV__EXCLUDE_IFPHYS,
147 UV__EXCLUDE_IFADDR
148 };
149
150 typedef enum {
151 UV_CLOCK_PRECISE = 0, /* Use the highest resolution clock available. */
152 UV_CLOCK_FAST = 1 /* Use the fastest clock with <= 1ms granularity. */
153 } uv_clocktype_t;
154
155 struct uv__stream_queued_fds_s {
156 unsigned int size;
157 unsigned int offset;
158 int fds[1];
159 };
160
161
162 #if defined(_AIX) || \
163 defined(__APPLE__) || \
164 defined(__DragonFly__) || \
165 defined(__FreeBSD__) || \
166 defined(__FreeBSD_kernel__) || \
167 defined(__linux__) || \
168 defined(__OpenBSD__) || \
169 defined(__NetBSD__)
170 #define uv__cloexec uv__cloexec_ioctl
171 #define uv__nonblock uv__nonblock_ioctl
172 #else
173 #define uv__cloexec uv__cloexec_fcntl
174 #define uv__nonblock uv__nonblock_fcntl
175 #endif
176
177 /* On Linux, uv__nonblock_fcntl() and uv__nonblock_ioctl() do not commute
178 * when O_NDELAY is not equal to O_NONBLOCK. Case in point: linux/sparc32
179 * and linux/sparc64, where O_NDELAY is O_NONBLOCK + another bit.
180 *
181 * Libuv uses uv__nonblock_fcntl() directly sometimes so ensure that it
182 * commutes with uv__nonblock().
183 */
184 #if defined(__linux__) && O_NDELAY != O_NONBLOCK
185 #undef uv__nonblock
186 #define uv__nonblock uv__nonblock_fcntl
187 #endif
188
189 /* core */
190 int uv__cloexec_ioctl(int fd, int set);
191 int uv__cloexec_fcntl(int fd, int set);
192 int uv__nonblock_ioctl(int fd, int set);
193 int uv__nonblock_fcntl(int fd, int set);
194 int uv__close(int fd); /* preserves errno */
195 int uv__close_nocheckstdio(int fd);
196 int uv__close_nocancel(int fd);
197 int uv__socket(int domain, int type, int protocol);
198 ssize_t uv__recvmsg(int fd, struct msghdr *msg, int flags);
199 void uv__make_close_pending(uv_handle_t* handle);
200 int uv__getiovmax(void);
201
202 void uv__io_init(uv__io_t* w, uv__io_cb cb, int fd);
203 void uv__io_start(uv_loop_t* loop, uv__io_t* w, unsigned int events);
204 void uv__io_stop(uv_loop_t* loop, uv__io_t* w, unsigned int events);
205 void uv__io_close(uv_loop_t* loop, uv__io_t* w);
206 void uv__io_feed(uv_loop_t* loop, uv__io_t* w);
207 int uv__io_active(const uv__io_t* w, unsigned int events);
208 int uv__io_check_fd(uv_loop_t* loop, int fd);
209 void uv__io_poll(uv_loop_t* loop, int timeout); /* in milliseconds or -1 */
210 int uv__io_fork(uv_loop_t* loop);
211 int uv__fd_exists(uv_loop_t* loop, int fd);
212
213 /* async */
214 void uv__async_stop(uv_loop_t* loop);
215 int uv__async_fork(uv_loop_t* loop);
216
217
218 /* loop */
219 void uv__run_idle(uv_loop_t* loop);
220 void uv__run_check(uv_loop_t* loop);
221 void uv__run_prepare(uv_loop_t* loop);
222
223 /* stream */
224 void uv__stream_init(uv_loop_t* loop, uv_stream_t* stream,
225 uv_handle_type type);
226 int uv__stream_open(uv_stream_t*, int fd, int flags);
227 void uv__stream_destroy(uv_stream_t* stream);
228 #if defined(__APPLE__)
229 int uv__stream_try_select(uv_stream_t* stream, int* fd);
230 #endif /* defined(__APPLE__) */
231 void uv__server_io(uv_loop_t* loop, uv__io_t* w, unsigned int events);
232 int uv__accept(int sockfd);
233 int uv__dup2_cloexec(int oldfd, int newfd);
234 int uv__open_cloexec(const char* path, int flags);
235
236 /* tcp */
237 int uv_tcp_listen(uv_tcp_t* tcp, int backlog, uv_connection_cb cb);
238 int uv__tcp_nodelay(int fd, int on);
239 int uv__tcp_keepalive(int fd, int on, unsigned int delay);
240
241 /* pipe */
242 int uv_pipe_listen(uv_pipe_t* handle, int backlog, uv_connection_cb cb);
243
244 /* signal */
245 void uv__signal_close(uv_signal_t* handle);
246 void uv__signal_global_once_init(void);
247 void uv__signal_loop_cleanup(uv_loop_t* loop);
248 int uv__signal_loop_fork(uv_loop_t* loop);
249
250 /* platform specific */
251 uint64_t uv__hrtime(uv_clocktype_t type);
252 int uv__kqueue_init(uv_loop_t* loop);
253 int uv__platform_loop_init(uv_loop_t* loop);
254 void uv__platform_loop_delete(uv_loop_t* loop);
255 void uv__platform_invalidate_fd(uv_loop_t* loop, int fd);
256
257 /* various */
258 void uv__async_close(uv_async_t* handle);
259 void uv__check_close(uv_check_t* handle);
260 void uv__fs_event_close(uv_fs_event_t* handle);
261 void uv__idle_close(uv_idle_t* handle);
262 void uv__pipe_close(uv_pipe_t* handle);
263 void uv__poll_close(uv_poll_t* handle);
264 void uv__prepare_close(uv_prepare_t* handle);
265 void uv__process_close(uv_process_t* handle);
266 void uv__stream_close(uv_stream_t* handle);
267 void uv__tcp_close(uv_tcp_t* handle);
268 void uv__udp_close(uv_udp_t* handle);
269 void uv__udp_finish_close(uv_udp_t* handle);
270 uv_handle_type uv__handle_type(int fd);
271 FILE* uv__open_file(const char* path);
272 int uv__getpwuid_r(uv_passwd_t* pwd);
273
274 /* random */
275 int uv__random_devurandom(void* buf, size_t buflen);
276 int uv__random_getrandom(void* buf, size_t buflen);
277 int uv__random_getentropy(void* buf, size_t buflen);
278 int uv__random_readpath(const char* path, void* buf, size_t buflen);
279 int uv__random_sysctl(void* buf, size_t buflen);
280
281 #if defined(__APPLE__)
282 int uv___stream_fd(const uv_stream_t* handle);
283 #define uv__stream_fd(handle) (uv___stream_fd((const uv_stream_t*) (handle)))
284 #else
285 #define uv__stream_fd(handle) ((handle)->io_watcher.fd)
286 #endif /* defined(__APPLE__) */
287
288 #ifdef O_NONBLOCK
289 # define UV__F_NONBLOCK O_NONBLOCK
290 #else
291 # define UV__F_NONBLOCK 1
292 #endif
293
294 int uv__make_pipe(int fds[2], int flags);
295
296 #if defined(__APPLE__)
297
298 int uv__fsevents_init(uv_fs_event_t* handle);
299 int uv__fsevents_close(uv_fs_event_t* handle);
300 void uv__fsevents_loop_delete(uv_loop_t* loop);
301
302 #endif /* defined(__APPLE__) */
303
UV_UNUSED(static void uv__update_time (uv_loop_t * loop))304 UV_UNUSED(static void uv__update_time(uv_loop_t* loop)) {
305 /* Use a fast time source if available. We only need millisecond precision.
306 */
307 loop->time = uv__hrtime(UV_CLOCK_FAST) / 1000000;
308 }
309
UV_UNUSED(static char * uv__basename_r (const char * path))310 UV_UNUSED(static char* uv__basename_r(const char* path)) {
311 char* s;
312
313 s = strrchr(path, '/');
314 if (s == NULL)
315 return (char*) path;
316
317 return s + 1;
318 }
319
320 #if defined(__linux__)
321 int uv__inotify_fork(uv_loop_t* loop, void* old_watchers);
322 #endif
323
324 typedef int (*uv__peersockfunc)(int, struct sockaddr*, socklen_t*);
325
326 int uv__getsockpeername(const uv_handle_t* handle,
327 uv__peersockfunc func,
328 struct sockaddr* name,
329 int* namelen);
330
331 #if defined(__linux__) || \
332 defined(__FreeBSD__) || \
333 defined(__FreeBSD_kernel__)
334 #define HAVE_MMSG 1
335 struct uv__mmsghdr {
336 struct msghdr msg_hdr;
337 unsigned int msg_len;
338 };
339
340 int uv__recvmmsg(int fd,
341 struct uv__mmsghdr* mmsg,
342 unsigned int vlen,
343 unsigned int flags,
344 struct timespec* timeout);
345 int uv__sendmmsg(int fd,
346 struct uv__mmsghdr* mmsg,
347 unsigned int vlen,
348 unsigned int flags);
349 #else
350 #define HAVE_MMSG 0
351 #endif
352
353
354 #endif /* UV_UNIX_INTERNAL_H_ */
355