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