Coverage Report

Created: 2026-03-12 06:35

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/CMake/Utilities/cmlibuv/include/uv.h
Line
Count
Source
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 defined(__GNUC__)
48
# define UV_EXTERN __attribute__((visibility("default")))
49
#else
50
# define UV_EXTERN /* nothing */
51
#endif
52
#endif /* UV_EXTERN */
53
54
#include "uv/errno.h"
55
#include "uv/version.h"
56
#include <stddef.h>
57
#include <stdio.h>
58
#include <stdint.h>
59
#include <math.h>
60
61
/* Internal type, do not use. */
62
struct uv__queue {
63
  struct uv__queue* next;
64
  struct uv__queue* prev;
65
};
66
67
#if defined(_WIN32)
68
# include "uv/win.h"
69
#else
70
# include "uv/unix.h"
71
#endif
72
73
/* Expand this list if necessary. */
74
#define UV_ERRNO_MAP(XX)                                                      \
75
0
  XX(E2BIG, "argument list too long")                                         \
76
0
  XX(EACCES, "permission denied")                                             \
77
0
  XX(EADDRINUSE, "address already in use")                                    \
78
0
  XX(EADDRNOTAVAIL, "address not available")                                  \
79
0
  XX(EAFNOSUPPORT, "address family not supported")                            \
80
0
  XX(EAGAIN, "resource temporarily unavailable")                              \
81
0
  XX(EAI_ADDRFAMILY, "address family not supported")                          \
82
0
  XX(EAI_AGAIN, "temporary failure")                                          \
83
0
  XX(EAI_BADFLAGS, "bad ai_flags value")                                      \
84
0
  XX(EAI_BADHINTS, "invalid value for hints")                                 \
85
0
  XX(EAI_CANCELED, "request canceled")                                        \
86
0
  XX(EAI_FAIL, "permanent failure")                                           \
87
0
  XX(EAI_FAMILY, "ai_family not supported")                                   \
88
0
  XX(EAI_MEMORY, "out of memory")                                             \
89
0
  XX(EAI_NODATA, "no address")                                                \
90
0
  XX(EAI_NONAME, "unknown node or service")                                   \
91
0
  XX(EAI_OVERFLOW, "argument buffer overflow")                                \
92
0
  XX(EAI_PROTOCOL, "resolved protocol is unknown")                            \
93
0
  XX(EAI_SERVICE, "service not available for socket type")                    \
94
0
  XX(EAI_SOCKTYPE, "socket type not supported")                               \
95
0
  XX(EALREADY, "connection already in progress")                              \
96
0
  XX(EBADF, "bad file descriptor")                                            \
97
0
  XX(EBUSY, "resource busy or locked")                                        \
98
0
  XX(ECANCELED, "operation canceled")                                         \
99
0
  XX(ECHARSET, "invalid Unicode character")                                   \
100
0
  XX(ECONNABORTED, "software caused connection abort")                        \
101
0
  XX(ECONNREFUSED, "connection refused")                                      \
102
0
  XX(ECONNRESET, "connection reset by peer")                                  \
103
0
  XX(EDESTADDRREQ, "destination address required")                            \
104
0
  XX(EEXIST, "file already exists")                                           \
105
0
  XX(EFAULT, "bad address in system call argument")                           \
106
0
  XX(EFBIG, "file too large")                                                 \
107
0
  XX(EHOSTUNREACH, "host is unreachable")                                     \
108
0
  XX(EINTR, "interrupted system call")                                        \
109
0
  XX(EINVAL, "invalid argument")                                              \
110
0
  XX(EIO, "i/o error")                                                        \
111
0
  XX(EISCONN, "socket is already connected")                                  \
112
0
  XX(EISDIR, "illegal operation on a directory")                              \
113
0
  XX(ELOOP, "too many symbolic links encountered")                            \
114
0
  XX(EMFILE, "too many open files")                                           \
115
0
  XX(EMSGSIZE, "message too long")                                            \
116
0
  XX(ENAMETOOLONG, "name too long")                                           \
117
0
  XX(ENETDOWN, "network is down")                                             \
118
0
  XX(ENETUNREACH, "network is unreachable")                                   \
119
0
  XX(ENFILE, "file table overflow")                                           \
120
0
  XX(ENOBUFS, "no buffer space available")                                    \
121
0
  XX(ENODEV, "no such device")                                                \
122
0
  XX(ENOENT, "no such file or directory")                                     \
123
0
  XX(ENOMEM, "not enough memory")                                             \
124
0
  XX(ENONET, "machine is not on the network")                                 \
125
0
  XX(ENOPROTOOPT, "protocol not available")                                   \
126
0
  XX(ENOSPC, "no space left on device")                                       \
127
0
  XX(ENOSYS, "function not implemented")                                      \
128
0
  XX(ENOTCONN, "socket is not connected")                                     \
129
0
  XX(ENOTDIR, "not a directory")                                              \
130
0
  XX(ENOTEMPTY, "directory not empty")                                        \
131
0
  XX(ENOTSOCK, "socket operation on non-socket")                              \
132
0
  XX(ENOTSUP, "operation not supported on socket")                            \
133
0
  XX(EOVERFLOW, "value too large for defined data type")                      \
134
0
  XX(EPERM, "operation not permitted")                                        \
135
0
  XX(EPIPE, "broken pipe")                                                    \
136
0
  XX(EPROTO, "protocol error")                                                \
137
0
  XX(EPROTONOSUPPORT, "protocol not supported")                               \
138
0
  XX(EPROTOTYPE, "protocol wrong type for socket")                            \
139
0
  XX(ERANGE, "result too large")                                              \
140
0
  XX(EROFS, "read-only file system")                                          \
141
0
  XX(ESHUTDOWN, "cannot send after transport endpoint shutdown")              \
142
0
  XX(ESPIPE, "invalid seek")                                                  \
143
0
  XX(ESRCH, "no such process")                                                \
144
0
  XX(ETIMEDOUT, "connection timed out")                                       \
145
0
  XX(ETXTBSY, "text file is busy")                                            \
146
0
  XX(EXDEV, "cross-device link not permitted")                                \
147
0
  XX(UNKNOWN, "unknown error")                                                \
148
0
  XX(EOF, "end of file")                                                      \
149
0
  XX(ENXIO, "no such device or address")                                      \
150
0
  XX(EMLINK, "too many links")                                                \
151
0
  XX(EHOSTDOWN, "host is down")                                               \
152
0
  XX(EREMOTEIO, "remote I/O error")                                           \
153
0
  XX(ENOTTY, "inappropriate ioctl for device")                                \
154
0
  XX(EFTYPE, "inappropriate file type or format")                             \
155
0
  XX(EILSEQ, "illegal byte sequence")                                         \
156
0
  XX(ESOCKTNOSUPPORT, "socket type not supported")                            \
157
0
  XX(ENODATA, "no data available")                                            \
158
0
  XX(EUNATCH, "protocol driver not attached")                                 \
159
0
  XX(ENOEXEC, "exec format error")                                            \
160
161
#define UV_HANDLE_TYPE_MAP(XX)                                                \
162
0
  XX(ASYNC, async)                                                            \
163
0
  XX(CHECK, check)                                                            \
164
0
  XX(FS_EVENT, fs_event)                                                      \
165
0
  XX(FS_POLL, fs_poll)                                                        \
166
0
  XX(HANDLE, handle)                                                          \
167
0
  XX(IDLE, idle)                                                              \
168
0
  XX(NAMED_PIPE, pipe)                                                        \
169
0
  XX(POLL, poll)                                                              \
170
0
  XX(PREPARE, prepare)                                                        \
171
0
  XX(PROCESS, process)                                                        \
172
0
  XX(STREAM, stream)                                                          \
173
0
  XX(TCP, tcp)                                                                \
174
0
  XX(TIMER, timer)                                                            \
175
0
  XX(TTY, tty)                                                                \
176
0
  XX(UDP, udp)                                                                \
177
0
  XX(SIGNAL, signal)                                                          \
178
179
#define UV_REQ_TYPE_MAP(XX)                                                   \
180
0
  XX(REQ, req)                                                                \
181
0
  XX(CONNECT, connect)                                                        \
182
0
  XX(WRITE, write)                                                            \
183
0
  XX(SHUTDOWN, shutdown)                                                      \
184
0
  XX(UDP_SEND, udp_send)                                                      \
185
0
  XX(FS, fs)                                                                  \
186
0
  XX(WORK, work)                                                              \
187
0
  XX(GETADDRINFO, getaddrinfo)                                                \
188
0
  XX(GETNAMEINFO, getnameinfo)                                                \
189
0
  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
0
#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_keepalive_ex(uv_tcp_t* handle,
606
                                  int on,
607
                                  unsigned int idle,
608
                                  unsigned int intvl,
609
                                  unsigned int cnt);
