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(PATH_MAX)
66# define UV__PATH_MAX PATH_MAX
67#else
68# define UV__PATH_MAX 8192
69#endif
70
71#if defined(__ANDROID__)
72int uv__pthread_sigmask(int how, const sigset_t* set, sigset_t* oset);
73# ifdef pthread_sigmask
74# undef pthread_sigmask
75# endif
76# define pthread_sigmask(how, set, oldset) uv__pthread_sigmask(how, set, oldset)
77#endif
78
79#define ACCESS_ONCE(type, var) \
80 (*(volatile type*) &(var))
81
82#define ROUND_UP(a, b) \
83 ((a) % (b) ? ((a) + (b)) - ((a) % (b)) : (a))
84
85#define UNREACHABLE() \
86 do { \
87 assert(0 && "unreachable code"); \
88 abort(); \
89 } \
90 while (0)
91
92#define SAVE_ERRNO(block) \
93 do { \
94 int _saved_errno = errno; \
95 do { block; } while (0); \
96 errno = _saved_errno; \
97 } \
98 while (0)
99
100/* The __clang__ and __INTEL_COMPILER checks are superfluous because they
101 * define __GNUC__. They are here to convey to you, dear reader, that these
102 * macros are enabled when compiling with clang or icc.
103 */
104#if defined(__clang__) || \
105 defined(__GNUC__) || \
106 defined(__INTEL_COMPILER)
107# define UV_UNUSED(declaration) __attribute__((unused)) declaration
108#else
109# define UV_UNUSED(declaration) declaration
110#endif
111
112/* Leans on the fact that, on Linux, POLLRDHUP == EPOLLRDHUP. */
113#ifdef POLLRDHUP
114# define UV__POLLRDHUP POLLRDHUP
115#else
116# define UV__POLLRDHUP 0x2000
117#endif
118
119#ifdef POLLPRI
120# define UV__POLLPRI POLLPRI
121#else
122# define UV__POLLPRI 0
123#endif
124
125#if !defined(O_CLOEXEC) && defined(__FreeBSD__)
126/*
127 * It may be that we are just missing `__POSIX_VISIBLE >= 200809`.
128 * Try using fixed value const and give up, if it doesn't work
129 */
130# define O_CLOEXEC 0x00100000
131#endif
132
133typedef struct uv__stream_queued_fds_s uv__stream_queued_fds_t;
134
135/* loop flags */
136enum {
137 UV_LOOP_BLOCK_SIGPROF = 1
138};
139
140/* flags of excluding ifaddr */
141enum {
142 UV__EXCLUDE_IFPHYS,
143 UV__EXCLUDE_IFADDR
144};
145
146typedef enum {
147 UV_CLOCK_PRECISE = 0, /* Use the highest resolution clock available. */
148 UV_CLOCK_FAST = 1 /* Use the fastest clock with <= 1ms granularity. */
149} uv_clocktype_t;
150
151struct uv__stream_queued_fds_s {
152 unsigned int size;
153 unsigned int offset;
154 int fds[1];
155};
156
157
158#if defined(_AIX) || \
159 defined(__APPLE__) || \
160 defined(__DragonFly__) || \
161 defined(__FreeBSD__) || \
162 defined(__FreeBSD_kernel__) || \
163 defined(__linux__) || \
164 defined(__OpenBSD__) || \
165 defined(__NetBSD__)
166#define uv__cloexec uv__cloexec_ioctl
167#define uv__nonblock uv__nonblock_ioctl
168#else
169#define uv__cloexec uv__cloexec_fcntl
170#define uv__nonblock uv__nonblock_fcntl
171#endif
172
173/* On Linux, uv__nonblock_fcntl() and uv__nonblock_ioctl() do not commute
174 * when O_NDELAY is not equal to O_NONBLOCK. Case in point: linux/sparc32
175 * and linux/sparc64, where O_NDELAY is O_NONBLOCK + another bit.
176 *
177 * Libuv uses uv__nonblock_fcntl() directly sometimes so ensure that it
178 * commutes with uv__nonblock().
179 */
180#if defined(__linux__) && O_NDELAY != O_NONBLOCK
181#undef uv__nonblock
182#define uv__nonblock uv__nonblock_fcntl
183#endif
184
185/* core */
186int uv__cloexec_ioctl(int fd, int set);
187int uv__cloexec_fcntl(int fd, int set);
188int uv__nonblock_ioctl(int fd, int set);
189int uv__nonblock_fcntl(int fd, int set);
190int uv__close(int fd); /* preserves errno */
191int uv__close_nocheckstdio(int fd);
192int uv__close_nocancel(int fd);
193int uv__socket(int domain, int type, int protocol);
194ssize_t uv__recvmsg(int fd, struct msghdr *msg, int flags);
195void uv__make_close_pending(uv_handle_t* handle);
196int uv__getiovmax(void);
197
198void uv__io_init(uv__io_t* w, uv__io_cb cb, int fd);
199void uv__io_start(uv_loop_t* loop, uv__io_t* w, unsigned int events);
200void uv__io_stop(uv_loop_t* loop, uv__io_t* w, unsigned int events);
201void uv__io_close(uv_loop_t* loop, uv__io_t* w);
202void uv__io_feed(uv_loop_t* loop, uv__io_t* w);
203int uv__io_active(const uv__io_t* w, unsigned int events);
204int uv__io_check_fd(uv_loop_t* loop, int fd);
205void uv__io_poll(uv_loop_t* loop, int timeout); /* in milliseconds or -1 */
206int uv__io_fork(uv_loop_t* loop);
207int uv__fd_exists(uv_loop_t* loop, int fd);
208
209/* async */
210void uv__async_stop(uv_loop_t* loop);
211int uv__async_fork(uv_loop_t* loop);
212
213
214/* loop */
215void uv__run_idle(uv_loop_t* loop);
216void uv__run_check(uv_loop_t* loop);
217void uv__run_prepare(uv_loop_t* loop);
218
219/* stream */
220void uv__stream_init(uv_loop_t* loop, uv_stream_t* stream,
221 uv_handle_type type);
222int uv__stream_open(uv_stream_t*, int fd, int flags);
223void uv__stream_destroy(uv_stream_t* stream);
224#if defined(__APPLE__)
225int uv__stream_try_select(uv_stream_t* stream, int* fd);
226#endif /* defined(__APPLE__) */
227void uv__server_io(uv_loop_t* loop, uv__io_t* w, unsigned int events);
228int uv__accept(int sockfd);
229int uv__dup2_cloexec(int oldfd, int newfd);
230int uv__open_cloexec(const char* path, int flags);
231
232/* tcp */
233int uv_tcp_listen(uv_tcp_t* tcp, int backlog, uv_connection_cb cb);
234int uv__tcp_nodelay(int fd, int on);
235int uv__tcp_keepalive(int fd, int on, unsigned int delay);
236
237/* pipe */
238int uv_pipe_listen(uv_pipe_t* handle, int backlog, uv_connection_cb cb);
239
240/* signal */
241void uv__signal_close(uv_signal_t* handle);
242void uv__signal_global_once_init(void);
243void uv__signal_loop_cleanup(uv_loop_t* loop);
244int uv__signal_loop_fork(uv_loop_t* loop);
245
246/* platform specific */
247uint64_t uv__hrtime(uv_clocktype_t type);
248int uv__kqueue_init(uv_loop_t* loop);
249int uv__platform_loop_init(uv_loop_t* loop);
250void uv__platform_loop_delete(uv_loop_t* loop);
251void uv__platform_invalidate_fd(uv_loop_t* loop, int fd);
252
253/* various */
254void uv__async_close(uv_async_t* handle);
255void uv__check_close(uv_check_t* handle);
256void uv__fs_event_close(uv_fs_event_t* handle);
257void uv__idle_close(uv_idle_t* handle);
258void uv__pipe_close(uv_pipe_t* handle);
259void uv__poll_close(uv_poll_t* handle);
260void uv__prepare_close(uv_prepare_t* handle);
261void uv__process_close(uv_process_t* handle);
262void uv__stream_close(uv_stream_t* handle);
263void uv__tcp_close(uv_tcp_t* handle);
264void uv__udp_close(uv_udp_t* handle);
265void uv__udp_finish_close(uv_udp_t* handle);
266uv_handle_type uv__handle_type(int fd);
267FILE* uv__open_file(const char* path);
268int uv__getpwuid_r(uv_passwd_t* pwd);
269int uv__search_path(const char* prog, char* buf, size_t* buflen);
270
271/* random */
272int uv__random_devurandom(void* buf, size_t buflen);
273int uv__random_getrandom(void* buf, size_t buflen);
274int uv__random_getentropy(void* buf, size_t buflen);
275int uv__random_readpath(const char* path, void* buf, size_t buflen);
276int uv__random_sysctl(void* buf, size_t buflen);
277
278#if defined(__APPLE__)
279int uv___stream_fd(const uv_stream_t* handle);
280#define uv__stream_fd(handle) (uv___stream_fd((const uv_stream_t*) (handle)))
281#else
282#define uv__stream_fd(handle) ((handle)->io_watcher.fd)
283#endif /* defined(__APPLE__) */
284
285int uv__make_pipe(int fds[2], int flags);
286
287#if defined(__APPLE__)
288
289int uv__fsevents_init(uv_fs_event_t* handle);
290int uv__fsevents_close(uv_fs_event_t* handle);
291void uv__fsevents_loop_delete(uv_loop_t* loop);
292
293#endif /* defined(__APPLE__) */
294
295UV_UNUSED(static void uv__update_time(uv_loop_t* loop)) {
296 /* Use a fast time source if available. We only need millisecond precision.
297 */
298 loop->time = uv__hrtime(UV_CLOCK_FAST) / 1000000;
299}
300
301UV_UNUSED(static char* uv__basename_r(const char* path)) {
302 char* s;
303
304 s = strrchr(path, '/');
305 if (s == NULL)
306 return (char*) path;
307
308 return s + 1;
309}
310
311#if defined(__linux__)
312int uv__inotify_fork(uv_loop_t* loop, void* old_watchers);
313#endif
314
315typedef int (*uv__peersockfunc)(int, struct sockaddr*, socklen_t*);
316
317int uv__getsockpeername(const uv_handle_t* handle,
318 uv__peersockfunc func,
319 struct sockaddr* name,
320 int* namelen);
321
322#if defined(__linux__) || \
323 defined(__FreeBSD__) || \
324 defined(__FreeBSD_kernel__)
325#define HAVE_MMSG 1
326struct uv__mmsghdr {
327 struct msghdr msg_hdr;
328 unsigned int msg_len;
329};
330
331int uv__recvmmsg(int fd, struct uv__mmsghdr* mmsg, unsigned int vlen);
332int uv__sendmmsg(int fd, struct uv__mmsghdr* mmsg, unsigned int vlen);
333#else
334#define HAVE_MMSG 0
335#endif
336
337
338#endif /* UV_UNIX_INTERNAL_H_ */
339