docs/yardstick/opnfv_yardstick_tc010.rst

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