4 * Copyright 2015 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
53 * Keepalive failure callback.
55 * Receives a data pointer passed to rte_keepalive_create() and the id of the
58 typedef void (*rte_keepalive_failure_callback_t)(
64 * Keepalive state structure.
67 struct rte_keepalive {
74 } __rte_cache_aligned state_flags[RTE_KEEPALIVE_MAXCORES];
76 /** Last-seen-alive timestamps */
77 uint64_t last_alive[RTE_KEEPALIVE_MAXCORES];
81 * Indexed by core id, non-zero if the core should be checked.
83 uint8_t active_cores[RTE_KEEPALIVE_MAXCORES];
85 /** Dead core handler. */
86 rte_keepalive_failure_callback_t callback;
89 * Dead core handler app data.
90 * Pointer is passed to dead core handler.
99 * Initialise keepalive sub-system.
101 * Function called upon detection of a dead core.
103 * Data pointer to be passed to function callback.
105 * Keepalive structure success, NULL on failure.
107 struct rte_keepalive *rte_keepalive_create(
108 rte_keepalive_failure_callback_t callback,
113 * Checks & handles keepalive state of monitored cores.
114 * @param *ptr_timer Triggering timer (unused)
115 * @param *ptr_data Data pointer (keepalive structure)
117 void rte_keepalive_dispatch_pings(void *ptr_timer, void *ptr_data);
121 * Registers a core for keepalive checks.
123 * Keepalive structure pointer
125 * ID number of core to register.
127 void rte_keepalive_register_core(struct rte_keepalive *keepcfg,
132 * Per-core keepalive check.
134 * Keepalive structure pointer
136 * This function needs to be called from within the main process loop of
137 * the LCore to be checked.
140 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
142 keepcfg->state_flags[rte_lcore_id()] = ALIVE;
146 #endif /* _KEEPALIVE_H_ */