text: /* 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 <stdio.h>
  #include <stddef.h>
  #include <stdlib.h>
  
  #if defined(_MSC_VER) && _MSC_VER < 1600
  # include "uv-private/stdint-msvc2008.h"
  #else
  # include <stdint.h>
  #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"
  #else
  # define TEST_PIPENAME "/tmp/uv-test-sock"
  # define TEST_PIPENAME_2 "/tmp/uv-test-sock2"
  #endif
  
  // YQ_MARK: 获取数组的大小
  #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  
  // YQ_MARK: 已知结构体type中的member元素的地址ptr，求member元素所在的结构体的地址
  // e.g.:
  // typedef struct {
  //    int a;
  //    int b;
  //    char c;
  // } A;
  // struct A aa;
  // container_of(&aa.b, struct A, b);
  #define container_of(ptr, type, member) \
    ((type *) ((char *) (ptr) - offsetof(type, member)))
  
  typedef enum {
    TCP = 0,
    UDP,
    PIPE
  } stream_type;
  
  /* Log to stderr. */
  // YQ_MARK: e.g.: LOG("string");
  #define LOG(...)                        \
    do {                                  \
      fprintf(stderr, "%s", __VA_ARGS__); \
      fflush(stderr);                     \
    } while (0)
  
  // YQ_MARK: e.g.: LOGF("string %s, %d", "info", 123);
  #define LOGF(...)                       \
    do {                                  \
      fprintf(stderr, __VA_ARGS__);       \
      fflush(stderr);                     \
    } while (0)
  
  /* Die with fatal error. */
  // YQ_MARK: e.g.: FATAL("Error Message");
  #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)
  
  /* This macro cleans up the main loop. This is used to avoid valgrind
   * warnings about memory being "leaked" by the main event loop.
   */
  // YQ_MARK: TODO:: 需要看过uv_loop机制再来分析
  #define MAKE_VALGRIND_HAPPY()  \
    uv_loop_delete(uv_default_loop())
  
  /* Just sugar for wrapping the main() for a task or helper. */
  // YQ_MARK: 使用宏去动态定义测试样例函数并且声明函数，属于语法糖
  #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)
  
  /* Pause the calling thread for a number of milliseconds. */
  void uv_sleep(int msec);
  
  /* Format big numbers nicely. WARNING: leaks memory. */
  const char* fmt(double d);
  
  /* Reserved test exit codes. */
  enum test_status {
    TEST_OK = 0,
    TEST_TODO,
    TEST_SKIP
  };
  
  #define RETURN_OK()                                                           \
    do {                                                                        \
      return TEST_OK;                                                           \
    } while (0)
  
  #define RETURN_TODO(explanation)                                              \
    do {                                                                        \
      LOGF("%s\n", explanation);                                                \
      return TEST_TODO;                                                         \
    } while (0)
  
  #define RETURN_SKIP(explanation)                                              \
    do {                                                                        \
      LOGF("%s\n", explanation);                                                \
      return TEST_SKIP;                                                         \
    } while (0)
  
  #endif /* TASK_H_ */
  