lib/librte_eal/common/include/rte_keepalive.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2015-2016 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 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
  59 };
  60
  61 /**
  62  * Keepalive failure callback.
  63  *
  64  *  Receives a data pointer passed to rte_keepalive_create() and the id of the
  65  *  failed core.
  66  */
  67 typedef void (*rte_keepalive_failure_callback_t)(
  68         void *data,
  69         const int id_core);
  70
  71 /**
  72  * Keepalive state structure.
  73  * @internal
  74  */
  75 struct rte_keepalive;
  76
  77 /**
  78  * Initialise keepalive sub-system.
  79  * @param callback
  80  *   Function called upon detection of a dead core.
  81  * @param data
  82  *   Data pointer to be passed to function callback.
  83  * @return
  84  *   Keepalive structure success, NULL on failure.
  85  */
  86 struct rte_keepalive *rte_keepalive_create(
  87         rte_keepalive_failure_callback_t callback,
  88         void *data);
  89
  90 /**
  91  * Checks & handles keepalive state of monitored cores.
  92  * @param *ptr_timer Triggering timer (unused)
  93  * @param *ptr_data  Data pointer (keepalive structure)
  94  */
  95 void rte_keepalive_dispatch_pings(void *ptr_timer, void *ptr_data);
  96
  97 /**
  98  * Registers a core for keepalive checks.
  99  * @param *keepcfg
 100  *   Keepalive structure pointer
 101  * @param id_core
 102  *   ID number of core to register.
 103  */
 104 void rte_keepalive_register_core(struct rte_keepalive *keepcfg,
 105         const int id_core);
 106
 107 /**
 108  * Per-core keepalive check.
 109  * @param *keepcfg
 110  *   Keepalive structure pointer
 111  *
 112  * This function needs to be called from within the main process loop of
 113  * the LCore to be checked.
 114  */
 115 void
 116 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg);
 117
 118 #endif /* _KEEPALIVE_H_ */