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