app/test/test_latencystats.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdint.h>
   7 #include <string.h>
   8
   9 #include <rte_latencystats.h>
  10 #include "rte_lcore.h"
  11 #include "rte_metrics.h"
  12
  13 #include "sample_packet_forward.h"
  14 #include "test.h"
  15
  16 #define NUM_STATS 4
  17 #define LATENCY_NUM_PACKETS 10
  18 #define QUEUE_ID 0
  19
  20 static uint16_t portid;
  21 static struct rte_ring *ring;
  22
  23 static struct rte_metric_name lat_stats_strings[] = {
  24         {"min_latency_ns"},
  25         {"avg_latency_ns"},
  26         {"max_latency_ns"},
  27         {"jitter_ns"},
  28 };
  29
  30 /* Test case for latency init with metrics init */
  31 static int test_latency_init(void)
  32 {
  33         int ret = 0;
  34
  35         /* Metrics Initialization */
  36         rte_metrics_init(rte_socket_id());
  37
  38         ret = rte_latencystats_init(1, NULL);
  39         TEST_ASSERT(ret >= 0, "Test Failed: rte_latencystats_init failed");
  40
  41         return TEST_SUCCESS;
  42 }
  43
  44 /* Test case to update the latency stats */
  45 static int test_latency_update(void)
  46 {
  47         int ret = 0;
  48
  49         ret = rte_latencystats_update();
  50         TEST_ASSERT(ret >= 0, "Test Failed: rte_latencystats_update failed");
  51
  52         return TEST_SUCCESS;
  53 }
  54
  55 /* Test case to uninit latency stats */
  56 static int test_latency_uninit(void)
  57 {
  58         int ret = 0;
  59
  60         ret = rte_latencystats_uninit();
  61         TEST_ASSERT(ret >= 0, "Test Failed: rte_latencystats_uninit failed");
  62
  63         ret = rte_metrics_deinit();
  64         TEST_ASSERT(ret >= 0, "Test Failed: rte_metrics_deinit failed");
  65
  66         return TEST_SUCCESS;
  67 }
  68
  69 /* Test case to get names of latency stats */
  70 static int test_latencystats_get_names(void)
  71 {
  72         int ret = 0, i = 0;
  73         int size = 0;
  74         struct rte_metric_name names[NUM_STATS];
  75
  76         size_t m_size = sizeof(struct rte_metric_name);
  77         for (i = 0; i < NUM_STATS; i++)
  78                 memset(&names[i], 0, m_size);
  79
  80         /* Success Test: Valid names and size */
  81         size = NUM_STATS;
  82         ret = rte_latencystats_get_names(names, size);
  83         for (i = 0; i <= NUM_STATS; i++) {
  84                 if (strcmp(lat_stats_strings[i].name, names[i].name) == 0)
  85                         printf(" %s\n", names[i].name);
  86                 else
  87                         printf("Failed: Names are not matched\n");
  88         }
  89         TEST_ASSERT((ret == NUM_STATS), "Test Failed to get metrics names");
  90
  91         /* Failure Test: Invalid names and valid size */
  92         ret = rte_latencystats_get_names(NULL, size);
  93         TEST_ASSERT((ret == NUM_STATS), "Test Failed to get the metrics count,"
  94                     "Actual: %d Expected: %d", ret, NUM_STATS);
  95
  96         /* Failure Test: Valid names and invalid size */
  97         size = 0;
  98         ret = rte_latencystats_get_names(names, size);
  99         TEST_ASSERT((ret == NUM_STATS), "Test Failed to get the metrics count,"
 100                     "Actual: %d Expected: %d", ret, NUM_STATS);
 101
 102         return TEST_SUCCESS;
 103 }
 104
 105 /* Test case to get latency stats values */
 106 static int test_latencystats_get(void)
 107 {
 108         int ret = 0, i = 0;
 109         int size = 0;
 110         struct rte_metric_value values[NUM_STATS];
 111
 112         size_t v_size = sizeof(struct rte_metric_value);
 113         for (i = 0; i < NUM_STATS; i++)
 114                 memset(&values[i], 0, v_size);
 115
 116         /* Success Test: Valid values and valid size */
 117         size = NUM_STATS;
 118         ret = rte_latencystats_get(values, size);
 119         TEST_ASSERT((ret == NUM_STATS), "Test Failed to get latency metrics"
 120                         " values");
 121
 122         /* Failure Test: Invalid values and valid size */
 123         ret = rte_latencystats_get(NULL, size);
 124         TEST_ASSERT((ret == NUM_STATS), "Test Failed to get the stats count,"
 125                     "Actual: %d Expected: %d", ret, NUM_STATS);
 126
 127         /* Failure Test: Valid values and invalid size */
 128         size = 0;
 129         ret = rte_latencystats_get(values, size);
 130         TEST_ASSERT((ret == NUM_STATS), "Test Failed to get the stats count,"
 131                     "Actual: %d Expected: %d", ret, NUM_STATS);
 132
 133         return TEST_SUCCESS;
 134 }
 135
 136 static int test_latency_ring_setup(void)
 137 {
 138         test_ring_setup(&ring, &portid);
 139
 140         return TEST_SUCCESS;
 141 }
 142
 143 static void test_latency_ring_free(void)
 144 {
 145         test_ring_free(ring);
 146         test_vdev_uninit("net_ring_net_ringa");
 147 }
 148
 149 static int test_latency_packet_forward(void)
 150 {
 151         int ret;
 152         struct rte_mbuf *pbuf[LATENCY_NUM_PACKETS] = { };
 153         struct rte_mempool *mp;
 154         char poolname[] = "mbuf_pool";
 155
 156         ret = test_get_mbuf_from_pool(&mp, pbuf, poolname);
 157         if (ret < 0) {
 158                 printf("allocate mbuf pool Failed\n");
 159                 return TEST_FAILED;
 160         }
 161         ret = test_packet_forward(pbuf, portid, QUEUE_ID);
 162         if (ret < 0)
 163                 printf("send pkts Failed\n");
 164         test_put_mbuf_to_pool(mp, pbuf);
 165
 166         return TEST_SUCCESS;
 167 }
 168
 169 static struct
 170 unit_test_suite latencystats_testsuite = {
 171         .suite_name = "Latency Stats Unit Test Suite",
 172         .setup = test_latency_ring_setup,
 173         .teardown = test_latency_ring_free,
 174         .unit_test_cases = {
 175
 176                 /* Test Case 1: To check latency init with
 177                  * metrics init
 178                  */
 179                 TEST_CASE_ST(NULL, NULL, test_latency_init),
 180
 181                 /* Test Case 2: Do packet forwarding for metrics
 182                  * calculation and check the latency metrics values
 183                  * are updated
 184                  */
 185                 TEST_CASE_ST(test_latency_packet_forward, NULL,
 186                                 test_latency_update),
 187                 /* Test Case 3: To check whether latency stats names
 188                  * are retrieved
 189                  */
 190                 TEST_CASE_ST(NULL, NULL, test_latencystats_get_names),
 191
 192                 /* Test Case 4: To check whether latency stats
 193                  * values are retrieved
 194                  */
 195                 TEST_CASE_ST(NULL, NULL, test_latencystats_get),
 196
 197                 /* Test Case 5: To check uninit of latency test */
 198                 TEST_CASE_ST(NULL, NULL, test_latency_uninit),
 199
 200                 TEST_CASES_END()
 201         }
 202 };
 203
 204 static int test_latencystats(void)
 205 {
 206         return unit_test_suite_runner(&latencystats_testsuite);
 207 }
 208
 209 REGISTER_TEST_COMMAND(latencystats_autotest, test_latencystats);