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
  69 static void
  70 print_trace(const char *msg, struct rte_keepalive *keepcfg, int idx_core)
  71 {
  72         RTE_LOG(INFO, EAL, "%sLast seen %" PRId64 "ms ago.\n",
  73                 msg,
  74                 ((rte_rdtsc() - keepcfg->last_alive[idx_core])*1000)
  75                 / rte_get_tsc_hz()
  76               );
  77 }
  78
  79 void
  80 rte_keepalive_dispatch_pings(__rte_unused void *ptr_timer,
  81         void *ptr_data)
  82 {
  83         struct rte_keepalive *keepcfg = ptr_data;
  84         int idx_core;
  85
  86         for (idx_core = 0; idx_core < RTE_KEEPALIVE_MAXCORES; idx_core++) {
  87                 if (keepcfg->active_cores[idx_core] == 0)
  88                         continue;
  89
  90                 switch (keepcfg->state_flags[idx_core]) {
  91                 case RTE_KA_STATE_UNUSED:
  92                         break;
  93                 case RTE_KA_STATE_ALIVE: /* Alive */
  94                         keepcfg->state_flags[idx_core] = RTE_KA_STATE_MISSING;
  95                         keepcfg->last_alive[idx_core] = rte_rdtsc();
  96                         break;
  97                 case RTE_KA_STATE_MISSING: /* MIA */
  98                         print_trace("Core MIA. ", keepcfg, idx_core);
  99                         keepcfg->state_flags[idx_core] = RTE_KA_STATE_DEAD;
 100                         break;
 101                 case RTE_KA_STATE_DEAD: /* Dead */
 102                         keepcfg->state_flags[idx_core] = RTE_KA_STATE_GONE;
 103                         print_trace("Core died. ", keepcfg, idx_core);
 104                         if (keepcfg->callback)
 105                                 keepcfg->callback(
 106                                         keepcfg->callback_data,
 107                                         idx_core
 108                                         );
 109                         break;
 110                 case RTE_KA_STATE_GONE: /* Buried */
 111                         break;
 112                 case RTE_KA_STATE_DOZING: /* Core going idle */
 113                         keepcfg->state_flags[idx_core] = RTE_KA_STATE_SLEEP;
 114                         keepcfg->last_alive[idx_core] = rte_rdtsc();
 115                         break;
 116                 case RTE_KA_STATE_SLEEP: /* Idled core */
 117                         break;
 118                 }
 119         }
 120 }
 121
 122 struct rte_keepalive *
 123 rte_keepalive_create(rte_keepalive_failure_callback_t callback,
 124         void *data)
 125 {
 126         struct rte_keepalive *keepcfg;
 127
 128         keepcfg = rte_zmalloc("RTE_EAL_KEEPALIVE",
 129                 sizeof(struct rte_keepalive),
 130                 RTE_CACHE_LINE_SIZE);
 131         if (keepcfg != NULL) {
 132                 keepcfg->callback = callback;
 133                 keepcfg->callback_data = data;
 134                 keepcfg->tsc_initial = rte_rdtsc();
 135                 keepcfg->tsc_mhz = rte_get_tsc_hz() / 1000;
 136         }
 137         return keepcfg;
 138 }
 139
 140 void
 141 rte_keepalive_register_core(struct rte_keepalive *keepcfg, const int id_core)
 142 {
 143         if (id_core < RTE_KEEPALIVE_MAXCORES) {
 144                 keepcfg->active_cores[id_core] = RTE_KA_STATE_ALIVE;
 145                 keepcfg->last_alive[id_core] = rte_rdtsc();
 146         }
 147 }
 148
 149 void
 150 rte_keepalive_mark_alive(struct rte_keepalive *keepcfg)
 151 {
 152         keepcfg->state_flags[rte_lcore_id()] = RTE_KA_STATE_ALIVE;
 153 }