610
UV_EXTERN int uv_tcp_simultaneous_accepts(uv_tcp_t* handle, int enable);
611
612
enum uv_tcp_flags {
613
  /* Used with uv_tcp_bind, when an IPv6 address is used. */
614
  UV_TCP_IPV6ONLY = 1,
615
616
  /* Enable SO_REUSEPORT socket option when binding the handle.
617
   * This allows completely duplicate bindings by multiple processes
618
   * or threads if they all set SO_REUSEPORT before binding the port.
619
   * Incoming connections are distributed across the participating
620
   * listener sockets.
621
   *
622
   * This flag is available only on Linux 3.9+, DragonFlyBSD 3.6+,
623
   * FreeBSD 12.0+, Solaris 11.4, and AIX 7.2.5+ for now.
624
   */
625
  UV_TCP_REUSEPORT = 2,
626
};
627
628
UV_EXTERN int uv_tcp_bind(uv_tcp_t* handle,
629
                          const struct sockaddr* addr,
630
                          unsigned int flags);
631
UV_EXTERN int uv_tcp_getsockname(const uv_tcp_t* handle,
632
                                 struct sockaddr* name,
633
                                 int* namelen);
634
UV_EXTERN int uv_tcp_getpeername(const uv_tcp_t* handle,
635
                                 struct sockaddr* name,
636
                                 int* namelen);
637
UV_EXTERN int uv_tcp_close_reset(uv_tcp_t* handle, uv_close_cb close_cb);
638
UV_EXTERN int uv_tcp_connect(uv_connect_t* req,
639
                             uv_tcp_t* handle,
640
                             const struct sockaddr* addr,
641
                             uv_connect_cb cb);
642
643
/* uv_connect_t is a subclass of uv_req_t. */
644
struct uv_connect_s {
645
  UV_REQ_FIELDS
646
  uv_connect_cb cb;
647
  uv_stream_t* handle;
648
  UV_CONNECT_PRIVATE_FIELDS
649
};
650
651
652
/*
653
 * UDP support.
654
 */
655
656
enum uv_udp_flags {
657
  /* Disables dual stack mode. */
658
  UV_UDP_IPV6ONLY = 1,
659
  /*
660
   * Indicates message was truncated because read buffer was too small. The
661
   * remainder was discarded by the OS. Used in uv_udp_recv_cb.
662
   */
663
  UV_UDP_PARTIAL = 2,
664
  /*
665
   * Indicates if SO_REUSEADDR will be set when binding the handle.
666
   * This sets the SO_REUSEPORT socket flag on the BSDs (except for
667
   * DragonFlyBSD), OS X, and other platforms where SO_REUSEPORTs don't
668
   * have the capability of load balancing, as the opposite of what
669
   * UV_UDP_REUSEPORT would do. On other Unix platforms, it sets the
670
   * SO_REUSEADDR flag. What that means is that multiple threads or
671
   * processes can bind to the same address without error (provided
672
   * they all set the flag) but only the last one to bind will receive
673
   * any traffic, in effect "stealing" the port from the previous listener.
674
   */
675
  UV_UDP_REUSEADDR = 4,
676
  /*
677
   * Indicates that the message was received by recvmmsg, so the buffer provided
678
   * must not be freed by the recv_cb callback.
679
   */
680
  UV_UDP_MMSG_CHUNK = 8,
681
  /*
682
   * Indicates that the buffer provided has been fully utilized by recvmmsg and
683
   * that it should now be freed by the recv_cb callback. When this flag is set
684
   * in uv_udp_recv_cb, nread will always be 0 and addr will always be NULL.
685
   */
686
  UV_UDP_MMSG_FREE = 16,
687
  /*
688
   * Indicates if IP_RECVERR/IPV6_RECVERR will be set when binding the handle.
689
   * This sets IP_RECVERR for IPv4 and IPV6_RECVERR for IPv6 UDP sockets on
690
   * Linux. This stops the Linux kernel from suppressing some ICMP error
691
   * messages and enables full ICMP error reporting for faster failover.
692
   * This flag is no-op on platforms other than Linux.
693
   */
694
  UV_UDP_LINUX_RECVERR = 32,
695
  /*
696
   * Indicates if SO_REUSEPORT will be set when binding the handle.
697
   * This sets the SO_REUSEPORT socket option on supported platforms.
698
   * Unlike UV_UDP_REUSEADDR, this flag will make multiple threads or
699
   * processes that are binding to the same address and port "share"
700
   * the port, which means incoming datagrams are distributed across
701
   * the receiving sockets among threads or processes.
702
   *
703
   * This flag is available only on Linux 3.9+, DragonFlyBSD 3.6+,
704
   * FreeBSD 12.0+, Solaris 11.4, and AIX 7.2.5+ for now.
705
   */
706
  UV_UDP_REUSEPORT = 64,
707
  /*
708
   * Indicates that recvmmsg should be used, if available.
709
   */
710
  UV_UDP_RECVMMSG = 256
711
};
712
713
typedef void (*uv_udp_send_cb)(uv_udp_send_t* req, int status);
714
typedef void (*uv_udp_recv_cb)(uv_udp_t* handle,
715
                               ssize_t nread,
716
                               const uv_buf_t* buf,
717
                               const struct sockaddr* addr,
718
                               unsigned flags);
719
720
/* uv_udp_t is a subclass of uv_handle_t. */
721
struct uv_udp_s {
722
  UV_HANDLE_FIELDS
723
  /* read-only */
724
  /*
725
   * Number of bytes queued for sending. This field strictly shows how much
726
   * information is currently queued.
727
   */
728
  size_t send_queue_size;
729
  /*
730
   * Number of send requests currently in the queue awaiting to be processed.
731
   */
732
  size_t send_queue_count;
733
  UV_UDP_PRIVATE_FIELDS
734
};
735
736
/* uv_udp_send_t is a subclass of uv_req_t. */
737
struct uv_udp_send_s {
738
  UV_REQ_FIELDS
739
  uv_udp_t* handle;
740
  uv_udp_send_cb cb;
741
  UV_UDP_SEND_PRIVATE_FIELDS
742
};
743
744
UV_EXTERN int uv_udp_init(uv_loop_t*, uv_udp_t* handle);
745
UV_EXTERN int uv_udp_init_ex(uv_loop_t*, uv_udp_t* handle, unsigned int flags);
746
UV_EXTERN int uv_udp_open(uv_udp_t* handle, uv_os_sock_t sock);
747
UV_EXTERN int uv_udp_open_ex(uv_udp_t* handle,
748
                             uv_os_sock_t sock,
749
                             unsigned int flags);
750
UV_EXTERN int uv_udp_bind(uv_udp_t* handle,
751
                          const struct sockaddr* addr,
752
                          unsigned int flags);
753
UV_EXTERN int uv_udp_connect(uv_udp_t* handle, const struct sockaddr* addr);
754
755
UV_EXTERN int uv_udp_getpeername(const uv_udp_t* handle,
756
                                 struct sockaddr* name,
757
                                 int* namelen);
758
UV_EXTERN int uv_udp_getsockname(const uv_udp_t* handle,
759
                                 struct sockaddr* name,
760
                                 int* namelen);
761
UV_EXTERN int uv_udp_set_membership(uv_udp_t* handle,
762
                                    const char* multicast_addr,
763
                                    const char* interface_addr,
764
                                    uv_membership membership);
765
UV_EXTERN int uv_udp_set_source_membership(uv_udp_t* handle,
766
                                           const char* multicast_addr,
767
                                           const char* interface_addr,
768
                                           const char* source_addr,
769
                                           uv_membership membership);
770
UV_EXTERN int uv_udp_set_multicast_loop(uv_udp_t* handle, int on);
771
UV_EXTERN int uv_udp_set_multicast_ttl(uv_udp_t* handle, int ttl);
772
UV_EXTERN int uv_udp_set_multicast_interface(uv_udp_t* handle,
773
                                             const char* interface_addr);
774
UV_EXTERN int uv_udp_set_broadcast(uv_udp_t* handle, int on);
775
UV_EXTERN int uv_udp_set_ttl(uv_udp_t* handle, int ttl);
776
UV_EXTERN int uv_udp_send(uv_udp_send_t* req,
777
                          uv_udp_t* handle,
778
                          const uv_buf_t bufs[],
779
                          unsigned int nbufs,
780
                          const struct sockaddr* addr,
781
                          uv_udp_send_cb send_cb);
782
UV_EXTERN int uv_udp_try_send(uv_udp_t* handle,
783
                              const uv_buf_t bufs[],
784
                              unsigned int nbufs,
785
                              const struct sockaddr* addr);
786
UV_EXTERN int uv_udp_try_send2(uv_udp_t* handle,
787
                               unsigned int count,
788
                               uv_buf_t* bufs[/*count*/],
789
                               unsigned int nbufs[/*count*/],
790
                               struct sockaddr* addrs[/*count*/],
791
                               unsigned int flags);
792
UV_EXTERN int uv_udp_recv_start(uv_udp_t* handle,
793
                                uv_alloc_cb alloc_cb,
794
                                uv_udp_recv_cb recv_cb);
795
UV_EXTERN int uv_udp_using_recvmmsg(const uv_udp_t* handle);
796
UV_EXTERN int uv_udp_recv_stop(uv_udp_t* handle);
797
UV_EXTERN size_t uv_udp_get_send_queue_size(const uv_udp_t* handle);
798
UV_EXTERN size_t uv_udp_get_send_queue_count(const uv_udp_t* handle);
799
800
801
/*
802
 * uv_tty_t is a subclass of uv_stream_t.
803
 *
804
 * Representing a stream for the console.
805
 */
