doc: add runtime option examples to hns3 guide

[dpdk.git] / doc / guides / sample_app_ug / keep_alive.rst

diff --git a/doc/guides/sample_app_ug/keep_alive.rst b/doc/guides/sample_app_ug/keep_alive.rst
index 3897377..c9392c9 100644 (file)
--- a/doc/guides/sample_app_ug/keep_alive.rst
+++ b/doc/guides/sample_app_ug/keep_alive.rst
@@ -1,33 +1,5 @@
-
-..  BSD LICENSE
-    Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions
-    are met:
-
-    * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in
-    the documentation and/or other materials provided with the
-    distribution.
-    * Neither the name of Intel Corporation nor the names of its
-    contributors may be used to endorse or promote products derived
-    from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2015-2016 Intel Corporation.

 
 Keep Alive Sample Application
 =============================
 
 Keep Alive Sample Application
 =============================


@@ -44,7 +16,7 @@ Overview
 --------
 
 The application demonstrates how to protect against 'silent outages'
 --------
 
 The application demonstrates how to protect against 'silent outages'

-on packet processing cores. A Keep Alive Monitor Agent Core (master)
+on packet processing cores. A Keep Alive Monitor Agent Core (main)

 monitors the state of packet processing cores (worker cores) by
 dispatching pings at a regular time interval (default is 5ms) and
 monitoring the state of the cores. Cores states are: Alive, MIA, Dead
 monitors the state of packet processing cores (worker cores) by
 dispatching pings at a regular time interval (default is 5ms) and
 monitoring the state of the cores. Cores states are: Alive, MIA, Dead


@@ -66,27 +38,9 @@ of the L2 forwarding application.
 Compiling the Application
 -------------------------
 
 Compiling the Application
 -------------------------
 

-To compile the application:
-
-#.  Go to the sample application directory:
-
-    .. code-block:: console
-
-        export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/keep_alive
-
-#.  Set the target (a default target is used if not specified). For example:
-
-    .. code-block:: console
-
-        export RTE_TARGET=x86_64-native-linuxapp-gcc
-
-    See the *DPDK Getting Started Guide* for possible RTE_TARGET values.
-
-#.  Build the application:
-
-    .. code-block:: console
+To compile the sample application see :doc:`compiling`.

 
 

-        make
+The application is located in the ``l2fwd_keep_alive`` sub-directory.

 
 Running the Application
 -----------------------
 
 Running the Application
 -----------------------


@@ -95,7 +49,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-    ./build/l2fwd-keepalive [EAL options] \
+    ./<build_dir>/examples/dpdk-l2fwd-keepalive [EAL options] \

             -- -p PORTMASK [-q NQ] [-K PERIOD] [-T PERIOD]
 
 where,
             -- -p PORTMASK [-q NQ] [-K PERIOD] [-T PERIOD]
 
 where,


@@ -109,12 +63,12 @@ where,
 * ``T PERIOD``: statistics will be refreshed each PERIOD seconds (0 to
   disable, 10 default, 86400 maximum).
 
 * ``T PERIOD``: statistics will be refreshed each PERIOD seconds (0 to
   disable, 10 default, 86400 maximum).
 

-To run the application in linuxapp environment with 4 lcores, 16 ports
+To run the application in linux environment with 4 lcores, 16 ports

 8 RX queues per lcore and a ping interval of 10ms, issue the command:
 
 .. code-block:: console
 
 8 RX queues per lcore and a ping interval of 10ms, issue the command:
 
 .. code-block:: console
 

-    ./build/l2fwd-keepalive -c f -n 4 -- -q 8 -p ffff -K 10
+    ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10

 
 Refer to the *DPDK Getting Started Guide* for general information on
 running applications and the Environment Abstraction Layer (EAL)
 
 Refer to the *DPDK Getting Started Guide* for general information on
 running applications and the Environment Abstraction Layer (EAL)


@@ -166,7 +120,7 @@ is configured to run every check_period milliseconds.
         rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
 
 The rest of the initialization and run-time path follows
         rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
 
 The rest of the initialization and run-time path follows

-the same paths as the the L2 forwarding application. The only
+the same paths as the L2 forwarding application. The only

 addition to the main processing loop is the mark alive
 functionality and the example random failures.
 
 addition to the main processing loop is the mark alive
 functionality and the example random failures.
 


@@ -186,5 +140,5 @@ The rte_keepalive_mark_alive function simply sets the core state to alive.
     static inline void
     rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
     {
     static inline void
     rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
     {

-        keepcfg->state_flags[rte_lcore_id()] = ALIVE;
+        keepcfg->live_data[rte_lcore_id()].core_state = RTE_KA_STATE_ALIVE;

     }
     }