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/*
23 * This file is private to libuv. It provides common functionality to both
24 * Windows and Unix backends.
25 */
26
27#ifndef UV_COMMON_H_
28#define UV_COMMON_H_
29
30#include <assert.h>
31#include <stdarg.h>
32#include <stddef.h>
33
34#if defined(_MSC_VER) && _MSC_VER < 1600
35# include "uv/stdint-msvc2008.h"
36#else
37# include <stdint.h>
38#endif
39
40#include "uv.h"
41#include "uv/tree.h"
42#include "queue.h"
43#include "strscpy.h"
44
45#if EDOM > 0
46# define UV__ERR(x) (-(x))
47#else
48# define UV__ERR(x) (x)
49#endif
50
51#if !defined(snprintf) && defined(_MSC_VER) && _MSC_VER < 1900
52extern int snprintf(char*, size_t, const char*, ...);
53#endif
54
55#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
56
57#define container_of(ptr, type, member) \
58 ((type *) ((char *) (ptr) - offsetof(type, member)))
59
60#define STATIC_ASSERT(expr) \
61 void uv__static_assert(int static_assert_failed[1 - 2 * !(expr)])
62
63#if defined(__GNUC__) && (__GNUC__ > 4 || __GNUC__ == 4 && __GNUC_MINOR__ >= 7)
64#define uv__load_relaxed(p) __atomic_load_n(p, __ATOMIC_RELAXED)
65#define uv__store_relaxed(p, v) __atomic_store_n(p, v, __ATOMIC_RELAXED)
66#else
67#define uv__load_relaxed(p) (*p)
68#define uv__store_relaxed(p, v) do *p = v; while (0)
69#endif
70
71/* Handle flags. Some flags are specific to Windows or UNIX. */
72enum {
73 /* Used by all handles. */
74 UV_HANDLE_CLOSING = 0x00000001,
75 UV_HANDLE_CLOSED = 0x00000002,
76 UV_HANDLE_ACTIVE = 0x00000004,
77 UV_HANDLE_REF = 0x00000008,
78 UV_HANDLE_INTERNAL = 0x00000010,
79 UV_HANDLE_ENDGAME_QUEUED = 0x00000020,
80
81 /* Used by streams. */
82 UV_HANDLE_LISTENING = 0x00000040,
83 UV_HANDLE_CONNECTION = 0x00000080,
84 UV_HANDLE_SHUTTING = 0x00000100,
85 UV_HANDLE_SHUT = 0x00000200,
86 UV_HANDLE_READ_PARTIAL = 0x00000400,
87 UV_HANDLE_READ_EOF = 0x00000800,
88
89 /* Used by streams and UDP handles. */
90 UV_HANDLE_READING = 0x00001000,
91 UV_HANDLE_BOUND = 0x00002000,
92 UV_HANDLE_READABLE = 0x00004000,
93 UV_HANDLE_WRITABLE = 0x00008000,
94 UV_HANDLE_READ_PENDING = 0x00010000,
95 UV_HANDLE_SYNC_BYPASS_IOCP = 0x00020000,
96 UV_HANDLE_ZERO_READ = 0x00040000,
97 UV_HANDLE_EMULATE_IOCP = 0x00080000,
98 UV_HANDLE_BLOCKING_WRITES = 0x00100000,
99 UV_HANDLE_CANCELLATION_PENDING = 0x00200000,
100
101 /* Used by uv_tcp_t and uv_udp_t handles */
102 UV_HANDLE_IPV6 = 0x00400000,
103
104 /* Only used by uv_tcp_t handles. */
105 UV_HANDLE_TCP_NODELAY = 0x01000000,
106 UV_HANDLE_TCP_KEEPALIVE = 0x02000000,
107 UV_HANDLE_TCP_SINGLE_ACCEPT = 0x04000000,
108 UV_HANDLE_TCP_ACCEPT_STATE_CHANGING = 0x08000000,
109 UV_HANDLE_TCP_SOCKET_CLOSED = 0x10000000,
110 UV_HANDLE_SHARED_TCP_SOCKET = 0x20000000,
111
112 /* Only used by uv_udp_t handles. */
113 UV_HANDLE_UDP_PROCESSING = 0x01000000,
114 UV_HANDLE_UDP_CONNECTED = 0x02000000,
115 UV_HANDLE_UDP_RECVMMSG = 0x04000000,
116
117 /* Only used by uv_pipe_t handles. */
118 UV_HANDLE_NON_OVERLAPPED_PIPE = 0x01000000,
119 UV_HANDLE_PIPESERVER = 0x02000000,
120
121 /* Only used by uv_tty_t handles. */
122 UV_HANDLE_TTY_READABLE = 0x01000000,
123 UV_HANDLE_TTY_RAW = 0x02000000,
124 UV_HANDLE_TTY_SAVED_POSITION = 0x04000000,
125 UV_HANDLE_TTY_SAVED_ATTRIBUTES = 0x08000000,
126
127 /* Only used by uv_signal_t handles. */
128 UV_SIGNAL_ONE_SHOT_DISPATCHED = 0x01000000,
129 UV_SIGNAL_ONE_SHOT = 0x02000000,
130
131 /* Only used by uv_poll_t handles. */
132 UV_HANDLE_POLL_SLOW = 0x01000000
133};
134
135int uv__loop_configure(uv_loop_t* loop, uv_loop_option option, va_list ap);
136
137void uv__loop_close(uv_loop_t* loop);
138
139int uv__read_start(uv_stream_t* stream,
140 uv_alloc_cb alloc_cb,
141 uv_read_cb read_cb);
142
143int uv__tcp_bind(uv_tcp_t* tcp,
144 const struct sockaddr* addr,
145 unsigned int addrlen,
146 unsigned int flags);
147
148int uv__tcp_connect(uv_connect_t* req,
149 uv_tcp_t* handle,
150 const struct sockaddr* addr,
151 unsigned int addrlen,
152 uv_connect_cb cb);
153
154int uv__udp_init_ex(uv_loop_t* loop,
155 uv_udp_t* handle,
156 unsigned flags,
157 int domain);
158
159int uv__udp_bind(uv_udp_t* handle,
160 const struct sockaddr* addr,
161 unsigned int addrlen,
162 unsigned int flags);
163
164int uv__udp_connect(uv_udp_t* handle,
165 const struct sockaddr* addr,
166 unsigned int addrlen);
167
168int uv__udp_disconnect(uv_udp_t* handle);
169
170int uv__udp_is_connected(uv_udp_t* handle);
171
172int uv__udp_send(uv_udp_send_t* req,
173 uv_udp_t* handle,
174 const uv_buf_t bufs[],
175 unsigned int nbufs,
176 const struct sockaddr* addr,
177 unsigned int addrlen,
178 uv_udp_send_cb send_cb);
179
180int uv__udp_try_send(uv_udp_t* handle,
181 const uv_buf_t bufs[],
182 unsigned int nbufs,
183 const struct sockaddr* addr,
184 unsigned int addrlen);
185
186int uv__udp_recv_start(uv_udp_t* handle, uv_alloc_cb alloccb,
187 uv_udp_recv_cb recv_cb);
188
189int uv__udp_recv_stop(uv_udp_t* handle);
190
191void uv__fs_poll_close(uv_fs_poll_t* handle);
192
193int uv__getaddrinfo_translate_error(int sys_err); /* EAI_* error. */
194
195enum uv__work_kind {
196 UV__WORK_CPU,
197 UV__WORK_FAST_IO,
198 UV__WORK_SLOW_IO
199};
200
201void uv__work_submit(uv_loop_t* loop,
202 struct uv__work *w,
203 enum uv__work_kind kind,
204 void (*work)(struct uv__work *w),
205 void (*done)(struct uv__work *w, int status));
206
207void uv__work_done(uv_async_t* handle);
208
209size_t uv__count_bufs(const uv_buf_t bufs[], unsigned int nbufs);
210
211int uv__socket_sockopt(uv_handle_t* handle, int optname, int* value);
212
213void uv__fs_scandir_cleanup(uv_fs_t* req);
214void uv__fs_readdir_cleanup(uv_fs_t* req);
215uv_dirent_type_t uv__fs_get_dirent_type(uv__dirent_t* dent);
216
217int uv__next_timeout(const uv_loop_t* loop);
218void uv__run_timers(uv_loop_t* loop);
219void uv__timer_close(uv_timer_t* handle);
220
221void uv__process_title_cleanup(void);
222void uv__signal_cleanup(void);
223void uv__threadpool_cleanup(void);
224
225#define uv__has_active_reqs(loop) \
226 ((loop)->active_reqs.count > 0)
227
228#define uv__req_register(loop, req) \
229 do { \
230 (loop)->active_reqs.count++; \
231 } \
232 while (0)
233
234#define uv__req_unregister(loop, req) \
235 do { \
236 assert(uv__has_active_reqs(loop)); \
237 (loop)->active_reqs.count--; \
238 } \
239 while (0)
240
241#define uv__has_active_handles(loop) \
242 ((loop)->active_handles > 0)
243
244#define uv__active_handle_add(h) \
245 do { \
246 (h)->loop->active_handles++; \
247 } \
248 while (0)
249
250#define uv__active_handle_rm(h) \
251 do { \
252 (h)->loop->active_handles--; \
253 } \
254 while (0)
255
256#define uv__is_active(h) \
257 (((h)->flags & UV_HANDLE_ACTIVE) != 0)
258
259#define uv__is_closing(h) \
260 (((h)->flags & (UV_HANDLE_CLOSING | UV_HANDLE_CLOSED)) != 0)
261
262#define uv__handle_start(h) \
263 do { \
264 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) break; \
265 (h)->flags |= UV_HANDLE_ACTIVE; \
266 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_add(h); \
267 } \
268 while (0)
269
270#define uv__handle_stop(h) \
271 do { \
272 if (((h)->flags & UV_HANDLE_ACTIVE) == 0) break; \
273 (h)->flags &= ~UV_HANDLE_ACTIVE; \
274 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_rm(h); \
275 } \
276 while (0)
277
278#define uv__handle_ref(h) \
279 do { \
280 if (((h)->flags & UV_HANDLE_REF) != 0) break; \
281 (h)->flags |= UV_HANDLE_REF; \
282 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \
283 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_add(h); \
284 } \
285 while (0)
286
287#define uv__handle_unref(h) \
288 do { \
289 if (((h)->flags & UV_HANDLE_REF) == 0) break; \
290 (h)->flags &= ~UV_HANDLE_REF; \
291 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \
292 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_rm(h); \
293 } \
294 while (0)
295
296#define uv__has_ref(h) \
297 (((h)->flags & UV_HANDLE_REF) != 0)
298
299#if defined(_WIN32)
300# define uv__handle_platform_init(h) ((h)->u.fd = -1)
301#else
302# define uv__handle_platform_init(h) ((h)->next_closing = NULL)
303#endif
304
305#define uv__handle_init(loop_, h, type_) \
306 do { \
307 (h)->loop = (loop_); \
308 (h)->type = (type_); \
309 (h)->flags = UV_HANDLE_REF; /* Ref the loop when active. */ \
310 QUEUE_INSERT_TAIL(&(loop_)->handle_queue, &(h)->handle_queue); \
311 uv__handle_platform_init(h); \
312 } \
313 while (0)
314
315/* Note: uses an open-coded version of SET_REQ_SUCCESS() because of
316 * a circular dependency between src/uv-common.h and src/win/internal.h.
317 */
318#if defined(_WIN32)
319# define UV_REQ_INIT(req, typ) \
320 do { \
321 (req)->type = (typ); \
322 (req)->u.io.overlapped.Internal = 0; /* SET_REQ_SUCCESS() */ \
323 } \
324 while (0)
325#else
326# define UV_REQ_INIT(req, typ) \
327 do { \
328 (req)->type = (typ); \
329 } \
330 while (0)
331#endif
332
333#define uv__req_init(loop, req, typ) \
334 do { \
335 UV_REQ_INIT(req, typ); \
336 uv__req_register(loop, req); \
337 } \
338 while (0)
339
340#define uv__get_internal_fields(loop) \
341 ((uv__loop_internal_fields_t*) loop->internal_fields)
342
343#define uv__get_loop_metrics(loop) \
344 (&uv__get_internal_fields(loop)->loop_metrics)
345
346/* Allocator prototypes */
347void *uv__calloc(size_t count, size_t size);
348char *uv__strdup(const char* s);
349char *uv__strndup(const char* s, size_t n);
350void* uv__malloc(size_t size);
351void uv__free(void* ptr);
352void* uv__realloc(void* ptr, size_t size);
353void* uv__reallocf(void* ptr, size_t size);
354
355typedef struct uv__loop_metrics_s uv__loop_metrics_t;
356typedef struct uv__loop_internal_fields_s uv__loop_internal_fields_t;
357
358struct uv__loop_metrics_s {
359 uint64_t provider_entry_time;
360 uint64_t provider_idle_time;
361 uv_mutex_t lock;
362};
363
364void uv__metrics_update_idle_time(uv_loop_t* loop);
365void uv__metrics_set_provider_entry_time(uv_loop_t* loop);
366
367struct uv__loop_internal_fields_s {
368 unsigned int flags;
369 uv__loop_metrics_t loop_metrics;
370};
371
372#endif /* UV_COMMON_H_ */
373