806
struct uv_tty_s {
807
  UV_HANDLE_FIELDS
808
  UV_STREAM_FIELDS
809
  UV_TTY_PRIVATE_FIELDS
810
};
811
812
typedef enum {
813
  /* Initial/normal terminal mode */
814
  UV_TTY_MODE_NORMAL,
815
  /*
816
   * Raw input mode (On Windows, ENABLE_WINDOW_INPUT is also enabled).
817
   * May become equivalent to UV_TTY_MODE_RAW_VT in future libuv versions.
818
   */
819
  UV_TTY_MODE_RAW,
820
  /* Binary-safe I/O mode for IPC (Unix-only) */
821
  UV_TTY_MODE_IO,
822
  /* Raw input mode. On Windows ENABLE_VIRTUAL_TERMINAL_INPUT is also set. */
823
  UV_TTY_MODE_RAW_VT
824
} uv_tty_mode_t;
825
826
typedef enum {
827
  /*
828
   * The console supports handling of virtual terminal sequences
829
   * (Windows10 new console, ConEmu)
830
   */
831
  UV_TTY_SUPPORTED,
832
  /* The console cannot process the virtual terminal sequence.  (Legacy
833
   * console)
834
   */
835
  UV_TTY_UNSUPPORTED
836
} uv_tty_vtermstate_t;
837
838
839
UV_EXTERN int uv_tty_init(uv_loop_t*, uv_tty_t*, uv_file fd, int readable);
840
UV_EXTERN int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode);
841
UV_EXTERN int uv_tty_reset_mode(void);
842
UV_EXTERN int uv_tty_get_winsize(uv_tty_t*, int* width, int* height);
843
UV_EXTERN void uv_tty_set_vterm_state(uv_tty_vtermstate_t state);
844
UV_EXTERN int uv_tty_get_vterm_state(uv_tty_vtermstate_t* state);
845
846
#ifdef __cplusplus
847
extern "C++" {
848
849
0
inline int uv_tty_set_mode(uv_tty_t* handle, int mode) {
850
0
  return uv_tty_set_mode(handle, static_cast<uv_tty_mode_t>(mode));
851
0
}
852
853
}
854
#endif
855
856
UV_EXTERN uv_handle_type uv_guess_handle(uv_file file);
857
858
enum {
859
  UV_PIPE_NO_TRUNCATE = 1u << 0
860
};
861
862
/*
863
 * uv_pipe_t is a subclass of uv_stream_t.
864
 *
865
 * Representing a pipe stream or pipe server. On Windows this is a Named
866
 * Pipe. On Unix this is a Unix domain socket.
867
 */
868
struct uv_pipe_s {
869
  UV_HANDLE_FIELDS
870
  UV_STREAM_FIELDS
871
  int ipc; /* non-zero if this pipe is used for passing handles */
872
  UV_PIPE_PRIVATE_FIELDS
873
};
874
875
UV_EXTERN int uv_pipe_init(uv_loop_t*, uv_pipe_t* handle, int ipc);
876
UV_EXTERN int uv_pipe_open(uv_pipe_t*, uv_file file);
877
UV_EXTERN int uv_pipe_bind(uv_pipe_t* handle, const char* name);
878
UV_EXTERN int uv_pipe_bind2(uv_pipe_t* handle,
879
                            const char* name,
880
                            size_t namelen,
881
                            unsigned int flags);
882
UV_EXTERN void uv_pipe_connect(uv_connect_t* req,
883
                               uv_pipe_t* handle,
884
                               const char* name,
885
                               uv_connect_cb cb);
886
UV_EXTERN int uv_pipe_connect2(uv_connect_t* req,
887
                               uv_pipe_t* handle,
888
                               const char* name,
889
                               size_t namelen,
890
                               unsigned int flags,
891
                               uv_connect_cb cb);
892
UV_EXTERN int uv_pipe_getsockname(const uv_pipe_t* handle,
893
                                  char* buffer,
894
                                  size_t* size);
895
UV_EXTERN int uv_pipe_getpeername(const uv_pipe_t* handle,
896
                                  char* buffer,
897
                                  size_t* size);
898
UV_EXTERN void uv_pipe_pending_instances(uv_pipe_t* handle, int count);
899
UV_EXTERN int uv_pipe_pending_count(uv_pipe_t* handle);
900
UV_EXTERN uv_handle_type uv_pipe_pending_type(uv_pipe_t* handle);
901
UV_EXTERN int uv_pipe_chmod(uv_pipe_t* handle, int flags);
902
903
904
struct uv_poll_s {
905
  UV_HANDLE_FIELDS
906
  uv_poll_cb poll_cb;
907
  UV_POLL_PRIVATE_FIELDS
908
};
909
910
enum uv_poll_event {
911
  UV_READABLE = 1,
912
  UV_WRITABLE = 2,
913
  UV_DISCONNECT = 4,
914
  UV_PRIORITIZED = 8
915
};
916
917
UV_EXTERN int uv_poll_init(uv_loop_t* loop, uv_poll_t* handle, int fd);
918
UV_EXTERN int uv_poll_init_socket(uv_loop_t* loop,
919
                                  uv_poll_t* handle,
920
                                  uv_os_sock_t socket);
921
UV_EXTERN int uv_poll_start(uv_poll_t* handle, int events, uv_poll_cb cb);
922
UV_EXTERN int uv_poll_stop(uv_poll_t* handle);
923
924
925
struct uv_prepare_s {
926
  UV_HANDLE_FIELDS
927
  UV_PREPARE_PRIVATE_FIELDS
928
};
929
930
UV_EXTERN int uv_prepare_init(uv_loop_t*, uv_prepare_t* prepare);
931
UV_EXTERN int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb);
932
UV_EXTERN int uv_prepare_stop(uv_prepare_t* prepare);
933
934
935
struct uv_check_s {
936
  UV_HANDLE_FIELDS
937
  UV_CHECK_PRIVATE_FIELDS
938
};
939
940
UV_EXTERN int uv_check_init(uv_loop_t*, uv_check_t* check);
941
UV_EXTERN int uv_check_start(uv_check_t* check, uv_check_cb cb);
942
UV_EXTERN int uv_check_stop(uv_check_t* check);
943
944
945
struct uv_idle_s {
946
  UV_HANDLE_FIELDS
947
  UV_IDLE_PRIVATE_FIELDS
948
};
949
950
UV_EXTERN int uv_idle_init(uv_loop_t*, uv_idle_t* idle);
951
UV_EXTERN int uv_idle_start(uv_idle_t* idle, uv_idle_cb cb);
952
UV_EXTERN int uv_idle_stop(uv_idle_t* idle);
953
954
955
struct uv_async_s {
956
  UV_HANDLE_FIELDS
957
  UV_ASYNC_PRIVATE_FIELDS
958
};
959
960
UV_EXTERN int uv_async_init(uv_loop_t*,
961
                            uv_async_t* async,
962
                            uv_async_cb async_cb);
963
UV_EXTERN int uv_async_send(uv_async_t* async);
964
965
966
/*
967
 * uv_timer_t is a subclass of uv_handle_t.
968
 *
969
 * Used to get woken up at a specified time in the future.
970
 */
971
struct uv_timer_s {
972
  UV_HANDLE_FIELDS
973
  UV_TIMER_PRIVATE_FIELDS
974
};
975
976
UV_EXTERN int uv_timer_init(uv_loop_t*, uv_timer_t* handle);
977
UV_EXTERN int uv_timer_start(uv_timer_t* handle,
978
                             uv_timer_cb cb,
979
                             uint64_t timeout,
980
                             uint64_t repeat);
981
UV_EXTERN int uv_timer_stop(uv_timer_t* handle);
982
UV_EXTERN int uv_timer_again(uv_timer_t* handle);
983
UV_EXTERN void uv_timer_set_repeat(uv_timer_t* handle, uint64_t repeat);
984
UV_EXTERN uint64_t uv_timer_get_repeat(const uv_timer_t* handle);
985
UV_EXTERN uint64_t uv_timer_get_due_in(const uv_timer_t* handle);
986
987
988
/*
989
 * uv_getaddrinfo_t is a subclass of uv_req_t.
990
 *
991
 * Request object for uv_getaddrinfo.
992
 */
993
struct uv_getaddrinfo_s {
994
  UV_REQ_FIELDS
995
  /* read-only */
996
  uv_loop_t* loop;
997
  /* struct addrinfo* addrinfo is marked as private, but it really isn't. */
998
  UV_GETADDRINFO_PRIVATE_FIELDS
999
};
1000
1001
1002
UV_EXTERN int uv_getaddrinfo(uv_loop_t* loop,
1003
                             uv_getaddrinfo_t* req,
1004
                             uv_getaddrinfo_cb getaddrinfo_cb,
1005
                             const char* node,
1006
                             const char* service,
1007
                             const struct addrinfo* hints);
