/* 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>

#include <stdint.h>

#if !defined(_WIN32)

# include <sys/time.h>

# include <sys/resource.h> /* setrlimit() */

#endif

#define TEST_PORT 9123

#define TEST_PORT_2 9124

#define TEST_PORT_3 9125

#ifdef _WIN32

# define TEST_PIPENAME "\\\\.\\pipe\\LOCAL\\uv-test"

# define TEST_PIPENAME_2 "\\\\.\\pipe\\LOCAL\\uv-test2"

# define TEST_PIPENAME_3 "\\\\.\\pipe\\LOCAL\\uv-test3"

#else

# define TEST_PIPENAME "uv-test-sock"

# define TEST_PIPENAME_2 "uv-test-sock2"

# define TEST_PIPENAME_3 "uv-test-sock3"

#endif

#ifdef _WIN32

# include <sys/stat.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(a, operator, b, type, conv) \

do { \

type const eval_a = (a); \

type const eval_b = (b); \

if (!(eval_a operator eval_b)) { \

fprintf(stderr, \

"Assertion failed in %s on line %d: `%s %s %s` " \

"(%"conv" %s %"conv")\n", \

__FILE__, \

__LINE__, \

#a, \

#operator, \

#b, \

eval_a, \

#operator, \

eval_b); \

abort(); \

} \

} while (0)

#define ASSERT_OK(a) \

do { \

int64_t const eval_a = (a); \

if (eval_a) { \

fprintf(stderr, \

"Assertion failed in %s on line %d: `%s` okay " \

"(error: %"PRId64")\n", \

__FILE__, \

__LINE__, \

#a, \

eval_a); \

abort(); \

} \

} while (0)

#define ASSERT_BASE_STR(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; \

const unsigned char* a_ = (a); \

const unsigned char* b_ = (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_EQ(a, b) ASSERT_BASE(a, ==, b, int64_t, PRId64)

#define ASSERT_GE(a, b) ASSERT_BASE(a, >=, b, int64_t, PRId64)

#define ASSERT_GT(a, b) ASSERT_BASE(a, >, b, int64_t, PRId64)

#define ASSERT_LE(a, b) ASSERT_BASE(a, <=, b, int64_t, PRId64)

#define ASSERT_LT(a, b) ASSERT_BASE(a, <, b, int64_t, PRId64)

#define ASSERT_NE(a, b) ASSERT_BASE(a, !=, b, int64_t, PRId64)

#define ASSERT_UINT64_EQ(a, b) ASSERT_BASE(a, ==, b, uint64_t, PRIu64)

#define ASSERT_UINT64_GE(a, b) ASSERT_BASE(a, >=, b, uint64_t, PRIu64)

#define ASSERT_UINT64_GT(a, b) ASSERT_BASE(a, >, b, uint64_t, PRIu64)

#define ASSERT_UINT64_LE(a, b) ASSERT_BASE(a, <=, b, uint64_t, PRIu64)

#define ASSERT_UINT64_LT(a, b) ASSERT_BASE(a, <, b, uint64_t, PRIu64)

#define ASSERT_UINT64_NE(a, b) ASSERT_BASE(a, !=, b, uint64_t, PRIu64)

#define ASSERT_DOUBLE_EQ(a, b) ASSERT_BASE(a, ==, b, volatile double, "f")

#define ASSERT_DOUBLE_GE(a, b) ASSERT_BASE(a, >=, b, volatile double, "f")

#define ASSERT_DOUBLE_GT(a, b) ASSERT_BASE(a, >, b, volatile double, "f")

#define ASSERT_DOUBLE_LE(a, b) ASSERT_BASE(a, <=, b, volatile double, "f")

#define ASSERT_DOUBLE_LT(a, b) ASSERT_BASE(a, <, b, volatile double, "f")

#define ASSERT_DOUBLE_NE(a, b) ASSERT_BASE(a, !=, b, volatile double, "f")

#define ASSERT_STR_EQ(a, b) \

ASSERT_BASE_STR(strcmp(a, b) == 0, a, == , b, char*, "s")

#define ASSERT_STR_NE(a, b) \

ASSERT_BASE_STR(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, const void*, "p")

#define ASSERT_NOT_NULL(a) \

ASSERT_BASE(a, !=, NULL, const void*, "p")

#define ASSERT_PTR_EQ(a, b) \

ASSERT_BASE(a, ==, b, const void*, "p")

#define ASSERT_PTR_NE(a, b) \

ASSERT_BASE(a, !=, b, const void*, "p")

#define ASSERT_PTR_LT(a, b) \

ASSERT_BASE(a, <, b, const void*, "p")

#define ASSERT_PTR_LE(a, b) \

ASSERT_BASE(a, <=, b, const void*, "p")

#define ASSERT_PTR_GE(a, b) \

ASSERT_BASE(a, >=, b, const void*, "p")

/* This macro cleans up the event loop. This is used to avoid valgrind

* warnings about memory being "leaked" by the event loop.

*/

#define MAKE_VALGRIND_HAPPY(loop) \

do { \

close_loop(loop); \

ASSERT_EQ(0, uv_loop_close(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)

#ifdef __linux__

#define TEST_FS_IMPL(name) \

int run_test_##name(void); \

int run_test_##name##_iouring(void) { \

uv_os_setenv("UV_USE_IO_URING", "1"); \

uv_loop_configure(uv_default_loop(), UV_LOOP_USE_IO_URING_SQPOLL); \

return run_test_##name(); \

} \

int run_test_##name(void)

#else

#define TEST_FS_IMPL(name) TEST_IMPL(name)

#endif

#define HELPER_IMPL(name) \

int run_helper_##name(void); \

int run_helper_##name(void)

/* Format big numbers nicely. */

char* fmt(char (*buf)[32], double d);

#if defined(__clang__) || \

defined(__GNUC__) || \

defined(__INTEL_COMPILER)

# define UNUSED __attribute__((unused))

#else

# define UNUSED

#endif

/* Reserved test exit codes. */

enum test_status {

TEST_OK = 0,

TEST_SKIP = 7

};

#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)

#ifdef _WIN32

UNUSED static int is_in_appcontainer(void) {

HANDLE token;

DWORD ac;

DWORD len;

int ok;

if (!OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &token))

return 0;

ac = 0;

len = sizeof(ac);

ok = GetTokenInformation(token, TokenIsAppContainer, &ac, len, &len);

CloseHandle(token);

return ok && ac != 0;

}

# define RETURN_SKIP_IN_APPCONTAINER(reason) \

do { \

if (is_in_appcontainer()) \

RETURN_SKIP("AppContainer: " reason); \

} while (0)

#else

# define RETURN_SKIP_IN_APPCONTAINER(reason) do {} while (0)

#endif

#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

extern void notify_parent_process(void);

/* 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__) || defined(__QNX__)

# 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

#if !defined(__linux__) && \

!(defined(__FreeBSD__) && __FreeBSD_version >= 1301000) && \

!defined(_WIN32)

# define NO_CPU_AFFINITY \

"affinity not supported on this platform."

#endif

#endif /* TASK_H_ */