diff options
Diffstat (limited to 'vtysh/extract.pl.in')
| -rwxr-xr-x | vtysh/extract.pl.in | 282 |
1 files changed, 282 insertions, 0 deletions
diff --git a/vtysh/extract.pl.in b/vtysh/extract.pl.in new file mode 100755 index 0000000..228a136 --- /dev/null +++ b/vtysh/extract.pl.in @@ -0,0 +1,282 @@ +#! @PERL@ +## +## @configure_input@ +## +## Virtual terminal interface shell command extractor. +## Copyright (C) 2000 Kunihiro Ishiguro +## +## This file is part of GNU Zebra. +## +## GNU Zebra is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by the +## Free Software Foundation; either version 2, or (at your option) any +## later version. +## +## GNU Zebra is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with GNU Zebra; see the file COPYING. If not, write to the Free +## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA +## 02111-1307, USA. +## + +use Getopt::Long; + +print <<EOF; +#include <zebra.h> + +#include "command.h" +#include "linklist.h" + +#include "vtysh/vtysh.h" + +EOF + +my $cli_stomp = 0; + +sub scan_file { + my ( $file, $fabricd) = @_; + + $cppadd = $fabricd ? "-DFABRICD=1" : ""; + + $command_line = "@CPP@ -P -std=gnu11 -DHAVE_CONFIG_H -DVTYSH_EXTRACT_PL -Ivtysh/@top_builddir@ -Ivtysh/@top_srcdir@ -Ivtysh/@top_srcdir@/lib -Ivtysh/@top_builddir@/lib -Ivtysh/@top_srcdir@/bgpd -Ivtysh/@top_srcdir@/bgpd/rfapi @LUA_INCLUDE@ @CPPFLAGS@ @LIBYANG_CFLAGS@ $cppadd $file |"; + open (FH, $command_line) + || die "Open to the pipeline failed: $!\n\nCommand Issued:\n$command_line"; + local $/; undef $/; + $line = <FH>; + if (!close (FH)) { + die "File: $file failed to compile:\n$!\nwhen extracting cli from it please inspect\n" + } + + # ?: makes a group non-capturing + @defun = ($line =~ /((?:DEFUN|DEFUN_HIDDEN|DEFUN_YANG|ALIAS|ALIAS_HIDDEN|ALIAS_YANG|DEFPY|DEFPY_HIDDEN|DEFPY_YANG)\s*\(.+?\));?\s?\s?\n/sg); + @install = ($line =~ /install_element\s*\(\s*[0-9A-Z_]+,\s*&[^;]*;\s*\n/sg); + + # DEFUN process + foreach (@defun) { + # $_ will contain the entire string including the DEFUN, ALIAS, etc. + # We need to extract the DEFUN/ALIAS from everything in ()s. + # The /s at the end tells the regex to allow . to match newlines. + $_ =~ /^(.*?)\s*\((.*)\)$/s; + + my (@defun_array); + $defun_or_alias = $1; + @defun_array = split (/,/, $2); + + if ($defun_or_alias =~ /_HIDDEN/) { + $hidden = 1; + } else { + $hidden = 0; + } + + $defun_array[0] = ''; + + # Actual input command string. + $str = "$defun_array[2]"; + $str =~ s/^\s+//g; + $str =~ s/\s+$//g; + + # Get VTY command structure. This is needed for searching + # install_element() command. + $cmd = "$defun_array[1]"; + $cmd =~ s/^\s+//g; + $cmd =~ s/\s+$//g; + + if ($fabricd) { + $cmd = "fabricd_" . $cmd; + } + + # $protocol is VTYSH_PROTO format for redirection of user input + if ($file =~ /lib\/keychain\.c$/) { + $protocol = "VTYSH_RIPD|VTYSH_EIGRPD|VTYSH_OSPF6D"; + } + elsif ($file =~ /lib\/routemap\.c$/ || $file =~ /lib\/routemap_cli\.c$/) { + $protocol = "VTYSH_RMAP"; + } + elsif ($file =~ /lib\/vrf\.c$/) { + $protocol = "VTYSH_VRF"; + } + elsif ($file =~ /lib\/if\.c$/) { + $protocol = "VTYSH_INTERFACE"; + } + elsif ($file =~ /lib\/(filter|filter_cli)\.c$/) { + $protocol = "VTYSH_ACL"; + } + elsif ($file =~ /lib\/(lib|log)_vty\.c$/) { + $protocol = "VTYSH_ALL"; + } + elsif ($file =~ /lib\/agentx\.c$/) { + $protocol = "VTYSH_ISISD|VTYSH_RIPD|VTYSH_OSPFD|VTYSH_OSPF6D|VTYSH_BGPD|VTYSH_ZEBRA"; + } + elsif ($file =~ /lib\/nexthop_group\.c$/) { + $protocol = "VTYSH_NH_GROUP"; + } + elsif ($file =~ /lib\/plist\.c$/) { + if ($defun_array[1] =~ m/ipv6/) { + $protocol = "VTYSH_RIPNGD|VTYSH_OSPF6D|VTYSH_BGPD|VTYSH_ZEBRA|VTYSH_PIM6D|VTYSH_BABELD|VTYSH_ISISD|VTYSH_FABRICD"; + } else { + $protocol = "VTYSH_RIPD|VTYSH_OSPFD|VTYSH_BGPD|VTYSH_ZEBRA|VTYSH_PIMD|VTYSH_EIGRPD|VTYSH_BABELD|VTYSH_ISISD|VTYSH_FABRICD"; + } + } + elsif ($file =~ /lib\/if_rmap\.c$/) { + if ($defun_array[1] =~ m/ipv6/) { + $protocol = "VTYSH_RIPNGD"; + } else { + $protocol = "VTYSH_RIPD"; + } + } + elsif ($file =~ /lib\/resolver\.c$/) { + $protocol = "VTYSH_NHRPD|VTYSH_BGPD"; + } + elsif ($file =~ /lib\/spf_backoff\.c$/) { + $protocol = "VTYSH_ISISD"; + } + elsif ($file =~ /lib\/(vty|thread)\.c$/) { + $protocol = "VTYSH_ALL"; + } + elsif ($file =~ /librfp\/.*\.c$/ || $file =~ /rfapi\/.*\.c$/) { + $protocol = "VTYSH_BGPD"; + } + elsif ($fabricd) { + $protocol = "VTYSH_FABRICD"; + } + elsif ($file =~ /pimd\/pim6_.*\.c$/) { + $protocol = "VTYSH_PIM6D"; + } + else { + ($protocol) = ($file =~ /^(?:.*\/)?([a-z0-9]+)\/[a-zA-Z0-9_\-]+\.c$/); + $protocol = "VTYSH_" . uc $protocol; + } + + # Append _vtysh to structure then build DEFUN again + $defun_array[1] = $cmd . "_vtysh"; + $defun_body = join (", ", @defun_array); + + # $cmd -> $str hash for lookup + if (exists($cmd2str{$cmd})) { + warn "Duplicate CLI Function: $cmd\n"; + warn "\tFrom cli: $cmd2str{$cmd} to New cli: $str\n"; + warn "\tOriginal Protocol: $cmd2proto{$cmd} to New Protocol: $protocol\n"; + $cli_stomp++; + } + $cmd2str{$cmd} = $str; + $cmd2defun{$cmd} = $defun_body; + $cmd2proto{$cmd} = $protocol; + $cmd2hidden{$cmd} = $hidden; + } + + # install_element() process + foreach (@install) { + my (@element_array); + @element_array = split (/,/); + + # Install node + $enode = $element_array[0]; + $enode =~ s/^\s+//g; + $enode =~ s/\s+$//g; + ($enode) = ($enode =~ /([0-9A-Z_]+)$/); + + # VTY command structure. + ($ecmd) = ($element_array[1] =~ /&([^\)]+)/); + $ecmd =~ s/^\s+//g; + $ecmd =~ s/\s+$//g; + + if ($fabricd) { + $ecmd = "fabricd_" . $ecmd; + } + + # Register $ecmd + if (defined ($cmd2str{$ecmd})) { + my ($key); + $key = $enode . "," . $cmd2str{$ecmd}; + $ocmd{$key} = $ecmd; + $odefun{$key} = $cmd2defun{$ecmd}; + + if ($cmd2hidden{$ecmd}) { + $defsh{$key} = "DEFSH_HIDDEN" + } else { + $defsh{$key} = "DEFSH" + } + push (@{$oproto{$key}}, $cmd2proto{$ecmd}); + } + } +} + +my $have_isisd = 0; +my $have_fabricd = 0; + +GetOptions('have-isisd' => \$have_isisd, 'have-fabricd' => \$have_fabricd); + +foreach (@ARGV) { + if (/(^|\/)isisd\//) { + # We scan all the IS-IS files twice, once for isisd, + # once for fabricd. Exceptions are made for the files + # that are not shared between the two. + if (/isis_vty_isisd.c/) { + if ( $have_isisd ) { + scan_file($_, 0); + } + } elsif (/isis_vty_fabricd.c/) { + if ( $have_fabricd ) { + scan_file($_, 1); + } + } else { + if ( $have_isisd ) { + scan_file($_, 0); + } + if ( $have_fabricd ) { + scan_file($_, 1); + } + } + } else { + scan_file($_, 0); + } +} + +# When we have cli commands that map to the same function name, we +# can introduce subtle bugs due to code not being called when +# we think it is. +# +# If extract.pl fails with a error message and you've been +# modifying the cli, then go back and fix your code to +# not have cli command function collisions. +# please fix your code before submittal +if ($cli_stomp) { + warn "There are $cli_stomp command line stomps\n"; +} + +# Check finaly alive $cmd; +foreach (keys %odefun) { + my ($node, $str) = (split (/,/)); + my ($cmd) = $ocmd{$_}; + $live{$cmd} = $_; +} + +# Output DEFSH +foreach (sort keys %live) { + my ($proto); + my ($key); + $key = $live{$_}; + $proto = join ("|", @{$oproto{$key}}); + printf "$defsh{$key} ($proto$odefun{$key})\n\n"; +} + +# Output install_element +print <<EOF; +void vtysh_init_cmd(void) +{ +EOF + +foreach (sort keys %odefun) { + my ($node, $str) = (split (/,/)); + $cmd = $ocmd{$_}; + $cmd =~ s/_cmd$/_cmd_vtysh/; + printf " install_element ($node, &$cmd);\n"; +} + +print <<EOF +} +EOF |