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 #if defined(__GNUC__) && (__GNUC__ > 4 || __GNUC__ == 4 && __GNUC_MINOR__ >= 7) 64 #define uv__load_relaxed(p) __atomic_load_n(p, __ATOMIC_RELAXED) 65 #define uv__store_relaxed(p, v) __atomic_store_n(p, v, __ATOMIC_RELAXED) 66 #else 67 #define uv__load_relaxed(p) (*p) 68 #define uv__store_relaxed(p, v) do *p = v; while (0) 69 #endif 70 71 /* Handle flags. Some flags are specific to Windows or UNIX. */ 72 enum { 73 /* Used by all handles. */ 74 UV_HANDLE_CLOSING = 0x00000001, 75 UV_HANDLE_CLOSED = 0x00000002, 76 UV_HANDLE_ACTIVE = 0x00000004, 77 UV_HANDLE_REF = 0x00000008, 78 UV_HANDLE_INTERNAL = 0x00000010, 79 UV_HANDLE_ENDGAME_QUEUED = 0x00000020, 80 81 /* Used by streams. */ 82 UV_HANDLE_LISTENING = 0x00000040, 83 UV_HANDLE_CONNECTION = 0x00000080, 84 UV_HANDLE_SHUTTING = 0x00000100, 85 UV_HANDLE_SHUT = 0x00000200, 86 UV_HANDLE_READ_PARTIAL = 0x00000400, 87 UV_HANDLE_READ_EOF = 0x00000800, 88 89 /* Used by streams and UDP handles. */ 90 UV_HANDLE_READING = 0x00001000, 91 UV_HANDLE_BOUND = 0x00002000, 92 UV_HANDLE_READABLE = 0x00004000, 93 UV_HANDLE_WRITABLE = 0x00008000, 94 UV_HANDLE_READ_PENDING = 0x00010000, 95 UV_HANDLE_SYNC_BYPASS_IOCP = 0x00020000, 96 UV_HANDLE_ZERO_READ = 0x00040000, 97 UV_HANDLE_EMULATE_IOCP = 0x00080000, 98 UV_HANDLE_BLOCKING_WRITES = 0x00100000, 99 UV_HANDLE_CANCELLATION_PENDING = 0x00200000, 100 101 /* Used by uv_tcp_t and uv_udp_t handles */ 102 UV_HANDLE_IPV6 = 0x00400000, 103 104 /* Only used by uv_tcp_t handles. */ 105 UV_HANDLE_TCP_NODELAY = 0x01000000, 106 UV_HANDLE_TCP_KEEPALIVE = 0x02000000, 107 UV_HANDLE_TCP_SINGLE_ACCEPT = 0x04000000, 108 UV_HANDLE_TCP_ACCEPT_STATE_CHANGING = 0x08000000, 109 UV_HANDLE_TCP_SOCKET_CLOSED = 0x10000000, 110 UV_HANDLE_SHARED_TCP_SOCKET = 0x20000000, 111 112 /* Only used by uv_udp_t handles. */ 113 UV_HANDLE_UDP_PROCESSING = 0x01000000, 114 UV_HANDLE_UDP_CONNECTED = 0x02000000, 115 UV_HANDLE_UDP_RECVMMSG = 0x04000000, 116 117 /* Only used by uv_pipe_t handles. */ 118 UV_HANDLE_NON_OVERLAPPED_PIPE = 0x01000000, 119 UV_HANDLE_PIPESERVER = 0x02000000, 120 121 /* Only used by uv_tty_t handles. */ 122 UV_HANDLE_TTY_READABLE = 0x01000000, 123 UV_HANDLE_TTY_RAW = 0x02000000, 124 UV_HANDLE_TTY_SAVED_POSITION = 0x04000000, 125 UV_HANDLE_TTY_SAVED_ATTRIBUTES = 0x08000000, 126 127 /* Only used by uv_signal_t handles. */ 128 UV_SIGNAL_ONE_SHOT_DISPATCHED = 0x01000000, 129 UV_SIGNAL_ONE_SHOT = 0x02000000, 130 131 /* Only used by uv_poll_t handles. */ 132 UV_HANDLE_POLL_SLOW = 0x01000000 133 }; 134 135 int uv__loop_configure(uv_loop_t* loop, uv_loop_option option, va_list ap); 136 137 void uv__loop_close(uv_loop_t* loop); 138 139 int uv__tcp_bind(uv_tcp_t* tcp, 140 const struct sockaddr* addr, 141 unsigned int addrlen, 142 unsigned int flags); 143 144 int uv__tcp_connect(uv_connect_t* req, 145 uv_tcp_t* handle, 146 const struct sockaddr* addr, 147 unsigned int addrlen, 148 uv_connect_cb cb); 149 150 int uv__udp_init_ex(uv_loop_t* loop, 151 uv_udp_t* handle, 152 unsigned flags, 153 int domain); 154 155 int uv__udp_bind(uv_udp_t* handle, 156 const struct sockaddr* addr, 157 unsigned int addrlen, 158 unsigned int flags); 159 160 int uv__udp_connect(uv_udp_t* handle, 161 const struct sockaddr* addr, 162 unsigned int addrlen); 163 164 int uv__udp_disconnect(uv_udp_t* handle); 165 166 int uv__udp_is_connected(uv_udp_t* handle); 167 168 int uv__udp_send(uv_udp_send_t* req, 169 uv_udp_t* handle, 170 const uv_buf_t bufs[], 171 unsigned int nbufs, 172 const struct sockaddr* addr, 173 unsigned int addrlen, 174 uv_udp_send_cb send_cb); 175 176 int uv__udp_try_send(uv_udp_t* handle, 177 const uv_buf_t bufs[], 178 unsigned int nbufs, 179 const struct sockaddr* addr, 180 unsigned int addrlen); 181 182 int uv__udp_recv_start(uv_udp_t* handle, uv_alloc_cb alloccb, 183 uv_udp_recv_cb recv_cb); 184 185 int uv__udp_recv_stop(uv_udp_t* handle); 186 187 void uv__fs_poll_close(uv_fs_poll_t* handle); 188 189 int uv__getaddrinfo_translate_error(int sys_err); /* EAI_* error. */ 190 191 enum uv__work_kind { 192 UV__WORK_CPU, 193 UV__WORK_FAST_IO, 194 UV__WORK_SLOW_IO 195 }; 196 197 void uv__work_submit(uv_loop_t* loop, 198 struct uv__work *w, 199 enum uv__work_kind kind, 200 void (*work)(struct uv__work *w), 201 void (*done)(struct uv__work *w, int status)); 202 203 void uv__work_done(uv_async_t* handle); 204 205 size_t uv__count_bufs(const uv_buf_t bufs[], unsigned int nbufs); 206 207 int uv__socket_sockopt(uv_handle_t* handle, int optname, int* value); 208 209 void uv__fs_scandir_cleanup(uv_fs_t* req); 210 void uv__fs_readdir_cleanup(uv_fs_t* req); 211 uv_dirent_type_t uv__fs_get_dirent_type(uv__dirent_t* dent); 212 213 int uv__next_timeout(const uv_loop_t* loop); 214 void uv__run_timers(uv_loop_t* loop); 215 void uv__timer_close(uv_timer_t* handle); 216 217 void uv__process_title_cleanup(void); 218 void uv__signal_cleanup(void); 219 void uv__threadpool_cleanup(void); 220 221 #define uv__has_active_reqs(loop) \ 222 ((loop)->active_reqs.count > 0) 223 224 #define uv__req_register(loop, req) \ 225 do { \ 226 (loop)->active_reqs.count++; \ 227 } \ 228 while (0) 229 230 #define uv__req_unregister(loop, req) \ 231 do { \ 232 assert(uv__has_active_reqs(loop)); \ 233 (loop)->active_reqs.count--; \ 234 } \ 235 while (0) 236 237 #define uv__has_active_handles(loop) \ 238 ((loop)->active_handles > 0) 239 240 #define uv__active_handle_add(h) \ 241 do { \ 242 (h)->loop->active_handles++; \ 243 } \ 244 while (0) 245 246 #define uv__active_handle_rm(h) \ 247 do { \ 248 (h)->loop->active_handles--; \ 249 } \ 250 while (0) 251 252 #define uv__is_active(h) \ 253 (((h)->flags & UV_HANDLE_ACTIVE) != 0) 254 255 #define uv__is_closing(h) \ 256 (((h)->flags & (UV_HANDLE_CLOSING | UV_HANDLE_CLOSED)) != 0) 257 258 #define uv__handle_start(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_add(h); \ 263 } \ 264 while (0) 265 266 #define uv__handle_stop(h) \ 267 do { \ 268 if (((h)->flags & UV_HANDLE_ACTIVE) == 0) break; \ 269 (h)->flags &= ~UV_HANDLE_ACTIVE; \ 270 if (((h)->flags & UV_HANDLE_REF) != 0) uv__active_handle_rm(h); \ 271 } \ 272 while (0) 273 274 #define uv__handle_ref(h) \ 275 do { \ 276 if (((h)->flags & UV_HANDLE_REF) != 0) break; \ 277 (h)->flags |= UV_HANDLE_REF; \ 278 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 279 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_add(h); \ 280 } \ 281 while (0) 282 283 #define uv__handle_unref(h) \ 284 do { \ 285 if (((h)->flags & UV_HANDLE_REF) == 0) break; \ 286 (h)->flags &= ~UV_HANDLE_REF; \ 287 if (((h)->flags & UV_HANDLE_CLOSING) != 0) break; \ 288 if (((h)->flags & UV_HANDLE_ACTIVE) != 0) uv__active_handle_rm(h); \ 289 } \ 290 while (0) 291 292 #define uv__has_ref(h) \ 293 (((h)->flags & UV_HANDLE_REF) != 0) 294 295 #if defined(_WIN32) 296 # define uv__handle_platform_init(h) ((h)->u.fd = -1) 297 #else 298 # define uv__handle_platform_init(h) ((h)->next_closing = NULL) 299 #endif 300 301 #define uv__handle_init(loop_, h, type_) \ 302 do { \ 303 (h)->loop = (loop_); \ 304 (h)->type = (type_); \ 305 (h)->flags = UV_HANDLE_REF; /* Ref the loop when active. */ \ 306 QUEUE_INSERT_TAIL(&(loop_)->handle_queue, &(h)->handle_queue); \ 307 uv__handle_platform_init(h); \ 308 } \ 309 while (0) 310 311 /* Note: uses an open-coded version of SET_REQ_SUCCESS() because of 312 * a circular dependency between src/uv-common.h and src/win/internal.h. 313 */ 314 #if defined(_WIN32) 315 # define UV_REQ_INIT(req, typ) \ 316 do { \ 317 (req)->type = (typ); \ 318 (req)->u.io.overlapped.Internal = 0; /* SET_REQ_SUCCESS() */ \ 319 } \ 320 while (0) 321 #else 322 # define UV_REQ_INIT(req, typ) \ 323 do { \ 324 (req)->type = (typ); \ 325 } \ 326 while (0) 327 #endif 328 329 #define uv__req_init(loop, req, typ) \ 330 do { \ 331 UV_REQ_INIT(req, typ); \ 332 uv__req_register(loop, req); \ 333 } \ 334 while (0) 335 336 #define uv__get_internal_fields(loop) \ 337 ((uv__loop_internal_fields_t*) loop->internal_fields) 338 339 #define uv__get_loop_metrics(loop) \ 340 (&uv__get_internal_fields(loop)->loop_metrics) 341 342 /* Allocator prototypes */ 343 void *uv__calloc(size_t count, size_t size); 344 char *uv__strdup(const char* s); 345 char *uv__strndup(const char* s, size_t n); 346 void* uv__malloc(size_t size); 347 void uv__free(void* ptr); 348 void* uv__realloc(void* ptr, size_t size); 349 void* uv__reallocf(void* ptr, size_t size); 350 351 typedef struct uv__loop_metrics_s uv__loop_metrics_t; 352 typedef struct uv__loop_internal_fields_s uv__loop_internal_fields_t; 353 354 struct uv__loop_metrics_s { 355 uint64_t provider_entry_time; 356 uint64_t provider_idle_time; 357 uv_mutex_t lock; 358 }; 359 360 void uv__metrics_update_idle_time(uv_loop_t* loop); 361 void uv__metrics_set_provider_entry_time(uv_loop_t* loop); 362 363 struct uv__loop_internal_fields_s { 364 unsigned int flags; 365 uv__loop_metrics_t loop_metrics; 366 }; 367 368 #endif /* UV_COMMON_H_ */ 369