1008
UV_EXTERN void uv_freeaddrinfo(struct addrinfo* ai);
1009
1010
1011
/*
1012
* uv_getnameinfo_t is a subclass of uv_req_t.
1013
*
1014
* Request object for uv_getnameinfo.
1015
*/
1016
struct uv_getnameinfo_s {
1017
  UV_REQ_FIELDS
1018
  /* read-only */
1019
  uv_loop_t* loop;
1020
  /* host and service are marked as private, but they really aren't. */
1021
  UV_GETNAMEINFO_PRIVATE_FIELDS
1022
};
1023
1024
UV_EXTERN int uv_getnameinfo(uv_loop_t* loop,
1025
                             uv_getnameinfo_t* req,
1026
                             uv_getnameinfo_cb getnameinfo_cb,
1027
                             const struct sockaddr* addr,
1028
                             int flags);
1029
1030
1031
/* uv_spawn() options. */
1032
typedef enum {
1033
  UV_IGNORE         = 0x00,
1034
  UV_CREATE_PIPE    = 0x01,
1035
  UV_INHERIT_FD     = 0x02,
1036
  UV_INHERIT_STREAM = 0x04,
1037
1038
  /*
1039
   * When UV_CREATE_PIPE is specified, UV_READABLE_PIPE and UV_WRITABLE_PIPE
1040
   * determine the direction of flow, from the child process' perspective. Both
1041
   * flags may be specified to create a duplex data stream.
1042
   */
1043
  UV_READABLE_PIPE  = 0x10,
1044
  UV_WRITABLE_PIPE  = 0x20,
1045
1046
  /*
1047
   * When UV_CREATE_PIPE is specified, specifying UV_NONBLOCK_PIPE opens the
1048
   * handle in non-blocking mode in the child. This may cause loss of data,
1049
   * if the child is not designed to handle to encounter this mode,
1050
   * but can also be significantly more efficient.
1051
   */
1052
  UV_NONBLOCK_PIPE  = 0x40,
1053
  UV_OVERLAPPED_PIPE = 0x40 /* old name, for compatibility */
1054
} uv_stdio_flags;
1055
1056
typedef struct uv_stdio_container_s {
1057
  uv_stdio_flags flags;
1058
1059
  union {
1060
    uv_stream_t* stream;
1061
    int fd;
1062
  } data;
1063
} uv_stdio_container_t;
1064
1065
typedef struct uv_process_options_s {
1066
  uv_exit_cb exit_cb; /* Called after the process exits. */
1067
  const char* file;   /* Path to program to execute. */
1068
  /*
1069
   * Command line arguments. args[0] should be the path to the program. On
1070
   * Windows this uses CreateProcess which concatenates the arguments into a
1071
   * string this can cause some strange errors. See the note at
1072
   * windows_verbatim_arguments.
1073
   */
1074
  char** args;
1075
  /*
1076
   * This will be set as the environ variable in the subprocess. If this is
1077
   * NULL then the parents environ will be used.
1078
   */
1079
  char** env;
1080
  /*
1081
   * If non-null this represents a directory the subprocess should execute
1082
   * in. Stands for current working directory.
1083
   */
1084
  const char* cwd;
1085
  /*
1086
   * Various flags that control how uv_spawn() behaves. See the definition of
1087
   * `enum uv_process_flags` below.
1088
   */
1089
  unsigned int flags;
1090
  /*
1091
   * The `stdio` field points to an array of uv_stdio_container_t structs that
1092
   * describe the file descriptors that will be made available to the child
1093
   * process. The convention is that stdio[0] points to stdin, fd 1 is used for
1094
   * stdout, and fd 2 is stderr.
1095
   *
1096
   * Note that on windows file descriptors greater than 2 are available to the
1097
   * child process only if the child processes uses the MSVCRT runtime.
1098
   */
1099
  int stdio_count;
1100
  uv_stdio_container_t* stdio;
1101
  /*
1102
   * Libuv can change the child process' user/group id. This happens only when
1103
   * the appropriate bits are set in the flags fields. This is not supported on
1104
   * windows; uv_spawn() will fail and set the error to UV_ENOTSUP.
1105
   */
1106
  uv_uid_t uid;
1107
  uv_gid_t gid;
1108
  /*
1109
    Libuv can set the child process' CPU affinity mask.  This happens when
1110
    `cpumask` is non-NULL.  It must point to an array of char values
1111
    of length `cpumask_size`, whose value must be at least that returned by
1112
    uv_cpumask_size().  Each byte in the mask can be either zero (false)
1113
    or non-zero (true) to indicate whether the corresponding processor at
1114
    that index is included.
1115
1116
    If enabled on an unsupported platform, uv_spawn() will fail with
1117
    UV_ENOTSUP.
1118
   */
1119
  char* cpumask;
1120
  size_t cpumask_size;
1121
} uv_process_options_t;
1122
1123
/*
1124
 * These are the flags that can be used for the uv_process_options.flags field.
1125
 */
1126
enum uv_process_flags {
1127
  /*
1128
   * Set the child process' user id. The user id is supplied in the `uid` field
1129
   * of the options struct. This does not work on windows; setting this flag
1130
   * will cause uv_spawn() to fail.
1131
   */
1132
  UV_PROCESS_SETUID = (1 << 0),
1133
  /*
1134
   * Set the child process' group id. The user id is supplied in the `gid`
1135
   * field of the options struct. This does not work on windows; setting this
1136
   * flag will cause uv_spawn() to fail.
1137
   */
1138
  UV_PROCESS_SETGID = (1 << 1),
1139
  /*
1140
   * Do not wrap any arguments in quotes, or perform any other escaping, when
1141
   * converting the argument list into a command line string. This option is
1142
   * only meaningful on Windows systems. On Unix it is silently ignored.
1143
   */
1144
  UV_PROCESS_WINDOWS_VERBATIM_ARGUMENTS = (1 << 2),
1145
  /*
1146
   * Spawn the child process in a detached state - this will make it a process
1147
   * group leader, and will effectively enable the child to keep running after
1148
   * the parent exits.  Note that the child process will still keep the
1149
   * parent's event loop alive unless the parent process calls uv_unref() on
1150
   * the child's process handle.
1151
   */
1152
  UV_PROCESS_DETACHED = (1 << 3),
1153
  /*
1154
   * Hide the subprocess window that would normally be created. This option is
1155
   * only meaningful on Windows systems. On Unix it is silently ignored.
1156
   */
1157
  UV_PROCESS_WINDOWS_HIDE = (1 << 4),
1158
  /*
1159
   * Hide the subprocess console window that would normally be created. This
1160
   * option is only meaningful on Windows systems. On Unix it is silently
1161
   * ignored.
1162
   */
1163
  UV_PROCESS_WINDOWS_HIDE_CONSOLE = (1 << 5),
1164
  /*
1165
   * Hide the subprocess GUI window that would normally be created. This
1166
   * option is only meaningful on Windows systems. On Unix it is silently
1167
   * ignored.
1168
   */
1169
  UV_PROCESS_WINDOWS_HIDE_GUI = (1 << 6),
1170
  /*
1171
   * On Windows, if the path to the program to execute, specified in
1172
   * uv_process_options_t's file field, has a directory component,
1173
   * search for the exact file name before trying variants with
1174
   * extensions like '.exe' or '.cmd'.
1175
   */
1176
  UV_PROCESS_WINDOWS_FILE_PATH_EXACT_NAME = (1 << 7),
1177
  /*
1178
   * Spawn the child process with the error mode of its parent.
1179
   * This option is only meaningful on Windows systems. On Unix
1180
   * it is silently ignored.
1181
   */
1182
  UV_PROCESS_WINDOWS_USE_PARENT_ERROR_MODE = (1 << 8)
1183
};
1184
1185
/*
1186
 * uv_process_t is a subclass of uv_handle_t.
1187
 */
1188
struct uv_process_s {
1189
  UV_HANDLE_FIELDS
1190
  uv_exit_cb exit_cb;
1191
  int pid;
1192
  UV_PROCESS_PRIVATE_FIELDS
1193
};
1194
1195
UV_EXTERN int uv_spawn(uv_loop_t* loop,
1196
                       uv_process_t* handle,
1197
                       const uv_process_options_t* options);
1198
UV_EXTERN int uv_process_kill(uv_process_t*, int signum);
1199
UV_EXTERN int uv_kill(int pid, int signum);
1200
UV_EXTERN uv_pid_t uv_process_get_pid(const uv_process_t*);
1201
1202
1203
/*
1204
 * uv_work_t is a subclass of uv_req_t.
1205
 */
1206
struct uv_work_s {
1207
  UV_REQ_FIELDS
1208
  uv_loop_t* loop;
1209
  uv_work_cb work_cb;
1210
  uv_after_work_cb after_work_cb;
1211
  UV_WORK_PRIVATE_FIELDS
1212
};
1213
1214
UV_EXTERN int uv_queue_work(uv_loop_t* loop,
1215
                            uv_work_t* req,
1216
                            uv_work_cb work_cb,
1217
                            uv_after_work_cb after_work_cb);
