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