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. */
46 #if defined(HAVE_MALLINFO2) || defined(HAVE_MALLINFO)
47 static int show_memory_mallinfo(struct vty
*vty
)
49 #if defined(HAVE_MALLINFO2)
50 struct mallinfo2 minfo
= mallinfo2();
51 #elif defined(HAVE_MALLINFO)
52 struct mallinfo minfo
= mallinfo();
54 char buf
[MTYPE_MEMSTR_LEN
];
56 vty_out(vty
, "System allocator statistics:\n");
57 vty_out(vty
, " Total heap allocated: %s\n",
58 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.arena
));
59 vty_out(vty
, " Holding block headers: %s\n",
60 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.hblkhd
));
61 vty_out(vty
, " Used small blocks: %s\n",
62 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.usmblks
));
63 vty_out(vty
, " Used ordinary blocks: %s\n",
64 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.uordblks
));
65 vty_out(vty
, " Free small blocks: %s\n",
66 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.fsmblks
));
67 vty_out(vty
, " Free ordinary blocks: %s\n",
68 mtype_memstr(buf
, MTYPE_MEMSTR_LEN
, minfo
.fordblks
));
69 vty_out(vty
, " Ordinary blocks: %ld\n",
70 (unsigned long)minfo
.ordblks
);
71 vty_out(vty
, " Small blocks: %ld\n",
72 (unsigned long)minfo
.smblks
);
73 vty_out(vty
, " Holding blocks: %ld\n",
74 (unsigned long)minfo
.hblks
);
75 vty_out(vty
, "(see system documentation for 'mallinfo' for meaning)\n");
78 #endif /* HAVE_MALLINFO */
80 static int qmem_walker(void *arg
, struct memgroup
*mg
, struct memtype
*mt
)
82 struct vty
*vty
= arg
;
84 vty_out(vty
, "--- qmem %s ---\n", mg
->name
);
85 vty_out(vty
, "%-30s: %8s %-8s%s %8s %9s\n",
86 "Type", "Current#", " Size",
87 #ifdef HAVE_MALLOC_USABLE_SIZE
93 #ifdef HAVE_MALLOC_USABLE_SIZE
100 if (mt
->n_max
!= 0) {
102 snprintf(size
, sizeof(size
), "%6zu", mt
->size
);
103 #ifdef HAVE_MALLOC_USABLE_SIZE
105 #define TARG , mt->total
106 #define TARG2 , mt->max_size
112 vty_out(vty
, "%-30s: %8zu %-8s"TSTR
" %8zu"TSTR
"\n",
116 : mt
->size
== SIZE_VAR
128 DEFUN_NOSH (show_memory
,
131 "Show running system information\n"
132 "Memory statistics\n")
135 show_memory_mallinfo(vty
);
136 #endif /* HAVE_MALLINFO */
138 qmem_walk(qmem_walker
, vty
);
142 DEFUN_NOSH (show_modules
,
145 "Show running system information\n"
148 struct frrmod_runtime
*plug
= frrmod_list
;
150 vty_out(vty
, "%-12s %-25s %s\n\n", "Module Name", "Version",
153 const struct frrmod_info
*i
= plug
->info
;
155 vty_out(vty
, "%-12s %-25s %s\n", i
->name
, i
->version
,
157 if (plug
->dl_handle
) {
158 #ifdef HAVE_DLINFO_ORIGIN
159 char origin
[MAXPATHLEN
] = "";
160 dlinfo(plug
->dl_handle
, RTLD_DI_ORIGIN
, &origin
);
161 #ifdef HAVE_DLINFO_LINKMAP
163 struct link_map
*lm
= NULL
;
164 dlinfo(plug
->dl_handle
, RTLD_DI_LINKMAP
, &lm
);
166 name
= strrchr(lm
->l_name
, '/');
167 name
= name
? name
+ 1 : lm
->l_name
;
168 vty_out(vty
, "\tfrom: %s/%s\n", origin
, name
);
171 vty_out(vty
, "\tfrom: %s \n", origin
, plug
->load_name
);
174 vty_out(vty
, "\tfrom: %s\n", plug
->load_name
);
180 vty_out(vty
, "pid: %u\n", (uint32_t)(getpid()));
187 "frr defaults PROFILE...",
188 "FRRouting global parameters\n"
189 "set of configuration defaults used\n"
192 char *profile
= argv_concat(argv
, argc
, 2);
193 int rv
= CMD_SUCCESS
;
195 if (!frr_defaults_profile_valid(profile
)) {
196 vty_out(vty
, "%% WARNING: profile %s is not known in this version\n",
200 frr_defaults_profile_set(profile
);
201 XFREE(MTYPE_TMP
, profile
);
207 "frr version VERSION...",
208 "FRRouting global parameters\n"
209 "version configuration was written by\n"
212 char *version
= argv_concat(argv
, argc
, 2);
214 frr_defaults_version_set(version
);
215 XFREE(MTYPE_TMP
, version
);
219 static struct call_back
{
222 void (*start_config
)(void);
223 void (*end_config
)(void);
227 DEFUN_HIDDEN (start_config
,
229 "XFRR_start_configuration",
230 "The Beginning of Configuration\n")
232 callback
.readin_time
= monotime(NULL
);
234 if (callback
.start_config
)
235 (*callback
.start_config
)();
240 DEFUN_HIDDEN (end_config
,
242 "XFRR_end_configuration",
243 "The End of Configuration\n")
246 char readin_time_str
[MONOTIME_STRLEN
];
248 readin_time
= monotime(NULL
);
249 readin_time
-= callback
.readin_time
;
251 frrtime_to_interval(readin_time
, readin_time_str
,
252 sizeof(readin_time_str
));
254 zlog_info("Configuration Read in Took: %s", readin_time_str
);
256 if (callback
.end_config
)
257 (*callback
.end_config
)();
262 void cmd_init_config_callbacks(void (*start_config_cb
)(void),
263 void (*end_config_cb
)(void))
265 callback
.start_config
= start_config_cb
;
266 callback
.end_config
= end_config_cb
;
270 static void defaults_autocomplete(vector comps
, struct cmd_token
*token
)
274 for (p
= frr_defaults_profiles
; *p
; p
++)
275 vector_set(comps
, XSTRDUP(MTYPE_COMPLETION
, *p
));
278 static const struct cmd_variable_handler default_var_handlers
[] = {
279 {.tokenname
= "PROFILE", .completions
= defaults_autocomplete
},
280 {.completions
= NULL
},
283 void lib_cmd_init(void)
285 cmd_variable_handler_register(default_var_handlers
);
287 install_element(CONFIG_NODE
, &frr_defaults_cmd
);
288 install_element(CONFIG_NODE
, &frr_version_cmd
);
290 install_element(VIEW_NODE
, &show_memory_cmd
);
291 install_element(VIEW_NODE
, &show_modules_cmd
);
293 install_element(CONFIG_NODE
, &start_config_cmd
);
294 install_element(CONFIG_NODE
, &end_config_cmd
);
297 /* Stats querying from users */
298 /* Return a pointer to a human friendly string describing
299 * the byte count passed in. E.g:
300 * "0 bytes", "2048 bytes", "110kB", "500MiB", "11GiB", etc.
301 * Up to 4 significant figures will be given.
302 * The pointer returned may be NULL (indicating an error)
303 * or point to the given buffer, or point to static storage.
305 const char *mtype_memstr(char *buf
, size_t len
, unsigned long bytes
)
316 * When we pass the 2gb barrier mallinfo() can no longer report
317 * correct data so it just does something odd...
318 * Reporting like Terrabytes of data. Which makes users...
319 * edgy.. yes edgy that's the term for it.
320 * So let's just give up gracefully
322 if (bytes
> 0x7fffffff)
329 if (bytes
& (1 << 19))
331 snprintf(buf
, len
, "%d MiB", m
);
333 if (bytes
& (1 << 9))
335 snprintf(buf
, len
, "%d KiB", k
);
337 snprintf(buf
, len
, "%ld bytes", bytes
);