1218
1219
UV_EXTERN int uv_cancel(uv_req_t* req);
1220
1221
1222
struct uv_cpu_times_s {
1223
  uint64_t user; /* milliseconds */
1224
  uint64_t nice; /* milliseconds */
1225
  uint64_t sys; /* milliseconds */
1226
  uint64_t idle; /* milliseconds */
1227
  uint64_t irq; /* milliseconds */
1228
};
1229
1230
struct uv_cpu_info_s {
1231
  char* model;
1232
  int speed;
1233
  struct uv_cpu_times_s cpu_times;
1234
};
1235
1236
struct uv_interface_address_s {
1237
  char* name;
1238
  char phys_addr[6];
1239
  int is_internal;
1240
  union {
1241
    struct sockaddr_in address4;
1242
    struct sockaddr_in6 address6;
1243
  } address;
1244
  union {
1245
    struct sockaddr_in netmask4;
1246
    struct sockaddr_in6 netmask6;
1247
  } netmask;
1248
};
1249
1250
struct uv_passwd_s {
1251
  char* username;
1252
  unsigned long uid;
1253
  unsigned long gid;
1254
  char* shell;
1255
  char* homedir;
1256
};
1257
1258
struct uv_group_s {
1259
  char* groupname;
1260
  unsigned long gid;
1261
  char** members;
1262
};
1263
1264
struct uv_utsname_s {
1265
  char sysname[256];
1266
  char release[256];
1267
  char version[256];
1268
  char machine[256];
1269
  /* This struct does not contain the nodename and domainname fields present in
1270
     the utsname type. domainname is a GNU extension. Both fields are referred
1271
     to as meaningless in the docs. */
1272
};
1273
1274
struct uv_statfs_s {
1275
  uint64_t f_type;
1276
  uint64_t f_bsize;
1277
  uint64_t f_blocks;
1278
  uint64_t f_bfree;
1279
  uint64_t f_bavail;
1280
  uint64_t f_files;
1281
  uint64_t f_ffree;
1282
  uint64_t f_frsize;
1283
  uint64_t f_spare[3];
1284
};
1285
1286
typedef enum {
1287
  UV_DIRENT_UNKNOWN,
1288
  UV_DIRENT_FILE,
1289
  UV_DIRENT_DIR,
1290
  UV_DIRENT_LINK,
1291
  UV_DIRENT_FIFO,
1292
  UV_DIRENT_SOCKET,
1293
  UV_DIRENT_CHAR,
1294
  UV_DIRENT_BLOCK
1295
} uv_dirent_type_t;
1296
1297
struct uv_dirent_s {
1298
  const char* name;
1299
  uv_dirent_type_t type;
1300
};
1301
1302
UV_EXTERN char** uv_setup_args(int argc, char** argv);
1303
UV_EXTERN int uv_get_process_title(char* buffer, size_t size);
1304
UV_EXTERN int uv_set_process_title(const char* title);
1305
UV_EXTERN int uv_resident_set_memory(size_t* rss);
1306
UV_EXTERN int uv_uptime(double* uptime);
1307
UV_EXTERN uv_os_fd_t uv_get_osfhandle(int fd);
1308
UV_EXTERN int uv_open_osfhandle(uv_os_fd_t os_fd);
1309
1310
typedef struct {
1311
   uv_timeval_t ru_utime; /* user CPU time used */
1312
   uv_timeval_t ru_stime; /* system CPU time used */
1313
   uint64_t ru_maxrss;    /* maximum resident set size */
1314
   uint64_t ru_ixrss;     /* integral shared memory size */
1315
   uint64_t ru_idrss;     /* integral unshared data size */
1316
   uint64_t ru_isrss;     /* integral unshared stack size */
1317
   uint64_t ru_minflt;    /* page reclaims (soft page faults) */
1318
   uint64_t ru_majflt;    /* page faults (hard page faults) */
1319
   uint64_t ru_nswap;     /* swaps */
1320
   uint64_t ru_inblock;   /* block input operations */
1321
   uint64_t ru_oublock;   /* block output operations */
1322
   uint64_t ru_msgsnd;    /* IPC messages sent */
1323
   uint64_t ru_msgrcv;    /* IPC messages received */
1324
   uint64_t ru_nsignals;  /* signals received */
1325
   uint64_t ru_nvcsw;     /* voluntary context switches */
1326
   uint64_t ru_nivcsw;    /* involuntary context switches */
1327
} uv_rusage_t;
1328
1329
UV_EXTERN int uv_getrusage(uv_rusage_t* rusage);
1330
UV_EXTERN int uv_getrusage_thread(uv_rusage_t* rusage);
1331
1332
UV_EXTERN int uv_os_homedir(char* buffer, size_t* size);
1333
UV_EXTERN int uv_os_tmpdir(char* buffer, size_t* size);
1334
UV_EXTERN int uv_os_get_passwd(uv_passwd_t* pwd);
1335
UV_EXTERN void uv_os_free_passwd(uv_passwd_t* pwd);
1336
UV_EXTERN int uv_os_get_passwd2(uv_passwd_t* pwd, uv_uid_t uid);
1337
UV_EXTERN int uv_os_get_group(uv_group_t* grp, uv_uid_t gid);
1338
UV_EXTERN void uv_os_free_group(uv_group_t* grp);
1339
UV_EXTERN uv_pid_t uv_os_getpid(void);
1340
UV_EXTERN uv_pid_t uv_os_getppid(void);
1341
1342
#if defined(__PASE__)
1343
/* On IBM i PASE, the highest process priority is -10 */
1344
# define UV_PRIORITY_LOW 39          /* RUNPTY(99) */
1345
# define UV_PRIORITY_BELOW_NORMAL 15 /* RUNPTY(50) */
1346
# define UV_PRIORITY_NORMAL 0        /* RUNPTY(20) */
1347
# define UV_PRIORITY_ABOVE_NORMAL -4 /* RUNTY(12) */
1348
# define UV_PRIORITY_HIGH -7         /* RUNPTY(6) */
1349
# define UV_PRIORITY_HIGHEST -10     /* RUNPTY(1) */
1350
#else
1351
0
# define UV_PRIORITY_LOW 19
1352
# define UV_PRIORITY_BELOW_NORMAL 10
1353
# define UV_PRIORITY_NORMAL 0
1354
# define UV_PRIORITY_ABOVE_NORMAL -7
1355
# define UV_PRIORITY_HIGH -14
1356
0
# define UV_PRIORITY_HIGHEST -20
1357
#endif
1358
1359
UV_EXTERN int uv_os_getpriority(uv_pid_t pid, int* priority);
1360
UV_EXTERN int uv_os_setpriority(uv_pid_t pid, int priority);
1361
1362
enum {
1363
  UV_THREAD_PRIORITY_HIGHEST = 2,
1364
  UV_THREAD_PRIORITY_ABOVE_NORMAL = 1,
1365
  UV_THREAD_PRIORITY_NORMAL = 0,
1366
  UV_THREAD_PRIORITY_BELOW_NORMAL = -1,
1367
  UV_THREAD_PRIORITY_LOWEST = -2,
1368
};
1369
1370
UV_EXTERN int uv_thread_getpriority(uv_thread_t tid, int* priority);
1371
UV_EXTERN int uv_thread_setpriority(uv_thread_t tid, int priority);
1372
1373
UV_EXTERN unsigned int uv_available_parallelism(void);
1374
UV_EXTERN int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count);
1375
UV_EXTERN void uv_free_cpu_info(uv_cpu_info_t* cpu_infos, int count);
1376
UV_EXTERN int uv_cpumask_size(void);
1377
1378
UV_EXTERN int uv_interface_addresses(uv_interface_address_t** addresses,
1379
                                     int* count);
1380
UV_EXTERN void uv_free_interface_addresses(uv_interface_address_t* addresses,
1381
                                           int count);
1382
1383
struct uv_env_item_s {
1384
  char* name;
1385
  char* value;
1386
};
1387
1388
UV_EXTERN int uv_os_environ(uv_env_item_t** envitems, int* count);
1389
UV_EXTERN void uv_os_free_environ(uv_env_item_t* envitems, int count);
1390
UV_EXTERN int uv_os_getenv(const char* name, char* buffer, size_t* size);
1391
UV_EXTERN int uv_os_setenv(const char* name, const char* value);
1392
UV_EXTERN int uv_os_unsetenv(const char* name);
1393
1394
#ifdef MAXHOSTNAMELEN
1395
# define UV_MAXHOSTNAMESIZE (MAXHOSTNAMELEN + 1)
1396
#else
1397
  /*
1398
    Fallback for the maximum hostname size, including the null terminator. The
1399
    Windows gethostname() documentation states that 256 bytes will always be
1400
    large enough to hold the null-terminated hostname.
1401
  */
