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