docs/yardstick/opnfv_yardstick_tc012.rst

   1 *************************************
   2 Yardstick Test Case Description TC012
   3 *************************************
   4
   5 +-----------------------------------------------------------------------------+
   6 |Memory Bandwidth                                                             |
   7 +==============+==============================================================+
   8 |test case id  | OPNFV_YARDSTICK_TC012_Memory Bandwidth                       |
   9 +--------------+--------------------------------------------------------------+
  10 |metric        | Megabyte per second (MBps)                                   |
  11 +--------------+--------------------------------------------------------------+
  12 |test purpose  | Measure the rate at which data can be read from and written  |
  13 |              | to the memory (this includes all levels of memory).          |
  14 +--------------+--------------------------------------------------------------+
  15 |configuration | File: opnfv_yardstick_tc012.yaml                             |
  16 |              |                                                              |
  17 |              | * SLA (optional): 15000 (MBps)                               |
  18 |              |     min_bw: The minimum amount of memory bandwidth that is   |
  19 |              |     accepted.                                                |
  20 |              | * Size: 10 240 kB - test allocates twice that size (20 480kB)|
  21 |              |   zeros it and then measures the time it takes to copy from  |
  22 |              |   one side to another.                                       |
  23 |              | * Benchmark: rdwr - measures the time to read data into      |
  24 |              |   memory and then write data to the same location.           |
  25 |              | * Warmup: 0 - the number of iterations to perform before     |
  26 |              |   taking actual measurements.                                |
  27 |              | * Iterations: 10 - test is run 10 times iteratively.         |
  28 |              | * Interval: 1 - there is 1 second delay between each         |
  29 |              |   iteration.                                                 |
  30 +--------------+--------------------------------------------------------------+
  31 |test tool     | Lmbench                                                      |
  32 |              |                                                              |
  33 |              | Lmbench is a suite of operating system microbenchmarks. This |
  34 |              | test uses bw_mem tool from that suite.                       |
  35 |              | Lmbench is not always part of a Linux distribution, hence it |
  36 |              | needs to be installed in the test image                      |
  37 |              | (See :ref:`guest-image` for how to generate a Linux image    |
  38 |              | for Glance with Lmbench included).                           |
  39 +--------------+--------------------------------------------------------------+
  40 |references    | * http://manpages.ubuntu.com/manpages/trusty/bw_mem.8.html   |
  41 |              |                                                              |
  42 |              | * McVoy, Larry W., and Carl Staelin. "lmbench: Portable Tools|
  43 |              |   for Performance Analysis."                                 |
  44 |              | * USENIX annual technical conference. 1996.                  |
  45 +--------------+--------------------------------------------------------------+
  46 |applicability | Test can be configured with different                        |
  47 |              |   * memory sizes;                                            |
  48 |              |   * memory operations (such as rd, wr, rdwr, cp, frd, fwr,   |
  49 |              |     fcp, bzero, bcopy);                                      |
  50 |              |   * number of warmup iterations;                             |
  51 |              |   * iterations and intervals.                                |
  52 |              |                                                              |
  53 |              | There are default values for each above-mentioned option.    |
  54 +--------------+--------------------------------------------------------------+
  55 |pre-test      | The test case image needs to be installed into Glance        |
  56 |conditions    | with Lmbench included in the image.                          |
  57 |              |                                                              |
  58 |              | No POD specific requirements have been identified.           |
  59 +--------------+------+----------------------------------+--------------------+
  60 |test sequence | step | description                      | result             |
  61 |              +------+----------------------------------+--------------------+
  62 |              |  1   | The host is installed as client. | Logs are stored    |
  63 |              |      | Lmbench's bw_mem tool is invoked |                    |
  64 |              |      | and logs are produced and stored.|                    |
  65 +--------------+------+----------------------------------+--------------------+
  66 |test verdict  | Test fails if the measured memory bandwidth is below the SLA |
  67 |              | value or if there is a test case execution problem.          |
  68 +--------------+--------------------------------------------------------------+