2 * Assorted library VTY commands
4 * Copyright (C) 1998 Kunihiro Ishiguro
5 * Copyright (C) 2016-2017 David Lamparter for NetDEF, Inc.
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)
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
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
23 /* malloc.h is generally obsolete, however GNU Libc mallinfo wants it. */
27 #ifdef HAVE_MALLOC_MALLOC_H
28 #include <malloc/malloc.h>
41 /* Looking up memory status from vty interface. */
47 static int show_memory_mallinfo(struct vty
*vty
)
49 struct mallinfo minfo
= mallinfo();
50 char buf
[MTYPE_MEMSTR_LEN
];
52 vty_out(vty
, "System allocator statistics:\n");
53 vty_out(vty
, " Total heap allocated: %s\n",
54 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.arena
));
55 vty_out(vty
, " Holding block headers: %s\n",
56 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.hblkhd
));
57 vty_out(vty
, " Used small blocks: %s\n",
58 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.usmblks
));
59 vty_out(vty
, " Used ordinary blocks: %s\n",
60 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.uordblks
));
61 vty_out(vty
, " Free small blocks: %s\n",
62 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.fsmblks
));
63 vty_out(vty
, " Free ordinary blocks: %s\n",
64 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.fordblks
));
65 vty_out(vty
, " Ordinary blocks: %ld\n",
66 (unsigned long)minfo
.ordblks
);
67 vty_out(vty
, " Small blocks: %ld\n",
68 (unsigned long)minfo
.smblks
);
69 vty_out(vty
, " Holding blocks: %ld\n",
70 (unsigned long)minfo
.hblks
);
71 vty_out(vty
, "(see system documentation for 'mallinfo' for meaning)\n");
74 #endif /* HAVE_MALLINFO */
76 static int qmem_walker(void *arg
, struct memgroup
*mg
, struct memtype
*mt
)
78 struct vty
*vty
= arg
;
80 vty_out(vty
, "--- qmem %s ---\n", mg
->name
);
81 vty_out(vty
, "%-30s: %8s %-8s%s %8s %9s\n",
82 "Type", "Current#", " Size",
83 #ifdef HAVE_MALLOC_USABLE_SIZE
89 #ifdef HAVE_MALLOC_USABLE_SIZE
98 snprintf(size
, sizeof(size
), "%6zu", mt
->size
);
99 #ifdef HAVE_MALLOC_USABLE_SIZE
101 #define TARG , mt->total
102 #define TARG2 , mt->max_size
108 vty_out(vty
, "%-30s: %8zu %-8s"TSTR
" %8zu"TSTR
"\n",
112 : mt
->size
== SIZE_VAR
124 DEFUN_NOSH (show_memory
,
127 "Show running system information\n"
128 "Memory statistics\n")
131 show_memory_mallinfo(vty
);
132 #endif /* HAVE_MALLINFO */
134 qmem_walk(qmem_walker
, vty
);
138 DEFUN_NOSH (show_modules
,
141 "Show running system information\n"
144 struct frrmod_runtime
*plug
= frrmod_list
;
146 vty_out(vty
, "%-12s %-25s %s\n\n", "Module Name", "Version",
149 const struct frrmod_info
*i
= plug
->info
;
151 vty_out(vty
, "%-12s %-25s %s\n", i
->name
, i
->version
,
153 if (plug
->dl_handle
) {
154 #ifdef HAVE_DLINFO_ORIGIN
155 char origin
[MAXPATHLEN
] = "";
156 dlinfo(plug
->dl_handle
, RTLD_DI_ORIGIN
, &origin
);
157 #ifdef HAVE_DLINFO_LINKMAP
159 struct link_map
*lm
= NULL
;
160 dlinfo(plug
->dl_handle
, RTLD_DI_LINKMAP
, &lm
);
162 name
= strrchr(lm
->l_name
, '/');
163 name
= name
? name
+ 1 : lm
->l_name
;
164 vty_out(vty
, "\tfrom: %s/%s\n", origin
, name
);
167 vty_out(vty
, "\tfrom: %s \n", origin
, plug
->load_name
);
170 vty_out(vty
, "\tfrom: %s\n", plug
->load_name
);
176 vty_out(vty
, "pid: %u\n", (uint32_t)(getpid()));
183 "frr defaults PROFILE...",
184 "FRRouting global parameters\n"
185 "set of configuration defaults used\n"
188 char *profile
= argv_concat(argv
, argc
, 2);
189 int rv
= CMD_SUCCESS
;
191 if (!frr_defaults_profile_valid(profile
)) {
192 vty_out(vty
, "%% WARNING: profile %s is not known in this version\n",
196 frr_defaults_profile_set(profile
);
197 XFREE(MTYPE_TMP
, profile
);
203 "frr version VERSION...",
204 "FRRouting global parameters\n"
205 "version configuration was written by\n"
208 char *version
= argv_concat(argv
, argc
, 2);
210 frr_defaults_version_set(version
);
211 XFREE(MTYPE_TMP
, version
);
215 static void defaults_autocomplete(vector comps
, struct cmd_token
*token
)
219 for (p
= frr_defaults_profiles
; *p
; p
++)
220 vector_set(comps
, XSTRDUP(MTYPE_COMPLETION
, *p
));
223 static const struct cmd_variable_handler default_var_handlers
[] = {
224 {.tokenname
= "PROFILE", .completions
= defaults_autocomplete
},
225 {.completions
= NULL
},
228 void lib_cmd_init(void)
230 cmd_variable_handler_register(default_var_handlers
);
232 install_element(CONFIG_NODE
, &frr_defaults_cmd
);
233 install_element(CONFIG_NODE
, &frr_version_cmd
);
235 install_element(VIEW_NODE
, &show_memory_cmd
);
236 install_element(VIEW_NODE
, &show_modules_cmd
);
239 /* Stats querying from users */
240 /* Return a pointer to a human friendly string describing
241 * the byte count passed in. E.g:
242 * "0 bytes", "2048 bytes", "110kB", "500MiB", "11GiB", etc.
243 * Up to 4 significant figures will be given.
244 * The pointer returned may be NULL (indicating an error)
245 * or point to the given buffer, or point to static storage.
247 const char *mtype_memstr(char *buf
, size_t len
, unsigned long bytes
)
258 * When we pass the 2gb barrier mallinfo() can no longer report
259 * correct data so it just does something odd...
260 * Reporting like Terrabytes of data. Which makes users...
261 * edgy.. yes edgy that's the term for it.
262 * So let's just give up gracefully
264 if (bytes
> 0x7fffffff)
271 if (bytes
& (1 << 19))
273 snprintf(buf
, len
, "%d MiB", m
);
275 if (bytes
& (1 << 9))
277 snprintf(buf
, len
, "%d KiB", k
);
279 snprintf(buf
, len
, "%ld bytes", bytes
);