mirror of
https://github.com/libuv/libuv
synced 2025-03-28 21:13:16 +00:00
72fe3543fe
Make it possible to explicitly tell libuv to release any resources it's still holding onto (memory, threads, file descriptors, etc.) Before this commit, cleanup was performed in various destructors. This commit centralizes the cleanup logic, enabling the addition of `uv_library_shutdown()`, but maintains the current observable behavior of cleaning up when libuv is unloaded by means of `dlclose(3)`. Fixes: https://github.com/libuv/libuv/issues/2763 PR-URL: https://github.com/libuv/libuv/pull/2764 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
354 lines
13 KiB
C
354 lines
13 KiB
C
/* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to
|
|
* deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
* sell copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
* IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef TASK_H_
|
|
#define TASK_H_
|
|
|
|
#include "uv.h"
|
|
|
|
#include <stdio.h>
|
|
#include <stddef.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <inttypes.h>
|
|
|
|
#if defined(_MSC_VER) && _MSC_VER < 1600
|
|
# include "uv/stdint-msvc2008.h"
|
|
#else
|
|
# include <stdint.h>
|
|
#endif
|
|
|
|
#if !defined(_WIN32)
|
|
# include <sys/time.h>
|
|
# include <sys/resource.h> /* setrlimit() */
|
|
#endif
|
|
|
|
#ifdef __clang__
|
|
# pragma clang diagnostic ignored "-Wvariadic-macros"
|
|
# pragma clang diagnostic ignored "-Wc99-extensions"
|
|
#endif
|
|
|
|
#ifdef __GNUC__
|
|
# pragma GCC diagnostic ignored "-Wvariadic-macros"
|
|
#endif
|
|
|
|
#define TEST_PORT 9123
|
|
#define TEST_PORT_2 9124
|
|
|
|
#ifdef _WIN32
|
|
# define TEST_PIPENAME "\\\\?\\pipe\\uv-test"
|
|
# define TEST_PIPENAME_2 "\\\\?\\pipe\\uv-test2"
|
|
# define TEST_PIPENAME_3 "\\\\?\\pipe\\uv-test3"
|
|
#else
|
|
# define TEST_PIPENAME "/tmp/uv-test-sock"
|
|
# define TEST_PIPENAME_2 "/tmp/uv-test-sock2"
|
|
# define TEST_PIPENAME_3 "/tmp/uv-test-sock3"
|
|
#endif
|
|
|
|
#ifdef _WIN32
|
|
# include <io.h>
|
|
# ifndef S_IRUSR
|
|
# define S_IRUSR _S_IREAD
|
|
# endif
|
|
# ifndef S_IWUSR
|
|
# define S_IWUSR _S_IWRITE
|
|
# endif
|
|
#endif
|
|
|
|
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
|
|
|
|
#define container_of(ptr, type, member) \
|
|
((type *) ((char *) (ptr) - offsetof(type, member)))
|
|
|
|
typedef enum {
|
|
TCP = 0,
|
|
UDP,
|
|
PIPE
|
|
} stream_type;
|
|
|
|
/* Die with fatal error. */
|
|
#define FATAL(msg) \
|
|
do { \
|
|
fprintf(stderr, \
|
|
"Fatal error in %s on line %d: %s\n", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
msg); \
|
|
fflush(stderr); \
|
|
abort(); \
|
|
} while (0)
|
|
|
|
/* Have our own assert, so we are sure it does not get optimized away in
|
|
* a release build.
|
|
*/
|
|
#define ASSERT(expr) \
|
|
do { \
|
|
if (!(expr)) { \
|
|
fprintf(stderr, \
|
|
"Assertion failed in %s on line %d: %s\n", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
#expr); \
|
|
abort(); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define ASSERT_BASE(expr, a, operator, b, type, conv) \
|
|
do { \
|
|
if (!(expr)) { \
|
|
fprintf(stderr, \
|
|
"Assertion failed in %s on line %d: `%s %s %s` " \
|
|
"(%"conv" %s %"conv")\n", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
#a, \
|
|
#operator, \
|
|
#b, \
|
|
(type)a, \
|
|
#operator, \
|
|
(type)b); \
|
|
abort(); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define ASSERT_BASE_LEN(expr, a, operator, b, conv, len) \
|
|
do { \
|
|
if (!(expr)) { \
|
|
fprintf(stderr, \
|
|
"Assertion failed in %s on line %d: `%s %s %s` " \
|
|
"(%.*"#conv" %s %.*"#conv")\n", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
#a, \
|
|
#operator, \
|
|
#b, \
|
|
(int)len, \
|
|
a, \
|
|
#operator, \
|
|
(int)len, \
|
|
b); \
|
|
abort(); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define ASSERT_BASE_HEX(expr, a, operator, b, size) \
|
|
do { \
|
|
if (!(expr)) { \
|
|
int i; \
|
|
unsigned char* a_ = (unsigned char*)a; \
|
|
unsigned char* b_ = (unsigned char*)b; \
|
|
fprintf(stderr, \
|
|
"Assertion failed in %s on line %d: `%s %s %s` (", \
|
|
__FILE__, \
|
|
__LINE__, \
|
|
#a, \
|
|
#operator, \
|
|
#b); \
|
|
for (i = 0; i < size; ++i) { \
|
|
if (i > 0) fprintf(stderr, ":"); \
|
|
fprintf(stderr, "%02X", a_[i]); \
|
|
} \
|
|
fprintf(stderr, " %s ", #operator); \
|
|
for (i = 0; i < size; ++i) { \
|
|
if (i > 0) fprintf(stderr, ":"); \
|
|
fprintf(stderr, "%02X", b_[i]); \
|
|
} \
|
|
fprintf(stderr, ")\n"); \
|
|
abort(); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define ASSERT_INT_BASE(a, operator, b, type, conv) \
|
|
ASSERT_BASE(a operator b, a, operator, b, type, conv)
|
|
|
|
#define ASSERT_EQ(a, b) ASSERT_INT_BASE(a, ==, b, int64_t, PRId64)
|
|
#define ASSERT_GE(a, b) ASSERT_INT_BASE(a, >=, b, int64_t, PRId64)
|
|
#define ASSERT_GT(a, b) ASSERT_INT_BASE(a, >, b, int64_t, PRId64)
|
|
#define ASSERT_LE(a, b) ASSERT_INT_BASE(a, <=, b, int64_t, PRId64)
|
|
#define ASSERT_LT(a, b) ASSERT_INT_BASE(a, <, b, int64_t, PRId64)
|
|
#define ASSERT_NE(a, b) ASSERT_INT_BASE(a, !=, b, int64_t, PRId64)
|
|
|
|
#define ASSERT_UINT64_EQ(a, b) ASSERT_INT_BASE(a, ==, b, uint64_t, PRIu64)
|
|
#define ASSERT_UINT64_GE(a, b) ASSERT_INT_BASE(a, >=, b, uint64_t, PRIu64)
|
|
#define ASSERT_UINT64_GT(a, b) ASSERT_INT_BASE(a, >, b, uint64_t, PRIu64)
|
|
#define ASSERT_UINT64_LE(a, b) ASSERT_INT_BASE(a, <=, b, uint64_t, PRIu64)
|
|
#define ASSERT_UINT64_LT(a, b) ASSERT_INT_BASE(a, <, b, uint64_t, PRIu64)
|
|
#define ASSERT_UINT64_NE(a, b) ASSERT_INT_BASE(a, !=, b, uint64_t, PRIu64)
|
|
|
|
#define ASSERT_STR_EQ(a, b) \
|
|
ASSERT_BASE(strcmp(a, b) == 0, a, ==, b, char*, "s")
|
|
|
|
#define ASSERT_STR_NE(a, b) \
|
|
ASSERT_BASE(strcmp(a, b) != 0, a, !=, b, char*, "s")
|
|
|
|
#define ASSERT_MEM_EQ(a, b, size) \
|
|
ASSERT_BASE_LEN(memcmp(a, b, size) == 0, a, ==, b, s, size)
|
|
|
|
#define ASSERT_MEM_NE(a, b, size) \
|
|
ASSERT_BASE_LEN(memcmp(a, b, size) != 0, a, !=, b, s, size)
|
|
|
|
#define ASSERT_MEM_HEX_EQ(a, b, size) \
|
|
ASSERT_BASE_HEX(memcmp(a, b, size) == 0, a, ==, b, size)
|
|
|
|
#define ASSERT_MEM_HEX_NE(a, b, size) \
|
|
ASSERT_BASE_HEX(memcmp(a, b, size) != 0, a, !=, b, size)
|
|
|
|
#define ASSERT_NULL(a) \
|
|
ASSERT_BASE(a == NULL, a, ==, NULL, void*, "p")
|
|
|
|
#define ASSERT_NOT_NULL(a) \
|
|
ASSERT_BASE(a != NULL, a, !=, NULL, void*, "p")
|
|
|
|
#define ASSERT_PTR_EQ(a, b) \
|
|
ASSERT_BASE((void*)a == (void*)b, a, ==, b, void*, "p")
|
|
|
|
#define ASSERT_PTR_NE(a, b) \
|
|
ASSERT_BASE((void*)a != (void*)b, a, !=, b, void*, "p")
|
|
|
|
/* This macro cleans up the main loop. This is used to avoid valgrind
|
|
* warnings about memory being "leaked" by the main event loop.
|
|
*/
|
|
#define MAKE_VALGRIND_HAPPY() \
|
|
do { \
|
|
close_loop(uv_default_loop()); \
|
|
ASSERT(0 == uv_loop_close(uv_default_loop())); \
|
|
uv_library_shutdown(); \
|
|
} while (0)
|
|
|
|
/* Just sugar for wrapping the main() for a task or helper. */
|
|
#define TEST_IMPL(name) \
|
|
int run_test_##name(void); \
|
|
int run_test_##name(void)
|
|
|
|
#define BENCHMARK_IMPL(name) \
|
|
int run_benchmark_##name(void); \
|
|
int run_benchmark_##name(void)
|
|
|
|
#define HELPER_IMPL(name) \
|
|
int run_helper_##name(void); \
|
|
int run_helper_##name(void)
|
|
|
|
/* Format big numbers nicely. WARNING: leaks memory. */
|
|
const char* fmt(double d);
|
|
|
|
/* Reserved test exit codes. */
|
|
enum test_status {
|
|
TEST_OK = 0,
|
|
TEST_SKIP
|
|
};
|
|
|
|
#define RETURN_OK() \
|
|
do { \
|
|
return TEST_OK; \
|
|
} while (0)
|
|
|
|
#define RETURN_SKIP(explanation) \
|
|
do { \
|
|
fprintf(stderr, "%s\n", explanation); \
|
|
fflush(stderr); \
|
|
return TEST_SKIP; \
|
|
} while (0)
|
|
|
|
#if !defined(_WIN32)
|
|
|
|
# define TEST_FILE_LIMIT(num) \
|
|
do { \
|
|
struct rlimit lim; \
|
|
lim.rlim_cur = (num); \
|
|
lim.rlim_max = lim.rlim_cur; \
|
|
if (setrlimit(RLIMIT_NOFILE, &lim)) \
|
|
RETURN_SKIP("File descriptor limit too low."); \
|
|
} while (0)
|
|
|
|
#else /* defined(_WIN32) */
|
|
|
|
# define TEST_FILE_LIMIT(num) do {} while (0)
|
|
|
|
#endif
|
|
|
|
#if !defined(snprintf) && defined(_MSC_VER) && _MSC_VER < 1900
|
|
extern int snprintf(char*, size_t, const char*, ...);
|
|
#endif
|
|
|
|
#if defined(__clang__) || \
|
|
defined(__GNUC__) || \
|
|
defined(__INTEL_COMPILER)
|
|
# define UNUSED __attribute__((unused))
|
|
#else
|
|
# define UNUSED
|
|
#endif
|
|
|
|
#if defined(_WIN32)
|
|
#define notify_parent_process() ((void) 0)
|
|
#else
|
|
extern void notify_parent_process(void);
|
|
#endif
|
|
|
|
/* Fully close a loop */
|
|
static void close_walk_cb(uv_handle_t* handle, void* arg) {
|
|
if (!uv_is_closing(handle))
|
|
uv_close(handle, NULL);
|
|
}
|
|
|
|
UNUSED static void close_loop(uv_loop_t* loop) {
|
|
uv_walk(loop, close_walk_cb, NULL);
|
|
uv_run(loop, UV_RUN_DEFAULT);
|
|
}
|
|
|
|
UNUSED static int can_ipv6(void) {
|
|
uv_interface_address_t* addr;
|
|
int supported;
|
|
int count;
|
|
int i;
|
|
|
|
if (uv_interface_addresses(&addr, &count))
|
|
return 0; /* Assume no IPv6 support on failure. */
|
|
|
|
supported = 0;
|
|
for (i = 0; supported == 0 && i < count; i += 1)
|
|
supported = (AF_INET6 == addr[i].address.address6.sin6_family);
|
|
|
|
uv_free_interface_addresses(addr, count);
|
|
return supported;
|
|
}
|
|
|
|
#if defined(__CYGWIN__) || defined(__MSYS__) || defined(__PASE__)
|
|
# define NO_FS_EVENTS "Filesystem watching not supported on this platform."
|
|
#endif
|
|
|
|
#if defined(__MSYS__)
|
|
# define NO_SEND_HANDLE_ON_PIPE \
|
|
"MSYS2 runtime does not support sending handles on pipes."
|
|
#elif defined(__CYGWIN__)
|
|
# define NO_SEND_HANDLE_ON_PIPE \
|
|
"Cygwin runtime does not support sending handles on pipes."
|
|
#endif
|
|
|
|
#if defined(__MSYS__)
|
|
# define NO_SELF_CONNECT \
|
|
"MSYS2 runtime hangs on listen+connect in same process."
|
|
#elif defined(__CYGWIN__)
|
|
# define NO_SELF_CONNECT \
|
|
"Cygwin runtime hangs on listen+connect in same process."
|
|
#endif
|
|
|
|
#endif /* TASK_H_ */
|