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/* See https://github.com/libuv/libuv#documentation for documentation. */ 23 24#ifndef UV_H 25#define UV_H 26#ifdef __cplusplus 27extern "C" { 28#endif 29 30#if defined(BUILDING_UV_SHARED) && defined(USING_UV_SHARED) 31#error "Define either BUILDING_UV_SHARED or USING_UV_SHARED, not both." 32#endif 33 34#ifndef UV_EXTERN 35#ifdef _WIN32 36 /* Windows - set up dll import/export decorators. */ 37# if defined(BUILDING_UV_SHARED) 38 /* Building shared library. */ 39# define UV_EXTERN __declspec(dllexport) 40# elif defined(USING_UV_SHARED) 41 /* Using shared library. */ 42# define UV_EXTERN __declspec(dllimport) 43# else 44 /* Building static library. */ 45# define UV_EXTERN /* nothing */ 46# endif 47#elif __GNUC__ >= 4 48# define UV_EXTERN __attribute__((visibility("default"))) 49#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x550) /* Sun Studio >= 8 */ 50# define UV_EXTERN __global 51#else 52# define UV_EXTERN /* nothing */ 53#endif 54#endif /* UV_EXTERN */ 55 56#include "uv/errno.h" 57#include "uv/version.h" 58#include <stddef.h> 59#include <stdio.h> 60#include <stdint.h> 61 62/* Internal type, do not use. */ 63struct uv__queue { 64 struct uv__queue* next; 65 struct uv__queue* prev; 66}; 67 68#if defined(_WIN32) 69# include "uv/win.h" 70#else 71# include "uv/unix.h" 72#endif 73 74/* Expand this list if necessary. */ 75#define UV_ERRNO_MAP(XX) \ 76 XX(E2BIG, "argument list too long") \ 77 XX(EACCES, "permission denied") \ 78 XX(EADDRINUSE, "address already in use") \ 79 XX(EADDRNOTAVAIL, "address not available") \ 80 XX(EAFNOSUPPORT, "address family not supported") \ 81 XX(EAGAIN, "resource temporarily unavailable") \ 82 XX(EAI_ADDRFAMILY, "address family not supported") \ 83 XX(EAI_AGAIN, "temporary failure") \ 84 XX(EAI_BADFLAGS, "bad ai_flags value") \ 85 XX(EAI_BADHINTS, "invalid value for hints") \ 86 XX(EAI_CANCELED, "request canceled") \ 87 XX(EAI_FAIL, "permanent failure") \ 88 XX(EAI_FAMILY, "ai_family not supported") \ 89 XX(EAI_MEMORY, "out of memory") \ 90 XX(EAI_NODATA, "no address") \ 91 XX(EAI_NONAME, "unknown node or service") \ 92 XX(EAI_OVERFLOW, "argument buffer overflow") \ 93 XX(EAI_PROTOCOL, "resolved protocol is unknown") \ 94 XX(EAI_SERVICE, "service not available for socket type") \ 95 XX(EAI_SOCKTYPE, "socket type not supported") \ 96 XX(EALREADY, "connection already in progress") \ 97 XX(EBADF, "bad file descriptor") \ 98 XX(EBUSY, "resource busy or locked") \ 99 XX(ECANCELED, "operation canceled") \ 100 XX(ECHARSET, "invalid Unicode character") \ 101 XX(ECONNABORTED, "software caused connection abort") \ 102 XX(ECONNREFUSED, "connection refused") \ 103 XX(ECONNRESET, "connection reset by peer") \ 104 XX(EDESTADDRREQ, "destination address required") \ 105 XX(EEXIST, "file already exists") \ 106 XX(EFAULT, "bad address in system call argument") \ 107 XX(EFBIG, "file too large") \ 108 XX(EHOSTUNREACH, "host is unreachable") \ 109 XX(EINTR, "interrupted system call") \ 110 XX(EINVAL, "invalid argument") \ 111 XX(EIO, "i/o error") \ 112 XX(EISCONN, "socket is already connected") \ 113 XX(EISDIR, "illegal operation on a directory") \ 114 XX(ELOOP, "too many symbolic links encountered") \ 115 XX(EMFILE, "too many open files") \ 116 XX(EMSGSIZE, "message too long") \ 117 XX(ENAMETOOLONG, "name too long") \ 118 XX(ENETDOWN, "network is down") \ 119 XX(ENETUNREACH, "network is unreachable") \ 120 XX(ENFILE, "file table overflow") \ 121 XX(ENOBUFS, "no buffer space available") \ 122 XX(ENODEV, "no such device") \ 123 XX(ENOENT, "no such file or directory") \ 124 XX(ENOMEM, "not enough memory") \ 125 XX(ENONET, "machine is not on the network") \ 126 XX(ENOPROTOOPT, "protocol not available") \ 127 XX(ENOSPC, "no space left on device") \ 128 XX(ENOSYS, "function not implemented") \ 129 XX(ENOTCONN, "socket is not connected") \ 130 XX(ENOTDIR, "not a directory") \ 131 XX(ENOTEMPTY, "directory not empty") \ 132 XX(ENOTSOCK, "socket operation on non-socket") \ 133 XX(ENOTSUP, "operation not supported on socket") \ 134 XX(EOVERFLOW, "value too large for defined data type") \ 135 XX(EPERM, "operation not permitted") \ 136 XX(EPIPE, "broken pipe") \ 137 XX(EPROTO, "protocol error") \ 138 XX(EPROTONOSUPPORT, "protocol not supported") \ 139 XX(EPROTOTYPE, "protocol wrong type for socket") \ 140 XX(ERANGE, "result too large") \ 141 XX(EROFS, "read-only file system") \ 142 XX(ESHUTDOWN, "cannot send after transport endpoint shutdown") \ 143 XX(ESPIPE, "invalid seek") \ 144 XX(ESRCH, "no such process") \ 145 XX(ETIMEDOUT, "connection timed out") \ 146 XX(ETXTBSY, "text file is busy") \ 147 XX(EXDEV, "cross-device link not permitted") \ 148 XX(UNKNOWN, "unknown error") \ 149 XX(EOF, "end of file") \ 150 XX(ENXIO, "no such device or address") \ 151 XX(EMLINK, "too many links") \ 152 XX(EHOSTDOWN, "host is down") \ 153 XX(EREMOTEIO, "remote I/O error") \ 154 XX(ENOTTY, "inappropriate ioctl for device") \ 155 XX(EFTYPE, "inappropriate file type or format") \ 156 XX(EILSEQ, "illegal byte sequence") \ 157 XX(ESOCKTNOSUPPORT, "socket type not supported") \ 158 XX(ENODATA, "no data available") \ 159 XX(EUNATCH, "protocol driver not attached") \ 160 161#define UV_HANDLE_TYPE_MAP(XX) \ 162 XX(ASYNC, async) \ 163 XX(CHECK, check) \ 164 XX(FS_EVENT, fs_event) \ 165 XX(FS_POLL, fs_poll) \ 166 XX(HANDLE, handle) \ 167 XX(IDLE, idle) \ 168 XX(NAMED_PIPE, pipe) \ 169 XX(POLL, poll) \ 170 XX(PREPARE, prepare) \ 171 XX(PROCESS, process) \ 172 XX(STREAM, stream) \ 173 XX(TCP, tcp) \ 174 XX(TIMER, timer) \ 175 XX(TTY, tty) \ 176 XX(UDP, udp) \ 177 XX(SIGNAL, signal) \ 178 179#define UV_REQ_TYPE_MAP(XX) \ 180 XX(REQ, req) \ 181 XX(CONNECT, connect) \ 182 XX(WRITE, write) \ 183 XX(SHUTDOWN, shutdown) \ 184 XX(UDP_SEND, udp_send) \ 185 XX(FS, fs) \ 186 XX(WORK, work) \ 187 XX(GETADDRINFO, getaddrinfo) \ 188 XX(GETNAMEINFO, getnameinfo) \ 189 XX(RANDOM, random) \ 190 191#ifdef PRINT_ERRNO_ABORT 192#include "info/fatal_message.h" 193#define UV_ERRNO_ABORT(...) \ 194 do { \ 195 char errno_message[1024]; \ 196 snprintf(errno_message, sizeof(errno_message), __VA_ARGS__); \ 197 set_fatal_message(errno_message); \ 198 abort(); \ 199 } while(0) 200#endif 201 202typedef enum { 203#define XX(code, _) UV_ ## code = UV__ ## code, 204 UV_ERRNO_MAP(XX) 205#undef XX 206 UV_ERRNO_MAX = UV__EOF - 1 207} uv_errno_t; 208 209typedef enum { 210 UV_UNKNOWN_HANDLE = 0, 211#define XX(uc, lc) UV_##uc, 212 UV_HANDLE_TYPE_MAP(XX) 213#undef XX 214 UV_FILE, 215 UV_HANDLE_TYPE_MAX 216} uv_handle_type; 217 218typedef enum { 219 UV_UNKNOWN_REQ = 0, 220#define XX(uc, lc) UV_##uc, 221 UV_REQ_TYPE_MAP(XX) 222#undef XX 223 UV_REQ_TYPE_PRIVATE 224 UV_REQ_TYPE_MAX 225} uv_req_type; 226 227#define UV_EVENT_MAGIC_OFFSET 0x12345ULL 228#define UV_EVENT_MAGIC_OFFSETBITS 44 229 230/* Handle types. */ 231typedef struct uv_loop_s uv_loop_t; 232typedef struct uv_handle_s uv_handle_t; 233typedef struct uv_dir_s uv_dir_t; 234typedef struct uv_stream_s uv_stream_t; 235typedef struct uv_tcp_s uv_tcp_t; 236typedef struct uv_udp_s uv_udp_t; 237typedef struct uv_pipe_s uv_pipe_t; 238typedef struct uv_tty_s uv_tty_t; 239typedef struct uv_poll_s uv_poll_t; 240typedef struct uv_timer_s uv_timer_t; 241typedef struct uv_prepare_s uv_prepare_t; 242typedef struct uv_check_s uv_check_t; 243typedef struct uv_idle_s uv_idle_t; 244typedef struct uv_async_s uv_async_t; 245typedef struct uv_process_s uv_process_t; 246typedef struct uv_fs_event_s uv_fs_event_t; 247typedef struct uv_fs_poll_s uv_fs_poll_t; 248typedef struct uv_signal_s uv_signal_t; 249 250/* Request types. */ 251typedef struct uv_req_s uv_req_t; 252typedef struct uv_getaddrinfo_s uv_getaddrinfo_t; 253typedef struct uv_getnameinfo_s uv_getnameinfo_t; 254typedef struct uv_shutdown_s uv_shutdown_t; 255typedef struct uv_write_s uv_write_t; 256typedef struct uv_connect_s uv_connect_t; 257typedef struct uv_udp_send_s uv_udp_send_t; 258typedef struct uv_fs_s uv_fs_t; 259typedef struct uv_work_s uv_work_t; 260typedef struct uv_random_s uv_random_t; 261 262/* None of the above. */ 263typedef struct uv_env_item_s uv_env_item_t; 264typedef struct uv_cpu_info_s uv_cpu_info_t; 265typedef struct uv_interface_address_s uv_interface_address_t; 266typedef struct uv_dirent_s uv_dirent_t; 267typedef struct uv_passwd_s uv_passwd_t; 268typedef struct uv_group_s uv_group_t; 269typedef struct uv_utsname_s uv_utsname_t; 270typedef struct uv_statfs_s uv_statfs_t; 271 272typedef struct uv_metrics_s uv_metrics_t; 273 274typedef enum { 275 UV_LOOP_BLOCK_SIGNAL = 0, 276 UV_METRICS_IDLE_TIME 277} uv_loop_option; 278 279typedef enum { 280 UV_RUN_DEFAULT = 0, 281 UV_RUN_ONCE, 282 UV_RUN_NOWAIT 283} uv_run_mode; 284 285 286UV_EXTERN unsigned int uv_version(void); 287UV_EXTERN const char* uv_version_string(void); 288 289typedef void* (*uv_malloc_func)(size_t size); 290typedef void* (*uv_realloc_func)(void* ptr, size_t size); 291typedef void* (*uv_calloc_func)(size_t count, size_t size); 292typedef void (*uv_free_func)(void* ptr); 293 294UV_EXTERN void uv_library_shutdown(void); 295 296UV_EXTERN int uv_replace_allocator(uv_malloc_func malloc_func, 297 uv_realloc_func realloc_func, 298 uv_calloc_func calloc_func, 299 uv_free_func free_func); 300 301UV_EXTERN uv_loop_t* uv_default_loop(void); 302UV_EXTERN int uv_loop_init(uv_loop_t* loop); 303UV_EXTERN int uv_loop_close(uv_loop_t* loop); 304/* 305 * NOTE: 306 * This function is DEPRECATED, users should 307 * allocate the loop manually and use uv_loop_init instead. 308 */ 309UV_EXTERN uv_loop_t* uv_loop_new(void); 310/* 311 * NOTE: 312 * This function is DEPRECATED. Users should use 313 * uv_loop_close and free the memory manually instead. 314 */ 315UV_EXTERN void uv_loop_delete(uv_loop_t*); 316UV_EXTERN size_t uv_loop_size(void); 317UV_EXTERN int uv_loop_alive(const uv_loop_t* loop); 318UV_EXTERN int uv_loop_configure(uv_loop_t* loop, uv_loop_option option, ...); 319UV_EXTERN int uv_loop_fork(uv_loop_t* loop); 320/* This function is called by taskpool */ 321UV_EXTERN int uv_loop_alive_taskpool(const uv_loop_t* loop, int initial_handles); 322 323UV_EXTERN int uv_run(uv_loop_t*, uv_run_mode mode); 324UV_EXTERN void uv_stop(uv_loop_t*); 325 326UV_EXTERN void uv_ref(uv_handle_t*); 327UV_EXTERN void uv_unref(uv_handle_t*); 328UV_EXTERN int uv_has_ref(const uv_handle_t*); 329 330UV_EXTERN void uv_update_time(uv_loop_t*); 331UV_EXTERN uint64_t uv_now(const uv_loop_t*); 332 333UV_EXTERN int uv_backend_fd(const uv_loop_t*); 334UV_EXTERN int uv_backend_timeout(const uv_loop_t*); 335 336typedef void (*uv_alloc_cb)(uv_handle_t* handle, 337 size_t suggested_size, 338 uv_buf_t* buf); 339typedef void (*uv_read_cb)(uv_stream_t* stream, 340 ssize_t nread, 341 const uv_buf_t* buf); 342typedef void (*uv_write_cb)(uv_write_t* req, int status); 343typedef void (*uv_connect_cb)(uv_connect_t* req, int status); 344typedef void (*uv_shutdown_cb)(uv_shutdown_t* req, int status); 345typedef void (*uv_connection_cb)(uv_stream_t* server, int status); 346typedef void (*uv_close_cb)(uv_handle_t* handle); 347typedef void (*uv_poll_cb)(uv_poll_t* handle, int status, int events); 348typedef void (*uv_timer_cb)(uv_timer_t* handle); 349typedef void (*uv_async_cb)(uv_async_t* handle); 350typedef void (*uv_prepare_cb)(uv_prepare_t* handle); 351typedef void (*uv_check_cb)(uv_check_t* handle); 352typedef void (*uv_idle_cb)(uv_idle_t* handle); 353typedef void (*uv_exit_cb)(uv_process_t*, int64_t exit_status, int term_signal); 354typedef void (*uv_walk_cb)(uv_handle_t* handle, void* arg); 355typedef void (*uv_fs_cb)(uv_fs_t* req); 356typedef void (*uv_work_cb)(uv_work_t* req); 357typedef void (*uv_after_work_cb)(uv_work_t* req, int status); 358typedef void (*uv_getaddrinfo_cb)(uv_getaddrinfo_t* req, 359 int status, 360 struct addrinfo* res); 361typedef void (*uv_getnameinfo_cb)(uv_getnameinfo_t* req, 362 int status, 363 const char* hostname, 364 const char* service); 365typedef void (*uv_random_cb)(uv_random_t* req, 366 int status, 367 void* buf, 368 size_t buflen); 369 370typedef enum { 371 UV_CLOCK_MONOTONIC, 372 UV_CLOCK_REALTIME 373} uv_clock_id; 374 375/* XXX(bnoordhuis) not 2038-proof, https://github.com/libuv/libuv/issues/3864 */ 376typedef struct { 377 long tv_sec; 378 long tv_nsec; 379} uv_timespec_t; 380 381typedef struct { 382 int64_t tv_sec; 383 int32_t tv_nsec; 384} uv_timespec64_t; 385 386/* XXX(bnoordhuis) not 2038-proof, https://github.com/libuv/libuv/issues/3864 */ 387typedef struct { 388 long tv_sec; 389 long tv_usec; 390} uv_timeval_t; 391 392typedef struct { 393 int64_t tv_sec; 394 int32_t tv_usec; 395} uv_timeval64_t; 396 397typedef struct { 398 uint64_t st_dev; 399 uint64_t st_mode; 400 uint64_t st_nlink; 401 uint64_t st_uid; 402 uint64_t st_gid; 403 uint64_t st_rdev; 404 uint64_t st_ino; 405 uint64_t st_size; 406 uint64_t st_blksize; 407 uint64_t st_blocks; 408 uint64_t st_flags; 409 uint64_t st_gen; 410 uv_timespec_t st_atim; 411 uv_timespec_t st_mtim; 412 uv_timespec_t st_ctim; 413 uv_timespec_t st_birthtim; 414} uv_stat_t; 415 416 417typedef void (*uv_fs_event_cb)(uv_fs_event_t* handle, 418 const char* filename, 419 int events, 420 int status); 421 422typedef void (*uv_fs_poll_cb)(uv_fs_poll_t* handle, 423 int status, 424 const uv_stat_t* prev, 425 const uv_stat_t* curr); 426 427typedef void (*uv_signal_cb)(uv_signal_t* handle, int signum); 428 429 430typedef enum { 431 UV_LEAVE_GROUP = 0, 432 UV_JOIN_GROUP 433} uv_membership; 434 435 436UV_EXTERN int uv_translate_sys_error(int sys_errno); 437 438UV_EXTERN const char* uv_strerror(int err); 439UV_EXTERN char* uv_strerror_r(int err, char* buf, size_t buflen); 440 441UV_EXTERN const char* uv_err_name(int err); 442UV_EXTERN char* uv_err_name_r(int err, char* buf, size_t buflen); 443 444 445#define UV_REQ_FIELDS \ 446 /* public */ \ 447 void* data; \ 448 /* read-only */ \ 449 uv_req_type type; \ 450 /* private */ \ 451 void* reserved[6]; \ 452 UV_REQ_PRIVATE_FIELDS \ 453 454/* Abstract base class of all requests. */ 455struct uv_req_s { 456 UV_REQ_FIELDS 457}; 458 459 460/* Platform-specific request types. */ 461UV_PRIVATE_REQ_TYPES 462 463 464UV_EXTERN int uv_shutdown(uv_shutdown_t* req, 465 uv_stream_t* handle, 466 uv_shutdown_cb cb); 467 468struct uv_shutdown_s { 469 UV_REQ_FIELDS 470 uv_stream_t* handle; 471 uv_shutdown_cb cb; 472 UV_SHUTDOWN_PRIVATE_FIELDS 473}; 474 475 476#define UV_HANDLE_FIELDS \ 477 /* public */ \ 478 void* data; \ 479 /* read-only */ \ 480 uv_loop_t* loop; \ 481 uv_handle_type type; \ 482 /* private */ \ 483 uv_close_cb close_cb; \ 484 struct uv__queue handle_queue; \ 485 union { \ 486 int fd; \ 487 void* reserved[4]; \ 488 } u; \ 489 UV_HANDLE_PRIVATE_FIELDS \ 490 491/* The abstract base class of all handles. */ 492struct uv_handle_s { 493 UV_HANDLE_FIELDS 494}; 495 496UV_EXTERN size_t uv_handle_size(uv_handle_type type); 497UV_EXTERN uv_handle_type uv_handle_get_type(const uv_handle_t* handle); 498UV_EXTERN const char* uv_handle_type_name(uv_handle_type type); 499UV_EXTERN void* uv_handle_get_data(const uv_handle_t* handle); 500UV_EXTERN uv_loop_t* uv_handle_get_loop(const uv_handle_t* handle); 501UV_EXTERN void uv_handle_set_data(uv_handle_t* handle, void* data); 502 503UV_EXTERN size_t uv_req_size(uv_req_type type); 504UV_EXTERN void* uv_req_get_data(const uv_req_t* req); 505UV_EXTERN void uv_req_set_data(uv_req_t* req, void* data); 506UV_EXTERN uv_req_type uv_req_get_type(const uv_req_t* req); 507UV_EXTERN const char* uv_req_type_name(uv_req_type type); 508 509UV_EXTERN int uv_is_active(const uv_handle_t* handle); 510 511UV_EXTERN void uv_walk(uv_loop_t* loop, uv_walk_cb walk_cb, void* arg); 512 513/* Helpers for ad hoc debugging, no API/ABI stability guaranteed. */ 514UV_EXTERN void uv_print_all_handles(uv_loop_t* loop, FILE* stream); 515UV_EXTERN void uv_print_active_handles(uv_loop_t* loop, FILE* stream); 516 517UV_EXTERN void uv_close(uv_handle_t* handle, uv_close_cb close_cb); 518 519UV_EXTERN int uv_send_buffer_size(uv_handle_t* handle, int* value); 520UV_EXTERN int uv_recv_buffer_size(uv_handle_t* handle, int* value); 521 522UV_EXTERN int uv_fileno(const uv_handle_t* handle, uv_os_fd_t* fd); 523 524UV_EXTERN uv_buf_t uv_buf_init(char* base, unsigned int len); 525 526UV_EXTERN int uv_pipe(uv_file fds[2], int read_flags, int write_flags); 527UV_EXTERN int uv_socketpair(int type, 528 int protocol, 529 uv_os_sock_t socket_vector[2], 530 int flags0, 531 int flags1); 532 533#define UV_STREAM_FIELDS \ 534 /* number of bytes queued for writing */ \ 535 size_t write_queue_size; \ 536 uv_alloc_cb alloc_cb; \ 537 uv_read_cb read_cb; \ 538 /* private */ \ 539 UV_STREAM_PRIVATE_FIELDS 540 541/* 542 * uv_stream_t is a subclass of uv_handle_t. 543 * 544 * uv_stream is an abstract class. 545 * 546 * uv_stream_t is the parent class of uv_tcp_t, uv_pipe_t and uv_tty_t. 547 */ 548struct uv_stream_s { 549 UV_HANDLE_FIELDS 550 UV_STREAM_FIELDS 551}; 552 553UV_EXTERN size_t uv_stream_get_write_queue_size(const uv_stream_t* stream); 554 555UV_EXTERN int uv_listen(uv_stream_t* stream, int backlog, uv_connection_cb cb); 556UV_EXTERN int uv_accept(uv_stream_t* server, uv_stream_t* client); 557 558UV_EXTERN int uv_read_start(uv_stream_t*, 559 uv_alloc_cb alloc_cb, 560 uv_read_cb read_cb); 561UV_EXTERN int uv_read_stop(uv_stream_t*); 562 563UV_EXTERN int uv_write(uv_write_t* req, 564 uv_stream_t* handle, 565 const uv_buf_t bufs[], 566 unsigned int nbufs, 567 uv_write_cb cb); 568UV_EXTERN int uv_write2(uv_write_t* req, 569 uv_stream_t* handle, 570 const uv_buf_t bufs[], 571 unsigned int nbufs, 572 uv_stream_t* send_handle, 573 uv_write_cb cb); 574UV_EXTERN int uv_try_write(uv_stream_t* handle, 575 const uv_buf_t bufs[], 576 unsigned int nbufs); 577UV_EXTERN int uv_try_write2(uv_stream_t* handle, 578 const uv_buf_t bufs[], 579 unsigned int nbufs, 580 uv_stream_t* send_handle); 581 582/* uv_write_t is a subclass of uv_req_t. */ 583struct uv_write_s { 584 UV_REQ_FIELDS 585 uv_write_cb cb; 586 uv_stream_t* send_handle; /* TODO: make private and unix-only in v2.x. */ 587 uv_stream_t* handle; 588 UV_WRITE_PRIVATE_FIELDS 589}; 590 591 592UV_EXTERN int uv_is_readable(const uv_stream_t* handle); 593UV_EXTERN int uv_is_writable(const uv_stream_t* handle); 594 595UV_EXTERN int uv_stream_set_blocking(uv_stream_t* handle, int blocking); 596 597UV_EXTERN int uv_is_closing(const uv_handle_t* handle); 598 599 600/* 601 * uv_tcp_t is a subclass of uv_stream_t. 602 * 603 * Represents a TCP stream or TCP server. 604 */ 605struct uv_tcp_s { 606 UV_HANDLE_FIELDS 607 UV_STREAM_FIELDS 608 UV_TCP_PRIVATE_FIELDS 609}; 610 611UV_EXTERN int uv_tcp_init(uv_loop_t*, uv_tcp_t* handle); 612UV_EXTERN int uv_tcp_init_ex(uv_loop_t*, uv_tcp_t* handle, unsigned int flags); 613UV_EXTERN int uv_tcp_open(uv_tcp_t* handle, uv_os_sock_t sock); 614UV_EXTERN int uv_tcp_nodelay(uv_tcp_t* handle, int enable); 615UV_EXTERN int uv_tcp_keepalive(uv_tcp_t* handle, 616 int enable, 617 unsigned int delay); 618UV_EXTERN int uv_tcp_simultaneous_accepts(uv_tcp_t* handle, int enable); 619 620enum uv_tcp_flags { 621 /* Used with uv_tcp_bind, when an IPv6 address is used. */ 622 UV_TCP_IPV6ONLY = 1 623}; 624 625UV_EXTERN int uv_tcp_bind(uv_tcp_t* handle, 626 const struct sockaddr* addr, 627 unsigned int flags); 628UV_EXTERN int uv_tcp_getsockname(const uv_tcp_t* handle, 629 struct sockaddr* name, 630 int* namelen); 631UV_EXTERN int uv_tcp_getpeername(const uv_tcp_t* handle, 632 struct sockaddr* name, 633 int* namelen); 634UV_EXTERN int uv_tcp_close_reset(uv_tcp_t* handle, uv_close_cb close_cb); 635UV_EXTERN int uv_tcp_connect(uv_connect_t* req, 636 uv_tcp_t* handle, 637 const struct sockaddr* addr, 638 uv_connect_cb cb); 639 640/* uv_connect_t is a subclass of uv_req_t. */ 641struct uv_connect_s { 642 UV_REQ_FIELDS 643 uv_connect_cb cb; 644 uv_stream_t* handle; 645 UV_CONNECT_PRIVATE_FIELDS 646}; 647 648 649/* 650 * UDP support. 651 */ 652 653enum uv_udp_flags { 654 /* Disables dual stack mode. */ 655 UV_UDP_IPV6ONLY = 1, 656 /* 657 * Indicates message was truncated because read buffer was too small. The 658 * remainder was discarded by the OS. Used in uv_udp_recv_cb. 659 */ 660 UV_UDP_PARTIAL = 2, 661 /* 662 * Indicates if SO_REUSEADDR will be set when binding the handle. 663 * This sets the SO_REUSEPORT socket flag on the BSDs and OS X. On other 664 * Unix platforms, it sets the SO_REUSEADDR flag. What that means is that 665 * multiple threads or processes can bind to the same address without error 666 * (provided they all set the flag) but only the last one to bind will receive 667 * any traffic, in effect "stealing" the port from the previous listener. 668 */ 669 UV_UDP_REUSEADDR = 4, 670 /* 671 * Indicates that the message was received by recvmmsg, so the buffer provided 672 * must not be freed by the recv_cb callback. 673 */ 674 UV_UDP_MMSG_CHUNK = 8, 675 /* 676 * Indicates that the buffer provided has been fully utilized by recvmmsg and 677 * that it should now be freed by the recv_cb callback. When this flag is set 678 * in uv_udp_recv_cb, nread will always be 0 and addr will always be NULL. 679 */ 680 UV_UDP_MMSG_FREE = 16, 681 /* 682 * Indicates if IP_RECVERR/IPV6_RECVERR will be set when binding the handle. 683 * This sets IP_RECVERR for IPv4 and IPV6_RECVERR for IPv6 UDP sockets on 684 * Linux. This stops the Linux kernel from suppressing some ICMP error 685 * messages and enables full ICMP error reporting for faster failover. 686 * This flag is no-op on platforms other than Linux. 687 */ 688 UV_UDP_LINUX_RECVERR = 32, 689 /* 690 * Indicates that recvmmsg should be used, if available. 691 */ 692 UV_UDP_RECVMMSG = 256 693}; 694 695typedef void (*uv_udp_send_cb)(uv_udp_send_t* req, int status); 696typedef void (*uv_udp_recv_cb)(uv_udp_t* handle, 697 ssize_t nread, 698 const uv_buf_t* buf, 699 const struct sockaddr* addr, 700 unsigned flags); 701 702/* uv_udp_t is a subclass of uv_handle_t. */ 703struct uv_udp_s { 704 UV_HANDLE_FIELDS 705 /* read-only */ 706 /* 707 * Number of bytes queued for sending. This field strictly shows how much 708 * information is currently queued. 709 */ 710 size_t send_queue_size; 711 /* 712 * Number of send requests currently in the queue awaiting to be processed. 713 */ 714 size_t send_queue_count; 715 UV_UDP_PRIVATE_FIELDS 716}; 717 718/* uv_udp_send_t is a subclass of uv_req_t. */ 719struct uv_udp_send_s { 720 UV_REQ_FIELDS 721 uv_udp_t* handle; 722 uv_udp_send_cb cb; 723 UV_UDP_SEND_PRIVATE_FIELDS 724}; 725 726UV_EXTERN int uv_udp_init(uv_loop_t*, uv_udp_t* handle); 727UV_EXTERN int uv_udp_init_ex(uv_loop_t*, uv_udp_t* handle, unsigned int flags); 728UV_EXTERN int uv_udp_open(uv_udp_t* handle, uv_os_sock_t sock); 729UV_EXTERN int uv_udp_bind(uv_udp_t* handle, 730 const struct sockaddr* addr, 731 unsigned int flags); 732UV_EXTERN int uv_udp_connect(uv_udp_t* handle, const struct sockaddr* addr); 733 734UV_EXTERN int uv_udp_getpeername(const uv_udp_t* handle, 735 struct sockaddr* name, 736 int* namelen); 737UV_EXTERN int uv_udp_getsockname(const uv_udp_t* handle, 738 struct sockaddr* name, 739 int* namelen); 740UV_EXTERN int uv_udp_set_membership(uv_udp_t* handle, 741 const char* multicast_addr, 742 const char* interface_addr, 743 uv_membership membership); 744UV_EXTERN int uv_udp_set_source_membership(uv_udp_t* handle, 745 const char* multicast_addr, 746 const char* interface_addr, 747 const char* source_addr, 748 uv_membership membership); 749UV_EXTERN int uv_udp_set_multicast_loop(uv_udp_t* handle, int on); 750UV_EXTERN int uv_udp_set_multicast_ttl(uv_udp_t* handle, int ttl); 751UV_EXTERN int uv_udp_set_multicast_interface(uv_udp_t* handle, 752 const char* interface_addr); 753UV_EXTERN int uv_udp_set_broadcast(uv_udp_t* handle, int on); 754UV_EXTERN int uv_udp_set_ttl(uv_udp_t* handle, int ttl); 755UV_EXTERN int uv_udp_send(uv_udp_send_t* req, 756 uv_udp_t* handle, 757 const uv_buf_t bufs[], 758 unsigned int nbufs, 759 const struct sockaddr* addr, 760 uv_udp_send_cb send_cb); 761UV_EXTERN int uv_udp_try_send(uv_udp_t* handle, 762 const uv_buf_t bufs[], 763 unsigned int nbufs, 764 const struct sockaddr* addr); 765UV_EXTERN int uv_udp_recv_start(uv_udp_t* handle, 766 uv_alloc_cb alloc_cb, 767 uv_udp_recv_cb recv_cb); 768UV_EXTERN int uv_udp_using_recvmmsg(const uv_udp_t* handle); 769UV_EXTERN int uv_udp_recv_stop(uv_udp_t* handle); 770UV_EXTERN size_t uv_udp_get_send_queue_size(const uv_udp_t* handle); 771UV_EXTERN size_t uv_udp_get_send_queue_count(const uv_udp_t* handle); 772 773 774/* 775 * uv_tty_t is a subclass of uv_stream_t. 776 * 777 * Representing a stream for the console. 778 */ 779struct uv_tty_s { 780 UV_HANDLE_FIELDS 781 UV_STREAM_FIELDS 782 UV_TTY_PRIVATE_FIELDS 783}; 784 785typedef enum { 786 /* Initial/normal terminal mode */ 787 UV_TTY_MODE_NORMAL, 788 /* Raw input mode (On Windows, ENABLE_WINDOW_INPUT is also enabled) */ 789 UV_TTY_MODE_RAW, 790 /* Binary-safe I/O mode for IPC (Unix-only) */ 791 UV_TTY_MODE_IO 792} uv_tty_mode_t; 793 794typedef enum { 795 /* 796 * The console supports handling of virtual terminal sequences 797 * (Windows10 new console, ConEmu) 798 */ 799 UV_TTY_SUPPORTED, 800 /* The console cannot process the virtual terminal sequence. (Legacy 801 * console) 802 */ 803 UV_TTY_UNSUPPORTED 804} uv_tty_vtermstate_t; 805 806 807UV_EXTERN int uv_tty_init(uv_loop_t*, uv_tty_t*, uv_file fd, int readable); 808UV_EXTERN int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode); 809UV_EXTERN int uv_tty_reset_mode(void); 810UV_EXTERN int uv_tty_get_winsize(uv_tty_t*, int* width, int* height); 811UV_EXTERN void uv_tty_set_vterm_state(uv_tty_vtermstate_t state); 812UV_EXTERN int uv_tty_get_vterm_state(uv_tty_vtermstate_t* state); 813 814#ifdef __cplusplus 815extern "C++" { 816 817inline int uv_tty_set_mode(uv_tty_t* handle, int mode) { 818 return uv_tty_set_mode(handle, static_cast<uv_tty_mode_t>(mode)); 819} 820 821} 822#endif 823 824UV_EXTERN uv_handle_type uv_guess_handle(uv_file file); 825 826enum { 827 UV_PIPE_NO_TRUNCATE = 1u << 0 828}; 829 830/* 831 * uv_pipe_t is a subclass of uv_stream_t. 832 * 833 * Representing a pipe stream or pipe server. On Windows this is a Named 834 * Pipe. On Unix this is a Unix domain socket. 835 */ 836struct uv_pipe_s { 837 UV_HANDLE_FIELDS 838 UV_STREAM_FIELDS 839 int ipc; /* non-zero if this pipe is used for passing handles */ 840 UV_PIPE_PRIVATE_FIELDS 841}; 842 843UV_EXTERN int uv_pipe_init(uv_loop_t*, uv_pipe_t* handle, int ipc); 844UV_EXTERN int uv_pipe_open(uv_pipe_t*, uv_file file); 845UV_EXTERN int uv_pipe_bind(uv_pipe_t* handle, const char* name); 846UV_EXTERN int uv_pipe_bind2(uv_pipe_t* handle, 847 const char* name, 848 size_t namelen, 849 unsigned int flags); 850UV_EXTERN void uv_pipe_connect(uv_connect_t* req, 851 uv_pipe_t* handle, 852 const char* name, 853 uv_connect_cb cb); 854UV_EXTERN int uv_pipe_connect2(uv_connect_t* req, 855 uv_pipe_t* handle, 856 const char* name, 857 size_t namelen, 858 unsigned int flags, 859 uv_connect_cb cb); 860UV_EXTERN int uv_pipe_getsockname(const uv_pipe_t* handle, 861 char* buffer, 862 size_t* size); 863UV_EXTERN int uv_pipe_getpeername(const uv_pipe_t* handle, 864 char* buffer, 865 size_t* size); 866UV_EXTERN void uv_pipe_pending_instances(uv_pipe_t* handle, int count); 867UV_EXTERN int uv_pipe_pending_count(uv_pipe_t* handle); 868UV_EXTERN uv_handle_type uv_pipe_pending_type(uv_pipe_t* handle); 869UV_EXTERN int uv_pipe_chmod(uv_pipe_t* handle, int flags); 870 871 872struct uv_poll_s { 873 UV_HANDLE_FIELDS 874 uv_poll_cb poll_cb; 875 UV_POLL_PRIVATE_FIELDS 876}; 877 878enum uv_poll_event { 879 UV_READABLE = 1, 880 UV_WRITABLE = 2, 881 UV_DISCONNECT = 4, 882 UV_PRIORITIZED = 8 883}; 884 885UV_EXTERN int uv_poll_init(uv_loop_t* loop, uv_poll_t* handle, int fd); 886UV_EXTERN int uv_poll_init_socket(uv_loop_t* loop, 887 uv_poll_t* handle, 888 uv_os_sock_t socket); 889UV_EXTERN int uv_poll_start(uv_poll_t* handle, int events, uv_poll_cb cb); 890UV_EXTERN int uv_poll_stop(uv_poll_t* handle); 891 892 893struct uv_prepare_s { 894 UV_HANDLE_FIELDS 895 UV_PREPARE_PRIVATE_FIELDS 896}; 897 898UV_EXTERN int uv_prepare_init(uv_loop_t*, uv_prepare_t* prepare); 899UV_EXTERN int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb); 900UV_EXTERN int uv_prepare_stop(uv_prepare_t* prepare); 901 902 903struct uv_check_s { 904 UV_HANDLE_FIELDS 905 UV_CHECK_PRIVATE_FIELDS 906}; 907 908UV_EXTERN int uv_check_init(uv_loop_t*, uv_check_t* check); 909UV_EXTERN int uv_check_start(uv_check_t* check, uv_check_cb cb); 910UV_EXTERN int uv_check_stop(uv_check_t* check); 911 912 913struct uv_idle_s { 914 UV_HANDLE_FIELDS 915 UV_IDLE_PRIVATE_FIELDS 916}; 917 918UV_EXTERN int uv_idle_init(uv_loop_t*, uv_idle_t* idle); 919UV_EXTERN int uv_idle_start(uv_idle_t* idle, uv_idle_cb cb); 920UV_EXTERN int uv_idle_stop(uv_idle_t* idle); 921 922 923struct uv_async_s { 924 UV_HANDLE_FIELDS 925 UV_ASYNC_PRIVATE_FIELDS 926}; 927 928UV_EXTERN int uv_async_init(uv_loop_t*, 929 uv_async_t* async, 930 uv_async_cb async_cb); 931UV_EXTERN int uv_async_send(uv_async_t* async); 932 933 934/* 935 * uv_timer_t is a subclass of uv_handle_t. 936 * 937 * Used to get woken up at a specified time in the future. 938 */ 939struct uv_timer_s { 940 UV_HANDLE_FIELDS 941 UV_TIMER_PRIVATE_FIELDS 942}; 943 944UV_EXTERN int uv_timer_init(uv_loop_t*, uv_timer_t* handle); 945UV_EXTERN int uv_timer_start(uv_timer_t* handle, 946 uv_timer_cb cb, 947 uint64_t timeout, 948 uint64_t repeat); 949UV_EXTERN int uv_timer_stop(uv_timer_t* handle); 950UV_EXTERN int uv_timer_again(uv_timer_t* handle); 951UV_EXTERN void uv_timer_set_repeat(uv_timer_t* handle, uint64_t repeat); 952UV_EXTERN uint64_t uv_timer_get_repeat(const uv_timer_t* handle); 953UV_EXTERN uint64_t uv_timer_get_due_in(const uv_timer_t* handle); 954 955 956/* 957 * uv_getaddrinfo_t is a subclass of uv_req_t. 958 * 959 * Request object for uv_getaddrinfo. 960 */ 961struct uv_getaddrinfo_s { 962 UV_REQ_FIELDS 963 /* read-only */ 964 uv_loop_t* loop; 965 /* struct addrinfo* addrinfo is marked as private, but it really isn't. */ 966 UV_GETADDRINFO_PRIVATE_FIELDS 967}; 968 969 970UV_EXTERN int uv_getaddrinfo(uv_loop_t* loop, 971 uv_getaddrinfo_t* req, 972 uv_getaddrinfo_cb getaddrinfo_cb, 973 const char* node, 974 const char* service, 975 const struct addrinfo* hints); 976UV_EXTERN void uv_freeaddrinfo(struct addrinfo* ai); 977 978 979/* 980* uv_getnameinfo_t is a subclass of uv_req_t. 981* 982* Request object for uv_getnameinfo. 983*/ 984struct uv_getnameinfo_s { 985 UV_REQ_FIELDS 986 /* read-only */ 987 uv_loop_t* loop; 988 /* host and service are marked as private, but they really aren't. */ 989 UV_GETNAMEINFO_PRIVATE_FIELDS 990}; 991 992UV_EXTERN int uv_getnameinfo(uv_loop_t* loop, 993 uv_getnameinfo_t* req, 994 uv_getnameinfo_cb getnameinfo_cb, 995 const struct sockaddr* addr, 996 int flags); 997 998 999/* uv_spawn() options. */ 1000typedef enum { 1001 UV_IGNORE = 0x00, 1002 UV_CREATE_PIPE = 0x01, 1003 UV_INHERIT_FD = 0x02, 1004 UV_INHERIT_STREAM = 0x04, 1005 1006 /* 1007 * When UV_CREATE_PIPE is specified, UV_READABLE_PIPE and UV_WRITABLE_PIPE 1008 * determine the direction of flow, from the child process' perspective. Both 1009 * flags may be specified to create a duplex data stream. 1010 */ 1011 UV_READABLE_PIPE = 0x10, 1012 UV_WRITABLE_PIPE = 0x20, 1013 1014 /* 1015 * When UV_CREATE_PIPE is specified, specifying UV_NONBLOCK_PIPE opens the 1016 * handle in non-blocking mode in the child. This may cause loss of data, 1017 * if the child is not designed to handle to encounter this mode, 1018 * but can also be significantly more efficient. 1019 */ 1020 UV_NONBLOCK_PIPE = 0x40, 1021 UV_OVERLAPPED_PIPE = 0x40 /* old name, for compatibility */ 1022} uv_stdio_flags; 1023 1024typedef struct uv_stdio_container_s { 1025 uv_stdio_flags flags; 1026 1027 union { 1028 uv_stream_t* stream; 1029 int fd; 1030 } data; 1031} uv_stdio_container_t; 1032 1033typedef struct uv_process_options_s { 1034 uv_exit_cb exit_cb; /* Called after the process exits. */ 1035 const char* file; /* Path to program to execute. */ 1036 /* 1037 * Command line arguments. args[0] should be the path to the program. On 1038 * Windows this uses CreateProcess which concatenates the arguments into a 1039 * string this can cause some strange errors. See the note at 1040 * windows_verbatim_arguments. 1041 */ 1042 char** args; 1043 /* 1044 * This will be set as the environ variable in the subprocess. If this is 1045 * NULL then the parents environ will be used. 1046 */ 1047 char** env; 1048 /* 1049 * If non-null this represents a directory the subprocess should execute 1050 * in. Stands for current working directory. 1051 */ 1052 const char* cwd; 1053 /* 1054 * Various flags that control how uv_spawn() behaves. See the definition of 1055 * `enum uv_process_flags` below. 1056 */ 1057 unsigned int flags; 1058 /* 1059 * The `stdio` field points to an array of uv_stdio_container_t structs that 1060 * describe the file descriptors that will be made available to the child 1061 * process. The convention is that stdio[0] points to stdin, fd 1 is used for 1062 * stdout, and fd 2 is stderr. 1063 * 1064 * Note that on windows file descriptors greater than 2 are available to the 1065 * child process only if the child processes uses the MSVCRT runtime. 1066 */ 1067 int stdio_count; 1068 uv_stdio_container_t* stdio; 1069 /* 1070 * Libuv can change the child process' user/group id. This happens only when 1071 * the appropriate bits are set in the flags fields. This is not supported on 1072 * windows; uv_spawn() will fail and set the error to UV_ENOTSUP. 1073 */ 1074 uv_uid_t uid; 1075 uv_gid_t gid; 1076} uv_process_options_t; 1077 1078/* 1079 * These are the flags that can be used for the uv_process_options.flags field. 1080 */ 1081enum uv_process_flags { 1082 /* 1083 * Set the child process' user id. The user id is supplied in the `uid` field 1084 * of the options struct. This does not work on windows; setting this flag 1085 * will cause uv_spawn() to fail. 1086 */ 1087 UV_PROCESS_SETUID = (1 << 0), 1088 /* 1089 * Set the child process' group id. The user id is supplied in the `gid` 1090 * field of the options struct. This does not work on windows; setting this 1091 * flag will cause uv_spawn() to fail. 1092 */ 1093 UV_PROCESS_SETGID = (1 << 1), 1094 /* 1095 * Do not wrap any arguments in quotes, or perform any other escaping, when 1096 * converting the argument list into a command line string. This option is 1097 * only meaningful on Windows systems. On Unix it is silently ignored. 1098 */ 1099 UV_PROCESS_WINDOWS_VERBATIM_ARGUMENTS = (1 << 2), 1100 /* 1101 * Spawn the child process in a detached state - this will make it a process 1102 * group leader, and will effectively enable the child to keep running after 1103 * the parent exits. Note that the child process will still keep the 1104 * parent's event loop alive unless the parent process calls uv_unref() on 1105 * the child's process handle. 1106 */ 1107 UV_PROCESS_DETACHED = (1 << 3), 1108 /* 1109 * Hide the subprocess window that would normally be created. This option is 1110 * only meaningful on Windows systems. On Unix it is silently ignored. 1111 */ 1112 UV_PROCESS_WINDOWS_HIDE = (1 << 4), 1113 /* 1114 * Hide the subprocess console window that would normally be created. This 1115 * option is only meaningful on Windows systems. On Unix it is silently 1116 * ignored. 1117 */ 1118 UV_PROCESS_WINDOWS_HIDE_CONSOLE = (1 << 5), 1119 /* 1120 * Hide the subprocess GUI window that would normally be created. This 1121 * option is only meaningful on Windows systems. On Unix it is silently 1122 * ignored. 1123 */ 1124 UV_PROCESS_WINDOWS_HIDE_GUI = (1 << 6), 1125 /* 1126 * On Windows, if the path to the program to execute, specified in 1127 * uv_process_options_t's file field, has a directory component, 1128 * search for the exact file name before trying variants with 1129 * extensions like '.exe' or '.cmd'. 1130 */ 1131 UV_PROCESS_WINDOWS_FILE_PATH_EXACT_NAME = (1 << 7) 1132}; 1133 1134/* 1135 * uv_process_t is a subclass of uv_handle_t. 1136 */ 1137struct uv_process_s { 1138 UV_HANDLE_FIELDS 1139 uv_exit_cb exit_cb; 1140 int pid; 1141 UV_PROCESS_PRIVATE_FIELDS 1142}; 1143 1144UV_EXTERN int uv_spawn(uv_loop_t* loop, 1145 uv_process_t* handle, 1146 const uv_process_options_t* options); 1147UV_EXTERN int uv_process_kill(uv_process_t*, int signum); 1148UV_EXTERN int uv_kill(int pid, int signum); 1149UV_EXTERN uv_pid_t uv_process_get_pid(const uv_process_t*); 1150 1151 1152/* 1153 * uv_work_t is a subclass of uv_req_t. 1154 */ 1155struct uv_work_s { 1156 UV_REQ_FIELDS 1157 uv_loop_t* loop; 1158 uv_work_cb work_cb; 1159 uv_after_work_cb after_work_cb; 1160 UV_WORK_PRIVATE_FIELDS 1161}; 1162 1163 1164typedef struct uv_worker_info_s uv_worker_info_t; 1165 1166struct uv_worker_info_s { 1167 uint64_t queue_time; 1168 void* builtin_return_address[3]; 1169 char state[20]; 1170 uint64_t execute_start_time; 1171 uint64_t execute_end_time; 1172 uint64_t done_start_time; 1173 uint64_t done_end_time; 1174}; 1175 1176UV_EXTERN uv_worker_info_t* uv_dump_work_queue(int* size); 1177 1178UV_EXTERN int uv_queue_work(uv_loop_t* loop, 1179 uv_work_t* req, 1180 uv_work_cb work_cb, 1181 uv_after_work_cb after_work_cb); 1182 1183UV_EXTERN int uv_cancel(uv_req_t* req); 1184 1185typedef enum { 1186 uv_qos_background = 0, 1187 uv_qos_utility = 1, 1188 uv_qos_default = 2, 1189 uv_qos_user_initiated = 3, 1190} uv_qos_t; 1191 1192UV_EXTERN int uv_queue_work_with_qos(uv_loop_t* loop, 1193 uv_work_t* req, 1194 uv_work_cb work_cb, 1195 uv_after_work_cb after_work_cb, 1196 uv_qos_t qos); 1197 1198struct uv_cpu_times_s { 1199 uint64_t user; /* milliseconds */ 1200 uint64_t nice; /* milliseconds */ 1201 uint64_t sys; /* milliseconds */ 1202 uint64_t idle; /* milliseconds */ 1203 uint64_t irq; /* milliseconds */ 1204}; 1205 1206struct uv_cpu_info_s { 1207 char* model; 1208 int speed; 1209 struct uv_cpu_times_s cpu_times; 1210}; 1211 1212struct uv_interface_address_s { 1213 char* name; 1214 char phys_addr[6]; 1215 int is_internal; 1216 union { 1217 struct sockaddr_in address4; 1218 struct sockaddr_in6 address6; 1219 } address; 1220 union { 1221 struct sockaddr_in netmask4; 1222 struct sockaddr_in6 netmask6; 1223 } netmask; 1224}; 1225 1226struct uv_passwd_s { 1227 char* username; 1228 unsigned long uid; 1229 unsigned long gid; 1230 char* shell; 1231 char* homedir; 1232}; 1233 1234struct uv_group_s { 1235 char* groupname; 1236 unsigned long gid; 1237 char** members; 1238}; 1239 1240struct uv_utsname_s { 1241 char sysname[256]; 1242 char release[256]; 1243 char version[256]; 1244 char machine[256]; 1245 /* This struct does not contain the nodename and domainname fields present in 1246 the utsname type. domainname is a GNU extension. Both fields are referred 1247 to as meaningless in the docs. */ 1248}; 1249 1250struct uv_statfs_s { 1251 uint64_t f_type; 1252 uint64_t f_bsize; 1253 uint64_t f_blocks; 1254 uint64_t f_bfree; 1255 uint64_t f_bavail; 1256 uint64_t f_files; 1257 uint64_t f_ffree; 1258 uint64_t f_spare[4]; 1259}; 1260 1261typedef enum { 1262 UV_DIRENT_UNKNOWN, 1263 UV_DIRENT_FILE, 1264 UV_DIRENT_DIR, 1265 UV_DIRENT_LINK, 1266 UV_DIRENT_FIFO, 1267 UV_DIRENT_SOCKET, 1268 UV_DIRENT_CHAR, 1269 UV_DIRENT_BLOCK 1270} uv_dirent_type_t; 1271 1272struct uv_dirent_s { 1273 const char* name; 1274 uv_dirent_type_t type; 1275}; 1276 1277UV_EXTERN char** uv_setup_args(int argc, char** argv); 1278UV_EXTERN int uv_get_process_title(char* buffer, size_t size); 1279UV_EXTERN int uv_set_process_title(const char* title); 1280UV_EXTERN int uv_resident_set_memory(size_t* rss); 1281UV_EXTERN int uv_uptime(double* uptime); 1282UV_EXTERN uv_os_fd_t uv_get_osfhandle(int fd); 1283UV_EXTERN int uv_open_osfhandle(uv_os_fd_t os_fd); 1284 1285typedef struct { 1286 uv_timeval_t ru_utime; /* user CPU time used */ 1287 uv_timeval_t ru_stime; /* system CPU time used */ 1288 uint64_t ru_maxrss; /* maximum resident set size */ 1289 uint64_t ru_ixrss; /* integral shared memory size */ 1290 uint64_t ru_idrss; /* integral unshared data size */ 1291 uint64_t ru_isrss; /* integral unshared stack size */ 1292 uint64_t ru_minflt; /* page reclaims (soft page faults) */ 1293 uint64_t ru_majflt; /* page faults (hard page faults) */ 1294 uint64_t ru_nswap; /* swaps */ 1295 uint64_t ru_inblock; /* block input operations */ 1296 uint64_t ru_oublock; /* block output operations */ 1297 uint64_t ru_msgsnd; /* IPC messages sent */ 1298 uint64_t ru_msgrcv; /* IPC messages received */ 1299 uint64_t ru_nsignals; /* signals received */ 1300 uint64_t ru_nvcsw; /* voluntary context switches */ 1301 uint64_t ru_nivcsw; /* involuntary context switches */ 1302} uv_rusage_t; 1303 1304UV_EXTERN int uv_getrusage(uv_rusage_t* rusage); 1305 1306UV_EXTERN int uv_os_homedir(char* buffer, size_t* size); 1307UV_EXTERN int uv_os_tmpdir(char* buffer, size_t* size); 1308UV_EXTERN int uv_os_get_passwd(uv_passwd_t* pwd); 1309UV_EXTERN void uv_os_free_passwd(uv_passwd_t* pwd); 1310UV_EXTERN int uv_os_get_passwd2(uv_passwd_t* pwd, uv_uid_t uid); 1311UV_EXTERN int uv_os_get_group(uv_group_t* grp, uv_uid_t gid); 1312UV_EXTERN void uv_os_free_group(uv_group_t* grp); 1313UV_EXTERN uv_pid_t uv_os_getpid(void); 1314UV_EXTERN uv_pid_t uv_os_getppid(void); 1315 1316#if defined(__PASE__) 1317/* On IBM i PASE, the highest process priority is -10 */ 1318# define UV_PRIORITY_LOW 39 /* RUNPTY(99) */ 1319# define UV_PRIORITY_BELOW_NORMAL 15 /* RUNPTY(50) */ 1320# define UV_PRIORITY_NORMAL 0 /* RUNPTY(20) */ 1321# define UV_PRIORITY_ABOVE_NORMAL -4 /* RUNTY(12) */ 1322# define UV_PRIORITY_HIGH -7 /* RUNPTY(6) */ 1323# define UV_PRIORITY_HIGHEST -10 /* RUNPTY(1) */ 1324#else 1325# define UV_PRIORITY_LOW 19 1326# define UV_PRIORITY_BELOW_NORMAL 10 1327# define UV_PRIORITY_NORMAL 0 1328# define UV_PRIORITY_ABOVE_NORMAL -7 1329# define UV_PRIORITY_HIGH -14 1330# define UV_PRIORITY_HIGHEST -20 1331#endif 1332 1333UV_EXTERN int uv_os_getpriority(uv_pid_t pid, int* priority); 1334UV_EXTERN int uv_os_setpriority(uv_pid_t pid, int priority); 1335 1336enum { 1337 UV_THREAD_PRIORITY_HIGHEST = 2, 1338 UV_THREAD_PRIORITY_ABOVE_NORMAL = 1, 1339 UV_THREAD_PRIORITY_NORMAL = 0, 1340 UV_THREAD_PRIORITY_BELOW_NORMAL = -1, 1341 UV_THREAD_PRIORITY_LOWEST = -2, 1342}; 1343 1344UV_EXTERN int uv_thread_getpriority(uv_thread_t tid, int* priority); 1345UV_EXTERN int uv_thread_setpriority(uv_thread_t tid, int priority); 1346 1347UV_EXTERN unsigned int uv_available_parallelism(void); 1348UV_EXTERN int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count); 1349UV_EXTERN void uv_free_cpu_info(uv_cpu_info_t* cpu_infos, int count); 1350UV_EXTERN int uv_cpumask_size(void); 1351 1352UV_EXTERN int uv_interface_addresses(uv_interface_address_t** addresses, 1353 int* count); 1354UV_EXTERN void uv_free_interface_addresses(uv_interface_address_t* addresses, 1355 int count); 1356 1357struct uv_env_item_s { 1358 char* name; 1359 char* value; 1360}; 1361 1362UV_EXTERN int uv_os_environ(uv_env_item_t** envitems, int* count); 1363UV_EXTERN void uv_os_free_environ(uv_env_item_t* envitems, int count); 1364UV_EXTERN int uv_os_getenv(const char* name, char* buffer, size_t* size); 1365UV_EXTERN int uv_os_setenv(const char* name, const char* value); 1366UV_EXTERN int uv_os_unsetenv(const char* name); 1367 1368#ifdef MAXHOSTNAMELEN 1369# define UV_MAXHOSTNAMESIZE (MAXHOSTNAMELEN + 1) 1370#else 1371 /* 1372 Fallback for the maximum hostname size, including the null terminator. The 1373 Windows gethostname() documentation states that 256 bytes will always be 1374 large enough to hold the null-terminated hostname. 1375 */ 1376# define UV_MAXHOSTNAMESIZE 256 1377#endif 1378 1379UV_EXTERN int uv_os_gethostname(char* buffer, size_t* size); 1380 1381UV_EXTERN int uv_os_uname(uv_utsname_t* buffer); 1382 1383struct uv_metrics_s { 1384 uint64_t loop_count; 1385 uint64_t events; 1386 uint64_t events_waiting; 1387 /* private */ 1388 uint64_t* reserved[13]; 1389}; 1390 1391UV_EXTERN int uv_metrics_info(uv_loop_t* loop, uv_metrics_t* metrics); 1392UV_EXTERN uint64_t uv_metrics_idle_time(uv_loop_t* loop); 1393 1394typedef enum { 1395 UV_FS_UNKNOWN = -1, 1396 UV_FS_CUSTOM, 1397 UV_FS_OPEN, 1398 UV_FS_CLOSE, 1399 UV_FS_READ, 1400 UV_FS_WRITE, 1401 UV_FS_SENDFILE, 1402 UV_FS_STAT, 1403 UV_FS_LSTAT, 1404 UV_FS_FSTAT, 1405 UV_FS_FTRUNCATE, 1406 UV_FS_UTIME, 1407 UV_FS_FUTIME, 1408 UV_FS_ACCESS, 1409 UV_FS_CHMOD, 1410 UV_FS_FCHMOD, 1411 UV_FS_FSYNC, 1412 UV_FS_FDATASYNC, 1413 UV_FS_UNLINK, 1414 UV_FS_RMDIR, 1415 UV_FS_MKDIR, 1416 UV_FS_MKDTEMP, 1417 UV_FS_RENAME, 1418 UV_FS_SCANDIR, 1419 UV_FS_LINK, 1420 UV_FS_SYMLINK, 1421 UV_FS_READLINK, 1422 UV_FS_CHOWN, 1423 UV_FS_FCHOWN, 1424 UV_FS_REALPATH, 1425 UV_FS_COPYFILE, 1426 UV_FS_LCHOWN, 1427 UV_FS_OPENDIR, 1428 UV_FS_READDIR, 1429 UV_FS_CLOSEDIR, 1430 UV_FS_STATFS, 1431 UV_FS_MKSTEMP, 1432 UV_FS_LUTIME 1433} uv_fs_type; 1434 1435struct uv_dir_s { 1436 uv_dirent_t* dirents; 1437 size_t nentries; 1438 void* reserved[4]; 1439 UV_DIR_PRIVATE_FIELDS 1440}; 1441 1442/* uv_fs_t is a subclass of uv_req_t. */ 1443struct uv_fs_s { 1444 UV_REQ_FIELDS 1445 uv_fs_type fs_type; 1446 uv_loop_t* loop; 1447 uv_fs_cb cb; 1448 ssize_t result; 1449 void* ptr; 1450 const char* path; 1451 uv_stat_t statbuf; /* Stores the result of uv_fs_stat() and uv_fs_fstat(). */ 1452 UV_FS_PRIVATE_FIELDS 1453}; 1454 1455UV_EXTERN uv_fs_type uv_fs_get_type(const uv_fs_t*); 1456UV_EXTERN ssize_t uv_fs_get_result(const uv_fs_t*); 1457UV_EXTERN int uv_fs_get_system_error(const uv_fs_t*); 1458UV_EXTERN void* uv_fs_get_ptr(const uv_fs_t*); 1459UV_EXTERN const char* uv_fs_get_path(const uv_fs_t*); 1460UV_EXTERN uv_stat_t* uv_fs_get_statbuf(uv_fs_t*); 1461 1462UV_EXTERN void uv_fs_req_cleanup(uv_fs_t* req); 1463UV_EXTERN int uv_fs_close(uv_loop_t* loop, 1464 uv_fs_t* req, 1465 uv_file file, 1466 uv_fs_cb cb); 1467UV_EXTERN int uv_fs_open(uv_loop_t* loop, 1468 uv_fs_t* req, 1469 const char* path, 1470 int flags, 1471 int mode, 1472 uv_fs_cb cb); 1473UV_EXTERN int uv_fs_read(uv_loop_t* loop, 1474 uv_fs_t* req, 1475 uv_file file, 1476 const uv_buf_t bufs[], 1477 unsigned int nbufs, 1478 int64_t offset, 1479 uv_fs_cb cb); 1480UV_EXTERN int uv_fs_unlink(uv_loop_t* loop, 1481 uv_fs_t* req, 1482 const char* path, 1483 uv_fs_cb cb); 1484UV_EXTERN int uv_fs_write(uv_loop_t* loop, 1485 uv_fs_t* req, 1486 uv_file file, 1487 const uv_buf_t bufs[], 1488 unsigned int nbufs, 1489 int64_t offset, 1490 uv_fs_cb cb); 1491/* 1492 * This flag can be used with uv_fs_copyfile() to return an error if the 1493 * destination already exists. 1494 */ 1495#define UV_FS_COPYFILE_EXCL 0x0001 1496 1497/* 1498 * This flag can be used with uv_fs_copyfile() to attempt to create a reflink. 1499 * If copy-on-write is not supported, a fallback copy mechanism is used. 1500 */ 1501#define UV_FS_COPYFILE_FICLONE 0x0002 1502 1503/* 1504 * This flag can be used with uv_fs_copyfile() to attempt to create a reflink. 1505 * If copy-on-write is not supported, an error is returned. 1506 */ 1507#define UV_FS_COPYFILE_FICLONE_FORCE 0x0004 1508 1509UV_EXTERN int uv_fs_copyfile(uv_loop_t* loop, 1510 uv_fs_t* req, 1511 const char* path, 1512 const char* new_path, 1513 int flags, 1514 uv_fs_cb cb); 1515UV_EXTERN int uv_fs_mkdir(uv_loop_t* loop, 1516 uv_fs_t* req, 1517 const char* path, 1518 int mode, 1519 uv_fs_cb cb); 1520UV_EXTERN int uv_fs_mkdtemp(uv_loop_t* loop, 1521 uv_fs_t* req, 1522 const char* tpl, 1523 uv_fs_cb cb); 1524UV_EXTERN int uv_fs_mkstemp(uv_loop_t* loop, 1525 uv_fs_t* req, 1526 const char* tpl, 1527 uv_fs_cb cb); 1528UV_EXTERN int uv_fs_rmdir(uv_loop_t* loop, 1529 uv_fs_t* req, 1530 const char* path, 1531 uv_fs_cb cb); 1532UV_EXTERN int uv_fs_scandir(uv_loop_t* loop, 1533 uv_fs_t* req, 1534 const char* path, 1535 int flags, 1536 uv_fs_cb cb); 1537UV_EXTERN int uv_fs_scandir_next(uv_fs_t* req, 1538 uv_dirent_t* ent); 1539UV_EXTERN int uv_fs_opendir(uv_loop_t* loop, 1540 uv_fs_t* req, 1541 const char* path, 1542 uv_fs_cb cb); 1543UV_EXTERN int uv_fs_readdir(uv_loop_t* loop, 1544 uv_fs_t* req, 1545 uv_dir_t* dir, 1546 uv_fs_cb cb); 1547UV_EXTERN int uv_fs_closedir(uv_loop_t* loop, 1548 uv_fs_t* req, 1549 uv_dir_t* dir, 1550 uv_fs_cb cb); 1551UV_EXTERN int uv_fs_stat(uv_loop_t* loop, 1552 uv_fs_t* req, 1553 const char* path, 1554 uv_fs_cb cb); 1555UV_EXTERN int uv_fs_fstat(uv_loop_t* loop, 1556 uv_fs_t* req, 1557 uv_file file, 1558 uv_fs_cb cb); 1559UV_EXTERN int uv_fs_rename(uv_loop_t* loop, 1560 uv_fs_t* req, 1561 const char* path, 1562 const char* new_path, 1563 uv_fs_cb cb); 1564UV_EXTERN int uv_fs_fsync(uv_loop_t* loop, 1565 uv_fs_t* req, 1566 uv_file file, 1567 uv_fs_cb cb); 1568UV_EXTERN int uv_fs_fdatasync(uv_loop_t* loop, 1569 uv_fs_t* req, 1570 uv_file file, 1571 uv_fs_cb cb); 1572UV_EXTERN int uv_fs_ftruncate(uv_loop_t* loop, 1573 uv_fs_t* req, 1574 uv_file file, 1575 int64_t offset, 1576 uv_fs_cb cb); 1577UV_EXTERN int uv_fs_sendfile(uv_loop_t* loop, 1578 uv_fs_t* req, 1579 uv_file out_fd, 1580 uv_file in_fd, 1581 int64_t in_offset, 1582 size_t length, 1583 uv_fs_cb cb); 1584UV_EXTERN int uv_fs_access(uv_loop_t* loop, 1585 uv_fs_t* req, 1586 const char* path, 1587 int mode, 1588 uv_fs_cb cb); 1589UV_EXTERN int uv_fs_chmod(uv_loop_t* loop, 1590 uv_fs_t* req, 1591 const char* path, 1592 int mode, 1593 uv_fs_cb cb); 1594UV_EXTERN int uv_fs_utime(uv_loop_t* loop, 1595 uv_fs_t* req, 1596 const char* path, 1597 double atime, 1598 double mtime, 1599 uv_fs_cb cb); 1600UV_EXTERN int uv_fs_futime(uv_loop_t* loop, 1601 uv_fs_t* req, 1602 uv_file file, 1603 double atime, 1604 double mtime, 1605 uv_fs_cb cb); 1606UV_EXTERN int uv_fs_lutime(uv_loop_t* loop, 1607 uv_fs_t* req, 1608 const char* path, 1609 double atime, 1610 double mtime, 1611 uv_fs_cb cb); 1612UV_EXTERN int uv_fs_lstat(uv_loop_t* loop, 1613 uv_fs_t* req, 1614 const char* path, 1615 uv_fs_cb cb); 1616UV_EXTERN int uv_fs_link(uv_loop_t* loop, 1617 uv_fs_t* req, 1618 const char* path, 1619 const char* new_path, 1620 uv_fs_cb cb); 1621 1622/* 1623 * This flag can be used with uv_fs_symlink() on Windows to specify whether 1624 * path argument points to a directory. 1625 */ 1626#define UV_FS_SYMLINK_DIR 0x0001 1627 1628/* 1629 * This flag can be used with uv_fs_symlink() on Windows to specify whether 1630 * the symlink is to be created using junction points. 1631 */ 1632#define UV_FS_SYMLINK_JUNCTION 0x0002 1633 1634UV_EXTERN int uv_fs_symlink(uv_loop_t* loop, 1635 uv_fs_t* req, 1636 const char* path, 1637 const char* new_path, 1638 int flags, 1639 uv_fs_cb cb); 1640UV_EXTERN int uv_fs_readlink(uv_loop_t* loop, 1641 uv_fs_t* req, 1642 const char* path, 1643 uv_fs_cb cb); 1644UV_EXTERN int uv_fs_realpath(uv_loop_t* loop, 1645 uv_fs_t* req, 1646 const char* path, 1647 uv_fs_cb cb); 1648UV_EXTERN int uv_fs_fchmod(uv_loop_t* loop, 1649 uv_fs_t* req, 1650 uv_file file, 1651 int mode, 1652 uv_fs_cb cb); 1653UV_EXTERN int uv_fs_chown(uv_loop_t* loop, 1654 uv_fs_t* req, 1655 const char* path, 1656 uv_uid_t uid, 1657 uv_gid_t gid, 1658 uv_fs_cb cb); 1659UV_EXTERN int uv_fs_fchown(uv_loop_t* loop, 1660 uv_fs_t* req, 1661 uv_file file, 1662 uv_uid_t uid, 1663 uv_gid_t gid, 1664 uv_fs_cb cb); 1665UV_EXTERN int uv_fs_lchown(uv_loop_t* loop, 1666 uv_fs_t* req, 1667 const char* path, 1668 uv_uid_t uid, 1669 uv_gid_t gid, 1670 uv_fs_cb cb); 1671UV_EXTERN int uv_fs_statfs(uv_loop_t* loop, 1672 uv_fs_t* req, 1673 const char* path, 1674 uv_fs_cb cb); 1675 1676 1677enum uv_fs_event { 1678 UV_RENAME = 1, 1679 UV_CHANGE = 2 1680}; 1681 1682 1683struct uv_fs_event_s { 1684 UV_HANDLE_FIELDS 1685 /* private */ 1686 char* path; 1687 UV_FS_EVENT_PRIVATE_FIELDS 1688}; 1689 1690 1691/* 1692 * uv_fs_stat() based polling file watcher. 1693 */ 1694struct uv_fs_poll_s { 1695 UV_HANDLE_FIELDS 1696 /* Private, don't touch. */ 1697 void* poll_ctx; 1698}; 1699 1700UV_EXTERN int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle); 1701UV_EXTERN int uv_fs_poll_start(uv_fs_poll_t* handle, 1702 uv_fs_poll_cb poll_cb, 1703 const char* path, 1704 unsigned int interval); 1705UV_EXTERN int uv_fs_poll_stop(uv_fs_poll_t* handle); 1706UV_EXTERN int uv_fs_poll_getpath(uv_fs_poll_t* handle, 1707 char* buffer, 1708 size_t* size); 1709 1710 1711struct uv_signal_s { 1712 UV_HANDLE_FIELDS 1713 uv_signal_cb signal_cb; 1714 int signum; 1715 UV_SIGNAL_PRIVATE_FIELDS 1716}; 1717 1718UV_EXTERN int uv_signal_init(uv_loop_t* loop, uv_signal_t* handle); 1719UV_EXTERN int uv_signal_start(uv_signal_t* handle, 1720 uv_signal_cb signal_cb, 1721 int signum); 1722UV_EXTERN int uv_signal_start_oneshot(uv_signal_t* handle, 1723 uv_signal_cb signal_cb, 1724 int signum); 1725UV_EXTERN int uv_signal_stop(uv_signal_t* handle); 1726 1727UV_EXTERN void uv_loadavg(double avg[3]); 1728 1729 1730/* 1731 * Flags to be passed to uv_fs_event_start(). 1732 */ 1733enum uv_fs_event_flags { 1734 /* 1735 * By default, if the fs event watcher is given a directory name, we will 1736 * watch for all events in that directory. This flags overrides this behavior 1737 * and makes fs_event report only changes to the directory entry itself. This 1738 * flag does not affect individual files watched. 1739 * This flag is currently not implemented yet on any backend. 1740 */ 1741 UV_FS_EVENT_WATCH_ENTRY = 1, 1742 1743 /* 1744 * By default uv_fs_event will try to use a kernel interface such as inotify 1745 * or kqueue to detect events. This may not work on remote filesystems such 1746 * as NFS mounts. This flag makes fs_event fall back to calling stat() on a 1747 * regular interval. 1748 * This flag is currently not implemented yet on any backend. 1749 */ 1750 UV_FS_EVENT_STAT = 2, 1751 1752 /* 1753 * By default, event watcher, when watching directory, is not registering 1754 * (is ignoring) changes in it's subdirectories. 1755 * This flag will override this behaviour on platforms that support it. 1756 */ 1757 UV_FS_EVENT_RECURSIVE = 4 1758}; 1759 1760 1761UV_EXTERN int uv_fs_event_init(uv_loop_t* loop, uv_fs_event_t* handle); 1762UV_EXTERN int uv_fs_event_start(uv_fs_event_t* handle, 1763 uv_fs_event_cb cb, 1764 const char* path, 1765 unsigned int flags); 1766UV_EXTERN int uv_fs_event_stop(uv_fs_event_t* handle); 1767UV_EXTERN int uv_fs_event_getpath(uv_fs_event_t* handle, 1768 char* buffer, 1769 size_t* size); 1770 1771UV_EXTERN int uv_ip4_addr(const char* ip, int port, struct sockaddr_in* addr); 1772UV_EXTERN int uv_ip6_addr(const char* ip, int port, struct sockaddr_in6* addr); 1773 1774UV_EXTERN int uv_ip4_name(const struct sockaddr_in* src, char* dst, size_t size); 1775UV_EXTERN int uv_ip6_name(const struct sockaddr_in6* src, char* dst, size_t size); 1776UV_EXTERN int uv_ip_name(const struct sockaddr* src, char* dst, size_t size); 1777 1778UV_EXTERN int uv_inet_ntop(int af, const void* src, char* dst, size_t size); 1779UV_EXTERN int uv_inet_pton(int af, const char* src, void* dst); 1780 1781 1782struct uv_random_s { 1783 UV_REQ_FIELDS 1784 /* read-only */ 1785 uv_loop_t* loop; 1786 /* private */ 1787 int status; 1788 void* buf; 1789 size_t buflen; 1790 uv_random_cb cb; 1791 struct uv__work work_req; 1792}; 1793 1794UV_EXTERN int uv_random(uv_loop_t* loop, 1795 uv_random_t* req, 1796 void *buf, 1797 size_t buflen, 1798 unsigned flags, /* For future extension; must be 0. */ 1799 uv_random_cb cb); 1800 1801#if defined(IF_NAMESIZE) 1802# define UV_IF_NAMESIZE (IF_NAMESIZE + 1) 1803#elif defined(IFNAMSIZ) 1804# define UV_IF_NAMESIZE (IFNAMSIZ + 1) 1805#else 1806# define UV_IF_NAMESIZE (16 + 1) 1807#endif 1808 1809UV_EXTERN int uv_if_indextoname(unsigned int ifindex, 1810 char* buffer, 1811 size_t* size); 1812UV_EXTERN int uv_if_indextoiid(unsigned int ifindex, 1813 char* buffer, 1814 size_t* size); 1815 1816UV_EXTERN int uv_exepath(char* buffer, size_t* size); 1817 1818UV_EXTERN int uv_cwd(char* buffer, size_t* size); 1819 1820UV_EXTERN int uv_chdir(const char* dir); 1821 1822UV_EXTERN uint64_t uv_get_free_memory(void); 1823UV_EXTERN uint64_t uv_get_total_memory(void); 1824UV_EXTERN uint64_t uv_get_constrained_memory(void); 1825UV_EXTERN uint64_t uv_get_available_memory(void); 1826 1827UV_EXTERN int uv_clock_gettime(uv_clock_id clock_id, uv_timespec64_t* ts); 1828UV_EXTERN uint64_t uv_hrtime(void); 1829UV_EXTERN void uv_sleep(unsigned int msec); 1830 1831UV_EXTERN void uv_disable_stdio_inheritance(void); 1832 1833UV_EXTERN int uv_dlopen(const char* filename, uv_lib_t* lib); 1834UV_EXTERN void uv_dlclose(uv_lib_t* lib); 1835UV_EXTERN int uv_dlsym(uv_lib_t* lib, const char* name, void** ptr); 1836UV_EXTERN const char* uv_dlerror(const uv_lib_t* lib); 1837 1838UV_EXTERN int uv_mutex_init(uv_mutex_t* handle); 1839UV_EXTERN int uv_mutex_init_recursive(uv_mutex_t* handle); 1840UV_EXTERN void uv_mutex_destroy(uv_mutex_t* handle); 1841UV_EXTERN void uv_mutex_lock(uv_mutex_t* handle); 1842UV_EXTERN int uv_mutex_trylock(uv_mutex_t* handle); 1843UV_EXTERN void uv_mutex_unlock(uv_mutex_t* handle); 1844 1845UV_EXTERN int uv_rwlock_init(uv_rwlock_t* rwlock); 1846UV_EXTERN void uv_rwlock_destroy(uv_rwlock_t* rwlock); 1847UV_EXTERN void uv_rwlock_rdlock(uv_rwlock_t* rwlock); 1848UV_EXTERN int uv_rwlock_tryrdlock(uv_rwlock_t* rwlock); 1849UV_EXTERN void uv_rwlock_rdunlock(uv_rwlock_t* rwlock); 1850UV_EXTERN void uv_rwlock_wrlock(uv_rwlock_t* rwlock); 1851UV_EXTERN int uv_rwlock_trywrlock(uv_rwlock_t* rwlock); 1852UV_EXTERN void uv_rwlock_wrunlock(uv_rwlock_t* rwlock); 1853 1854UV_EXTERN int uv_sem_init(uv_sem_t* sem, unsigned int value); 1855UV_EXTERN void uv_sem_destroy(uv_sem_t* sem); 1856UV_EXTERN void uv_sem_post(uv_sem_t* sem); 1857UV_EXTERN void uv_sem_wait(uv_sem_t* sem); 1858UV_EXTERN int uv_sem_trywait(uv_sem_t* sem); 1859 1860UV_EXTERN int uv_cond_init(uv_cond_t* cond); 1861UV_EXTERN void uv_cond_destroy(uv_cond_t* cond); 1862UV_EXTERN void uv_cond_signal(uv_cond_t* cond); 1863UV_EXTERN void uv_cond_broadcast(uv_cond_t* cond); 1864 1865UV_EXTERN int uv_barrier_init(uv_barrier_t* barrier, unsigned int count); 1866UV_EXTERN void uv_barrier_destroy(uv_barrier_t* barrier); 1867UV_EXTERN int uv_barrier_wait(uv_barrier_t* barrier); 1868 1869UV_EXTERN void uv_cond_wait(uv_cond_t* cond, uv_mutex_t* mutex); 1870UV_EXTERN int uv_cond_timedwait(uv_cond_t* cond, 1871 uv_mutex_t* mutex, 1872 uint64_t timeout); 1873 1874UV_EXTERN void uv_once(uv_once_t* guard, void (*callback)(void)); 1875 1876UV_EXTERN int uv_key_create(uv_key_t* key); 1877UV_EXTERN void uv_key_delete(uv_key_t* key); 1878UV_EXTERN void* uv_key_get(uv_key_t* key); 1879UV_EXTERN void uv_key_set(uv_key_t* key, void* value); 1880 1881UV_EXTERN int uv_gettimeofday(uv_timeval64_t* tv); 1882 1883typedef void (*uv_thread_cb)(void* arg); 1884 1885UV_EXTERN int uv_thread_create(uv_thread_t* tid, uv_thread_cb entry, void* arg); 1886 1887typedef enum { 1888 UV_THREAD_NO_FLAGS = 0x00, 1889 UV_THREAD_HAS_STACK_SIZE = 0x01 1890} uv_thread_create_flags; 1891 1892struct uv_thread_options_s { 1893 unsigned int flags; 1894 size_t stack_size; 1895 /* More fields may be added at any time. */ 1896}; 1897 1898typedef struct uv_thread_options_s uv_thread_options_t; 1899 1900UV_EXTERN int uv_thread_create_ex(uv_thread_t* tid, 1901 const uv_thread_options_t* params, 1902 uv_thread_cb entry, 1903 void* arg); 1904UV_EXTERN int uv_thread_setaffinity(uv_thread_t* tid, 1905 char* cpumask, 1906 char* oldmask, 1907 size_t mask_size); 1908UV_EXTERN int uv_thread_getaffinity(uv_thread_t* tid, 1909 char* cpumask, 1910 size_t mask_size); 1911UV_EXTERN int uv_thread_getcpu(void); 1912UV_EXTERN uv_thread_t uv_thread_self(void); 1913UV_EXTERN int uv_thread_join(uv_thread_t *tid); 1914UV_EXTERN int uv_thread_equal(const uv_thread_t* t1, const uv_thread_t* t2); 1915 1916/* The presence of these unions force similar struct layout. */ 1917#define XX(_, name) uv_ ## name ## _t name; 1918union uv_any_handle { 1919 UV_HANDLE_TYPE_MAP(XX) 1920}; 1921 1922union uv_any_req { 1923 UV_REQ_TYPE_MAP(XX) 1924}; 1925#undef XX 1926 1927typedef void (*uv_io_cb)(void* work, int status); 1928typedef void (*uv_post_task)(void* handler, uv_io_cb func, void* work, int status, int prio); 1929 1930struct uv_loop_data { 1931 void* event_handler; 1932 uv_post_task post_task_func; 1933}; 1934 1935struct uv_loop_s { 1936 /* User data - use this for whatever. */ 1937 void* data; 1938 /* Loop reference counting. */ 1939 unsigned int active_handles; 1940 struct uv__queue handle_queue; 1941 union { 1942 void* unused; 1943 unsigned int count; 1944 } active_reqs; 1945 /* Internal storage for future extensions. */ 1946 void* internal_fields; 1947 /* Internal flag to signal loop stop. */ 1948 unsigned int stop_flag; 1949 UV_LOOP_PRIVATE_FIELDS 1950}; 1951 1952UV_EXTERN void* uv_loop_get_data(const uv_loop_t*); 1953UV_EXTERN void uv_loop_set_data(uv_loop_t*, void* data); 1954UV_EXTERN int uv_register_task_to_event(struct uv_loop_s* loop, uv_post_task func, void* handler); 1955UV_EXTERN int uv_unregister_task_to_event(struct uv_loop_s* loop); 1956UV_EXTERN int uv_check_data_valid(struct uv_loop_data* data); 1957 1958/* String utilities needed internally for dealing with Windows. */ 1959size_t uv_utf16_length_as_wtf8(const uint16_t* utf16, 1960 ssize_t utf16_len); 1961int uv_utf16_to_wtf8(const uint16_t* utf16, 1962 ssize_t utf16_len, 1963 char** wtf8_ptr, 1964 size_t* wtf8_len_ptr); 1965ssize_t uv_wtf8_length_as_utf16(const char* wtf8); 1966void uv_wtf8_to_utf16(const char* wtf8, 1967 uint16_t* utf16, 1968 size_t utf16_len); 1969 1970/* Don't export the private CPP symbols. */ 1971#undef UV_HANDLE_TYPE_PRIVATE 1972#undef UV_REQ_TYPE_PRIVATE 1973#undef UV_REQ_PRIVATE_FIELDS 1974#undef UV_STREAM_PRIVATE_FIELDS 1975#undef UV_TCP_PRIVATE_FIELDS 1976#undef UV_PREPARE_PRIVATE_FIELDS 1977#undef UV_CHECK_PRIVATE_FIELDS 1978#undef UV_IDLE_PRIVATE_FIELDS 1979#undef UV_ASYNC_PRIVATE_FIELDS 1980#undef UV_TIMER_PRIVATE_FIELDS 1981#undef UV_GETADDRINFO_PRIVATE_FIELDS 1982#undef UV_GETNAMEINFO_PRIVATE_FIELDS 1983#undef UV_FS_REQ_PRIVATE_FIELDS 1984#undef UV_WORK_PRIVATE_FIELDS 1985#undef UV_FS_EVENT_PRIVATE_FIELDS 1986#undef UV_SIGNAL_PRIVATE_FIELDS 1987#undef UV_LOOP_PRIVATE_FIELDS 1988#undef UV_LOOP_PRIVATE_PLATFORM_FIELDS 1989#undef UV__ERR 1990 1991#ifdef __cplusplus 1992} 1993#endif 1994#endif /* UV_H */ 1995