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 #include <stdint.h> 34 35 #include "uv.h" 36 #include "uv/tree.h" 37 #include "queue.h" 38 #include "strscpy.h" 39 40 #ifndef _MSC_VER 41 # include <stdatomic.h> 42 #endif 43 44 #if EDOM > 0 45 # define UV__ERR(x) (-(x)) 46 #else 47 # define UV__ERR(x) (x) 48 #endif 49 50 #if !defined(snprintf) && defined(_MSC_VER) && _MSC_VER < 1900 51 extern int snprintf(char*, size_t, const char*, ...); 52 #endif 53 54 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) 55 #define ARRAY_END(a) ((a) + ARRAY_SIZE(a)) 56 57 #define container_of(ptr, type, member) \ 58 ((type *) ((char *) (ptr) - offsetof(type, member))) 59 60 /* C11 defines static_assert to be a macro which calls _Static_assert. */ 61 #if defined(static_assert) 62 #define STATIC_ASSERT(expr) static_assert(expr, #expr) 63 #else 64 #define STATIC_ASSERT(expr) \ 65 void uv__static_assert(int static_assert_failed[1 - 2 * !(expr)]) 66 #endif 67 68 #ifdef _MSC_VER 69 #define uv__exchange_int_relaxed(p, v) \ 70 InterlockedExchangeNoFence((LONG volatile*)(p), v) 71 #else 72 #define uv__exchange_int_relaxed(p, v) \ 73 atomic_exchange_explicit((_Atomic int*)(p), v, memory_order_relaxed) 74 #endif 75 76 #define UV__UDP_DGRAM_MAXSIZE (64 * 1024) 77 78 /* Handle flags. Some flags are specific to Windows or UNIX. */ 79 enum { 80 /* Used by all handles. */ 81 UV_HANDLE_CLOSING = 0x00000001, 82 UV_HANDLE_CLOSED = 0x00000002, 83 UV_HANDLE_ACTIVE = 0x00000004, 84 UV_HANDLE_REF = 0x00000008, 85 UV_HANDLE_INTERNAL = 0x00000010, 86 UV_HANDLE_ENDGAME_QUEUED = 0x00000020, 87 88 /* Used by streams. */ 89 UV_HANDLE_LISTENING = 0x00000040, 90 UV_HANDLE_CONNECTION = 0x00000080, 91 UV_HANDLE_SHUT = 0x00000200, 92 UV_HANDLE_READ_PARTIAL = 0x00000400, 93 UV_HANDLE_READ_EOF = 0x00000800, 94 95 /* Used by streams and UDP handles. */ 96 UV_HANDLE_READING = 0x00001000, 97 UV_HANDLE_BOUND = 0x00002000, 98 UV_HANDLE_READABLE = 0x00004000, 99 UV_HANDLE_WRITABLE = 0x00008000, 100 UV_HANDLE_READ_PENDING = 0x00010000, 101 UV_HANDLE_SYNC_BYPASS_IOCP = 0x00020000, 102 UV_HANDLE_ZERO_READ = 0x00040000, 103 UV_HANDLE_EMULATE_IOCP = 0x00080000, 104 UV_HANDLE_BLOCKING_WRITES = 0x00100000, 105 UV_HANDLE_CANCELLATION_PENDING = 0x00200000, 106 107 /* Used by uv_tcp_t and uv_udp_t handles */ 108 UV_HANDLE_IPV6 = 0x00400000, 109 110 /* Only used by uv_tcp_t handles. */ 111 UV_HANDLE_TCP_NODELAY = 0x01000000, 112 UV_HANDLE_TCP_KEEPALIVE = 0x02000000, 113 UV_HANDLE_TCP_SINGLE_ACCEPT = 0x04000000, 114 UV_HANDLE_TCP_ACCEPT_STATE_CHANGING = 0x08000000, 115 UV_HANDLE_SHARED_TCP_SOCKET = 0x10000000, 116 117 /* Only used by uv_udp_t handles. */ 118 UV_HANDLE_UDP_PROCESSING = 0x01000000, 119 UV_HANDLE_UDP_CONNECTED = 0x02000000, 120 UV_HANDLE_UDP_RECVMMSG = 0x04000000, 121 122 /* Only used by uv_pipe_t handles. */ 123 UV_HANDLE_NON_OVERLAPPED_PIPE = 0x01000000, 124 UV_HANDLE_PIPESERVER = 0x02000000, 125 126 /* Only used by uv_tty_t handles. */ 127 UV_HANDLE_TTY_READABLE = 0x01000000, 128 UV_HANDLE_TTY_RAW = 0x02000000, 129 UV_HANDLE_TTY_SAVED_POSITION = 0x04000000, 130 UV_HANDLE_TTY_SAVED_ATTRIBUTES = 0x08000000, 131 132 /* Only used by uv_signal_t handles. */ 133 UV_SIGNAL_ONE_SHOT_DISPATCHED = 0x01000000, 134 UV_SIGNAL_ONE_SHOT = 0x02000000, 135 136 /* Only used by uv_poll_t handles. */ 137 UV_HANDLE_POLL_SLOW = 0x01000000, 138 139 /* Only used by uv_process_t handles. */ 140 UV_HANDLE_REAP = 0x10000000 141 }; 142 143 int uv__loop_configure(uv_loop_t* loop, uv_loop_option option, va_list ap); 144 145 void uv__loop_close(uv_loop_t* loop); 146 147 int uv__read_start(uv_stream_t* stream, 148 uv_alloc_cb alloc_cb, 149 uv_read_cb read_cb); 150 151 int uv__tcp_bind(uv_tcp_t* tcp, 152 const struct sockaddr* addr, 153 unsigned int addrlen, 154 unsigned int flags); 155 156 int uv__tcp_connect(uv_connect_t* req, 157 uv_tcp_t* handle, 158 const struct sockaddr* addr, 159 unsigned int addrlen, 160 uv_connect_cb cb); 161 162 int uv__udp_init_ex(uv_loop_t* loop, 163 uv_udp_t* handle, 164 unsigned flags, 165 int domain); 166 167 int uv__udp_bind(uv_udp_t* handle, 168 const struct sockaddr* addr, 169 unsigned int addrlen, 170 unsigned int flags); 171 172 int uv__udp_connect(uv_udp_t* handle, 173 const struct sockaddr* addr, 174 unsigned int addrlen); 175 176 int uv__udp_disconnect(uv_udp_t* handle); 177 178 int uv__udp_is_connected(uv_udp_t* handle); 179 180 int uv__udp_send(uv_udp_send_t* req, 181 uv_udp_t* handle, 182 const uv_buf_t bufs[], 183 unsigned int nbufs, 184 const struct sockaddr* addr, 185 unsigned int addrlen, 186 uv_udp_send_cb send_cb); 187 188 int uv__udp_try_send(uv_udp_t* handle, 189 const uv_buf_t bufs[], 190 unsigned int nbufs, 191 const struct sockaddr* addr, 192 unsigned int addrlen); 193 194 int uv__udp_recv_start(uv_udp_t* handle, uv_alloc_cb alloccb, 195 uv_udp_recv_cb recv_cb); 196 197 int uv__udp_recv_stop(uv_udp_t* handle); 198 199 void uv__fs_poll_close(uv_fs_poll_t* handle); 200 201 int uv__getaddrinfo_translate_error(int sys_err); /* EAI_* error. */ 202 203 enum uv__work_kind { 204 UV__WORK_CPU, 205 UV__WORK_FAST_IO, 206 UV__WORK_SLOW_IO 207 }; 208 209 void uv__work_submit(uv_loop_t* loop, 210 struct uv__work *w, 211 enum uv__work_kind kind, 212 void (*work)(struct uv__work *w), 213 void (*done)(struct uv__work *w, int status)); 214 215 void uv__work_done(uv_async_t* handle); 216 217 size_t uv__count_bufs(const uv_buf_t bufs[], unsigned int nbufs); 218 219 int uv__socket_sockopt(uv_handle_t* handle, int optname, int* value); 220 221 void uv__fs_scandir_cleanup(uv_fs_t* req); 222 void uv__fs_readdir_cleanup(uv_fs_t* req); 223 uv_dirent_type_t uv__fs_get_dirent_type(uv__dirent_t* dent); 224 225 int uv__next_timeout(const uv_loop_t* loop); 226 void uv__run_timers(uv_loop_t* loop); 227 void uv__timer_close(uv_timer_t* handle); 228 229 void uv__process_title_cleanup(void); 230 void uv__signal_cleanup(void); 231 void uv__threadpool_cleanup(void); 232 233 #define uv__has_active_reqs(loop) \ 234 ((loop)->active_reqs.count > 0) 235 236 #define uv__req_register(loop, req) \ 237 do { \ 238 (loop)->active_reqs.count++; \ 239 } \ 240 while (0) 241 242 #define uv__req_unregister(loop, req) \ 243 do { \ 244 assert(uv__has_active_reqs(loop)); \ 245 (loop)->active_reqs.count--; \ 246 } \ 247 while (0) 248 249 #define uv__has_active_handles(loop) \ 250 ((loop)->active_handles > 0) 251 252 #define uv__active_handle_add(h) \ 253 do { \ 254 (h)->loop->active_handles++; \ 255 } \ 256 while (0) 257 258 #define uv__active_handle_rm(h) \ 259 do { \ 260 (h)->loop->active_handles--; \ 261 } \ 262 while (0) 263 264 #define uv__is_active(h) \ 265 (((h)->flags & UV_HANDLE_ACTIVE) != 0) 266 267 #define uv__is_closing(h) \ 268 (((h)->flags & (UV_HANDLE_CLOSING | UV_HANDLE_CLOSED)) != 0) 269 270 #if defined(_WIN32) 271 # define uv__is_stream_shutting(h) \ 272 (h->stream.conn.shutdown_req != NULL) 273 #else 274 # define uv__is_stream_shutting(h) \ 275 (h->shutdown_req != NULL) 276 #endif 277 278 #define uv__handle_start(h) \ 279 do { \ 280 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) break; \ 281 (h)->flags |= UV_HANDLE_ACTIVE; \ 282 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_add(h); \ 283 } \ 284 while (0) 285 286 #define uv__handle_stop(h) \ 287 do { \ 288 if (((h)->flags & UV_HANDLE_ACTIVE) == 0) break; \ 289 (h)->flags &= ~UV_HANDLE_ACTIVE; \ 290 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_rm(h); \ 291 } \ 292 while (0) 293 294 #define uv__handle_ref(h) \ 295 do { \ 296 if (((h)->flags & UV_HANDLE_REF) != 0) break; \ 297 (h)->flags |= UV_HANDLE_REF; \ 298 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 299 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_add(h); \ 300 } \ 301 while (0) 302 303 #define uv__handle_unref(h) \ 304 do { \ 305 if (((h)->flags & UV_HANDLE_REF) == 0) break; \ 306 (h)->flags &= ~UV_HANDLE_REF; \ 307 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 308 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_rm(h); \ 309 } \ 310 while (0) 311 312 #define uv__has_ref(h) \ 313 (((h)->flags & UV_HANDLE_REF) != 0) 314 315 #if defined(_WIN32) 316 # define uv__handle_platform_init(h) ((h)->u.fd = -1) 317 #else 318 # define uv__handle_platform_init(h) ((h)->next_closing = NULL) 319 #endif 320 321 #define uv__handle_init(loop_, h, type_) \ 322 do { \ 323 (h)->loop = (loop_); \ 324 (h)->type = (type_); \ 325 (h)->flags = UV_HANDLE_REF; /* Ref the loop when active. */ \ 326 uv__queue_insert_tail(&(loop_)->handle_queue, &(h)->handle_queue); \ 327 uv__handle_platform_init(h); \ 328 } \ 329 while (0) 330 331 /* Note: uses an open-coded version of SET_REQ_SUCCESS() because of 332 * a circular dependency between src/uv-common.h and src/win/internal.h. 333 */ 334 #if defined(_WIN32) 335 # define UV_REQ_INIT(req, typ) \ 336 do { \ 337 (req)->type = (typ); \ 338 (req)->u.io.overlapped.Internal = 0; /* SET_REQ_SUCCESS() */ \ 339 } \ 340 while (0) 341 #else 342 # define UV_REQ_INIT(req, typ) \ 343 do { \ 344 (req)->type = (typ); \ 345 } \ 346 while (0) 347 #endif 348 349 #define uv__req_init(loop, req, typ) \ 350 do { \ 351 UV_REQ_INIT(req, typ); \ 352 uv__req_register(loop, req); \ 353 } \ 354 while (0) 355 356 #define uv__get_internal_fields(loop) \ 357 ((uv__loop_internal_fields_t*) loop->internal_fields) 358 359 #define uv__get_loop_metrics(loop) \ 360 (&uv__get_internal_fields(loop)->loop_metrics) 361 362 #define uv__metrics_inc_loop_count(loop) \ 363 do { \ 364 uv__get_loop_metrics(loop)->metrics.loop_count++; \ 365 } while (0) 366 367 #define uv__metrics_inc_events(loop, e) \ 368 do { \ 369 uv__get_loop_metrics(loop)->metrics.events += (e); \ 370 } while (0) 371 372 #define uv__metrics_inc_events_waiting(loop, e) \ 373 do { \ 374 uv__get_loop_metrics(loop)->metrics.events_waiting += (e); \ 375 } while (0) 376 377 /* Allocator prototypes */ 378 void *uv__calloc(size_t count, size_t size); 379 char *uv__strdup(const char* s); 380 char *uv__strndup(const char* s, size_t n); 381 void* uv__malloc(size_t size); 382 void uv__free(void* ptr); 383 void* uv__realloc(void* ptr, size_t size); 384 void* uv__reallocf(void* ptr, size_t size); 385 386 typedef struct uv__loop_metrics_s uv__loop_metrics_t; 387 typedef struct uv__loop_internal_fields_s uv__loop_internal_fields_t; 388 389 struct uv__loop_metrics_s { 390 uv_metrics_t metrics; 391 uint64_t provider_entry_time; 392 uint64_t provider_idle_time; 393 uv_mutex_t lock; 394 }; 395 396 void uv__metrics_update_idle_time(uv_loop_t* loop); 397 void uv__metrics_set_provider_entry_time(uv_loop_t* loop); 398 399 #ifdef __linux__ 400 struct uv__iou { 401 uint32_t* sqhead; 402 uint32_t* sqtail; 403 uint32_t* sqarray; 404 uint32_t sqmask; 405 uint32_t* sqflags; 406 uint32_t* cqhead; 407 uint32_t* cqtail; 408 uint32_t cqmask; 409 void* sq; /* pointer to munmap() on event loop teardown */ 410 void* cqe; /* pointer to array of struct uv__io_uring_cqe */ 411 void* sqe; /* pointer to array of struct uv__io_uring_sqe */ 412 size_t sqlen; 413 size_t cqlen; 414 size_t maxlen; 415 size_t sqelen; 416 int ringfd; 417 uint32_t in_flight; 418 uint32_t flags; 419 }; 420 #endif /* __linux__ */ 421 422 struct uv__loop_internal_fields_s { 423 unsigned int flags; 424 uv__loop_metrics_t loop_metrics; 425 int current_timeout; 426 #ifdef __linux__ 427 struct uv__iou ctl; 428 struct uv__iou iou; 429 void* inv; /* used by uv__platform_invalidate_fd() */ 430 #endif /* __linux__ */ 431 }; 432 433 #endif /* UV_COMMON_H_ */ 434
