]> git.proxmox.com Git - mirror_frr.git/blob - lib/memory_vty.c
zebra, lib: fix the ZEBRA_INTERFACE_VRF_UPDATE zapi message
[mirror_frr.git] / 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 #ifdef HAVE_MALLOC_H
25 #include <malloc.h>
26 #endif
27 #ifdef HAVE_MALLOC_MALLOC_H
28 #include <malloc/malloc.h>
29 #endif
30 #include <dlfcn.h>
31 #ifdef HAVE_LINK_H
32 #include <link.h>
33 #endif
34
35 #include "log.h"
36 #include "memory.h"
37 #include "module.h"
38 #include "memory_vty.h"
39
40 /* Looking up memory status from vty interface. */
41 #include "vector.h"
42 #include "vty.h"
43 #include "command.h"
44
45 #ifdef HAVE_MALLINFO
46 static int show_memory_mallinfo(struct vty *vty)
47 {
48 struct mallinfo minfo = mallinfo();
49 char buf[MTYPE_MEMSTR_LEN];
50
51 vty_out(vty, "System allocator statistics:\n");
52 vty_out(vty, " Total heap allocated: %s\n",
53 mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.arena));
54 vty_out(vty, " Holding block headers: %s\n",
55 mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.hblkhd));
56 vty_out(vty, " Used small blocks: %s\n",
57 mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.usmblks));
58 vty_out(vty, " Used ordinary blocks: %s\n",
59 mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.uordblks));
60 vty_out(vty, " Free small blocks: %s\n",
61 mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.fsmblks));
62 vty_out(vty, " Free ordinary blocks: %s\n",
63 mtype_memstr(buf, MTYPE_MEMSTR_LEN, minfo.fordblks));
64 vty_out(vty, " Ordinary blocks: %ld\n",
65 (unsigned long)minfo.ordblks);
66 vty_out(vty, " Small blocks: %ld\n",
67 (unsigned long)minfo.smblks);
68 vty_out(vty, " Holding blocks: %ld\n",
69 (unsigned long)minfo.hblks);
70 vty_out(vty, "(see system documentation for 'mallinfo' for meaning)\n");
71 return 1;
72 }
73 #endif /* HAVE_MALLINFO */
74
75 static int qmem_walker(void *arg, struct memgroup *mg, struct memtype *mt)
76 {
77 struct vty *vty = arg;
78 if (!mt) {
79 vty_out(vty, "--- qmem %s ---\n", mg->name);
80 vty_out(vty, "%-30s: %8s %-8s%s %8s %9s\n",
81 "Type", "Current#", " Size",
82 #ifdef HAVE_MALLOC_USABLE_SIZE
83 " Total",
84 #else
85 "",
86 #endif
87 "Max#",
88 #ifdef HAVE_MALLOC_USABLE_SIZE
89 "MaxBytes"
90 #else
91 ""
92 #endif
93 );
94 } else {
95 if (mt->n_alloc != 0) {
96 char size[32];
97 snprintf(size, sizeof(size), "%6zu", mt->size);
98 #ifdef HAVE_MALLOC_USABLE_SIZE
99 #define TSTR " %9zu"
100 #define TARG , mt->total
101 #define TARG2 , mt->max_size
102 #else
103 #define TSTR ""
104 #define TARG
105 #define TARG2
106 #endif
107 vty_out(vty, "%-30s: %8zu %-8s"TSTR" %8zu"TSTR"\n",
108 mt->name,
109 mt->n_alloc,
110 mt->size == 0 ? ""
111 : mt->size == SIZE_VAR
112 ? "variable"
113 : size
114 TARG,
115 mt->n_max
116 TARG2);
117 }
118 }
119 return 0;
120 }
121
122
123 DEFUN (show_memory,
124 show_memory_cmd,
125 "show memory",
126 "Show running system information\n"
127 "Memory statistics\n")
128 {
129 #ifdef HAVE_MALLINFO
130 show_memory_mallinfo(vty);
131 #endif /* HAVE_MALLINFO */
132
133 qmem_walk(qmem_walker, vty);
134 return CMD_SUCCESS;
135 }
136
137 DEFUN (show_modules,
138 show_modules_cmd,
139 "show modules",
140 "Show running system information\n"
141 "Loaded modules\n")
142 {
143 struct frrmod_runtime *plug = frrmod_list;
144
145 vty_out(vty, "%-12s %-25s %s\n\n", "Module Name", "Version",
146 "Description");
147 while (plug) {
148 const struct frrmod_info *i = plug->info;
149
150 vty_out(vty, "%-12s %-25s %s\n", i->name, i->version,
151 i->description);
152 if (plug->dl_handle) {
153 #ifdef HAVE_DLINFO_ORIGIN
154 char origin[MAXPATHLEN] = "";
155 dlinfo(plug->dl_handle, RTLD_DI_ORIGIN, &origin);
156 #ifdef HAVE_DLINFO_LINKMAP
157 const char *name;
158 struct link_map *lm = NULL;
159 dlinfo(plug->dl_handle, RTLD_DI_LINKMAP, &lm);
160 if (lm) {
161 name = strrchr(lm->l_name, '/');
162 name = name ? name + 1 : lm->l_name;
163 vty_out(vty, "\tfrom: %s/%s\n", origin, name);
164 }
165 #else
166 vty_out(vty, "\tfrom: %s \n", origin, plug->load_name);
167 #endif
168 #else
169 vty_out(vty, "\tfrom: %s\n", plug->load_name);
170 #endif
171 }
172 plug = plug->next;
173 }
174 return CMD_SUCCESS;
175 }
176
177 void memory_init(void)
178 {
179 install_element(VIEW_NODE, &show_memory_cmd);
180 install_element(VIEW_NODE, &show_modules_cmd);
181 }
182
183 /* Stats querying from users */
184 /* Return a pointer to a human friendly string describing
185 * the byte count passed in. E.g:
186 * "0 bytes", "2048 bytes", "110kB", "500MiB", "11GiB", etc.
187 * Up to 4 significant figures will be given.
188 * The pointer returned may be NULL (indicating an error)
189 * or point to the given buffer, or point to static storage.
190 */
191 const char *mtype_memstr(char *buf, size_t len, unsigned long bytes)
192 {
193 unsigned int m, k;
194
195 /* easy cases */
196 if (!bytes)
197 return "0 bytes";
198 if (bytes == 1)
199 return "1 byte";
200
201 /*
202 * When we pass the 2gb barrier mallinfo() can no longer report
203 * correct data so it just does something odd...
204 * Reporting like Terrabytes of data. Which makes users...
205 * edgy.. yes edgy that's the term for it.
206 * So let's just give up gracefully
207 */
208 if (bytes > 0x7fffffff)
209 return "> 2GB";
210
211 m = bytes >> 20;
212 k = bytes >> 10;
213
214 if (m > 10) {
215 if (bytes & (1 << 19))
216 m++;
217 snprintf(buf, len, "%d MiB", m);
218 } else if (k > 10) {
219 if (bytes & (1 << 9))
220 k++;
221 snprintf(buf, len, "%d KiB", k);
222 } else
223 snprintf(buf, len, "%ld bytes", bytes);
224
225 return buf;
226 }