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 /* 23 * This file is private to libuv. It provides common functionality to both 24 * Windows and Unix backends. 25 */ 26 27 #ifndef UV_COMMON_H_ 28 #define UV_COMMON_H_ 29 30 #include <assert.h> 31 #include <stdarg.h> 32 #include <stddef.h> 33 34 #if defined(_MSC_VER) && _MSC_VER < 1600 35 # include "uv/stdint-msvc2008.h" 36 #else 37 # include <stdint.h> 38 #endif 39 40 #include "uv.h" 41 #include "uv/tree.h" 42 #include "queue.h" 43 #include "strscpy.h" 44 45 #if EDOM > 0 46 # define UV__ERR(x) (-(x)) 47 #else 48 # define UV__ERR(x) (x) 49 #endif 50 51 #if !defined(snprintf) && defined(_MSC_VER) && _MSC_VER < 1900 52 extern int snprintf(char*, size_t, const char*, ...); 53 #endif 54 55 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) 56 57 #define container_of(ptr, type, member) \ 58 ((type *) ((char *) (ptr) - offsetof(type, member))) 59 60 #define STATIC_ASSERT(expr) \ 61 void uv__static_assert(int static_assert_failed[1 - 2 * !(expr)]) 62 63 /* Handle flags. Some flags are specific to Windows or UNIX. */ 64 enum { 65 /* Used by all handles. */ 66 UV_HANDLE_CLOSING = 0x00000001, 67 UV_HANDLE_CLOSED = 0x00000002, 68 UV_HANDLE_ACTIVE = 0x00000004, 69 UV_HANDLE_REF = 0x00000008, 70 UV_HANDLE_INTERNAL = 0x00000010, 71 UV_HANDLE_ENDGAME_QUEUED = 0x00000020, 72 73 /* Used by streams. */ 74 UV_HANDLE_LISTENING = 0x00000040, 75 UV_HANDLE_CONNECTION = 0x00000080, 76 UV_HANDLE_SHUTTING = 0x00000100, 77 UV_HANDLE_SHUT = 0x00000200, 78 UV_HANDLE_READ_PARTIAL = 0x00000400, 79 UV_HANDLE_READ_EOF = 0x00000800, 80 81 /* Used by streams and UDP handles. */ 82 UV_HANDLE_READING = 0x00001000, 83 UV_HANDLE_BOUND = 0x00002000, 84 UV_HANDLE_READABLE = 0x00004000, 85 UV_HANDLE_WRITABLE = 0x00008000, 86 UV_HANDLE_READ_PENDING = 0x00010000, 87 UV_HANDLE_SYNC_BYPASS_IOCP = 0x00020000, 88 UV_HANDLE_ZERO_READ = 0x00040000, 89 UV_HANDLE_EMULATE_IOCP = 0x00080000, 90 UV_HANDLE_BLOCKING_WRITES = 0x00100000, 91 UV_HANDLE_CANCELLATION_PENDING = 0x00200000, 92 93 /* Used by uv_tcp_t and uv_udp_t handles */ 94 UV_HANDLE_IPV6 = 0x00400000, 95 96 /* Only used by uv_tcp_t handles. */ 97 UV_HANDLE_TCP_NODELAY = 0x01000000, 98 UV_HANDLE_TCP_KEEPALIVE = 0x02000000, 99 UV_HANDLE_TCP_SINGLE_ACCEPT = 0x04000000, 100 UV_HANDLE_TCP_ACCEPT_STATE_CHANGING = 0x08000000, 101 UV_HANDLE_TCP_SOCKET_CLOSED = 0x10000000, 102 UV_HANDLE_SHARED_TCP_SOCKET = 0x20000000, 103 104 /* Only used by uv_udp_t handles. */ 105 UV_HANDLE_UDP_PROCESSING = 0x01000000, 106 UV_HANDLE_UDP_CONNECTED = 0x02000000, 107 108 /* Only used by uv_pipe_t handles. */ 109 UV_HANDLE_NON_OVERLAPPED_PIPE = 0x01000000, 110 UV_HANDLE_PIPESERVER = 0x02000000, 111 112 /* Only used by uv_tty_t handles. */ 113 UV_HANDLE_TTY_READABLE = 0x01000000, 114 UV_HANDLE_TTY_RAW = 0x02000000, 115 UV_HANDLE_TTY_SAVED_POSITION = 0x04000000, 116 UV_HANDLE_TTY_SAVED_ATTRIBUTES = 0x08000000, 117 118 /* Only used by uv_signal_t handles. */ 119 UV_SIGNAL_ONE_SHOT_DISPATCHED = 0x01000000, 120 UV_SIGNAL_ONE_SHOT = 0x02000000, 121 122 /* Only used by uv_poll_t handles. */ 123 UV_HANDLE_POLL_SLOW = 0x01000000 124 }; 125 126 int uv__loop_configure(uv_loop_t* loop, uv_loop_option option, va_list ap); 127 128 void uv__loop_close(uv_loop_t* loop); 129 130 int uv__tcp_bind(uv_tcp_t* tcp, 131 const struct sockaddr* addr, 132 unsigned int addrlen, 133 unsigned int flags); 134 135 int uv__tcp_connect(uv_connect_t* req, 136 uv_tcp_t* handle, 137 const struct sockaddr* addr, 138 unsigned int addrlen, 139 uv_connect_cb cb); 140 141 int uv__udp_bind(uv_udp_t* handle, 142 const struct sockaddr* addr, 143 unsigned int addrlen, 144 unsigned int flags); 145 146 int uv__udp_connect(uv_udp_t* handle, 147 const struct sockaddr* addr, 148 unsigned int addrlen); 149 150 int uv__udp_disconnect(uv_udp_t* handle); 151 152 int uv__udp_is_connected(uv_udp_t* handle); 153 154 int uv__udp_send(uv_udp_send_t* req, 155 uv_udp_t* handle, 156 const uv_buf_t bufs[], 157 unsigned int nbufs, 158 const struct sockaddr* addr, 159 unsigned int addrlen, 160 uv_udp_send_cb send_cb); 161 162 int uv__udp_try_send(uv_udp_t* handle, 163 const uv_buf_t bufs[], 164 unsigned int nbufs, 165 const struct sockaddr* addr, 166 unsigned int addrlen); 167 168 int uv__udp_recv_start(uv_udp_t* handle, uv_alloc_cb alloccb, 169 uv_udp_recv_cb recv_cb); 170 171 int uv__udp_recv_stop(uv_udp_t* handle); 172 173 void uv__fs_poll_close(uv_fs_poll_t* handle); 174 175 int uv__getaddrinfo_translate_error(int sys_err); /* EAI_* error. */ 176 177 enum uv__work_kind { 178 UV__WORK_CPU, 179 UV__WORK_FAST_IO, 180 UV__WORK_SLOW_IO 181 }; 182 183 void uv__work_submit(uv_loop_t* loop, 184 struct uv__work *w, 185 enum uv__work_kind kind, 186 void (*work)(struct uv__work *w), 187 void (*done)(struct uv__work *w, int status)); 188 189 void uv__work_done(uv_async_t* handle); 190 191 size_t uv__count_bufs(const uv_buf_t bufs[], unsigned int nbufs); 192 193 int uv__socket_sockopt(uv_handle_t* handle, int optname, int* value); 194 195 void uv__fs_scandir_cleanup(uv_fs_t* req); 196 void uv__fs_readdir_cleanup(uv_fs_t* req); 197 uv_dirent_type_t uv__fs_get_dirent_type(uv__dirent_t* dent); 198 199 int uv__next_timeout(const uv_loop_t* loop); 200 void uv__run_timers(uv_loop_t* loop); 201 void uv__timer_close(uv_timer_t* handle); 202 203 #define uv__has_active_reqs(loop) \ 204 ((loop)->active_reqs.count > 0) 205 206 #define uv__req_register(loop, req) \ 207 do { \ 208 (loop)->active_reqs.count++; \ 209 } \ 210 while (0) 211 212 #define uv__req_unregister(loop, req) \ 213 do { \ 214 assert(uv__has_active_reqs(loop)); \ 215 (loop)->active_reqs.count--; \ 216 } \ 217 while (0) 218 219 #define uv__has_active_handles(loop) \ 220 ((loop)->active_handles > 0) 221 222 #define uv__active_handle_add(h) \ 223 do { \ 224 (h)->loop->active_handles++; \ 225 } \ 226 while (0) 227 228 #define uv__active_handle_rm(h) \ 229 do { \ 230 (h)->loop->active_handles--; \ 231 } \ 232 while (0) 233 234 #define uv__is_active(h) \ 235 (((h)->flags & UV_HANDLE_ACTIVE) != 0) 236 237 #define uv__is_closing(h) \ 238 (((h)->flags & (UV_HANDLE_CLOSING | UV_HANDLE_CLOSED)) != 0) 239 240 #define uv__handle_start(h) \ 241 do { \ 242 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) break; \ 243 (h)->flags |= UV_HANDLE_ACTIVE; \ 244 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_add(h); \ 245 } \ 246 while (0) 247 248 #define uv__handle_stop(h) \ 249 do { \ 250 if (((h)->flags & UV_HANDLE_ACTIVE) == 0) break; \ 251 (h)->flags &= ~UV_HANDLE_ACTIVE; \ 252 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_rm(h); \ 253 } \ 254 while (0) 255 256 #define uv__handle_ref(h) \ 257 do { \ 258 if (((h)->flags & UV_HANDLE_REF) != 0) break; \ 259 (h)->flags |= UV_HANDLE_REF; \ 260 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 261 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_add(h); \ 262 } \ 263 while (0) 264 265 #define uv__handle_unref(h) \ 266 do { \ 267 if (((h)->flags & UV_HANDLE_REF) == 0) break; \ 268 (h)->flags &= ~UV_HANDLE_REF; \ 269 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 270 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_rm(h); \ 271 } \ 272 while (0) 273 274 #define uv__has_ref(h) \ 275 (((h)->flags & UV_HANDLE_REF) != 0) 276 277 #if defined(_WIN32) 278 # define uv__handle_platform_init(h) ((h)->u.fd = -1) 279 #else 280 # define uv__handle_platform_init(h) ((h)->next_closing = NULL) 281 #endif 282 283 #define uv__handle_init(loop_, h, type_) \ 284 do { \ 285 (h)->loop = (loop_); \ 286 (h)->type = (type_); \ 287 (h)->flags = UV_HANDLE_REF; /* Ref the loop when active. */ \ 288 QUEUE_INSERT_TAIL(&(loop_)->handle_queue, &(h)->handle_queue); \ 289 uv__handle_platform_init(h); \ 290 } \ 291 while (0) 292 293 /* Note: uses an open-coded version of SET_REQ_SUCCESS() because of 294 * a circular dependency between src/uv-common.h and src/win/internal.h. 295 */ 296 #if defined(_WIN32) 297 # define UV_REQ_INIT(req, typ) \ 298 do { \ 299 (req)->type = (typ); \ 300 (req)->u.io.overlapped.Internal = 0; /* SET_REQ_SUCCESS() */ \ 301 } \ 302 while (0) 303 #else 304 # define UV_REQ_INIT(req, typ) \ 305 do { \ 306 (req)->type = (typ); \ 307 } \ 308 while (0) 309 #endif 310 311 #define uv__req_init(loop, req, typ) \ 312 do { \ 313 UV_REQ_INIT(req, typ); \ 314 uv__req_register(loop, req); \ 315 } \ 316 while (0) 317 318 /* Allocator prototypes */ 319 void *uv__calloc(size_t count, size_t size); 320 char *uv__strdup(const char* s); 321 char *uv__strndup(const char* s, size_t n); 322 void* uv__malloc(size_t size); 323 void uv__free(void* ptr); 324 void* uv__realloc(void* ptr, size_t size); 325 326 #endif /* UV_COMMON_H_ */ 327