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