1402
# define UV_MAXHOSTNAMESIZE 256
1403
#endif
1404
1405
UV_EXTERN int uv_os_gethostname(char* buffer, size_t* size);
1406
1407
UV_EXTERN int uv_os_uname(uv_utsname_t* buffer);
1408
1409
struct uv_metrics_s {
1410
  uint64_t loop_count;
1411
  uint64_t events;
1412
  uint64_t events_waiting;
1413
  /* private */
1414
  uint64_t* reserved[13];
1415
};
1416
1417
UV_EXTERN int uv_metrics_info(uv_loop_t* loop, uv_metrics_t* metrics);
1418
UV_EXTERN uint64_t uv_metrics_idle_time(uv_loop_t* loop);
1419
1420
typedef enum {
1421
  UV_FS_UNKNOWN = -1,
1422
  UV_FS_CUSTOM,
1423
  UV_FS_OPEN,
1424
  UV_FS_CLOSE,
1425
  UV_FS_READ,
1426
  UV_FS_WRITE,
1427
  UV_FS_SENDFILE,
1428
  UV_FS_STAT,
1429
  UV_FS_LSTAT,
1430
  UV_FS_FSTAT,
1431
  UV_FS_FTRUNCATE,
1432
  UV_FS_UTIME,
1433
  UV_FS_FUTIME,
1434
  UV_FS_ACCESS,
1435
  UV_FS_CHMOD,
1436
  UV_FS_FCHMOD,
1437
  UV_FS_FSYNC,
1438
  UV_FS_FDATASYNC,
1439
  UV_FS_UNLINK,
1440
  UV_FS_RMDIR,
1441
  UV_FS_MKDIR,
1442
  UV_FS_MKDTEMP,
1443
  UV_FS_RENAME,
1444
  UV_FS_SCANDIR,
1445
  UV_FS_LINK,
1446
  UV_FS_SYMLINK,
1447
  UV_FS_READLINK,
1448
  UV_FS_CHOWN,
1449
  UV_FS_FCHOWN,
1450
  UV_FS_REALPATH,
1451
  UV_FS_COPYFILE,
1452
  UV_FS_LCHOWN,
1453
  UV_FS_OPENDIR,
1454
  UV_FS_READDIR,
1455
  UV_FS_CLOSEDIR,
1456
  UV_FS_STATFS,
1457
  UV_FS_MKSTEMP,
1458
  UV_FS_LUTIME
1459
} uv_fs_type;
1460
1461
struct uv_dir_s {
1462
  uv_dirent_t* dirents;
1463
  size_t nentries;
1464
  void* reserved[4];
1465
  UV_DIR_PRIVATE_FIELDS
1466
};
1467
1468
/* uv_fs_t is a subclass of uv_req_t. */
1469
struct uv_fs_s {
1470
  UV_REQ_FIELDS
1471
  uv_fs_type fs_type;
1472
  uv_loop_t* loop;
1473
  uv_fs_cb cb;
1474
  ssize_t result;
1475
  void* ptr;
1476
  const char* path;
1477
  uv_stat_t statbuf;  /* Stores the result of uv_fs_stat() and uv_fs_fstat(). */
1478
  UV_FS_PRIVATE_FIELDS
1479
};
1480
1481
UV_EXTERN uv_fs_type uv_fs_get_type(const uv_fs_t*);
1482
UV_EXTERN ssize_t uv_fs_get_result(const uv_fs_t*);
1483
UV_EXTERN int uv_fs_get_system_error(const uv_fs_t*);
1484
UV_EXTERN void* uv_fs_get_ptr(const uv_fs_t*);
1485
UV_EXTERN const char* uv_fs_get_path(const uv_fs_t*);
1486
UV_EXTERN uv_stat_t* uv_fs_get_statbuf(uv_fs_t*);
1487
1488
UV_EXTERN void uv_fs_req_cleanup(uv_fs_t* req);
1489
UV_EXTERN int uv_fs_close(uv_loop_t* loop,
1490
                          uv_fs_t* req,
1491
                          uv_file file,
1492
                          uv_fs_cb cb);
1493
UV_EXTERN int uv_fs_open(uv_loop_t* loop,
1494
                         uv_fs_t* req,
1495
                         const char* path,
1496
                         int flags,
1497
                         int mode,
1498
                         uv_fs_cb cb);
1499
UV_EXTERN int uv_fs_read(uv_loop_t* loop,
1500
                         uv_fs_t* req,
1501
                         uv_file file,
1502
                         const uv_buf_t bufs[],
1503
                         unsigned int nbufs,
1504
                         int64_t offset,
1505
                         uv_fs_cb cb);
1506
UV_EXTERN int uv_fs_unlink(uv_loop_t* loop,
1507
                           uv_fs_t* req,
1508
                           const char* path,
1509
                           uv_fs_cb cb);
1510
UV_EXTERN int uv_fs_write(uv_loop_t* loop,
1511
                          uv_fs_t* req,
1512
                          uv_file file,
1513
                          const uv_buf_t bufs[],
1514
                          unsigned int nbufs,
1515
                          int64_t offset,
1516
                          uv_fs_cb cb);
1517
/*
1518
 * This flag can be used with uv_fs_copyfile() to return an error if the
1519
 * destination already exists.
1520
 */
1521
0
#define UV_FS_COPYFILE_EXCL   0x0001
1522
1523
/*
1524
 * This flag can be used with uv_fs_copyfile() to attempt to create a reflink.
1525
 * If copy-on-write is not supported, a fallback copy mechanism is used.
1526
 */
1527
0
#define UV_FS_COPYFILE_FICLONE 0x0002
1528
1529
/*
1530
 * This flag can be used with uv_fs_copyfile() to attempt to create a reflink.
1531
 * If copy-on-write is not supported, an error is returned.
1532
 */
1533
0
#define UV_FS_COPYFILE_FICLONE_FORCE 0x0004
1534
1535
UV_EXTERN int uv_fs_copyfile(uv_loop_t* loop,
1536
                             uv_fs_t* req,
1537
                             const char* path,
1538
                             const char* new_path,
1539
                             int flags,
1540
                             uv_fs_cb cb);
1541
UV_EXTERN int uv_fs_mkdir(uv_loop_t* loop,
1542
                          uv_fs_t* req,
1543
                          const char* path,
1544
                          int mode,
1545
                          uv_fs_cb cb);
1546
UV_EXTERN int uv_fs_mkdtemp(uv_loop_t* loop,
1547
                            uv_fs_t* req,
1548
                            const char* tpl,
1549
                            uv_fs_cb cb);
1550
UV_EXTERN int uv_fs_mkstemp(uv_loop_t* loop,
1551
                            uv_fs_t* req,
1552
                            const char* tpl,
1553
                            uv_fs_cb cb);
1554
UV_EXTERN int uv_fs_rmdir(uv_loop_t* loop,
1555
                          uv_fs_t* req,
1556
                          const char* path,
1557
                          uv_fs_cb cb);
1558
UV_EXTERN int uv_fs_scandir(uv_loop_t* loop,
1559
                            uv_fs_t* req,
1560
                            const char* path,
1561
                            int flags,
1562
                            uv_fs_cb cb);
1563
UV_EXTERN int uv_fs_scandir_next(uv_fs_t* req,
1564
                                 uv_dirent_t* ent);
1565
UV_EXTERN int uv_fs_opendir(uv_loop_t* loop,
1566
                            uv_fs_t* req,
1567
                            const char* path,
1568
                            uv_fs_cb cb);
1569
UV_EXTERN int uv_fs_readdir(uv_loop_t* loop,
1570
                            uv_fs_t* req,
1571
                            uv_dir_t* dir,
1572
                            uv_fs_cb cb);
1573
UV_EXTERN int uv_fs_closedir(uv_loop_t* loop,
1574
                             uv_fs_t* req,
1575
                             uv_dir_t* dir,
1576
                             uv_fs_cb cb);
1577
UV_EXTERN int uv_fs_stat(uv_loop_t* loop,
1578
                         uv_fs_t* req,
1579
                         const char* path,
1580
                         uv_fs_cb cb);
1581
UV_EXTERN int uv_fs_fstat(uv_loop_t* loop,
1582
                          uv_fs_t* req,
1583
                          uv_file file,
1584
                          uv_fs_cb cb);
1585
UV_EXTERN int uv_fs_rename(uv_loop_t* loop,
1586
                           uv_fs_t* req,
1587
                           const char* path,
1588
                           const char* new_path,
1589
                           uv_fs_cb cb);
1590
UV_EXTERN int uv_fs_fsync(uv_loop_t* loop,
1591
                          uv_fs_t* req,
1592
                          uv_file file,
1593
                          uv_fs_cb cb);
1594
UV_EXTERN int uv_fs_fdatasync(uv_loop_t* loop,
1595
                              uv_fs_t* req,
1596
                              uv_file file,
1597
                              uv_fs_cb cb);
1598
UV_EXTERN int uv_fs_ftruncate(uv_loop_t* loop,
1599
                              uv_fs_t* req,
1600
                              uv_file file,
1601
                              int64_t offset,
1602
                              uv_fs_cb cb);
1603
UV_EXTERN int uv_fs_sendfile(uv_loop_t* loop,
1604
                             uv_fs_t* req,
1605
                             uv_file out_fd,
1606
                             uv_file in_fd,
1607
                             int64_t in_offset,
1608
                             size_t length,
1609
                             uv_fs_cb cb);
1610
UV_EXTERN int uv_fs_access(uv_loop_t* loop,
1611
                           uv_fs_t* req,
1612
                           const char* path,
1613
                           int mode,
1614
                           uv_fs_cb cb);
1615
UV_EXTERN int uv_fs_chmod(uv_loop_t* loop,
1616
                          uv_fs_t* req,
1617
                          const char* path,
1618
                          int mode,
1619
                          uv_fs_cb cb);
1620
#define UV_FS_UTIME_NOW  (INFINITY)
1621
#define UV_FS_UTIME_OMIT (NAN)
1622
UV_EXTERN int uv_fs_utime(uv_loop_t* loop,
1623
                          uv_fs_t* req,
1624
                          const char* path,
1625
                          double atime,
1626
                          double mtime,
1627
                          uv_fs_cb cb);
