lib/librte_eal/common/include/rte_keepalive.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2015 Intel Shannon Ltd. 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
  33 /**
  34  * @file rte_keepalive.h
  35  * DPDK RTE LCore Keepalive Monitor.
  36  *
  37  **/
  38
  39 #ifndef _KEEPALIVE_H_
  40 #define _KEEPALIVE_H_
  41
  42 #include <rte_memory.h>
  43
  44 #ifndef RTE_KEEPALIVE_MAXCORES
  45 /**
  46  * Number of cores to track.
  47  * @note Must be larger than the highest core id. */
  48 #define RTE_KEEPALIVE_MAXCORES RTE_MAX_LCORE
  49 #endif
  50
  51 /**
  52  * Keepalive failure callback.
  53  *
  54  *  Receives a data pointer passed to rte_keepalive_create() and the id of the
  55  *  failed core.
  56  */
  57 typedef void (*rte_keepalive_failure_callback_t)(
  58         void *data,
  59         const int id_core);
  60
  61 /**
  62  * Keepalive state structure.
  63  * @internal
  64  */
  65 struct rte_keepalive;
  66
  67 /**
  68  * Initialise keepalive sub-system.
  69  * @param callback
  70  *   Function called upon detection of a dead core.
  71  * @param data
  72  *   Data pointer to be passed to function callback.
  73  * @return
  74  *   Keepalive structure success, NULL on failure.
  75  */
  76 struct rte_keepalive *rte_keepalive_create(
  77         rte_keepalive_failure_callback_t callback,
  78         void *data);
  79
  80 /**
  81  * Checks & handles keepalive state of monitored cores.
  82  * @param *ptr_timer Triggering timer (unused)
  83  * @param *ptr_data  Data pointer (keepalive structure)
  84  */
  85 void rte_keepalive_dispatch_pings(void *ptr_timer, void *ptr_data);
  86
  87 /**
  88  * Registers a core for keepalive checks.
  89  * @param *keepcfg
  90  *   Keepalive structure pointer
  91  * @param id_core
  92  *   ID number of core to register.
  93  */
  94 void rte_keepalive_register_core(struct rte_keepalive *keepcfg,
  95         const int id_core);
  96
  97 /**
  98  * Per-core keepalive check.
  99  * @param *keepcfg
 100  *   Keepalive structure pointer
 101  *
 102  * This function needs to be called from within the main process loop of
 103  * the LCore to be checked.
 104  */
 105 void
 106 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg);
 107
 108 #endif /* _KEEPALIVE_H_ */