docs/userguide/opnfv_yardstick_tc010.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) OPNFV, Ericsson AB and others.
   5
   6 *************************************
   7 Yardstick Test Case Description TC010
   8 *************************************
   9
  10 .. _man-pages: http://manpages.ubuntu.com/manpages/trusty/lat_mem_rd.8.html
  11
  12 +-----------------------------------------------------------------------------+
  13 |Memory Latency                                                               |
  14 |                                                                             |
  15 +--------------+--------------------------------------------------------------+
  16 |test case id  | OPNFV_YARDSTICK_TC010_Memory Latency                         |
  17 |              |                                                              |
  18 +--------------+--------------------------------------------------------------+
  19 |metric        | Latency in nanoseconds                                       |
  20 |              |                                                              |
  21 +--------------+--------------------------------------------------------------+
  22 |test purpose  | Measure the memory read latency for varying memory sizes and |
  23 |              | strides. Whole memory hierarchy is measured including all    |
  24 |              | levels of cache.                                             |
  25 |              |                                                              |
  26 +--------------+--------------------------------------------------------------+
  27 |configuration | File: opnfv_yardstick_tc010.yaml                             |
  28 |              |                                                              |
  29 |              | * SLA (max_latency): 30 nanoseconds                          |
  30 |              | * Stride - 128 bytes                                         |
  31 |              | * Stop size - 64 megabytes                                   |
  32 |              | * Iterations: 10 - test is run 10 times iteratively.         |
  33 |              | * Interval: 1 - there is 1 second delay between each         |
  34 |              |   iteration.                                                 |
  35 |              |                                                              |
  36 +--------------+--------------------------------------------------------------+
  37 |test tool     | Lmbench                                                      |
  38 |              |                                                              |
  39 |              | Lmbench is a suite of operating system microbenchmarks. This |
  40 |              | test uses lat_mem_rd tool from that suite.                   |
  41 |              | Lmbench is not always part of a Linux distribution, hence it |
  42 |              | needs to be installed in the test image                      |
  43 |              |                                                              |
  44 +--------------+--------------------------------------------------------------+
  45 |references    | man-pages_                                                   |
  46 |              |                                                              |
  47 |              | McVoy, Larry W.,and Carl Staelin. "lmbench: Portable Tools   |
  48 |              | for Performance Analysis." USENIX annual technical           |
  49 |              | conference 1996.                                             |
  50 |              |                                                              |
  51 +--------------+--------------------------------------------------------------+
  52 |applicability | Test can be configured with different:                       |
  53 |              |                                                              |
  54 |              | * strides;                                                   |
  55 |              | * stop_size;                                                 |
  56 |              | * iterations and intervals.                                  |
  57 |              |                                                              |
  58 |              | There are default values for each above-mentioned option.    |
  59 |              |                                                              |
  60 |              | SLA (optional) : max_latency: The maximum memory latency     |
  61 |              | that is accepted.                                            |
  62 |              |                                                              |
  63 +--------------+--------------------------------------------------------------+
  64 |pre-test      | The test case image needs to be installed into Glance        |
  65 |conditions    | with Lmbench included in the image.                          |
  66 |              |                                                              |
  67 |              | No POD specific requirements have been identified.           |
  68 |              |                                                              |
  69 +--------------+--------------------------------------------------------------+
  70 |test sequence | description and expected result                              |
  71 |              |                                                              |
  72 +--------------+--------------------------------------------------------------+
  73 |step 1        | The host is installed as client. Lmbench's lat_mem_rd tool   |
  74 |              | is invoked and logs are produced and stored.                 |
  75 |              |                                                              |
  76 |              | Result: logs are stored.                                     |
  77 |              |                                                              |
  78 +--------------+--------------------------------------------------------------+
  79 |test verdict  | Test fails if the measured memory latency is above the SLA   |
  80 |              | value or if there is a test case execution problem.          |
  81 |              |                                                              |
  82 +--------------+--------------------------------------------------------------+