lib/librte_eal/common/rte_keepalive.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2015-2016 Intel Corporation. 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 #include <inttypes.h>
  34
  35 #include <rte_common.h>
  36 #include <rte_cycles.h>
  37 #include <rte_lcore.h>
  38 #include <rte_log.h>
  39 #include <rte_keepalive.h>
  40 #include <rte_malloc.h>
  41
  42 struct rte_keepalive {
  43         /** Core Liveness. */
  44         struct {
  45                 /*
  46                  * Each element must be cache aligned to prevent false sharing.
  47                  */
  48                 enum rte_keepalive_state core_state __rte_cache_aligned;
  49         } live_data[RTE_KEEPALIVE_MAXCORES];
  50
  51         /** Last-seen-alive timestamps */
  52         uint64_t last_alive[RTE_KEEPALIVE_MAXCORES];
  53
  54         /**
  55          * Cores to check.
  56          * Indexed by core id, non-zero if the core should be checked.
  57          */
  58         uint8_t active_cores[RTE_KEEPALIVE_MAXCORES];
  59
  60         /** Dead core handler. */
  61         rte_keepalive_failure_callback_t callback;
  62
  63         /**
  64          * Dead core handler app data.
  65          * Pointer is passed to dead core handler.
  66          */
  67         void *callback_data;
  68         uint64_t tsc_initial;
  69         uint64_t tsc_mhz;
  70
  71         /** Core state relay handler. */
  72         rte_keepalive_relay_callback_t relay_callback;
  73
  74         /**
  75          * Core state relay handler app data.
  76          * Pointer is passed to live core handler.
  77          */
  78         void *relay_callback_data;
  79 };
  80
  81 static void
  82 print_trace(const char *msg, struct rte_keepalive *keepcfg, int idx_core)
  83 {
  84         RTE_LOG(INFO, EAL, "%sLast seen %" PRId64 "ms ago.\n",
  85                 msg,
  86                 ((rte_rdtsc() - keepcfg->last_alive[idx_core])*1000)
  87                 / rte_get_tsc_hz()
  88               );
  89 }
  90
  91 void
  92 rte_keepalive_dispatch_pings(__rte_unused void *ptr_timer,
  93         void *ptr_data)
  94 {
  95         struct rte_keepalive *keepcfg = ptr_data;
  96         int idx_core;
  97
  98         for (idx_core = 0; idx_core < RTE_KEEPALIVE_MAXCORES; idx_core++) {
  99                 if (keepcfg->active_cores[idx_core] == 0)
 100                         continue;
 101
 102                 switch (keepcfg->live_data[idx_core].core_state) {
 103                 case RTE_KA_STATE_UNUSED:
 104                         break;
 105                 case RTE_KA_STATE_ALIVE: /* Alive */
 106                         keepcfg->live_data[idx_core].core_state =
 107                             RTE_KA_STATE_MISSING;
 108                         keepcfg->last_alive[idx_core] = rte_rdtsc();
 109                         break;
 110                 case RTE_KA_STATE_MISSING: /* MIA */
 111                         print_trace("Core MIA. ", keepcfg, idx_core);
 112                         keepcfg->live_data[idx_core].core_state =
 113                             RTE_KA_STATE_DEAD;
 114                         break;
 115                 case RTE_KA_STATE_DEAD: /* Dead */
 116                         keepcfg->live_data[idx_core].core_state =
 117                             RTE_KA_STATE_GONE;
 118                         print_trace("Core died. ", keepcfg, idx_core);
 119                         if (keepcfg->callback)
 120                                 keepcfg->callback(
 121                                         keepcfg->callback_data,
 122                                         idx_core
 123                                         );
 124                         break;
 125                 case RTE_KA_STATE_GONE: /* Buried */
 126                         break;
 127                 case RTE_KA_STATE_DOZING: /* Core going idle */
 128                         keepcfg->live_data[idx_core].core_state =
 129                             RTE_KA_STATE_SLEEP;
 130                         keepcfg->last_alive[idx_core] = rte_rdtsc();
 131                         break;
 132                 case RTE_KA_STATE_SLEEP: /* Idled core */
 133                         break;
 134                 }
 135                 if (keepcfg->relay_callback)
 136                         keepcfg->relay_callback(
 137                                 keepcfg->relay_callback_data,
 138                                 idx_core,
 139                                 keepcfg->live_data[idx_core].core_state,
 140                                 keepcfg->last_alive[idx_core]
 141                                 );
 142         }
 143 }
 144
 145 struct rte_keepalive *
 146 rte_keepalive_create(rte_keepalive_failure_callback_t callback,
 147         void *data)
 148 {
 149         struct rte_keepalive *keepcfg;
 150
 151         keepcfg = rte_zmalloc("RTE_EAL_KEEPALIVE",
 152                 sizeof(struct rte_keepalive),
 153                 RTE_CACHE_LINE_SIZE);
 154         if (keepcfg != NULL) {
 155                 keepcfg->callback = callback;
 156                 keepcfg->callback_data = data;
 157                 keepcfg->tsc_initial = rte_rdtsc();
 158                 keepcfg->tsc_mhz = rte_get_tsc_hz() / 1000;
 159         }
 160         return keepcfg;
 161 }
 162
 163 void rte_keepalive_register_relay_callback(struct rte_keepalive *keepcfg,
 164         rte_keepalive_relay_callback_t callback,
 165         void *data)
 166 {
 167         keepcfg->relay_callback = callback;
 168         keepcfg->relay_callback_data = data;
 169 }
 170
 171 void
 172 rte_keepalive_register_core(struct rte_keepalive *keepcfg, const int id_core)
 173 {
 174         if (id_core < RTE_KEEPALIVE_MAXCORES) {
 175                 keepcfg->active_cores[id_core] = RTE_KA_STATE_ALIVE;
 176                 keepcfg->last_alive[id_core] = rte_rdtsc();
 177         }
 178 }
 179
 180 void
 181 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
 182 {
 183         keepcfg->live_data[rte_lcore_id()].core_state = RTE_KA_STATE_ALIVE;
 184 }
 185
 186 void
 187 rte_keepalive_mark_sleep(struct rte_keepalive *keepcfg)
 188 {
 189         keepcfg->live_data[rte_lcore_id()].core_state = RTE_KA_STATE_DOZING;
 190 }