doc/guides/sample_app_ug/keep_alive.rst

   1
   2 ..  BSD LICENSE
   3     Copyright(c) 2015 Intel Corporation. All rights reserved.
   4     All rights reserved.
   5
   6     Redistribution and use in source and binary forms, with or without
   7     modification, are permitted provided that the following conditions
   8     are met:
   9
  10     * Redistributions of source code must retain the above copyright
  11     notice, this list of conditions and the following disclaimer.
  12     * Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in
  14     the documentation and/or other materials provided with the
  15     distribution.
  16     * Neither the name of Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived
  18     from this software without specific prior written permission.
  19
  20     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31
  32 Keep Alive Sample Application
  33 =============================
  34
  35 The Keep Alive application is a simple example of a
  36 heartbeat/watchdog for packet processing cores. It demonstrates how
  37 to detect 'failed' DPDK cores and notify a fault management entity
  38 of this failure. Its purpose is to ensure the failure of the core
  39 does not result in a fault that is not detectable by a management
  40 entity.
  41
  42
  43 Overview
  44 --------
  45
  46 The application demonstrates how to protect against 'silent outages'
  47 on packet processing cores. A Keep Alive Monitor Agent Core (master)
  48 monitors the state of packet processing cores (worker cores) by
  49 dispatching pings at a regular time interval (default is 5ms) and
  50 monitoring the state of the cores. Cores states are: Alive, MIA, Dead
  51 or Buried. MIA indicates a missed ping, and Dead indicates two missed
  52 pings within the specified time interval. When a core is Dead, a
  53 callback function is invoked to restart the packet processing core;
  54 A real life application might use this callback function to notify a
  55 higher level fault management entity of the core failure in order to
  56 take the appropriate corrective action.
  57
  58 Note: Only the worker cores are monitored. A local (on the host) mechanism
  59 or agent to supervise the Keep Alive Monitor Agent Core DPDK core is required
  60 to detect its failure.
  61
  62 Note: This application is based on the L2 forwarding application. As
  63 such, the initialization and run-time paths are very similar to those
  64 of the L2 forwarding application.
  65
  66 Compiling the Application
  67 -------------------------
  68
  69 To compile the application:
  70
  71 #.  Go to the sample application directory:
  72
  73     .. code-block:: console
  74
  75         export RTE_SDK=/path/to/rte_sdk cd ${RTE_SDK}/examples/keep_alive
  76
  77 #.  Set the target (a default target is used if not specified). For example:
  78
  79     .. code-block:: console
  80
  81         export RTE_TARGET=x86_64-native-linuxapp-gcc
  82
  83     See the *DPDK Getting Started Guide* for possible RTE_TARGET values.
  84
  85 #.  Build the application:
  86
  87     .. code-block:: console
  88
  89         make
  90
  91 Running the Application
  92 -----------------------
  93
  94 The application has a number of command line options:
  95
  96 .. code-block:: console
  97
  98     ./build/l2fwd-keepalive [EAL options] \
  99             -- -p PORTMASK [-q NQ] [-K PERIOD] [-T PERIOD]
 100
 101 where,
 102
 103 * ``p PORTMASK``: A hexadecimal bitmask of the ports to configure
 104
 105 * ``q NQ``: A number of queues (=ports) per lcore (default is 1)
 106
 107 * ``K PERIOD``: Heartbeat check period in ms(5ms default; 86400 max)
 108
 109 * ``T PERIOD``: statistics will be refreshed each PERIOD seconds (0 to
 110   disable, 10 default, 86400 maximum).
 111
 112 To run the application in linuxapp environment with 4 lcores, 16 ports
 113 8 RX queues per lcore and a ping interval of 10ms, issue the command:
 114
 115 .. code-block:: console
 116
 117     ./build/l2fwd-keepalive -c f -n 4 -- -q 8 -p ffff -K 10
 118
 119 Refer to the *DPDK Getting Started Guide* for general information on
 120 running applications and the Environment Abstraction Layer (EAL)
 121 options.
 122
 123
 124 Explanation
 125 -----------
 126
 127 The following sections provide some explanation of the The
 128 Keep-Alive/'Liveliness' conceptual scheme. As mentioned in the
 129 overview section, the initialization and run-time paths are very
 130 similar to those of the L2 forwarding application (see Chapter 9
 131 "L2 Forwarding Sample Application (in Real and Virtualized
 132 Environments)" for more information).
 133
 134 The Keep-Alive/'Liveliness' conceptual scheme:
 135
 136 * A Keep- Alive Agent Runs every N Milliseconds.
 137
 138 * DPDK Cores respond to the keep-alive agent.
 139
 140 * If keep-alive agent detects time-outs, it notifies the
 141   fault management entity through a callback function.
 142
 143 The following sections provide some explanation of the code aspects
 144 that are specific to the Keep Alive sample application.
 145
 146 The heartbeat functionality is initialized with a struct
 147 rte_heartbeat and the callback function to invoke in the
 148 case of a timeout.
 149
 150 .. code-block:: c
 151
 152     rte_global_keepalive_info = rte_keepalive_create(&dead_core, NULL);
 153     if (rte_global_hbeat_info == NULL)
 154         rte_exit(EXIT_FAILURE, "keepalive_create() failed");
 155
 156 The function that issues the pings hbeat_dispatch_pings()
 157 is configured to run every check_period milliseconds.
 158
 159 .. code-block:: c
 160
 161     if (rte_timer_reset(&hb_timer,
 162             (check_period * rte_get_timer_hz()) / 1000,
 163             PERIODICAL,
 164             rte_lcore_id(),
 165             &hbeat_dispatch_pings, rte_global_keepalive_info
 166             ) != 0 )
 167         rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
 168
 169 The rest of the initialization and run-time path follows
 170 the same paths as the the L2 forwarding application. The only
 171 addition to the main processing loop is the mark alive
 172 functionality and the example random failures.
 173
 174 .. code-block:: c
 175
 176     rte_keepalive_mark_alive(&rte_global_hbeat_info);
 177     cur_tsc = rte_rdtsc();
 178
 179     /* Die randomly within 7 secs for demo purposes.. */
 180     if (cur_tsc - tsc_initial > tsc_lifetime)
 181     break;
 182
 183 The rte_keepalive_mark_alive function simply sets the core state to alive.
 184
 185 .. code-block:: c
 186
 187     static inline void
 188     rte_keepalive_mark_alive(struct rte_heartbeat *keepcfg)
 189     {
 190         keepcfg->state_flags[rte_lcore_id()] = 1;
 191     }