3 Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions
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
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.
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.
32 Keep Alive Sample Application
33 =============================
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
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.
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.
62 Note: This application is based on the :doc:`l2_forward_real_virtual`. As
63 such, the initialization and run-time paths are very similar to those
64 of the L2 forwarding application.
66 Compiling the Application
67 -------------------------
69 To compile the sample application see :doc:`compiling`.
71 The application is located in the ``l2fwd_keep_alive`` sub-directory.
73 Running the Application
74 -----------------------
76 The application has a number of command line options:
78 .. code-block:: console
80 ./build/l2fwd-keepalive [EAL options] \
81 -- -p PORTMASK [-q NQ] [-K PERIOD] [-T PERIOD]
85 * ``p PORTMASK``: A hexadecimal bitmask of the ports to configure
87 * ``q NQ``: A number of queues (=ports) per lcore (default is 1)
89 * ``K PERIOD``: Heartbeat check period in ms(5ms default; 86400 max)
91 * ``T PERIOD``: statistics will be refreshed each PERIOD seconds (0 to
92 disable, 10 default, 86400 maximum).
94 To run the application in linuxapp environment with 4 lcores, 16 ports
95 8 RX queues per lcore and a ping interval of 10ms, issue the command:
97 .. code-block:: console
99 ./build/l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10
101 Refer to the *DPDK Getting Started Guide* for general information on
102 running applications and the Environment Abstraction Layer (EAL)
109 The following sections provide some explanation of the The
110 Keep-Alive/'Liveliness' conceptual scheme. As mentioned in the
111 overview section, the initialization and run-time paths are very
112 similar to those of the :doc:`l2_forward_real_virtual`.
114 The Keep-Alive/'Liveliness' conceptual scheme:
116 * A Keep- Alive Agent Runs every N Milliseconds.
118 * DPDK Cores respond to the keep-alive agent.
120 * If keep-alive agent detects time-outs, it notifies the
121 fault management entity through a callback function.
123 The following sections provide some explanation of the code aspects
124 that are specific to the Keep Alive sample application.
126 The keepalive functionality is initialized with a struct
127 rte_keepalive and the callback function to invoke in the
132 rte_global_keepalive_info = rte_keepalive_create(&dead_core, NULL);
133 if (rte_global_keepalive_info == NULL)
134 rte_exit(EXIT_FAILURE, "keepalive_create() failed");
136 The function that issues the pings keepalive_dispatch_pings()
137 is configured to run every check_period milliseconds.
141 if (rte_timer_reset(&hb_timer,
142 (check_period * rte_get_timer_hz()) / 1000,
145 &rte_keepalive_dispatch_pings,
146 rte_global_keepalive_info
148 rte_exit(EXIT_FAILURE, "Keepalive setup failure.\n");
150 The rest of the initialization and run-time path follows
151 the same paths as the the L2 forwarding application. The only
152 addition to the main processing loop is the mark alive
153 functionality and the example random failures.
157 rte_keepalive_mark_alive(&rte_global_keepalive_info);
158 cur_tsc = rte_rdtsc();
160 /* Die randomly within 7 secs for demo purposes.. */
161 if (cur_tsc - tsc_initial > tsc_lifetime)
164 The rte_keepalive_mark_alive function simply sets the core state to alive.
169 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
171 keepcfg->state_flags[rte_lcore_id()] = ALIVE;