From 89cb86aeb0262e17ee39c1d791effe9515bd0dc8 Mon Sep 17 00:00:00 2001 From: David Lamparter Date: Tue, 4 Oct 2022 18:44:36 +0200 Subject: build, vtysh: extract vtysh commands from .xref Rather than running selected source files through the preprocessor and a bunch of perl regex'ing to get the list of all DEFUNs, use the data collected in frr.xref. This not only eliminates issues we've been having with preprocessor failures due to nonexistent header files, but is also much faster. Where extract.pl would take 5s, this now finishes in 0.2s. And since this is a non-parallelizable build step towards the end of the build (dependent on a lot of other things being done already), the speedup is actually noticeable. Also files containing CLI no longer need to be listed in `vtysh_scan` since the .xref data covers everything. `#ifndef VTYSH_EXTRACT_PL` checks are equally obsolete. Signed-off-by: David Lamparter --- python/vtysh-cmd-check.py | 72 ----------------------------------------------- 1 file changed, 72 deletions(-) delete mode 100644 python/vtysh-cmd-check.py (limited to 'python/vtysh-cmd-check.py') diff --git a/python/vtysh-cmd-check.py b/python/vtysh-cmd-check.py deleted file mode 100644 index ef9eea41ad..0000000000 --- a/python/vtysh-cmd-check.py +++ /dev/null @@ -1,72 +0,0 @@ -#!/usr/bin/env python3 -# -# Quick demo program that checks whether files define commands that aren't -# in vtysh. Execute after building. -# -# This is free and unencumbered software released into the public domain. -# -# Anyone is free to copy, modify, publish, use, compile, sell, or -# distribute this software, either in source code form or as a compiled -# binary, for any purpose, commercial or non-commercial, and by any -# means. -# -# In jurisdictions that recognize copyright laws, the author or authors -# of this software dedicate any and all copyright interest in the -# software to the public domain. We make this dedication for the benefit -# of the public at large and to the detriment of our heirs and -# successors. We intend this dedication to be an overt act of -# relinquishment in perpetuity of all present and future rights to this -# software under copyright law. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR -# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -# OTHER DEALINGS IN THE SOFTWARE. -# -# For more information, please refer to - -import os -import json -import subprocess - -os.chdir(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) - -with open("frr.xref", "r") as fd: - data = json.load(fd) - -vtysh_scan, _ = subprocess.Popen( - ["make", "var-vtysh_scan"], stdout=subprocess.PIPE -).communicate() -vtysh_scan = set(vtysh_scan.decode("US-ASCII").split()) - -check = set() -vtysh = {} - -for cmd, defs in data["cli"].items(): - for binary, clidef in defs.items(): - if clidef["defun"]["file"].startswith("vtysh/"): - vtysh[clidef["string"]] = clidef - -for cmd, defs in data["cli"].items(): - for binary, clidef in defs.items(): - if clidef["defun"]["file"].startswith("vtysh/"): - continue - - if clidef["defun"]["file"] not in vtysh_scan: - vtysh_def = vtysh.get(clidef["string"]) - if vtysh_def is not None: - print( - "\033[33m%s defines %s, has a custom define in vtysh %s\033[m" - % (clidef["defun"]["file"], cmd, vtysh_def["defun"]["file"]) - ) - else: - print( - "\033[31m%s defines %s, not in vtysh_scan\033[m" - % (clidef["defun"]["file"], cmd) - ) - check.add(clidef["defun"]["file"]) - -print("\nfiles to check:\n\t" + " ".join(sorted(check))) -- cgit v1.2.3