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 UV_HANDLE_UDP_RECVMMSG = 0x04000000, 108 109 /* Only used by uv_pipe_t handles. */ 110 UV_HANDLE_NON_OVERLAPPED_PIPE = 0x01000000, 111 UV_HANDLE_PIPESERVER = 0x02000000, 112 113 /* Only used by uv_tty_t handles. */ 114 UV_HANDLE_TTY_READABLE = 0x01000000, 115 UV_HANDLE_TTY_RAW = 0x02000000, 116 UV_HANDLE_TTY_SAVED_POSITION = 0x04000000, 117 UV_HANDLE_TTY_SAVED_ATTRIBUTES = 0x08000000, 118 119 /* Only used by uv_signal_t handles. */ 120 UV_SIGNAL_ONE_SHOT_DISPATCHED = 0x01000000, 121 UV_SIGNAL_ONE_SHOT = 0x02000000, 122 123 /* Only used by uv_poll_t handles. */ 124 UV_HANDLE_POLL_SLOW = 0x01000000 125 }; 126 127 int uv__loop_configure(uv_loop_t* loop, uv_loop_option option, va_list ap); 128 129 void uv__loop_close(uv_loop_t* loop); 130 131 int uv__tcp_bind(uv_tcp_t* tcp, 132 const struct sockaddr* addr, 133 unsigned int addrlen, 134 unsigned int flags); 135 136 int uv__tcp_connect(uv_connect_t* req, 137 uv_tcp_t* handle, 138 const struct sockaddr* addr, 139 unsigned int addrlen, 140 uv_connect_cb cb); 141 142 int uv__udp_init_ex(uv_loop_t* loop, 143 uv_udp_t* handle, 144 unsigned flags, 145 int domain); 146 147 int uv__udp_bind(uv_udp_t* handle, 148 const struct sockaddr* addr, 149 unsigned int addrlen, 150 unsigned int flags); 151 152 int uv__udp_connect(uv_udp_t* handle, 153 const struct sockaddr* addr, 154 unsigned int addrlen); 155 156 int uv__udp_disconnect(uv_udp_t* handle); 157 158 int uv__udp_is_connected(uv_udp_t* handle); 159 160 int uv__udp_send(uv_udp_send_t* req, 161 uv_udp_t* handle, 162 const uv_buf_t bufs[], 163 unsigned int nbufs, 164 const struct sockaddr* addr, 165 unsigned int addrlen, 166 uv_udp_send_cb send_cb); 167 168 int uv__udp_try_send(uv_udp_t* handle, 169 const uv_buf_t bufs[], 170 unsigned int nbufs, 171 const struct sockaddr* addr, 172 unsigned int addrlen); 173 174 int uv__udp_recv_start(uv_udp_t* handle, uv_alloc_cb alloccb, 175 uv_udp_recv_cb recv_cb); 176 177 int uv__udp_recv_stop(uv_udp_t* handle); 178 179 void uv__fs_poll_close(uv_fs_poll_t* handle); 180 181 int uv__getaddrinfo_translate_error(int sys_err); /* EAI_* error. */ 182 183 enum uv__work_kind { 184 UV__WORK_CPU, 185 UV__WORK_FAST_IO, 186 UV__WORK_SLOW_IO 187 }; 188 189 void uv__work_submit(uv_loop_t* loop, 190 struct uv__work *w, 191 enum uv__work_kind kind, 192 void (*work)(struct uv__work *w), 193 void (*done)(struct uv__work *w, int status)); 194 195 void uv__work_done(uv_async_t* handle); 196 197 size_t uv__count_bufs(const uv_buf_t bufs[], unsigned int nbufs); 198 199 int uv__socket_sockopt(uv_handle_t* handle, int optname, int* value); 200 201 void uv__fs_scandir_cleanup(uv_fs_t* req); 202 void uv__fs_readdir_cleanup(uv_fs_t* req); 203 uv_dirent_type_t uv__fs_get_dirent_type(uv__dirent_t* dent); 204 205 int uv__next_timeout(const uv_loop_t* loop); 206 void uv__run_timers(uv_loop_t* loop); 207 void uv__timer_close(uv_timer_t* handle); 208 209 void uv__process_title_cleanup(void); 210 void uv__signal_cleanup(void); 211 void uv__threadpool_cleanup(void); 212 213 #define uv__has_active_reqs(loop) \ 214 ((loop)->active_reqs.count > 0) 215 216 #define uv__req_register(loop, req) \ 217 do { \ 218 (loop)->active_reqs.count++; \ 219 } \ 220 while (0) 221 222 #define uv__req_unregister(loop, req) \ 223 do { \ 224 assert(uv__has_active_reqs(loop)); \ 225 (loop)->active_reqs.count--; \ 226 } \ 227 while (0) 228 229 #define uv__has_active_handles(loop) \ 230 ((loop)->active_handles > 0) 231 232 #define uv__active_handle_add(h) \ 233 do { \ 234 (h)->loop->active_handles++; \ 235 } \ 236 while (0) 237 238 #define uv__active_handle_rm(h) \ 239 do { \ 240 (h)->loop->active_handles--; \ 241 } \ 242 while (0) 243 244 #define uv__is_active(h) \ 245 (((h)->flags & UV_HANDLE_ACTIVE) != 0) 246 247 #define uv__is_closing(h) \ 248 (((h)->flags & (UV_HANDLE_CLOSING | UV_HANDLE_CLOSED)) != 0) 249 250 #define uv__handle_start(h) \ 251 do { \ 252 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) break; \ 253 (h)->flags |= UV_HANDLE_ACTIVE; \ 254 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_add(h); \ 255 } \ 256 while (0) 257 258 #define uv__handle_stop(h) \ 259 do { \ 260 if (((h)->flags & UV_HANDLE_ACTIVE) == 0) break; \ 261 (h)->flags &= ~UV_HANDLE_ACTIVE; \ 262 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_rm(h); \ 263 } \ 264 while (0) 265 266 #define uv__handle_ref(h) \ 267 do { \ 268 if (((h)->flags & UV_HANDLE_REF) != 0) break; \ 269 (h)->flags |= UV_HANDLE_REF; \ 270 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 271 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_add(h); \ 272 } \ 273 while (0) 274 275 #define uv__handle_unref(h) \ 276 do { \ 277 if (((h)->flags & UV_HANDLE_REF) == 0) break; \ 278 (h)->flags &= ~UV_HANDLE_REF; \ 279 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 280 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_rm(h); \ 281 } \ 282 while (0) 283 284 #define uv__has_ref(h) \ 285 (((h)->flags & UV_HANDLE_REF) != 0) 286 287 #if defined(_WIN32) 288 # define uv__handle_platform_init(h) ((h)->u.fd = -1) 289 #else 290 # define uv__handle_platform_init(h) ((h)->next_closing = NULL) 291 #endif 292 293 #define uv__handle_init(loop_, h, type_) \ 294 do { \ 295 (h)->loop = (loop_); \ 296 (h)->type = (type_); \ 297 (h)->flags = UV_HANDLE_REF; /* Ref the loop when active. */ \ 298 QUEUE_INSERT_TAIL(&(loop_)->handle_queue, &(h)->handle_queue); \ 299 uv__handle_platform_init(h); \ 300 } \ 301 while (0) 302 303 /* Note: uses an open-coded version of SET_REQ_SUCCESS() because of 304 * a circular dependency between src/uv-common.h and src/win/internal.h. 305 */ 306 #if defined(_WIN32) 307 # define UV_REQ_INIT(req, typ) \ 308 do { \ 309 (req)->type = (typ); \ 310 (req)->u.io.overlapped.Internal = 0; /* SET_REQ_SUCCESS() */ \ 311 } \ 312 while (0) 313 #else 314 # define UV_REQ_INIT(req, typ) \ 315 do { \ 316 (req)->type = (typ); \ 317 } \ 318 while (0) 319 #endif 320 321 #define uv__req_init(loop, req, typ) \ 322 do { \ 323 UV_REQ_INIT(req, typ); \ 324 uv__req_register(loop, req); \ 325 } \ 326 while (0) 327 328 /* Allocator prototypes */ 329 void *uv__calloc(size_t count, size_t size); 330 char *uv__strdup(const char* s); 331 char *uv__strndup(const char* s, size_t n); 332 void* uv__malloc(size_t size); 333 void uv__free(void* ptr); 334 void* uv__realloc(void* ptr, size_t size); 335 void* uv__reallocf(void* ptr, size_t size); 336 337 #endif /* UV_COMMON_H_ */ 338