lib/memory_vty.c

   1 /*
   2  * Memory and dynamic module VTY routine
   3  *
   4  * Copyright (C) 1998 Kunihiro Ishiguro
   5  * Copyright (C) 2016-2017  David Lamparter for NetDEF, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #include <zebra.h>
  23 /* malloc.h is generally obsolete, however GNU Libc mallinfo wants it. */
  24 #if (defined(GNU_LINUX) && defined(HAVE_MALLINFO))
  25 #include <malloc.h>
  26 #endif /* HAVE_MALLINFO */
  27 #include <dlfcn.h>
  28 #include <link.h>
  29
  30 #include "log.h"
  31 #include "memory.h"
  32 #include "module.h"
  33 #include "memory_vty.h"
  34
  35 /* Looking up memory status from vty interface. */
  36 #include "vector.h"
  37 #include "vty.h"
  38 #include "command.h"
  39
  40 #ifdef HAVE_MALLINFO
  41 static int
  42 show_memory_mallinfo (struct vty *vty)
  43 {
  44   struct mallinfo minfo = mallinfo();
  45   char buf[MTYPE_MEMSTR_LEN];
  46
  47   vty_out (vty, "System allocator statistics:\n");
  48   vty_out (vty, "  Total heap allocated:  %s\n",
  49            mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.arena));
  50   vty_out (vty, "  Holding block headers: %s\n",
  51            mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.hblkhd));
  52   vty_out (vty, "  Used small blocks:     %s\n",
  53            mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.usmblks));
  54   vty_out (vty, "  Used ordinary blocks:  %s\n",
  55            mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.uordblks));
  56   vty_out (vty, "  Free small blocks:     %s\n",
  57            mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.fsmblks));
  58   vty_out (vty, "  Free ordinary blocks:  %s\n",
  59            mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.fordblks));
  60   vty_out (vty, "  Ordinary blocks:       %ld\n",
  61            (unsigned long)minfo.ordblks);
  62   vty_out (vty, "  Small blocks:          %ld\n",
  63            (unsigned long)minfo.smblks);
  64   vty_out (vty, "  Holding blocks:        %ld\n",
  65            (unsigned long)minfo.hblks);
  66   vty_out (vty,"(see system documentation for 'mallinfo' for meaning)\n");
  67   return 1;
  68 }
  69 #endif /* HAVE_MALLINFO */
  70
  71 static int qmem_walker(void *arg, struct memgroup *mg, struct memtype *mt)
  72 {
  73         struct vty *vty = arg;
  74         if (!mt)
  75                 vty_out (vty, "--- qmem %s ---\n", mg->name);
  76         else {
  77                 if (mt->n_alloc != 0) {
  78                         char size[32];
  79                         snprintf(size, sizeof(size), "%6zu", mt->size);
  80                         vty_out (vty, "%-30s: %10zu  %s\n",
  81                                  mt->name, mt->n_alloc,
  82                                  mt->size == 0 ? "" : mt->size == SIZE_VAR ? "(variably sized)" : size);
  83                 }
  84         }
  85         return 0;
  86 }
  87
  88
  89 DEFUN (show_memory,
  90        show_memory_cmd,
  91        "show memory",
  92        "Show running system information\n"
  93        "Memory statistics\n")
  94 {
  95 #ifdef HAVE_MALLINFO
  96   show_memory_mallinfo (vty);
  97 #endif /* HAVE_MALLINFO */
  98
  99   qmem_walk(qmem_walker, vty);
 100   return CMD_SUCCESS;
 101 }
 102
 103 DEFUN (show_modules,
 104        show_modules_cmd,
 105        "show modules",
 106        "Show running system information\n"
 107        "Loaded modules\n")
 108 {
 109   struct frrmod_runtime *plug = frrmod_list;
 110
 111   vty_out (vty, "%-12s %-25s %s\n\n",
 112                 "Module Name", "Version", "Description");
 113   while (plug)
 114     {
 115       const struct frrmod_info *i = plug->info;
 116
 117       vty_out (vty, "%-12s %-25s %s\n", i->name, i->version,i->description);
 118       if (plug->dl_handle)
 119         {
 120 #ifdef HAVE_DLINFO_ORIGIN
 121           char origin[MAXPATHLEN] = "";
 122           dlinfo (plug->dl_handle, RTLD_DI_ORIGIN, &origin);
 123 # ifdef HAVE_DLINFO_LINKMAP
 124           const char *name;
 125           struct link_map *lm = NULL;
 126           dlinfo (plug->dl_handle, RTLD_DI_LINKMAP, &lm);
 127           if (lm)
 128             {
 129               name = strrchr(lm->l_name, '/');
 130               name = name ? name + 1 : lm->l_name;
 131               vty_out (vty, "\tfrom: %s/%s\n", origin, name);
 132             }
 133 # else
 134           vty_out (vty, "\tfrom: %s \n", origin, plug->load_name);
 135 # endif
 136 #else
 137           vty_out (vty, "\tfrom: %s\n", plug->load_name);
 138 #endif
 139         }
 140       plug = plug->next;
 141     }
 142   return CMD_SUCCESS;
 143 }
 144
 145 void
 146 memory_init (void)
 147 {
 148   install_element (VIEW_NODE, &show_memory_cmd);
 149   install_element (VIEW_NODE, &show_modules_cmd);
 150 }
 151
 152 /* Stats querying from users */
 153 /* Return a pointer to a human friendly string describing
 154  * the byte count passed in. E.g:
 155  * "0 bytes", "2048 bytes", "110kB", "500MiB", "11GiB", etc.
 156  * Up to 4 significant figures will be given.
 157  * The pointer returned may be NULL (indicating an error)
 158  * or point to the given buffer, or point to static storage.
 159  */
 160 const char *
 161 mtype_memstr (char *buf, size_t len, unsigned long bytes)
 162 {
 163   unsigned int m, k;
 164
 165   /* easy cases */
 166   if (!bytes)
 167     return "0 bytes";
 168   if (bytes == 1)
 169     return "1 byte";
 170
 171   /*
 172    * When we pass the 2gb barrier mallinfo() can no longer report
 173    * correct data so it just does something odd...
 174    * Reporting like Terrabytes of data.  Which makes users...
 175    * edgy.. yes edgy that's the term for it.
 176    * So let's just give up gracefully
 177    */
 178   if (bytes > 0x7fffffff)
 179     return "> 2GB";
 180
 181   m = bytes >> 20;
 182   k = bytes >> 10;
 183
 184  if (m > 10)
 185     {
 186       if (bytes & (1 << 19))
 187         m++;
 188       snprintf (buf, len, "%d MiB", m);
 189     }
 190   else if (k > 10)
 191     {
 192       if (bytes & (1 << 9))
 193         k++;
 194       snprintf (buf, len, "%d KiB", k);
 195     }
 196   else
 197     snprintf (buf, len, "%ld bytes", bytes);
 198
 199   return buf;
 200 }