app/test/test_memcpy_perf.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #include <stdint.h>
  36 #include <stdio.h>
  37 #include <string.h>
  38 #include <stdlib.h>
  39
  40 #include <rte_common.h>
  41 #include <cmdline_parse.h>
  42 #include <rte_cycles.h>
  43 #include <rte_random.h>
  44 #include <rte_malloc.h>
  45
  46 #include <rte_memcpy.h>
  47
  48 #include "test.h"
  49
  50 /*
  51  * Set this to the maximum buffer size you want to test. If it is 0, then the
  52  * values in the buf_sizes[] array below will be used.
  53  */
  54 #define TEST_VALUE_RANGE        0
  55
  56 /* List of buffer sizes to test */
  57 #if TEST_VALUE_RANGE == 0
  58 static size_t buf_sizes[] = {
  59         0, 1, 7, 8, 9, 15, 16, 17, 31, 32, 33, 63, 64, 65, 127, 128, 129, 255,
  60         256, 257, 320, 384, 511, 512, 513, 1023, 1024, 1025, 1518, 1522, 1600,
  61         2048, 3072, 4096, 5120, 6144, 7168, 8192
  62 };
  63 /* MUST be as large as largest packet size above */
  64 #define SMALL_BUFFER_SIZE       8192
  65 #else /* TEST_VALUE_RANGE != 0 */
  66 static size_t buf_sizes[TEST_VALUE_RANGE];
  67 #define SMALL_BUFFER_SIZE       TEST_VALUE_RANGE
  68 #endif /* TEST_VALUE_RANGE == 0 */
  69
  70
  71 /*
  72  * Arrays of this size are used for measuring uncached memory accesses by
  73  * picking a random location within the buffer. Make this smaller if there are
  74  * memory allocation errors.
  75  */
  76 #define LARGE_BUFFER_SIZE       (100 * 1024 * 1024)
  77
  78 /* How many times to run timing loop for performance tests */
  79 #define TEST_ITERATIONS         1000000
  80 #define TEST_BATCH_SIZE         100
  81
  82 /* Data is aligned on this many bytes (power of 2) */
  83 #define ALIGNMENT_UNIT          16
  84
  85 /*
  86  * Pointers used in performance tests. The two large buffers are for uncached
  87  * access where random addresses within the buffer are used for each
  88  * memcpy. The two small buffers are for cached access.
  89  */
  90 static uint8_t *large_buf_read, *large_buf_write;
  91 static uint8_t *small_buf_read, *small_buf_write;
  92
  93 /* Initialise data buffers. */
  94 static int
  95 init_buffers(void)
  96 {
  97         unsigned i;
  98
  99         large_buf_read = rte_malloc("memcpy", LARGE_BUFFER_SIZE, ALIGNMENT_UNIT);
 100         if (large_buf_read == NULL)
 101                 goto error_large_buf_read;
 102
 103         large_buf_write = rte_malloc("memcpy", LARGE_BUFFER_SIZE, ALIGNMENT_UNIT);
 104         if (large_buf_write == NULL)
 105                 goto error_large_buf_write;
 106
 107         small_buf_read = rte_malloc("memcpy", SMALL_BUFFER_SIZE, ALIGNMENT_UNIT);
 108         if (small_buf_read == NULL)
 109                 goto error_small_buf_read;
 110
 111         small_buf_write = rte_malloc("memcpy", SMALL_BUFFER_SIZE, ALIGNMENT_UNIT);
 112         if (small_buf_write == NULL)
 113                 goto error_small_buf_write;
 114
 115         for (i = 0; i < LARGE_BUFFER_SIZE; i++)
 116                 large_buf_read[i] = rte_rand();
 117         for (i = 0; i < SMALL_BUFFER_SIZE; i++)
 118                 small_buf_read[i] = rte_rand();
 119
 120         return 0;
 121
 122 error_small_buf_write:
 123         rte_free(small_buf_read);
 124 error_small_buf_read:
 125         rte_free(large_buf_write);
 126 error_large_buf_write:
 127         rte_free(large_buf_read);
 128 error_large_buf_read:
 129         printf("ERROR: not enough memory\n");
 130         return -1;
 131 }
 132
 133 /* Cleanup data buffers */
 134 static void
 135 free_buffers(void)
 136 {
 137         rte_free(large_buf_read);
 138         rte_free(large_buf_write);
 139         rte_free(small_buf_read);
 140         rte_free(small_buf_write);
 141 }
 142
 143 /*
 144  * Get a random offset into large array, with enough space needed to perform
 145  * max copy size. Offset is aligned.
 146  */
 147 static inline size_t
 148 get_rand_offset(void)
 149 {
 150         return ((rte_rand() % (LARGE_BUFFER_SIZE - SMALL_BUFFER_SIZE)) &
 151                         ~(ALIGNMENT_UNIT - 1));
 152 }
 153
 154 /* Fill in source and destination addresses. */
 155 static inline void
 156 fill_addr_arrays(size_t *dst_addr, int is_dst_cached,
 157                 size_t *src_addr, int is_src_cached)
 158 {
 159         unsigned int i;
 160
 161         for (i = 0; i < TEST_BATCH_SIZE; i++) {
 162                 dst_addr[i] = (is_dst_cached) ? 0 : get_rand_offset();
 163                 src_addr[i] = (is_src_cached) ? 0 : get_rand_offset();
 164         }
 165 }
 166
 167 /*
 168  * WORKAROUND: For some reason the first test doing an uncached write
 169  * takes a very long time (~25 times longer than is expected). So we do
 170  * it once without timing.
 171  */
 172 static void
 173 do_uncached_write(uint8_t *dst, int is_dst_cached,
 174                 const uint8_t *src, int is_src_cached, size_t size)
 175 {
 176         unsigned i, j;
 177         size_t dst_addrs[TEST_BATCH_SIZE], src_addrs[TEST_BATCH_SIZE];
 178
 179         for (i = 0; i < (TEST_ITERATIONS / TEST_BATCH_SIZE); i++) {
 180                 fill_addr_arrays(dst_addrs, is_dst_cached,
 181                          src_addrs, is_src_cached);
 182                 for (j = 0; j < TEST_BATCH_SIZE; j++)
 183                         rte_memcpy(dst+dst_addrs[j], src+src_addrs[j], size);
 184         }
 185 }
 186
 187 /*
 188  * Run a single memcpy performance test. This is a macro to ensure that if
 189  * the "size" parameter is a constant it won't be converted to a variable.
 190  */
 191 #define SINGLE_PERF_TEST(dst, is_dst_cached, src, is_src_cached, size) do {   \
 192         unsigned int iter, t;                                                 \
 193         size_t dst_addrs[TEST_BATCH_SIZE], src_addrs[TEST_BATCH_SIZE];        \
 194         uint64_t start_time, total_time = 0;                                  \
 195         uint64_t total_time2 = 0;                                             \
 196         for (iter = 0; iter < (TEST_ITERATIONS / TEST_BATCH_SIZE); iter++) {  \
 197                 fill_addr_arrays(dst_addrs, is_dst_cached,                    \
 198                                  src_addrs, is_src_cached);                   \
 199                 start_time = rte_rdtsc();                                     \
 200                 for (t = 0; t < TEST_BATCH_SIZE; t++)                         \
 201                         rte_memcpy(dst+dst_addrs[t], src+src_addrs[t], size); \
 202                 total_time += rte_rdtsc() - start_time;                       \
 203         }                                                                     \
 204         for (iter = 0; iter < (TEST_ITERATIONS / TEST_BATCH_SIZE); iter++) {  \
 205                 fill_addr_arrays(dst_addrs, is_dst_cached,                    \
 206                                  src_addrs, is_src_cached);                   \
 207                 start_time = rte_rdtsc();                                     \
 208                 for (t = 0; t < TEST_BATCH_SIZE; t++)                         \
 209                         memcpy(dst+dst_addrs[t], src+src_addrs[t], size);     \
 210                 total_time2 += rte_rdtsc() - start_time;                      \
 211         }                                                                     \
 212         printf("%8.0f -",  (double)total_time /TEST_ITERATIONS);              \
 213         printf("%5.0f",  (double)total_time2 / TEST_ITERATIONS);              \
 214 } while (0)
 215
 216 /* Run memcpy() tests for each cached/uncached permutation. */
 217 #define ALL_PERF_TESTS_FOR_SIZE(n) do {                             \
 218         if (__builtin_constant_p(n))                                \
 219                 printf("\nC%6u", (unsigned)n);                      \
 220         else                                                        \
 221                 printf("\n%7u", (unsigned)n);                       \
 222         SINGLE_PERF_TEST(small_buf_write, 1, small_buf_read, 1, n); \
 223         SINGLE_PERF_TEST(large_buf_write, 0, small_buf_read, 1, n); \
 224         SINGLE_PERF_TEST(small_buf_write, 1, large_buf_read, 0, n); \
 225         SINGLE_PERF_TEST(large_buf_write, 0, large_buf_read, 0, n); \
 226 } while (0)
 227
 228 /*
 229  * Run performance tests for a number of different sizes and cached/uncached
 230  * permutations.
 231  */
 232 static int
 233 perf_test(void)
 234 {
 235         const unsigned num_buf_sizes = sizeof(buf_sizes) / sizeof(buf_sizes[0]);
 236         unsigned i;
 237         int ret;
 238
 239         ret = init_buffers();
 240         if (ret != 0)
 241                 return ret;
 242
 243 #if TEST_VALUE_RANGE != 0
 244         /* Setup buf_sizes array, if required */
 245         for (i = 0; i < TEST_VALUE_RANGE; i++)
 246                 buf_sizes[i] = i;
 247 #endif
 248
 249         /* See function comment */
 250         do_uncached_write(large_buf_write, 0, small_buf_read, 1, SMALL_BUFFER_SIZE);
 251
 252         printf("\n** rte_memcpy() - memcpy perf. tests (C = compile-time constant) **\n"
 253                "======= ============== ============== ============== ==============\n"
 254                "   Size Cache to cache   Cache to mem   Mem to cache     Mem to mem\n"
 255                "(bytes)        (ticks)        (ticks)        (ticks)        (ticks)\n"
 256                "------- -------------- -------------- -------------- --------------");
 257
 258         /* Do tests where size is a variable */
 259         for (i = 0; i < num_buf_sizes; i++) {
 260                 ALL_PERF_TESTS_FOR_SIZE((size_t)buf_sizes[i]);
 261         }
 262         printf("\n------- -------------- -------------- -------------- --------------");
 263         /* Do tests where size is a compile-time constant */
 264         ALL_PERF_TESTS_FOR_SIZE(63U);
 265         ALL_PERF_TESTS_FOR_SIZE(64U);
 266         ALL_PERF_TESTS_FOR_SIZE(65U);
 267         ALL_PERF_TESTS_FOR_SIZE(255U);
 268         ALL_PERF_TESTS_FOR_SIZE(256U);
 269         ALL_PERF_TESTS_FOR_SIZE(257U);
 270         ALL_PERF_TESTS_FOR_SIZE(1023U);
 271         ALL_PERF_TESTS_FOR_SIZE(1024U);
 272         ALL_PERF_TESTS_FOR_SIZE(1025U);
 273         ALL_PERF_TESTS_FOR_SIZE(1518U);
 274
 275         printf("\n======= ============== ============== ============== ==============\n\n");
 276
 277         free_buffers();
 278
 279         return 0;
 280 }
 281
 282
 283 int
 284 test_memcpy_perf(void)
 285 {
 286         int ret;
 287
 288         ret = perf_test();
 289         if (ret != 0)
 290                 return -1;
 291         return 0;
 292 }