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