Updating documents of D-release.

[kvmfornfv.git] / docs / userguide / pcm_utility.userguide.rst

diff --git a/docs/userguide/pcm_utility.userguide.rst b/docs/userguide/pcm_utility.userguide.rst
index baef705..6695d50 100644 (file)
--- a/docs/userguide/pcm_utility.userguide.rst
+++ b/docs/userguide/pcm_utility.userguide.rst
@@ -1,6 +1,15 @@
-=========================================================
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. http://creativecommons.org/licenses/by/4.0
+
+======================
+PCM Utility in KVM4NFV
+======================
+
 Collecting Memory Bandwidth Information using PCM utility
-=========================================================
+---------------------------------------------------------
+This chapter includes how the PCM utility is used in kvm4nfv
+to collect memory bandwidth information
 
 About PCM utility
 -----------------
@@ -22,20 +31,20 @@ Version Features
 |                             |   cyclic testcases.                           |
 |                             |                                               |
 +-----------------------------+-----------------------------------------------+
-|                             | - pcm-memory.x provides the memory bandwidth  |
-|                             |   data throught out the testcases             |
-|                             | - pcm-memory.x will be executedbefore the     |
+|                             | - pcm-memory.x will be executed before the    |
 |       Danube                |   execution of every testcase                 |
+|                             | - pcm-memory.x provides the memory bandwidth  |
+|                             |   data throughout out the testcases           |
 |                             | - used for all test-types (stress/idle)       |
-|                             | - Generated memory bandwidth logs which are   |
-|                             |   to published to the KVMFORFNV artifacts     |
+|                             | - Generated memory bandwidth logs are         |
+|                             |   published to the KVMFORFNV artifacts        |
 +-----------------------------+-----------------------------------------------+
 
 Implementation of pcm-memory.x:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The tool measures the memory bandwidth observed for every channel reporting seperately throughputs
-for reads from memory and writes to the memory.pcm-memory.x tool tends to report values slightly
+The tool measures the memory bandwidth observed for every channel reporting seperate throughput
+for reads from memory and writes to the memory. pcm-memory.x tool tends to report values slightly
 higher than the application's own measurement.
 
 Command:
@@ -71,20 +80,20 @@ Parameters
 |    Mem Ch 3: Reads (MB/s): 6867.47    |    Mem Ch 3: Reads (MB/s): 7403.66    |
 |              Writes(MB/s): 1805.53    |              Writes(MB/s): 1950.95    |
 |                                       |                                       |
-|    NODE0 Mem Read (MB/s):  27478.96   |    NODE1 Mem Read (MB/s):  29624.51   |
+|    NODE0 Mem Read (MB/s) :  27478.96  |    NODE1 Mem Read (MB/s) :  29624.51  |
 |    NODE0 Mem Write (MB/s):  7225.79   |    NODE1 Mem Write (MB/s):  7811.36   |
-|    NODE0 P. Write (T/s) :    214810   |    NODE1 P. Write (T/s):     238294   |
-|    NODE0 Memory (MB/s):    34704.75   |    NODE1 Memory (MB/s):    37435.87   |
+|    NODE0 P. Write (T/s)  :  214810    |    NODE1 P. Write (T/s)  :  238294    |
+|    NODE0 Memory (MB/s)   :  34704.75  |    NODE1 Memory (MB/s)   :  37435.87  |
 +---------------------------------------+---------------------------------------+
 |                    - System Read Throughput(MB/s):  57103.47                  |
 |                    - System Write Throughput(MB/s):  15037.15                 |
 |                    - System Memory Throughput(MB/s):  72140.62                |
 +-------------------------------------------------------------------------------+
 
-pcm-memory.x in KVMFORNFV:
+pcm-memory.x in KVM4NFV:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-pcm-memory is a part of KVMFORNFV in D release.pcm-memory.x will be executed with delay of 60 seconds
+pcm-memory is a part of KVM4NFV in D release.pcm-memory.x will be executed with delay of 60 seconds
 before starting every testcase to monitor the memory traffic intensity which was handled in
 collect_MBWInfo function .The memory bandwidth information will be collected into the logs through
 the testcase updating every 60 seconds.
@@ -98,7 +107,7 @@ the testcase updating every 60 seconds.
    3.Installing MSR registers
 
 
-Memory Bandwidth logs for KVMFORNFV can be found `here`_:
+Memory Bandwidth logs for KVM4NFV can be found `here`_:
 
 .. code:: bash
 
@@ -112,9 +121,9 @@ In install_Pcm function, it handles the installation of pcm utility and the requ
 
 .. code:: bash
 
-   git clone https://github.com/opcm/pcm
-   cd pcm
-   make
+   $ git clone https://github.com/opcm/pcm
+   $ cd pcm
+   $ make
 
 In collect_MBWInfo Function,the below command is executed on the node which was collected to the logs
 with the timestamp and testType.The function will be called at the begining of each testcase and
@@ -122,5 +131,11 @@ signal will be passed to terminate the pcm-memory process which was executing th
 
 .. code:: bash
 
-  pcm-memory.x 60 &>/root/MBWInfo/MBWInfo_${testType}_${timeStamp}
+  $ pcm-memory.x 60 &>/root/MBWInfo/MBWInfo_${testType}_${timeStamp}
+
+  where,
+  ${testType} = verify (or) daily
 
+Future Scope
+------------
+PCM information will be added to cyclictest of kvm4nfv in yardstick.