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