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