1628
UV_EXTERN int uv_fs_futime(uv_loop_t* loop,
1629
                           uv_fs_t* req,
1630
                           uv_file file,
1631
                           double atime,
1632
                           double mtime,
1633
                           uv_fs_cb cb);
1634
UV_EXTERN int uv_fs_lutime(uv_loop_t* loop,
1635
                           uv_fs_t* req,
1636
                           const char* path,
1637
                           double atime,
1638
                           double mtime,
1639
                           uv_fs_cb cb);
1640
UV_EXTERN int uv_fs_lstat(uv_loop_t* loop,
1641
                          uv_fs_t* req,
1642
                          const char* path,
1643
                          uv_fs_cb cb);
1644
UV_EXTERN int uv_fs_link(uv_loop_t* loop,
1645
                         uv_fs_t* req,
1646
                         const char* path,
1647
                         const char* new_path,
1648
                         uv_fs_cb cb);
1649
1650
/*
1651
 * This flag can be used with uv_fs_symlink() on Windows to specify whether
1652
 * path argument points to a directory.
1653
 */
1654
#define UV_FS_SYMLINK_DIR          0x0001
1655
1656
/*
1657
 * This flag can be used with uv_fs_symlink() on Windows to specify whether
1658
 * the symlink is to be created using junction points.
1659
 */
1660
#define UV_FS_SYMLINK_JUNCTION     0x0002
1661
1662
UV_EXTERN int uv_fs_symlink(uv_loop_t* loop,
1663
                            uv_fs_t* req,
1664
                            const char* path,
1665
                            const char* new_path,
1666
                            int flags,
1667
                            uv_fs_cb cb);
1668
UV_EXTERN int uv_fs_readlink(uv_loop_t* loop,
1669
                             uv_fs_t* req,
1670
                             const char* path,
1671
                             uv_fs_cb cb);
1672
UV_EXTERN int uv_fs_realpath(uv_loop_t* loop,
1673
                             uv_fs_t* req,
1674
                             const char* path,
1675
                             uv_fs_cb cb);
1676
UV_EXTERN int uv_fs_fchmod(uv_loop_t* loop,
1677
                           uv_fs_t* req,
1678
                           uv_file file,
1679
                           int mode,
1680
                           uv_fs_cb cb);
1681
UV_EXTERN int uv_fs_chown(uv_loop_t* loop,
1682
                          uv_fs_t* req,
1683
                          const char* path,
1684
                          uv_uid_t uid,
1685
                          uv_gid_t gid,
1686
                          uv_fs_cb cb);
1687
UV_EXTERN int uv_fs_fchown(uv_loop_t* loop,
1688
                           uv_fs_t* req,
1689
                           uv_file file,
1690
                           uv_uid_t uid,
1691
                           uv_gid_t gid,
1692
                           uv_fs_cb cb);
1693
UV_EXTERN int uv_fs_lchown(uv_loop_t* loop,
1694
                           uv_fs_t* req,
1695
                           const char* path,
1696
                           uv_uid_t uid,
1697
                           uv_gid_t gid,
1698
                           uv_fs_cb cb);
1699
UV_EXTERN int uv_fs_statfs(uv_loop_t* loop,
1700
                           uv_fs_t* req,
1701
                           const char* path,
1702
                           uv_fs_cb cb);
1703
1704
1705
enum uv_fs_event {
1706
  UV_RENAME = 1,
1707
  UV_CHANGE = 2
1708
};
1709
1710
1711
struct uv_fs_event_s {
1712
  UV_HANDLE_FIELDS
1713
  /* private */
1714
  char* path;
1715
  UV_FS_EVENT_PRIVATE_FIELDS
1716
};
1717
1718
1719
/*
1720
 * uv_fs_stat() based polling file watcher.
1721
 */
1722
struct uv_fs_poll_s {
1723
  UV_HANDLE_FIELDS
1724
  /* Private, don't touch. */
1725
  void* poll_ctx;
1726
};
1727
1728
UV_EXTERN int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle);
1729
UV_EXTERN int uv_fs_poll_start(uv_fs_poll_t* handle,
1730
                               uv_fs_poll_cb poll_cb,
1731
                               const char* path,
1732
                               unsigned int interval);
1733
UV_EXTERN int uv_fs_poll_stop(uv_fs_poll_t* handle);
1734
UV_EXTERN int uv_fs_poll_getpath(uv_fs_poll_t* handle,
1735
                                 char* buffer,
1736
                                 size_t* size);
1737
1738
1739
struct uv_signal_s {
1740
  UV_HANDLE_FIELDS
1741
  uv_signal_cb signal_cb;
1742
  int signum;
1743
  UV_SIGNAL_PRIVATE_FIELDS
1744
};
1745
1746
UV_EXTERN int uv_signal_init(uv_loop_t* loop, uv_signal_t* handle);
1747
UV_EXTERN int uv_signal_start(uv_signal_t* handle,
1748
                              uv_signal_cb signal_cb,
1749
                              int signum);
1750
UV_EXTERN int uv_signal_start_oneshot(uv_signal_t* handle,
1751
                                      uv_signal_cb signal_cb,
1752
                                      int signum);
1753
UV_EXTERN int uv_signal_stop(uv_signal_t* handle);
1754
1755
UV_EXTERN void uv_loadavg(double avg[3]);
1756
1757
1758
/*
1759
 * Flags to be passed to uv_fs_event_start().
1760
 */
1761
enum uv_fs_event_flags {
1762
  /*
1763
   * By default, if the fs event watcher is given a directory name, we will
1764
   * watch for all events in that directory. This flags overrides this behavior
1765
   * and makes fs_event report only changes to the directory entry itself. This
1766
   * flag does not affect individual files watched.
1767
   * This flag is currently not implemented yet on any backend.
1768
   */
1769
  UV_FS_EVENT_WATCH_ENTRY = 1,
1770
1771
  /*
1772
   * By default uv_fs_event will try to use a kernel interface such as inotify
1773
   * or kqueue to detect events. This may not work on remote filesystems such
1774
   * as NFS mounts. This flag makes fs_event fall back to calling stat() on a
1775
   * regular interval.
1776
   * This flag is currently not implemented yet on any backend.
1777
   */
1778
  UV_FS_EVENT_STAT = 2,
1779
1780
  /*
1781
   * By default, event watcher, when watching directory, is not registering
1782
   * (is ignoring) changes in it's subdirectories.
1783
   * This flag will override this behaviour on platforms that support it.
1784
   */
1785
  UV_FS_EVENT_RECURSIVE = 4
1786
};
1787
1788
1789
UV_EXTERN int uv_fs_event_init(uv_loop_t* loop, uv_fs_event_t* handle);
1790
UV_EXTERN int uv_fs_event_start(uv_fs_event_t* handle,
1791
                                uv_fs_event_cb cb,
1792
                                const char* path,
1793
                                unsigned int flags);
1794
UV_EXTERN int uv_fs_event_stop(uv_fs_event_t* handle);
1795
UV_EXTERN int uv_fs_event_getpath(uv_fs_event_t* handle,
1796
                                  char* buffer,
1797
                                  size_t* size);
1798
1799
UV_EXTERN int uv_ip4_addr(const char* ip, int port, struct sockaddr_in* addr);
1800
UV_EXTERN int uv_ip6_addr(const char* ip, int port, struct sockaddr_in6* addr);
1801
1802
UV_EXTERN int uv_ip4_name(const struct sockaddr_in* src, char* dst, size_t size);
1803
UV_EXTERN int uv_ip6_name(const struct sockaddr_in6* src, char* dst, size_t size);
1804
UV_EXTERN int uv_ip_name(const struct sockaddr* src, char* dst, size_t size);
1805
1806
UV_EXTERN int uv_inet_ntop(int af, const void* src, char* dst, size_t size);
1807
UV_EXTERN int uv_inet_pton(int af, const char* src, void* dst);
1808
1809
1810
struct uv_random_s {
1811
  UV_REQ_FIELDS
1812
  /* read-only */
1813
  uv_loop_t* loop;
1814
  /* private */
1815
  int status;
1816
  void* buf;
1817
  size_t buflen;
1818
  uv_random_cb cb;
1819
  struct uv__work work_req;
1820
};
1821
1822
UV_EXTERN int uv_random(uv_loop_t* loop,
1823
                        uv_random_t* req,
1824
                        void *buf,
1825
                        size_t buflen,
1826
                        unsigned flags,  /* For future extension; must be 0. */
1827
                        uv_random_cb cb);
1828
1829
#if defined(IF_NAMESIZE)
1830
# define UV_IF_NAMESIZE (IF_NAMESIZE + 1)
1831
#elif defined(IFNAMSIZ)
1832
# define UV_IF_NAMESIZE (IFNAMSIZ + 1)
1833
#else
1834
# define UV_IF_NAMESIZE (16 + 1)
1835
#endif
1836
1837
UV_EXTERN int uv_if_indextoname(unsigned int ifindex,
1838
                                char* buffer,
1839
                                size_t* size);
1840
UV_EXTERN int uv_if_indextoiid(unsigned int ifindex,
1841
                               char* buffer,
1842
                               size_t* size);
