Utilities/cmlibuv/src/uv-common.h

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