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
27 extern "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. */
63 struct 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 USE_OHOS_DFX
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
202 typedef 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
209 typedef 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
218 typedef 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. */
231 typedef struct uv_loop_s uv_loop_t;
232 typedef struct uv_handle_s uv_handle_t;
233 typedef struct uv_dir_s uv_dir_t;
234 typedef struct uv_stream_s uv_stream_t;
235 typedef struct uv_tcp_s uv_tcp_t;
236 typedef struct uv_udp_s uv_udp_t;
237 typedef struct uv_pipe_s uv_pipe_t;
238 typedef struct uv_tty_s uv_tty_t;
239 typedef struct uv_poll_s uv_poll_t;
240 typedef struct uv_timer_s uv_timer_t;
241 typedef struct uv_prepare_s uv_prepare_t;
242 typedef struct uv_check_s uv_check_t;
243 typedef struct uv_idle_s uv_idle_t;
244 typedef struct uv_async_s uv_async_t;
245 typedef struct uv_process_s uv_process_t;
246 typedef struct uv_fs_event_s uv_fs_event_t;
247 typedef struct uv_fs_poll_s uv_fs_poll_t;
248 typedef struct uv_signal_s uv_signal_t;
249
250 /* Request types. */
251 typedef struct uv_req_s uv_req_t;
252 typedef struct uv_getaddrinfo_s uv_getaddrinfo_t;
253 typedef struct uv_getnameinfo_s uv_getnameinfo_t;
254 typedef struct uv_shutdown_s uv_shutdown_t;
255 typedef struct uv_write_s uv_write_t;
256 typedef struct uv_connect_s uv_connect_t;
257 typedef struct uv_udp_send_s uv_udp_send_t;
258 typedef struct uv_fs_s uv_fs_t;
259 typedef struct uv_work_s uv_work_t;
260 typedef struct uv_random_s uv_random_t;
261
262 /* None of the above. */
263 typedef struct uv_env_item_s uv_env_item_t;
264 typedef struct uv_cpu_info_s uv_cpu_info_t;
265 typedef struct uv_interface_address_s uv_interface_address_t;
266 typedef struct uv_dirent_s uv_dirent_t;
267 typedef struct uv_passwd_s uv_passwd_t;
268 typedef struct uv_group_s uv_group_t;
269 typedef struct uv_utsname_s uv_utsname_t;
270 typedef struct uv_statfs_s uv_statfs_t;
271
272 typedef struct uv_metrics_s uv_metrics_t;
273
274 typedef enum {
275 UV_LOOP_BLOCK_SIGNAL = 0,
276 UV_METRICS_IDLE_TIME
277 } uv_loop_option;
278
279 typedef enum {
280 UV_RUN_DEFAULT = 0,
281 UV_RUN_ONCE,
282 UV_RUN_NOWAIT
283 } uv_run_mode;
284
285
286 UV_EXTERN unsigned int uv_version(void);
287 UV_EXTERN const char* uv_version_string(void);
288
289 typedef void* (*uv_malloc_func)(size_t size);
290 typedef void* (*uv_realloc_func)(void* ptr, size_t size);
291 typedef void* (*uv_calloc_func)(size_t count, size_t size);
292 typedef void (*uv_free_func)(void* ptr);
293
294 UV_EXTERN void uv_library_shutdown(void);
295
296 UV_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
301 UV_EXTERN uv_loop_t* uv_default_loop(void);
302 UV_EXTERN int uv_loop_init(uv_loop_t* loop);
303 UV_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 */
309 UV_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 */
315 UV_EXTERN void uv_loop_delete(uv_loop_t*);
316 UV_EXTERN size_t uv_loop_size(void);
317 UV_EXTERN int uv_loop_alive(const uv_loop_t* loop);
318 UV_EXTERN int uv_loop_configure(uv_loop_t* loop, uv_loop_option option, ...);
319 UV_EXTERN int uv_loop_fork(uv_loop_t* loop);
320 /* This function is called by taskpool */
321 UV_EXTERN int uv_loop_alive_taskpool(const uv_loop_t* loop, int initial_handles);
322
323 UV_EXTERN int uv_run(uv_loop_t*, uv_run_mode mode);
324 UV_EXTERN void uv_stop(uv_loop_t*);
325
326 UV_EXTERN void uv_ref(uv_handle_t*);
327 UV_EXTERN void uv_unref(uv_handle_t*);
328 UV_EXTERN int uv_has_ref(const uv_handle_t*);
329
330 UV_EXTERN void uv_update_time(uv_loop_t*);
331 UV_EXTERN uint64_t uv_now(const uv_loop_t*);
332
333 UV_EXTERN int uv_backend_fd(const uv_loop_t*);
334 UV_EXTERN int uv_backend_timeout(const uv_loop_t*);
335
336 typedef void (*uv_alloc_cb)(uv_handle_t* handle,
337 size_t suggested_size,
338 uv_buf_t* buf);
339 typedef void (*uv_read_cb)(uv_stream_t* stream,
340 ssize_t nread,
341 const uv_buf_t* buf);
342 typedef void (*uv_write_cb)(uv_write_t* req, int status);
343 typedef void (*uv_connect_cb)(uv_connect_t* req, int status);
344 typedef void (*uv_shutdown_cb)(uv_shutdown_t* req, int status);
345 typedef void (*uv_connection_cb)(uv_stream_t* server, int status);
346 typedef void (*uv_close_cb)(uv_handle_t* handle);
347 typedef void (*uv_poll_cb)(uv_poll_t* handle, int status, int events);
348 typedef void (*uv_timer_cb)(uv_timer_t* handle);
349 typedef void (*uv_async_cb)(uv_async_t* handle);
350 typedef void (*uv_prepare_cb)(uv_prepare_t* handle);
351 typedef void (*uv_check_cb)(uv_check_t* handle);
352 typedef void (*uv_idle_cb)(uv_idle_t* handle);
353 typedef void (*uv_exit_cb)(uv_process_t*, int64_t exit_status, int term_signal);
354 typedef void (*uv_walk_cb)(uv_handle_t* handle, void* arg);
355 typedef void (*uv_fs_cb)(uv_fs_t* req);
356 typedef void (*uv_work_cb)(uv_work_t* req);
357 typedef void (*uv_after_work_cb)(uv_work_t* req, int status);
358 typedef void (*uv_getaddrinfo_cb)(uv_getaddrinfo_t* req,
359 int status,
360 struct addrinfo* res);
361 typedef void (*uv_getnameinfo_cb)(uv_getnameinfo_t* req,
362 int status,
363 const char* hostname,
364 const char* service);
365 typedef void (*uv_random_cb)(uv_random_t* req,
366 int status,
367 void* buf,
368 size_t buflen);
369
370 typedef 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 */
376 typedef struct {
377 long tv_sec;
378 long tv_nsec;
379 } uv_timespec_t;
380
381 typedef 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 */
387 typedef struct {
388 long tv_sec;
389 long tv_usec;
390 } uv_timeval_t;
391
392 typedef struct {
393 int64_t tv_sec;
394 int32_t tv_usec;
395 } uv_timeval64_t;
396
397 typedef 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
417 typedef void (*uv_fs_event_cb)(uv_fs_event_t* handle,
418 const char* filename,
419 int events,
420 int status);
421
422 typedef 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
427 typedef void (*uv_signal_cb)(uv_signal_t* handle, int signum);
428
429
430 typedef enum {
431 UV_LEAVE_GROUP = 0,
432 UV_JOIN_GROUP
433 } uv_membership;
434
435
436 UV_EXTERN int uv_translate_sys_error(int sys_errno);
437
438 UV_EXTERN const char* uv_strerror(int err);
439 UV_EXTERN char* uv_strerror_r(int err, char* buf, size_t buflen);
440
441 UV_EXTERN const char* uv_err_name(int err);
442 UV_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. */
455 struct uv_req_s {
456 UV_REQ_FIELDS
457 };
458
459
460 /* Platform-specific request types. */
461 UV_PRIVATE_REQ_TYPES
462
463
464 UV_EXTERN int uv_shutdown(uv_shutdown_t* req,
465 uv_stream_t* handle,
466 uv_shutdown_cb cb);
467
468 struct 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. */
492 struct uv_handle_s {
493 UV_HANDLE_FIELDS
494 };
495
496 UV_EXTERN size_t uv_handle_size(uv_handle_type type);
497 UV_EXTERN uv_handle_type uv_handle_get_type(const uv_handle_t* handle);
498 UV_EXTERN const char* uv_handle_type_name(uv_handle_type type);
499 UV_EXTERN void* uv_handle_get_data(const uv_handle_t* handle);
500 UV_EXTERN uv_loop_t* uv_handle_get_loop(const uv_handle_t* handle);
501 UV_EXTERN void uv_handle_set_data(uv_handle_t* handle, void* data);
502
503 UV_EXTERN size_t uv_req_size(uv_req_type type);
504 UV_EXTERN void* uv_req_get_data(const uv_req_t* req);
505 UV_EXTERN void uv_req_set_data(uv_req_t* req, void* data);
506 UV_EXTERN uv_req_type uv_req_get_type(const uv_req_t* req);
507 UV_EXTERN const char* uv_req_type_name(uv_req_type type);
508
509 UV_EXTERN int uv_is_active(const uv_handle_t* handle);
510
511 UV_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. */
514 UV_EXTERN void uv_print_all_handles(uv_loop_t* loop, FILE* stream);
515 UV_EXTERN void uv_print_active_handles(uv_loop_t* loop, FILE* stream);
516
517 UV_EXTERN void uv_close(uv_handle_t* handle, uv_close_cb close_cb);
518
519 UV_EXTERN int uv_send_buffer_size(uv_handle_t* handle, int* value);
520 UV_EXTERN int uv_recv_buffer_size(uv_handle_t* handle, int* value);
521
522 UV_EXTERN int uv_fileno(const uv_handle_t* handle, uv_os_fd_t* fd);
523
524 UV_EXTERN uv_buf_t uv_buf_init(char* base, unsigned int len);
525
526 UV_EXTERN int uv_pipe(uv_file fds[2], int read_flags, int write_flags);
527 UV_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 */
548 struct uv_stream_s {
549 UV_HANDLE_FIELDS
550 UV_STREAM_FIELDS
551 };
552
553 UV_EXTERN size_t uv_stream_get_write_queue_size(const uv_stream_t* stream);
554
555 UV_EXTERN int uv_listen(uv_stream_t* stream, int backlog, uv_connection_cb cb);
556 UV_EXTERN int uv_accept(uv_stream_t* server, uv_stream_t* client);
557
558 UV_EXTERN int uv_read_start(uv_stream_t*,
559 uv_alloc_cb alloc_cb,
560 uv_read_cb read_cb);
561 UV_EXTERN int uv_read_stop(uv_stream_t*);
562
563 UV_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);
568 UV_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);
574 UV_EXTERN int uv_try_write(uv_stream_t* handle,
575 const uv_buf_t bufs[],
576 unsigned int nbufs);
577 UV_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. */
583 struct 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
592 UV_EXTERN int uv_is_readable(const uv_stream_t* handle);
593 UV_EXTERN int uv_is_writable(const uv_stream_t* handle);
594
595 UV_EXTERN int uv_stream_set_blocking(uv_stream_t* handle, int blocking);
596
597 UV_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 */
605 struct uv_tcp_s {
606 UV_HANDLE_FIELDS
607 UV_STREAM_FIELDS
608 UV_TCP_PRIVATE_FIELDS
609 };
610
611 UV_EXTERN int uv_tcp_init(uv_loop_t*, uv_tcp_t* handle);
612 UV_EXTERN int uv_tcp_init_ex(uv_loop_t*, uv_tcp_t* handle, unsigned int flags);
613 UV_EXTERN int uv_tcp_open(uv_tcp_t* handle, uv_os_sock_t sock);
614 UV_EXTERN int uv_tcp_nodelay(uv_tcp_t* handle, int enable);
615 UV_EXTERN int uv_tcp_keepalive(uv_tcp_t* handle,
616 int enable,
617 unsigned int delay);
618 UV_EXTERN int uv_tcp_simultaneous_accepts(uv_tcp_t* handle, int enable);
619
620 enum uv_tcp_flags {
621 /* Used with uv_tcp_bind, when an IPv6 address is used. */
622 UV_TCP_IPV6ONLY = 1
623 };
624
625 UV_EXTERN int uv_tcp_bind(uv_tcp_t* handle,
626 const struct sockaddr* addr,
627 unsigned int flags);
628 UV_EXTERN int uv_tcp_getsockname(const uv_tcp_t* handle,
629 struct sockaddr* name,
630 int* namelen);
631 UV_EXTERN int uv_tcp_getpeername(const uv_tcp_t* handle,
632 struct sockaddr* name,
633 int* namelen);
634 UV_EXTERN int uv_tcp_close_reset(uv_tcp_t* handle, uv_close_cb close_cb);
635 UV_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. */
641 struct 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
653 enum 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
695 typedef void (*uv_udp_send_cb)(uv_udp_send_t* req, int status);
696 typedef 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. */
703 struct 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. */
719 struct 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
726 UV_EXTERN int uv_udp_init(uv_loop_t*, uv_udp_t* handle);
727 UV_EXTERN int uv_udp_init_ex(uv_loop_t*, uv_udp_t* handle, unsigned int flags);
728 UV_EXTERN int uv_udp_open(uv_udp_t* handle, uv_os_sock_t sock);
729 UV_EXTERN int uv_udp_bind(uv_udp_t* handle,
730 const struct sockaddr* addr,
731 unsigned int flags);
732 UV_EXTERN int uv_udp_connect(uv_udp_t* handle, const struct sockaddr* addr);
733
734 UV_EXTERN int uv_udp_getpeername(const uv_udp_t* handle,
735 struct sockaddr* name,
736 int* namelen);
737 UV_EXTERN int uv_udp_getsockname(const uv_udp_t* handle,
738 struct sockaddr* name,
739 int* namelen);
740 UV_EXTERN int uv_udp_set_membership(uv_udp_t* handle,
741 const char* multicast_addr,
742 const char* interface_addr,
743 uv_membership membership);
744 UV_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);
749 UV_EXTERN int uv_udp_set_multicast_loop(uv_udp_t* handle, int on);
750 UV_EXTERN int uv_udp_set_multicast_ttl(uv_udp_t* handle, int ttl);
751 UV_EXTERN int uv_udp_set_multicast_interface(uv_udp_t* handle,
752 const char* interface_addr);
753 UV_EXTERN int uv_udp_set_broadcast(uv_udp_t* handle, int on);
754 UV_EXTERN int uv_udp_set_ttl(uv_udp_t* handle, int ttl);
755 UV_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);
761 UV_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);
765 UV_EXTERN int uv_udp_recv_start(uv_udp_t* handle,
766 uv_alloc_cb alloc_cb,
767 uv_udp_recv_cb recv_cb);
768 UV_EXTERN int uv_udp_using_recvmmsg(const uv_udp_t* handle);
769 UV_EXTERN int uv_udp_recv_stop(uv_udp_t* handle);
770 UV_EXTERN size_t uv_udp_get_send_queue_size(const uv_udp_t* handle);
771 UV_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 */
779 struct uv_tty_s {
780 UV_HANDLE_FIELDS
781 UV_STREAM_FIELDS
782 UV_TTY_PRIVATE_FIELDS
783 };
784
785 typedef 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
794 typedef 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
807 UV_EXTERN int uv_tty_init(uv_loop_t*, uv_tty_t*, uv_file fd, int readable);
808 UV_EXTERN int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode);
809 UV_EXTERN int uv_tty_reset_mode(void);
810 UV_EXTERN int uv_tty_get_winsize(uv_tty_t*, int* width, int* height);
811 UV_EXTERN void uv_tty_set_vterm_state(uv_tty_vtermstate_t state);
812 UV_EXTERN int uv_tty_get_vterm_state(uv_tty_vtermstate_t* state);
813
814 #ifdef __cplusplus
815 extern "C++" {
816
uv_tty_set_mode(uv_tty_t * handle,int mode)817 inline 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
824 UV_EXTERN uv_handle_type uv_guess_handle(uv_file file);
825
826 enum {
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 */
836 struct 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
843 UV_EXTERN int uv_pipe_init(uv_loop_t*, uv_pipe_t* handle, int ipc);
844 UV_EXTERN int uv_pipe_open(uv_pipe_t*, uv_file file);
845 UV_EXTERN int uv_pipe_bind(uv_pipe_t* handle, const char* name);
846 UV_EXTERN int uv_pipe_bind2(uv_pipe_t* handle,
847 const char* name,
848 size_t namelen,
849 unsigned int flags);
850 UV_EXTERN void uv_pipe_connect(uv_connect_t* req,
851 uv_pipe_t* handle,
852 const char* name,
853 uv_connect_cb cb);
854 UV_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);
860 UV_EXTERN int uv_pipe_getsockname(const uv_pipe_t* handle,
861 char* buffer,
862 size_t* size);
863 UV_EXTERN int uv_pipe_getpeername(const uv_pipe_t* handle,
864 char* buffer,
865 size_t* size);
866 UV_EXTERN void uv_pipe_pending_instances(uv_pipe_t* handle, int count);
867 UV_EXTERN int uv_pipe_pending_count(uv_pipe_t* handle);
868 UV_EXTERN uv_handle_type uv_pipe_pending_type(uv_pipe_t* handle);
869 UV_EXTERN int uv_pipe_chmod(uv_pipe_t* handle, int flags);
870
871
872 struct uv_poll_s {
873 UV_HANDLE_FIELDS
874 uv_poll_cb poll_cb;
875 UV_POLL_PRIVATE_FIELDS
876 };
877
878 enum uv_poll_event {
879 UV_READABLE = 1,
880 UV_WRITABLE = 2,
881 UV_DISCONNECT = 4,
882 UV_PRIORITIZED = 8
883 };
884
885 UV_EXTERN int uv_poll_init(uv_loop_t* loop, uv_poll_t* handle, int fd);
886 UV_EXTERN int uv_poll_init_socket(uv_loop_t* loop,
887 uv_poll_t* handle,
888 uv_os_sock_t socket);
889 UV_EXTERN int uv_poll_start(uv_poll_t* handle, int events, uv_poll_cb cb);
890 UV_EXTERN int uv_poll_stop(uv_poll_t* handle);
891
892
893 struct uv_prepare_s {
894 UV_HANDLE_FIELDS
895 UV_PREPARE_PRIVATE_FIELDS
896 };
897
898 UV_EXTERN int uv_prepare_init(uv_loop_t*, uv_prepare_t* prepare);
899 UV_EXTERN int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb);
900 UV_EXTERN int uv_prepare_stop(uv_prepare_t* prepare);
901
902
903 struct uv_check_s {
904 UV_HANDLE_FIELDS
905 UV_CHECK_PRIVATE_FIELDS
906 };
907
908 UV_EXTERN int uv_check_init(uv_loop_t*, uv_check_t* check);
909 UV_EXTERN int uv_check_start(uv_check_t* check, uv_check_cb cb);
910 UV_EXTERN int uv_check_stop(uv_check_t* check);
911
912
913 struct uv_idle_s {
914 UV_HANDLE_FIELDS
915 UV_IDLE_PRIVATE_FIELDS
916 };
917
918 UV_EXTERN int uv_idle_init(uv_loop_t*, uv_idle_t* idle);
919 UV_EXTERN int uv_idle_start(uv_idle_t* idle, uv_idle_cb cb);
920 UV_EXTERN int uv_idle_stop(uv_idle_t* idle);
921
922
923 struct uv_async_s {
924 UV_HANDLE_FIELDS
925 UV_ASYNC_PRIVATE_FIELDS
926 };
927
928 UV_EXTERN int uv_async_init(uv_loop_t*,
929 uv_async_t* async,
930 uv_async_cb async_cb);
931 UV_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 */
939 struct uv_timer_s {
940 UV_HANDLE_FIELDS
941 UV_TIMER_PRIVATE_FIELDS
942 };
943
944 UV_EXTERN int uv_timer_init(uv_loop_t*, uv_timer_t* handle);
945 UV_EXTERN int uv_timer_start(uv_timer_t* handle,
946 uv_timer_cb cb,
947 uint64_t timeout,
948 uint64_t repeat);
949 UV_EXTERN int uv_timer_stop(uv_timer_t* handle);
950 UV_EXTERN int uv_timer_again(uv_timer_t* handle);
951 UV_EXTERN void uv_timer_set_repeat(uv_timer_t* handle, uint64_t repeat);
952 UV_EXTERN uint64_t uv_timer_get_repeat(const uv_timer_t* handle);
953 UV_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 */
961 struct 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
970 UV_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);
976 UV_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 */
984 struct 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
992 UV_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. */
1000 typedef 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
1024 typedef 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
1033 typedef 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 */
1081 enum 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 */
1137 struct uv_process_s {
1138 UV_HANDLE_FIELDS
1139 uv_exit_cb exit_cb;
1140 int pid;
1141 UV_PROCESS_PRIVATE_FIELDS
1142 };
1143
1144 UV_EXTERN int uv_spawn(uv_loop_t* loop,
1145 uv_process_t* handle,
1146 const uv_process_options_t* options);
1147 UV_EXTERN int uv_process_kill(uv_process_t*, int signum);
1148 UV_EXTERN int uv_kill(int pid, int signum);
1149 UV_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 */
1155 struct 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
1164 typedef struct uv_worker_info_s uv_worker_info_t;
1165
1166 struct 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
1176 UV_EXTERN uv_worker_info_t* uv_dump_work_queue(int* size);
1177
1178 UV_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
1183 UV_EXTERN int uv_cancel(uv_req_t* req);
1184
1185 typedef 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_user_interactive = 4,
1191 } uv_qos_t;
1192
1193 UV_EXTERN int uv_queue_work_with_qos(uv_loop_t* loop,
1194 uv_work_t* req,
1195 uv_work_cb work_cb,
1196 uv_after_work_cb after_work_cb,
1197 uv_qos_t qos);
1198
1199 struct uv_cpu_times_s {
1200 uint64_t user; /* milliseconds */
1201 uint64_t nice; /* milliseconds */
1202 uint64_t sys; /* milliseconds */
1203 uint64_t idle; /* milliseconds */
1204 uint64_t irq; /* milliseconds */
1205 };
1206
1207 struct uv_cpu_info_s {
1208 char* model;
1209 int speed;
1210 struct uv_cpu_times_s cpu_times;
1211 };
1212
1213 struct uv_interface_address_s {
1214 char* name;
1215 char phys_addr[6];
1216 int is_internal;
1217 union {
1218 struct sockaddr_in address4;
1219 struct sockaddr_in6 address6;
1220 } address;
1221 union {
1222 struct sockaddr_in netmask4;
1223 struct sockaddr_in6 netmask6;
1224 } netmask;
1225 };
1226
1227 struct uv_passwd_s {
1228 char* username;
1229 unsigned long uid;
1230 unsigned long gid;
1231 char* shell;
1232 char* homedir;
1233 };
1234
1235 struct uv_group_s {
1236 char* groupname;
1237 unsigned long gid;
1238 char** members;
1239 };
1240
1241 struct uv_utsname_s {
1242 char sysname[256];
1243 char release[256];
1244 char version[256];
1245 char machine[256];
1246 /* This struct does not contain the nodename and domainname fields present in
1247 the utsname type. domainname is a GNU extension. Both fields are referred
1248 to as meaningless in the docs. */
1249 };
1250
1251 struct uv_statfs_s {
1252 uint64_t f_type;
1253 uint64_t f_bsize;
1254 uint64_t f_blocks;
1255 uint64_t f_bfree;
1256 uint64_t f_bavail;
1257 uint64_t f_files;
1258 uint64_t f_ffree;
1259 uint64_t f_spare[4];
1260 };
1261
1262 typedef enum {
1263 UV_DIRENT_UNKNOWN,
1264 UV_DIRENT_FILE,
1265 UV_DIRENT_DIR,
1266 UV_DIRENT_LINK,
1267 UV_DIRENT_FIFO,
1268 UV_DIRENT_SOCKET,
1269 UV_DIRENT_CHAR,
1270 UV_DIRENT_BLOCK
1271 } uv_dirent_type_t;
1272
1273 struct uv_dirent_s {
1274 const char* name;
1275 uv_dirent_type_t type;
1276 };
1277
1278 UV_EXTERN char** uv_setup_args(int argc, char** argv);
1279 UV_EXTERN int uv_get_process_title(char* buffer, size_t size);
1280 UV_EXTERN int uv_set_process_title(const char* title);
1281 UV_EXTERN int uv_resident_set_memory(size_t* rss);
1282 UV_EXTERN int uv_uptime(double* uptime);
1283 UV_EXTERN uv_os_fd_t uv_get_osfhandle(int fd);
1284 UV_EXTERN int uv_open_osfhandle(uv_os_fd_t os_fd);
1285
1286 typedef struct {
1287 uv_timeval_t ru_utime; /* user CPU time used */
1288 uv_timeval_t ru_stime; /* system CPU time used */
1289 uint64_t ru_maxrss; /* maximum resident set size */
1290 uint64_t ru_ixrss; /* integral shared memory size */
1291 uint64_t ru_idrss; /* integral unshared data size */
1292 uint64_t ru_isrss; /* integral unshared stack size */
1293 uint64_t ru_minflt; /* page reclaims (soft page faults) */
1294 uint64_t ru_majflt; /* page faults (hard page faults) */
1295 uint64_t ru_nswap; /* swaps */
1296 uint64_t ru_inblock; /* block input operations */
1297 uint64_t ru_oublock; /* block output operations */
1298 uint64_t ru_msgsnd; /* IPC messages sent */
1299 uint64_t ru_msgrcv; /* IPC messages received */
1300 uint64_t ru_nsignals; /* signals received */
1301 uint64_t ru_nvcsw; /* voluntary context switches */
1302 uint64_t ru_nivcsw; /* involuntary context switches */
1303 } uv_rusage_t;
1304
1305 UV_EXTERN int uv_getrusage(uv_rusage_t* rusage);
1306
1307 UV_EXTERN int uv_os_homedir(char* buffer, size_t* size);
1308 UV_EXTERN int uv_os_tmpdir(char* buffer, size_t* size);
1309 UV_EXTERN int uv_os_get_passwd(uv_passwd_t* pwd);
1310 UV_EXTERN void uv_os_free_passwd(uv_passwd_t* pwd);
1311 UV_EXTERN int uv_os_get_passwd2(uv_passwd_t* pwd, uv_uid_t uid);
1312 UV_EXTERN int uv_os_get_group(uv_group_t* grp, uv_uid_t gid);
1313 UV_EXTERN void uv_os_free_group(uv_group_t* grp);
1314 UV_EXTERN uv_pid_t uv_os_getpid(void);
1315 UV_EXTERN uv_pid_t uv_os_getppid(void);
1316
1317 #if defined(__PASE__)
1318 /* On IBM i PASE, the highest process priority is -10 */
1319 # define UV_PRIORITY_LOW 39 /* RUNPTY(99) */
1320 # define UV_PRIORITY_BELOW_NORMAL 15 /* RUNPTY(50) */
1321 # define UV_PRIORITY_NORMAL 0 /* RUNPTY(20) */
1322 # define UV_PRIORITY_ABOVE_NORMAL -4 /* RUNTY(12) */
1323 # define UV_PRIORITY_HIGH -7 /* RUNPTY(6) */
1324 # define UV_PRIORITY_HIGHEST -10 /* RUNPTY(1) */
1325 #else
1326 # define UV_PRIORITY_LOW 19
1327 # define UV_PRIORITY_BELOW_NORMAL 10
1328 # define UV_PRIORITY_NORMAL 0
1329 # define UV_PRIORITY_ABOVE_NORMAL -7
1330 # define UV_PRIORITY_HIGH -14
1331 # define UV_PRIORITY_HIGHEST -20
1332 #endif
1333
1334 UV_EXTERN int uv_os_getpriority(uv_pid_t pid, int* priority);
1335 UV_EXTERN int uv_os_setpriority(uv_pid_t pid, int priority);
1336
1337 enum {
1338 UV_THREAD_PRIORITY_HIGHEST = 2,
1339 UV_THREAD_PRIORITY_ABOVE_NORMAL = 1,
1340 UV_THREAD_PRIORITY_NORMAL = 0,
1341 UV_THREAD_PRIORITY_BELOW_NORMAL = -1,
1342 UV_THREAD_PRIORITY_LOWEST = -2,
1343 };
1344
1345 UV_EXTERN int uv_thread_getpriority(uv_thread_t tid, int* priority);
1346 UV_EXTERN int uv_thread_setpriority(uv_thread_t tid, int priority);
1347
1348 UV_EXTERN unsigned int uv_available_parallelism(void);
1349 UV_EXTERN int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count);
1350 UV_EXTERN void uv_free_cpu_info(uv_cpu_info_t* cpu_infos, int count);
1351 UV_EXTERN int uv_cpumask_size(void);
1352
1353 UV_EXTERN int uv_interface_addresses(uv_interface_address_t** addresses,
1354 int* count);
1355 UV_EXTERN void uv_free_interface_addresses(uv_interface_address_t* addresses,
1356 int count);
1357
1358 struct uv_env_item_s {
1359 char* name;
1360 char* value;
1361 };
1362
1363 UV_EXTERN int uv_os_environ(uv_env_item_t** envitems, int* count);
1364 UV_EXTERN void uv_os_free_environ(uv_env_item_t* envitems, int count);
1365 UV_EXTERN int uv_os_getenv(const char* name, char* buffer, size_t* size);
1366 UV_EXTERN int uv_os_setenv(const char* name, const char* value);
1367 UV_EXTERN int uv_os_unsetenv(const char* name);
1368
1369 #ifdef MAXHOSTNAMELEN
1370 # define UV_MAXHOSTNAMESIZE (MAXHOSTNAMELEN + 1)
1371 #else
1372 /*
1373 Fallback for the maximum hostname size, including the null terminator. The
1374 Windows gethostname() documentation states that 256 bytes will always be
1375 large enough to hold the null-terminated hostname.
1376 */
1377 # define UV_MAXHOSTNAMESIZE 256
1378 #endif
1379
1380 UV_EXTERN int uv_os_gethostname(char* buffer, size_t* size);
1381
1382 UV_EXTERN int uv_os_uname(uv_utsname_t* buffer);
1383
1384 struct uv_metrics_s {
1385 uint64_t loop_count;
1386 uint64_t events;
1387 uint64_t events_waiting;
1388 /* private */
1389 uint64_t* reserved[13];
1390 };
1391
1392 UV_EXTERN int uv_metrics_info(uv_loop_t* loop, uv_metrics_t* metrics);
1393 UV_EXTERN uint64_t uv_metrics_idle_time(uv_loop_t* loop);
1394
1395 typedef enum {
1396 UV_FS_UNKNOWN = -1,
1397 UV_FS_CUSTOM,
1398 UV_FS_OPEN,
1399 UV_FS_CLOSE,
1400 UV_FS_READ,
1401 UV_FS_WRITE,
1402 UV_FS_SENDFILE,
1403 UV_FS_STAT,
1404 UV_FS_LSTAT,
1405 UV_FS_FSTAT,
1406 UV_FS_FTRUNCATE,
1407 UV_FS_UTIME,
1408 UV_FS_FUTIME,
1409 UV_FS_ACCESS,
1410 UV_FS_CHMOD,
1411 UV_FS_FCHMOD,
1412 UV_FS_FSYNC,
1413 UV_FS_FDATASYNC,
1414 UV_FS_UNLINK,
1415 UV_FS_RMDIR,
1416 UV_FS_MKDIR,
1417 UV_FS_MKDTEMP,
1418 UV_FS_RENAME,
1419 UV_FS_SCANDIR,
1420 UV_FS_LINK,
1421 UV_FS_SYMLINK,
1422 UV_FS_READLINK,
1423 UV_FS_CHOWN,
1424 UV_FS_FCHOWN,
1425 UV_FS_REALPATH,
1426 UV_FS_COPYFILE,
1427 UV_FS_LCHOWN,
1428 UV_FS_OPENDIR,
1429 UV_FS_READDIR,
1430 UV_FS_CLOSEDIR,
1431 UV_FS_STATFS,
1432 UV_FS_MKSTEMP,
1433 UV_FS_LUTIME
1434 } uv_fs_type;
1435
1436 struct uv_dir_s {
1437 uv_dirent_t* dirents;
1438 size_t nentries;
1439 void* reserved[4];
1440 UV_DIR_PRIVATE_FIELDS
1441 };
1442
1443 /* uv_fs_t is a subclass of uv_req_t. */
1444 struct uv_fs_s {
1445 UV_REQ_FIELDS
1446 uv_fs_type fs_type;
1447 uv_loop_t* loop;
1448 uv_fs_cb cb;
1449 ssize_t result;
1450 void* ptr;
1451 const char* path;
1452 uv_stat_t statbuf; /* Stores the result of uv_fs_stat() and uv_fs_fstat(). */
1453 UV_FS_PRIVATE_FIELDS
1454 };
1455
1456 UV_EXTERN uv_fs_type uv_fs_get_type(const uv_fs_t*);
1457 UV_EXTERN ssize_t uv_fs_get_result(const uv_fs_t*);
1458 UV_EXTERN int uv_fs_get_system_error(const uv_fs_t*);
1459 UV_EXTERN void* uv_fs_get_ptr(const uv_fs_t*);
1460 UV_EXTERN const char* uv_fs_get_path(const uv_fs_t*);
1461 UV_EXTERN uv_stat_t* uv_fs_get_statbuf(uv_fs_t*);
1462
1463 UV_EXTERN void uv_fs_req_cleanup(uv_fs_t* req);
1464 UV_EXTERN int uv_fs_close(uv_loop_t* loop,
1465 uv_fs_t* req,
1466 uv_file file,
1467 uv_fs_cb cb);
1468 UV_EXTERN int uv_fs_open(uv_loop_t* loop,
1469 uv_fs_t* req,
1470 const char* path,
1471 int flags,
1472 int mode,
1473 uv_fs_cb cb);
1474 UV_EXTERN int uv_fs_read(uv_loop_t* loop,
1475 uv_fs_t* req,
1476 uv_file file,
1477 const uv_buf_t bufs[],
1478 unsigned int nbufs,
1479 int64_t offset,
1480 uv_fs_cb cb);
1481 UV_EXTERN int uv_fs_unlink(uv_loop_t* loop,
1482 uv_fs_t* req,
1483 const char* path,
1484 uv_fs_cb cb);
1485 UV_EXTERN int uv_fs_write(uv_loop_t* loop,
1486 uv_fs_t* req,
1487 uv_file file,
1488 const uv_buf_t bufs[],
1489 unsigned int nbufs,
1490 int64_t offset,
1491 uv_fs_cb cb);
1492 /*
1493 * This flag can be used with uv_fs_copyfile() to return an error if the
1494 * destination already exists.
1495 */
1496 #define UV_FS_COPYFILE_EXCL 0x0001
1497
1498 /*
1499 * This flag can be used with uv_fs_copyfile() to attempt to create a reflink.
1500 * If copy-on-write is not supported, a fallback copy mechanism is used.
1501 */
1502 #define UV_FS_COPYFILE_FICLONE 0x0002
1503
1504 /*
1505 * This flag can be used with uv_fs_copyfile() to attempt to create a reflink.
1506 * If copy-on-write is not supported, an error is returned.
1507 */
1508 #define UV_FS_COPYFILE_FICLONE_FORCE 0x0004
1509
1510 UV_EXTERN int uv_fs_copyfile(uv_loop_t* loop,
1511 uv_fs_t* req,
1512 const char* path,
1513 const char* new_path,
1514 int flags,
1515 uv_fs_cb cb);
1516 UV_EXTERN int uv_fs_mkdir(uv_loop_t* loop,
1517 uv_fs_t* req,
1518 const char* path,
1519 int mode,
1520 uv_fs_cb cb);
1521 UV_EXTERN int uv_fs_mkdtemp(uv_loop_t* loop,
1522 uv_fs_t* req,
1523 const char* tpl,
1524 uv_fs_cb cb);
1525 UV_EXTERN int uv_fs_mkstemp(uv_loop_t* loop,
1526 uv_fs_t* req,
1527 const char* tpl,
1528 uv_fs_cb cb);
1529 UV_EXTERN int uv_fs_rmdir(uv_loop_t* loop,
1530 uv_fs_t* req,
1531 const char* path,
1532 uv_fs_cb cb);
1533 UV_EXTERN int uv_fs_scandir(uv_loop_t* loop,
1534 uv_fs_t* req,
1535 const char* path,
1536 int flags,
1537 uv_fs_cb cb);
1538 UV_EXTERN int uv_fs_scandir_next(uv_fs_t* req,
1539 uv_dirent_t* ent);
1540 UV_EXTERN int uv_fs_opendir(uv_loop_t* loop,
1541 uv_fs_t* req,
1542 const char* path,
1543 uv_fs_cb cb);
1544 UV_EXTERN int uv_fs_readdir(uv_loop_t* loop,
1545 uv_fs_t* req,
1546 uv_dir_t* dir,
1547 uv_fs_cb cb);
1548 UV_EXTERN int uv_fs_closedir(uv_loop_t* loop,
1549 uv_fs_t* req,
1550 uv_dir_t* dir,
1551 uv_fs_cb cb);
1552 UV_EXTERN int uv_fs_stat(uv_loop_t* loop,
1553 uv_fs_t* req,
1554 const char* path,
1555 uv_fs_cb cb);
1556 UV_EXTERN int uv_fs_fstat(uv_loop_t* loop,
1557 uv_fs_t* req,
1558 uv_file file,
1559 uv_fs_cb cb);
1560 UV_EXTERN int uv_fs_rename(uv_loop_t* loop,
1561 uv_fs_t* req,
1562 const char* path,
1563 const char* new_path,
1564 uv_fs_cb cb);
1565 UV_EXTERN int uv_fs_fsync(uv_loop_t* loop,
1566 uv_fs_t* req,
1567 uv_file file,
1568 uv_fs_cb cb);
1569 UV_EXTERN int uv_fs_fdatasync(uv_loop_t* loop,
1570 uv_fs_t* req,
1571 uv_file file,
1572 uv_fs_cb cb);
1573 UV_EXTERN int uv_fs_ftruncate(uv_loop_t* loop,
1574 uv_fs_t* req,
1575 uv_file file,
1576 int64_t offset,
1577 uv_fs_cb cb);
1578 UV_EXTERN int uv_fs_sendfile(uv_loop_t* loop,
1579 uv_fs_t* req,
1580 uv_file out_fd,
1581 uv_file in_fd,
1582 int64_t in_offset,
1583 size_t length,
1584 uv_fs_cb cb);
1585 UV_EXTERN int uv_fs_access(uv_loop_t* loop,
1586 uv_fs_t* req,
1587 const char* path,
1588 int mode,
1589 uv_fs_cb cb);
1590 UV_EXTERN int uv_fs_chmod(uv_loop_t* loop,
1591 uv_fs_t* req,
1592 const char* path,
1593 int mode,
1594 uv_fs_cb cb);
1595 UV_EXTERN int uv_fs_utime(uv_loop_t* loop,
1596 uv_fs_t* req,
1597 const char* path,
1598 double atime,
1599 double mtime,
1600 uv_fs_cb cb);
1601 UV_EXTERN int uv_fs_futime(uv_loop_t* loop,
1602 uv_fs_t* req,
1603 uv_file file,
1604 double atime,
1605 double mtime,
1606 uv_fs_cb cb);
1607 UV_EXTERN int uv_fs_lutime(uv_loop_t* loop,
1608 uv_fs_t* req,
1609 const char* path,
1610 double atime,
1611 double mtime,
1612 uv_fs_cb cb);
1613 UV_EXTERN int uv_fs_lstat(uv_loop_t* loop,
1614 uv_fs_t* req,
1615 const char* path,
1616 uv_fs_cb cb);
1617 UV_EXTERN int uv_fs_link(uv_loop_t* loop,
1618 uv_fs_t* req,
1619 const char* path,
1620 const char* new_path,
1621 uv_fs_cb cb);
1622
1623 /*
1624 * This flag can be used with uv_fs_symlink() on Windows to specify whether
1625 * path argument points to a directory.
1626 */
1627 #define UV_FS_SYMLINK_DIR 0x0001
1628
1629 /*
1630 * This flag can be used with uv_fs_symlink() on Windows to specify whether
1631 * the symlink is to be created using junction points.
1632 */
1633 #define UV_FS_SYMLINK_JUNCTION 0x0002
1634
1635 UV_EXTERN int uv_fs_symlink(uv_loop_t* loop,
1636 uv_fs_t* req,
1637 const char* path,
1638 const char* new_path,
1639 int flags,
1640 uv_fs_cb cb);
1641 UV_EXTERN int uv_fs_readlink(uv_loop_t* loop,
1642 uv_fs_t* req,
1643 const char* path,
1644 uv_fs_cb cb);
1645 UV_EXTERN int uv_fs_realpath(uv_loop_t* loop,
1646 uv_fs_t* req,
1647 const char* path,
1648 uv_fs_cb cb);
1649 UV_EXTERN int uv_fs_fchmod(uv_loop_t* loop,
1650 uv_fs_t* req,
1651 uv_file file,
1652 int mode,
1653 uv_fs_cb cb);
1654 UV_EXTERN int uv_fs_chown(uv_loop_t* loop,
1655 uv_fs_t* req,
1656 const char* path,
1657 uv_uid_t uid,
1658 uv_gid_t gid,
1659 uv_fs_cb cb);
1660 UV_EXTERN int uv_fs_fchown(uv_loop_t* loop,
1661 uv_fs_t* req,
1662 uv_file file,
1663 uv_uid_t uid,
1664 uv_gid_t gid,
1665 uv_fs_cb cb);
1666 UV_EXTERN int uv_fs_lchown(uv_loop_t* loop,
1667 uv_fs_t* req,
1668 const char* path,
1669 uv_uid_t uid,
1670 uv_gid_t gid,
1671 uv_fs_cb cb);
1672 UV_EXTERN int uv_fs_statfs(uv_loop_t* loop,
1673 uv_fs_t* req,
1674 const char* path,
1675 uv_fs_cb cb);
1676
1677
1678 enum uv_fs_event {
1679 UV_RENAME = 1,
1680 UV_CHANGE = 2
1681 };
1682
1683
1684 struct uv_fs_event_s {
1685 UV_HANDLE_FIELDS
1686 /* private */
1687 char* path;
1688 UV_FS_EVENT_PRIVATE_FIELDS
1689 };
1690
1691
1692 /*
1693 * uv_fs_stat() based polling file watcher.
1694 */
1695 struct uv_fs_poll_s {
1696 UV_HANDLE_FIELDS
1697 /* Private, don't touch. */
1698 void* poll_ctx;
1699 };
1700
1701 UV_EXTERN int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle);
1702 UV_EXTERN int uv_fs_poll_start(uv_fs_poll_t* handle,
1703 uv_fs_poll_cb poll_cb,
1704 const char* path,
1705 unsigned int interval);
1706 UV_EXTERN int uv_fs_poll_stop(uv_fs_poll_t* handle);
1707 UV_EXTERN int uv_fs_poll_getpath(uv_fs_poll_t* handle,
1708 char* buffer,
1709 size_t* size);
1710
1711
1712 struct uv_signal_s {
1713 UV_HANDLE_FIELDS
1714 uv_signal_cb signal_cb;
1715 int signum;
1716 UV_SIGNAL_PRIVATE_FIELDS
1717 };
1718
1719 UV_EXTERN int uv_signal_init(uv_loop_t* loop, uv_signal_t* handle);
1720 UV_EXTERN int uv_signal_start(uv_signal_t* handle,
1721 uv_signal_cb signal_cb,
1722 int signum);
1723 UV_EXTERN int uv_signal_start_oneshot(uv_signal_t* handle,
1724 uv_signal_cb signal_cb,
1725 int signum);
1726 UV_EXTERN int uv_signal_stop(uv_signal_t* handle);
1727
1728 UV_EXTERN void uv_loadavg(double avg[3]);
1729
1730
1731 /*
1732 * Flags to be passed to uv_fs_event_start().
1733 */
1734 enum uv_fs_event_flags {
1735 /*
1736 * By default, if the fs event watcher is given a directory name, we will
1737 * watch for all events in that directory. This flags overrides this behavior
1738 * and makes fs_event report only changes to the directory entry itself. This
1739 * flag does not affect individual files watched.
1740 * This flag is currently not implemented yet on any backend.
1741 */
1742 UV_FS_EVENT_WATCH_ENTRY = 1,
1743
1744 /*
1745 * By default uv_fs_event will try to use a kernel interface such as inotify
1746 * or kqueue to detect events. This may not work on remote filesystems such
1747 * as NFS mounts. This flag makes fs_event fall back to calling stat() on a
1748 * regular interval.
1749 * This flag is currently not implemented yet on any backend.
1750 */
1751 UV_FS_EVENT_STAT = 2,
1752
1753 /*
1754 * By default, event watcher, when watching directory, is not registering
1755 * (is ignoring) changes in it's subdirectories.
1756 * This flag will override this behaviour on platforms that support it.
1757 */
1758 UV_FS_EVENT_RECURSIVE = 4
1759 };
1760
1761
1762 UV_EXTERN int uv_fs_event_init(uv_loop_t* loop, uv_fs_event_t* handle);
1763 UV_EXTERN int uv_fs_event_start(uv_fs_event_t* handle,
1764 uv_fs_event_cb cb,
1765 const char* path,
1766 unsigned int flags);
1767 UV_EXTERN int uv_fs_event_stop(uv_fs_event_t* handle);
1768 UV_EXTERN int uv_fs_event_getpath(uv_fs_event_t* handle,
1769 char* buffer,
1770 size_t* size);
1771
1772 UV_EXTERN int uv_ip4_addr(const char* ip, int port, struct sockaddr_in* addr);
1773 UV_EXTERN int uv_ip6_addr(const char* ip, int port, struct sockaddr_in6* addr);
1774
1775 UV_EXTERN int uv_ip4_name(const struct sockaddr_in* src, char* dst, size_t size);
1776 UV_EXTERN int uv_ip6_name(const struct sockaddr_in6* src, char* dst, size_t size);
1777 UV_EXTERN int uv_ip_name(const struct sockaddr* src, char* dst, size_t size);
1778
1779 UV_EXTERN int uv_inet_ntop(int af, const void* src, char* dst, size_t size);
1780 UV_EXTERN int uv_inet_pton(int af, const char* src, void* dst);
1781
1782
1783 struct uv_random_s {
1784 UV_REQ_FIELDS
1785 /* read-only */
1786 uv_loop_t* loop;
1787 /* private */
1788 int status;
1789 void* buf;
1790 size_t buflen;
1791 uv_random_cb cb;
1792 struct uv__work work_req;
1793 };
1794
1795 UV_EXTERN int uv_random(uv_loop_t* loop,
1796 uv_random_t* req,
1797 void *buf,
1798 size_t buflen,
1799 unsigned flags, /* For future extension; must be 0. */
1800 uv_random_cb cb);
1801
1802 #if defined(IF_NAMESIZE)
1803 # define UV_IF_NAMESIZE (IF_NAMESIZE + 1)
1804 #elif defined(IFNAMSIZ)
1805 # define UV_IF_NAMESIZE (IFNAMSIZ + 1)
1806 #else
1807 # define UV_IF_NAMESIZE (16 + 1)
1808 #endif
1809
1810 UV_EXTERN int uv_if_indextoname(unsigned int ifindex,
1811 char* buffer,
1812 size_t* size);
1813 UV_EXTERN int uv_if_indextoiid(unsigned int ifindex,
1814 char* buffer,
1815 size_t* size);
1816
1817 UV_EXTERN int uv_exepath(char* buffer, size_t* size);
1818
1819 UV_EXTERN int uv_cwd(char* buffer, size_t* size);
1820
1821 UV_EXTERN int uv_chdir(const char* dir);
1822
1823 UV_EXTERN uint64_t uv_get_free_memory(void);
1824 UV_EXTERN uint64_t uv_get_total_memory(void);
1825 UV_EXTERN uint64_t uv_get_constrained_memory(void);
1826 UV_EXTERN uint64_t uv_get_available_memory(void);
1827
1828 UV_EXTERN int uv_clock_gettime(uv_clock_id clock_id, uv_timespec64_t* ts);
1829 UV_EXTERN uint64_t uv_hrtime(void);
1830 UV_EXTERN void uv_sleep(unsigned int msec);
1831
1832 UV_EXTERN void uv_disable_stdio_inheritance(void);
1833
1834 UV_EXTERN int uv_dlopen(const char* filename, uv_lib_t* lib);
1835 UV_EXTERN void uv_dlclose(uv_lib_t* lib);
1836 UV_EXTERN int uv_dlsym(uv_lib_t* lib, const char* name, void** ptr);
1837 UV_EXTERN const char* uv_dlerror(const uv_lib_t* lib);
1838
1839 UV_EXTERN int uv_mutex_init(uv_mutex_t* handle);
1840 UV_EXTERN int uv_mutex_init_recursive(uv_mutex_t* handle);
1841 UV_EXTERN void uv_mutex_destroy(uv_mutex_t* handle);
1842 UV_EXTERN void uv_mutex_lock(uv_mutex_t* handle);
1843 UV_EXTERN int uv_mutex_trylock(uv_mutex_t* handle);
1844 UV_EXTERN void uv_mutex_unlock(uv_mutex_t* handle);
1845
1846 UV_EXTERN int uv_rwlock_init(uv_rwlock_t* rwlock);
1847 UV_EXTERN void uv_rwlock_destroy(uv_rwlock_t* rwlock);
1848 UV_EXTERN void uv_rwlock_rdlock(uv_rwlock_t* rwlock);
1849 UV_EXTERN int uv_rwlock_tryrdlock(uv_rwlock_t* rwlock);
1850 UV_EXTERN void uv_rwlock_rdunlock(uv_rwlock_t* rwlock);
1851 UV_EXTERN void uv_rwlock_wrlock(uv_rwlock_t* rwlock);
1852 UV_EXTERN int uv_rwlock_trywrlock(uv_rwlock_t* rwlock);
1853 UV_EXTERN void uv_rwlock_wrunlock(uv_rwlock_t* rwlock);
1854
1855 UV_EXTERN int uv_sem_init(uv_sem_t* sem, unsigned int value);
1856 UV_EXTERN void uv_sem_destroy(uv_sem_t* sem);
1857 UV_EXTERN void uv_sem_post(uv_sem_t* sem);
1858 UV_EXTERN void uv_sem_wait(uv_sem_t* sem);
1859 UV_EXTERN int uv_sem_trywait(uv_sem_t* sem);
1860
1861 UV_EXTERN int uv_cond_init(uv_cond_t* cond);
1862 UV_EXTERN void uv_cond_destroy(uv_cond_t* cond);
1863 UV_EXTERN void uv_cond_signal(uv_cond_t* cond);
1864 UV_EXTERN void uv_cond_broadcast(uv_cond_t* cond);
1865
1866 UV_EXTERN int uv_barrier_init(uv_barrier_t* barrier, unsigned int count);
1867 UV_EXTERN void uv_barrier_destroy(uv_barrier_t* barrier);
1868 UV_EXTERN int uv_barrier_wait(uv_barrier_t* barrier);
1869
1870 UV_EXTERN void uv_cond_wait(uv_cond_t* cond, uv_mutex_t* mutex);
1871 UV_EXTERN int uv_cond_timedwait(uv_cond_t* cond,
1872 uv_mutex_t* mutex,
1873 uint64_t timeout);
1874
1875 UV_EXTERN void uv_once(uv_once_t* guard, void (*callback)(void));
1876
1877 UV_EXTERN int uv_key_create(uv_key_t* key);
1878 UV_EXTERN void uv_key_delete(uv_key_t* key);
1879 UV_EXTERN void* uv_key_get(uv_key_t* key);
1880 UV_EXTERN void uv_key_set(uv_key_t* key, void* value);
1881
1882 UV_EXTERN int uv_gettimeofday(uv_timeval64_t* tv);
1883
1884 typedef void (*uv_thread_cb)(void* arg);
1885
1886 UV_EXTERN int uv_thread_create(uv_thread_t* tid, uv_thread_cb entry, void* arg);
1887
1888 typedef enum {
1889 UV_THREAD_NO_FLAGS = 0x00,
1890 UV_THREAD_HAS_STACK_SIZE = 0x01
1891 } uv_thread_create_flags;
1892
1893 struct uv_thread_options_s {
1894 unsigned int flags;
1895 size_t stack_size;
1896 /* More fields may be added at any time. */
1897 };
1898
1899 typedef struct uv_thread_options_s uv_thread_options_t;
1900
1901 UV_EXTERN int uv_thread_create_ex(uv_thread_t* tid,
1902 const uv_thread_options_t* params,
1903 uv_thread_cb entry,
1904 void* arg);
1905 UV_EXTERN int uv_thread_setaffinity(uv_thread_t* tid,
1906 char* cpumask,
1907 char* oldmask,
1908 size_t mask_size);
1909 UV_EXTERN int uv_thread_getaffinity(uv_thread_t* tid,
1910 char* cpumask,
1911 size_t mask_size);
1912 UV_EXTERN int uv_thread_getcpu(void);
1913 UV_EXTERN uv_thread_t uv_thread_self(void);
1914 UV_EXTERN int uv_thread_join(uv_thread_t *tid);
1915 UV_EXTERN int uv_thread_equal(const uv_thread_t* t1, const uv_thread_t* t2);
1916
1917 /* The presence of these unions force similar struct layout. */
1918 #define XX(_, name) uv_ ## name ## _t name;
1919 union uv_any_handle {
1920 UV_HANDLE_TYPE_MAP(XX)
1921 };
1922
1923 union uv_any_req {
1924 UV_REQ_TYPE_MAP(XX)
1925 };
1926 #undef XX
1927
1928 typedef void (*uv_io_cb)(void* work, int status);
1929 typedef void (*uv_post_task)(void* handler, uv_io_cb func, void* work, int status, int prio);
1930
1931 struct uv_loop_data {
1932 void* event_handler;
1933 uv_post_task post_task_func;
1934 };
1935
1936 struct uv_loop_s {
1937 /* User data - use this for whatever. */
1938 void* data;
1939 /* Loop reference counting. */
1940 unsigned int active_handles;
1941 struct uv__queue handle_queue;
1942 union {
1943 void* unused;
1944 unsigned int count;
1945 } active_reqs;
1946 /* Internal storage for future extensions. */
1947 void* internal_fields;
1948 /* Internal flag to signal loop stop. */
1949 unsigned int stop_flag;
1950 UV_LOOP_PRIVATE_FIELDS
1951 };
1952
1953 UV_EXTERN void* uv_loop_get_data(const uv_loop_t*);
1954 UV_EXTERN void uv_loop_set_data(uv_loop_t*, void* data);
1955 UV_EXTERN int uv_register_task_to_event(struct uv_loop_s* loop, uv_post_task func, void* handler);
1956 UV_EXTERN int uv_unregister_task_to_event(struct uv_loop_s* loop);
1957 UV_EXTERN int uv_check_data_valid(struct uv_loop_data* data);
1958
1959 /* String utilities needed internally for dealing with Windows. */
1960 size_t uv_utf16_length_as_wtf8(const uint16_t* utf16,
1961 ssize_t utf16_len);
1962 int uv_utf16_to_wtf8(const uint16_t* utf16,
1963 ssize_t utf16_len,
1964 char** wtf8_ptr,
1965 size_t* wtf8_len_ptr);
1966 ssize_t uv_wtf8_length_as_utf16(const char* wtf8);
1967 void uv_wtf8_to_utf16(const char* wtf8,
1968 uint16_t* utf16,
1969 size_t utf16_len);
1970
1971 /* Don't export the private CPP symbols. */
1972 #undef UV_HANDLE_TYPE_PRIVATE
1973 #undef UV_REQ_TYPE_PRIVATE
1974 #undef UV_REQ_PRIVATE_FIELDS
1975 #undef UV_STREAM_PRIVATE_FIELDS
1976 #undef UV_TCP_PRIVATE_FIELDS
1977 #undef UV_PREPARE_PRIVATE_FIELDS
1978 #undef UV_CHECK_PRIVATE_FIELDS
1979 #undef UV_IDLE_PRIVATE_FIELDS
1980 #undef UV_ASYNC_PRIVATE_FIELDS
1981 #undef UV_TIMER_PRIVATE_FIELDS
1982 #undef UV_GETADDRINFO_PRIVATE_FIELDS
1983 #undef UV_GETNAMEINFO_PRIVATE_FIELDS
1984 #undef UV_FS_REQ_PRIVATE_FIELDS
1985 #undef UV_WORK_PRIVATE_FIELDS
1986 #undef UV_FS_EVENT_PRIVATE_FIELDS
1987 #undef UV_SIGNAL_PRIVATE_FIELDS
1988 #undef UV_LOOP_PRIVATE_FIELDS
1989 #undef UV_LOOP_PRIVATE_PLATFORM_FIELDS
1990 #undef UV__ERR
1991
1992 #ifdef __cplusplus
1993 }
1994 #endif
1995 #endif /* UV_H */
1996