mbuf: fix performance with 128-byte cache line
[dpdk.git] / app / test / test.h
index d208992..a2fba60 100644 (file)
 /*-
  *   BSD LICENSE
- * 
- *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
+ *
+ *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
  *   All rights reserved.
- * 
- *   Redistribution and use in source and binary forms, with or without 
- *   modification, are permitted provided that the following conditions 
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
  *   are met:
- * 
- *     * Redistributions of source code must retain the above copyright 
+ *
+ *     * Redistributions of source code must retain the above copyright
  *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright 
- *       notice, this list of conditions and the following disclaimer in 
- *       the documentation and/or other materials provided with the 
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
  *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its 
- *       contributors may be used to endorse or promote products derived 
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
  *       from this software without specific prior written permission.
- * 
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * 
  */
 
 #ifndef _TEST_H_
 #define _TEST_H_
+#include <stddef.h>
+#include <sys/queue.h>
 
-/* icc on baremetal gives us troubles with function named 'main' */
-#ifdef RTE_EXEC_ENV_BAREMETAL
-#define main _main
+#define TEST_SUCCESS  (0)
+#define TEST_FAILED  (-1)
+
+/* Before including test.h file you can define
+ * TEST_TRACE_FAILURE(_file, _line, _func) macro to better trace/debug test
+ * failures. Mostly useful in test development phase. */
+#ifndef TEST_TRACE_FAILURE
+# define TEST_TRACE_FAILURE(_file, _line, _func)
 #endif
 
-#define RECURSIVE_ENV_VAR "RTE_TEST_RECURSIVE"
+#define TEST_ASSERT(cond, msg, ...) do {                         \
+               if (!(cond)) {                                           \
+                       printf("TestCase %s() line %d failed: "              \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
 
-extern const char *prgname;
+#define TEST_ASSERT_EQUAL(a, b, msg, ...) do {                   \
+               if (!(a == b)) {                                         \
+                       printf("TestCase %s() line %d failed: "              \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
+
+
+#define TEST_ASSERT_BUFFERS_ARE_EQUAL(a, b, len,  msg, ...) do {       \
+       if (memcmp(a, b, len)) {                                        \
+               printf("TestCase %s() line %d failed: "              \
+                       msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+               TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+               return TEST_FAILED;                                  \
+       }                                                        \
+} while (0)
+
+
+#define TEST_ASSERT_NOT_EQUAL(a, b, msg, ...) do {               \
+               if (!(a != b)) {                                         \
+                       printf("TestCase %s() line %d failed: "              \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
+
+#define TEST_ASSERT_SUCCESS(val, msg, ...) do {                  \
+               typeof(val) _val = (val);                                \
+               if (!(_val == 0)) {                                      \
+                       printf("TestCase %s() line %d failed (err %d): "     \
+                               msg "\n", __func__, __LINE__, _val,              \
+                               ##__VA_ARGS__);                                  \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
+
+#define TEST_ASSERT_FAIL(val, msg, ...) do {                     \
+               if (!(val != 0)) {                                       \
+                       printf("TestCase %s() line %d failed: "              \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
+
+#define TEST_ASSERT_NULL(val, msg, ...) do {                     \
+               if (!(val == NULL)) {                                    \
+                       printf("TestCase %s() line %d failed: "              \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
+
+#define TEST_ASSERT_NOT_NULL(val, msg, ...) do {                 \
+               if (!(val != NULL)) {                                    \
+                       printf("TestCase %s() line %d failed: "              \
+                               msg "\n", __func__, __LINE__, ##__VA_ARGS__);    \
+                       TEST_TRACE_FAILURE(__FILE__, __LINE__, __func__);    \
+                       return TEST_FAILED;                                  \
+               }                                                        \
+} while (0)
+
+struct unit_test_case {
+       int (*setup)(void);
+       void (*teardown)(void);
+       int (*testcase)(void);
+       const char *success_msg;
+       const char *fail_msg;
+       unsigned enabled;
+};
+
+#define TEST_CASE(fn) { NULL, NULL, fn, #fn " succeeded", #fn " failed", 1 }
+
+#define TEST_CASE_NAMED(name, fn) { NULL, NULL, fn, name " succeeded", \
+               name " failed", 1 }
+
+#define TEST_CASE_ST(setup, teardown, testcase)         \
+               { setup, teardown, testcase, #testcase " succeeded",    \
+               #testcase " failed ", 1 }
 
-extern cmdline_parse_ctx_t main_ctx[];
 
-void test_hexdump(const char *title, const void *buf, unsigned int len);
+#define TEST_CASE_DISABLED(fn) { NULL, NULL, fn, #fn " succeeded", \
+       #fn " failed", 0 }
 
-int main(int argc, char **argv);
+#define TEST_CASE_ST_DISABLED(setup, teardown, testcase)         \
+               { setup, teardown, testcase, #testcase " succeeded",    \
+               #testcase " failed ", 0 }
+
+#define TEST_CASES_END() { NULL, NULL, NULL, NULL, NULL, 0 }
+
+struct unit_test_suite {
+       const char *suite_name;
+       int (*setup)(void);
+       void (*teardown)(void);
+       struct unit_test_case unit_test_cases[];
+};
+
+int unit_test_suite_runner(struct unit_test_suite *suite);
+
+#define RECURSIVE_ENV_VAR "RTE_TEST_RECURSIVE"
+
+#include <cmdline_parse.h>
+#include <cmdline_parse_string.h>
+
+extern const char *prgname;
+
+int commands_init(void);
 
 int test_pci(void);
-int test_memory(void);
-int test_per_lcore(void);
-int test_spinlock(void);
-int test_rwlock(void);
-int test_atomic(void);
-int test_byteorder(void);
-int test_prefetch(void);
-int test_cycles(void);
-int test_logs(void);
-int test_memzone(void);
-int test_ring(void);
-int test_mempool(void);
-int test_mbuf(void);
-int test_timer(void);
-int test_malloc(void);
-int test_memcpy(void);
-int test_hash(void);
-int test_lpm(void);
-int test_debug(void);
-int test_errno(void);
-int test_tailq(void);
-int test_string_fns(void);
+int test_pci_run;
+
 int test_mp_secondary(void);
-int test_cpuflags(void);
-int test_eal_flags(void);
-int test_alarm(void);
-int test_interrupt(void);
-int test_version(void);
-int test_eal_fs(void);
 
-int test_pci_run;
+int test_ivshmem(void);
+int test_set_rxtx_conf(cmdline_fixed_string_t mode);
+int test_set_rxtx_anchor(cmdline_fixed_string_t type);
+int test_set_rxtx_sc(cmdline_fixed_string_t type);
+
+typedef int (test_callback)(void);
+TAILQ_HEAD(test_commands_list, test_command);
+struct test_command {
+       TAILQ_ENTRY(test_command) next;
+       const char *command;
+       test_callback *callback;
+};
+
+void add_test_command(struct test_command *t);
+
+#define REGISTER_TEST_COMMAND(t) \
+static void __attribute__((used)) testfn_##t(void);\
+void __attribute__((constructor, used)) testfn_##t(void)\
+{\
+       add_test_command(&t);\
+}
 
 #endif