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