4 * Copyright 2015-2016 Intel Shannon Ltd. 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.
34 * @file rte_keepalive.h
35 * DPDK RTE LCore Keepalive Monitor.
42 #include <rte_memory.h>
44 #ifndef RTE_KEEPALIVE_MAXCORES
46 * Number of cores to track.
47 * @note Must be larger than the highest core id. */
48 #define RTE_KEEPALIVE_MAXCORES RTE_MAX_LCORE
51 enum rte_keepalive_state {
52 RTE_KA_STATE_UNUSED = 0,
53 RTE_KA_STATE_ALIVE = 1,
54 RTE_KA_STATE_MISSING = 4,
55 RTE_KA_STATE_DEAD = 2,
56 RTE_KA_STATE_GONE = 3,
57 RTE_KA_STATE_DOZING = 5,
58 RTE_KA_STATE_SLEEP = 6
62 * Keepalive failure callback.
64 * Receives a data pointer passed to rte_keepalive_create() and the id of the
66 * @param data Data pointer passed to rte_keepalive_create()
67 * @param id_core ID of the core that has failed
69 typedef void (*rte_keepalive_failure_callback_t)(
74 * Keepalive relay callback.
76 * Receives a data pointer passed to rte_keepalive_register_relay_callback(),
77 * the id of the core for which state is to be forwarded, and details of the
79 * @param data Data pointer passed to rte_keepalive_register_relay_callback()
80 * @param id_core ID of the core for which state is being reported
81 * @param core_state The current state of the core
82 * @param Timestamp of when core was last seen alive
84 typedef void (*rte_keepalive_relay_callback_t)(
87 enum rte_keepalive_state core_state,
92 * Keepalive state structure.
98 * Initialise keepalive sub-system.
100 * Function called upon detection of a dead core.
102 * Data pointer to be passed to function callback.
104 * Keepalive structure success, NULL on failure.
106 struct rte_keepalive *rte_keepalive_create(
107 rte_keepalive_failure_callback_t callback,
111 * Checks & handles keepalive state of monitored cores.
112 * @param *ptr_timer Triggering timer (unused)
113 * @param *ptr_data Data pointer (keepalive structure)
115 void rte_keepalive_dispatch_pings(void *ptr_timer, void *ptr_data);
118 * Registers a core for keepalive checks.
120 * Keepalive structure pointer
122 * ID number of core to register.
124 void rte_keepalive_register_core(struct rte_keepalive *keepcfg,
128 * Per-core keepalive check.
130 * Keepalive structure pointer
132 * This function needs to be called from within the main process loop of
133 * the LCore to be checked.
136 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg);
139 * Per-core sleep-time indication.
141 * Keepalive structure pointer
143 * If CPU idling is enabled, this function needs to be called from within
144 * the main process loop of the LCore going to sleep, in order to avoid
145 * the LCore being mis-detected as dead.
148 rte_keepalive_mark_sleep(struct rte_keepalive *keepcfg);
151 * Registers a 'live core' callback.
153 * The complement of the 'dead core' callback. This is called when a
154 * core is known to be alive, and is intended for cases when an app
155 * needs to know 'liveness' beyond just knowing when a core has died.
158 * Keepalive structure pointer
160 * Function called upon detection of a dead core.
162 * Data pointer to be passed to function callback.
165 rte_keepalive_register_relay_callback(struct rte_keepalive *keepcfg,
166 rte_keepalive_relay_callback_t callback,
169 #endif /* _KEEPALIVE_H_ */