1843
1844
UV_EXTERN int uv_exepath(char* buffer, size_t* size);
1845
1846
UV_EXTERN int uv_cwd(char* buffer, size_t* size);
1847
1848
UV_EXTERN int uv_chdir(const char* dir);
1849
1850
UV_EXTERN uint64_t uv_get_free_memory(void);
1851
UV_EXTERN uint64_t uv_get_total_memory(void);
1852
UV_EXTERN uint64_t uv_get_constrained_memory(void);
1853
UV_EXTERN uint64_t uv_get_available_memory(void);
1854
1855
UV_EXTERN int uv_clock_gettime(uv_clock_id clock_id, uv_timespec64_t* ts);
1856
UV_EXTERN uint64_t uv_hrtime(void);
1857
UV_EXTERN void uv_sleep(unsigned int msec);
1858
1859
UV_EXTERN void uv_disable_stdio_inheritance(void);
1860
1861
UV_EXTERN int uv_dlopen(const char* filename, uv_lib_t* lib);
1862
UV_EXTERN void uv_dlclose(uv_lib_t* lib);
1863
UV_EXTERN int uv_dlsym(uv_lib_t* lib, const char* name, void** ptr);
1864
UV_EXTERN const char* uv_dlerror(const uv_lib_t* lib);
1865
1866
UV_EXTERN int uv_mutex_init(uv_mutex_t* handle);
1867
UV_EXTERN int uv_mutex_init_recursive(uv_mutex_t* handle);
1868
UV_EXTERN void uv_mutex_destroy(uv_mutex_t* handle);
1869
UV_EXTERN void uv_mutex_lock(uv_mutex_t* handle);
1870
UV_EXTERN int uv_mutex_trylock(uv_mutex_t* handle);
1871
UV_EXTERN void uv_mutex_unlock(uv_mutex_t* handle);
1872
1873
UV_EXTERN int uv_rwlock_init(uv_rwlock_t* rwlock);
1874
UV_EXTERN void uv_rwlock_destroy(uv_rwlock_t* rwlock);
1875
UV_EXTERN void uv_rwlock_rdlock(uv_rwlock_t* rwlock);
1876
UV_EXTERN int uv_rwlock_tryrdlock(uv_rwlock_t* rwlock);
1877
UV_EXTERN void uv_rwlock_rdunlock(uv_rwlock_t* rwlock);
1878
UV_EXTERN void uv_rwlock_wrlock(uv_rwlock_t* rwlock);
1879
UV_EXTERN int uv_rwlock_trywrlock(uv_rwlock_t* rwlock);
1880
UV_EXTERN void uv_rwlock_wrunlock(uv_rwlock_t* rwlock);
1881
1882
UV_EXTERN int uv_sem_init(uv_sem_t* sem, unsigned int value);
1883
UV_EXTERN void uv_sem_destroy(uv_sem_t* sem);
1884
UV_EXTERN void uv_sem_post(uv_sem_t* sem);
1885
UV_EXTERN void uv_sem_wait(uv_sem_t* sem);
1886
UV_EXTERN int uv_sem_trywait(uv_sem_t* sem);
1887
1888
UV_EXTERN int uv_cond_init(uv_cond_t* cond);
1889
UV_EXTERN void uv_cond_destroy(uv_cond_t* cond);
1890
UV_EXTERN void uv_cond_signal(uv_cond_t* cond);
1891
UV_EXTERN void uv_cond_broadcast(uv_cond_t* cond);
1892
1893
UV_EXTERN int uv_barrier_init(uv_barrier_t* barrier, unsigned int count);
1894
UV_EXTERN void uv_barrier_destroy(uv_barrier_t* barrier);
1895
UV_EXTERN int uv_barrier_wait(uv_barrier_t* barrier);
1896
1897
UV_EXTERN void uv_cond_wait(uv_cond_t* cond, uv_mutex_t* mutex);
1898
UV_EXTERN int uv_cond_timedwait(uv_cond_t* cond,
1899
                                uv_mutex_t* mutex,
1900
                                uint64_t timeout);
1901
1902
UV_EXTERN void uv_once(uv_once_t* guard, void (*callback)(void));
1903
1904
UV_EXTERN int uv_key_create(uv_key_t* key);
1905
UV_EXTERN void uv_key_delete(uv_key_t* key);
1906
UV_EXTERN void* uv_key_get(uv_key_t* key);
1907
UV_EXTERN void uv_key_set(uv_key_t* key, void* value);
1908
1909
UV_EXTERN int uv_gettimeofday(uv_timeval64_t* tv);
1910
1911
typedef void (*uv_thread_cb)(void* arg);
1912
1913
UV_EXTERN int uv_thread_create(uv_thread_t* tid, uv_thread_cb entry, void* arg);
1914
UV_EXTERN int uv_thread_detach(uv_thread_t* tid);
1915
1916
typedef enum {
1917
  UV_THREAD_NO_FLAGS = 0x00,
1918
  UV_THREAD_HAS_STACK_SIZE = 0x01
1919
} uv_thread_create_flags;
1920
1921
struct uv_thread_options_s {
1922
  unsigned int flags;
1923
  size_t stack_size;
1924
  /* More fields may be added at any time. */
1925
};
1926
1927
typedef struct uv_thread_options_s uv_thread_options_t;
1928
1929
UV_EXTERN int uv_thread_create_ex(uv_thread_t* tid,
1930
                                  const uv_thread_options_t* params,
1931
                                  uv_thread_cb entry,
1932
                                  void* arg);
1933
UV_EXTERN int uv_thread_setaffinity(uv_thread_t* tid,
1934
                                    char* cpumask,
1935
                                    char* oldmask,
1936
                                    size_t mask_size);
1937
UV_EXTERN int uv_thread_getaffinity(uv_thread_t* tid,
1938
                                    char* cpumask,
1939
                                    size_t mask_size);
1940
UV_EXTERN int uv_thread_getcpu(void);
1941
UV_EXTERN uv_thread_t uv_thread_self(void);
1942
UV_EXTERN int uv_thread_join(uv_thread_t *tid);
1943
UV_EXTERN int uv_thread_equal(const uv_thread_t* t1, const uv_thread_t* t2);
1944
UV_EXTERN int uv_thread_setname(const char* name);
1945
UV_EXTERN int uv_thread_getname(uv_thread_t* tid, char* name, size_t size);
1946
1947
1948
/* The presence of these unions force similar struct layout. */
1949
#define XX(_, name) uv_ ## name ## _t name;
1950
union uv_any_handle {
1951
  UV_HANDLE_TYPE_MAP(XX)
1952
};
1953
1954
union uv_any_req {
1955
  UV_REQ_TYPE_MAP(XX)
1956
};
1957
#undef XX
1958
1959
1960
struct uv_loop_s {
1961
  /* User data - use this for whatever. */
1962
  void* data;
1963
  /* Loop reference counting. */
1964
  unsigned int active_handles;
1965
  struct uv__queue handle_queue;
1966
  union {
1967
    void* unused;
1968
    unsigned int count;
1969
  } active_reqs;
1970
  /* Internal storage for future extensions. */
1971
  void* internal_fields;
1972
  /* Internal flag to signal loop stop. */
1973
  unsigned int stop_flag;
1974
  UV_LOOP_PRIVATE_FIELDS
1975
};
1976
1977
UV_EXTERN void* uv_loop_get_data(const uv_loop_t*);
1978
UV_EXTERN void uv_loop_set_data(uv_loop_t*, void* data);
1979
1980
/* Unicode utilities needed for dealing with Windows. */
1981
UV_EXTERN size_t uv_utf16_length_as_wtf8(const uint16_t* utf16,
1982
                                         ssize_t utf16_len);
1983
UV_EXTERN int uv_utf16_to_wtf8(const uint16_t* utf16,
1984
                               ssize_t utf16_len,
1985
                               char** wtf8_ptr,
1986
                               size_t* wtf8_len_ptr);
1987
UV_EXTERN ssize_t uv_wtf8_length_as_utf16(const char* wtf8);
1988
UV_EXTERN void uv_wtf8_to_utf16(const char* wtf8,
1989
                                uint16_t* utf16,
1990
                                size_t utf16_len);
1991
1992
/* Don't export the private CPP symbols. */
1993
#undef UV_REQ_TYPE_PRIVATE
1994
#undef UV_REQ_PRIVATE_FIELDS
1995
#undef UV_STREAM_PRIVATE_FIELDS
1996
#undef UV_TCP_PRIVATE_FIELDS
1997
#undef UV_PREPARE_PRIVATE_FIELDS
1998
#undef UV_CHECK_PRIVATE_FIELDS
1999
#undef UV_IDLE_PRIVATE_FIELDS
2000
#undef UV_ASYNC_PRIVATE_FIELDS
2001
#undef UV_TIMER_PRIVATE_FIELDS
2002
#undef UV_GETADDRINFO_PRIVATE_FIELDS
2003
#undef UV_GETNAMEINFO_PRIVATE_FIELDS
2004
#undef UV_WORK_PRIVATE_FIELDS
2005
#undef UV_FS_EVENT_PRIVATE_FIELDS
2006
#undef UV_SIGNAL_PRIVATE_FIELDS
2007
#undef UV_LOOP_PRIVATE_FIELDS
2008
#undef UV__ERR
2009
2010
#ifdef __cplusplus
2011
}
2012
#endif
2013
#endif /* UV_H */