docs/yardstick/opnfv_yardstick_tc010.rst

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