VPP-23 Re-work pager line collation

To better handle lines longer than the terminal width, re-work how
the pager collates lines. We still store each output line in a vector
or lines; additionally we index the start and end of displayable lines.

The index then becomes the data to work out what to display.

If the terminal is resized this index is rebuilt and the current page
redisplayed and an attempt made to keep the current top-of-screen line
in place.

Change-Id: Icc6f4f72dabad89682cd82be88adb03eadb7811d
Signed-off-by: Chris Luke <chrisy@flirble.org>

Makefile

@@ -30,6 +30,7 @@ OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed
 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
+DEB_DEPENDS += doxygen graphviz
 ifeq ($(OS_VERSION_ID),14.04)
 	DEB_DEPENDS += openjdk-8-jdk-headless
 else
@@ -39,9 +40,8 @@ endif
 RPM_DEPENDS_GROUPS = 'Development Tools'
 RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
-#RPM_DEPENDS += doxygen # TODO
+RPM_DEPENDS += doxygen graphviz
 EPEL_DEPENDS = libconfuse-devel ganglia-devel
-#EPEL_DEPENDS += graphviz # TODO
 
 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
@@ -53,7 +53,7 @@ endif
 
 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
-.PHONY: ctags cscope
+.PHONY: ctags cscope doxygen wipe-doxygen
 
 help:
 	@echo "Make Targets:"
@@ -75,6 +75,8 @@ help:
 	@echo " pkg-rpm             - build RPM packages"
 	@echo " ctags               - (re)generate ctags database"
 	@echo " cscope              - (re)generate cscope database"
+	@echo " doxygen             - (re)generate documentation"
+	@echo " wipe-doxygen        - wipe all generated documentation"
 	@echo ""
 	@echo "Make Arguments:"
 	@echo " V=[0|1]             - set build verbosity level"
@@ -126,11 +128,11 @@ bootstrap: $(BR)/.bootstrap.ok
 install-dep:
 ifeq ($(OS_ID),ubuntu)
 ifeq ($(OS_VERSION_ID),14.04)
-	@sudo apt-get $(CONFIRM) install software-properties-common
-	@sudo add-apt-repository $(CONFIRM) ppa:openjdk-r/ppa
-	@sudo apt-get update
+	@sudo -E apt-get $(CONFIRM) install software-properties-common
+	@sudo -E add-apt-repository $(CONFIRM) ppa:openjdk-r/ppa
+	@sudo -E apt-get update
 endif
-	@sudo apt-get $(CONFIRM) install $(DEB_DEPENDS)
+	@sudo -E apt-get $(CONFIRM) install $(DEB_DEPENDS)
 else ifneq ("$(wildcard /etc/redhat-release)","")
 	@sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 	@sudo yum install $(CONFIRM) $(RPM_DEPENDS)
@@ -212,6 +214,10 @@ cscope: cscope.files
 	@cscope -b -q -v
 
 
+#
+# Build the documentation
+#
+
 DOXY_INPUT = \
 	README.md \
 	vppinfra \
@@ -222,7 +228,6 @@ DOXY_INPUT = \
 	vpp \
 	vpp-api
 
-.PHONY: doxygen
 doxygen:
 	@mkdir -p "$(BR)/docs"
 	ROOT="$(WS_ROOT)" \

build-root/scripts/find-dpdk-contents

@@ -5,6 +5,15 @@ rm -rf dpdk-includes
 mkdir dpdk-includes
 (cd $1/dpdk/include; tar cfh - . | (cd ../../../dpdk-includes; tar xf -))
 
+# If CDPATH is set, the "Change Directory" builtin (cd) will output the
+# destination directory when a relative path is passed as an argument.
+# In this case, this has the negative side effect of polluting the "paths"
+# variable with the destination directory, breaking the package generation.
+#
+#   Patient:  Doctor!  Doctor!  It hurts when I do this...
+#    Doctor:  Don't do that!
+#
+unset CDPATH
 paths=`cd dpdk-includes; find . -type f -print`
 rm -f $2
 

build-root/scripts/version

@@ -4,6 +4,10 @@ TAG=$(git describe | cut -d- -f1 | sed -e 's/^v//')
 ADD=$(git describe | cut -s -d- -f2)
 CMT=$(git describe --dirty --match 'v*'| cut -s -d- -f3,4)
 
+if [ -n "${BUILD_NUMBER}" ]; then
+       BLD="~b${BUILD_NUMBER}"
+fi
+
 if [ "$1" = "rpm-version" ]; then
   echo ${TAG}
   exit
@@ -12,12 +16,12 @@ fi
 if [ "$1" = "rpm-release" ]; then
   [ -z "${ADD}" ] && echo release && exit
   CMT=$(git describe --dirty --match 'v*'| cut -s -d- -f3,4 | sed 's/-/_/')
-  echo ${ADD}~${CMT}
+  echo ${ADD}~${CMT}${BLD}
   exit
 fi
 
 if [ -n "${ADD}" ]; then
-  echo ${TAG}-${ADD}~${CMT}
+  echo ${TAG}-${ADD}~${CMT}${BLD}
 else
   echo ${TAG}
 fi

doxygen/dir.dox.sample

@@ -1,6 +1,28 @@
+/*
+ * Copyright (c) <YEAR> <YOUR AFFILIATION HERE>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 /* Doxygen directory documentation */
+
 /**
 @dir
 @brief Someone please fix this description
 @todo This directory needs a description.
+
+This is where you would document the contents of a directory.
+
+This looks like a C file but it is not part of the build; it is purely
+for documentation.
 */

doxygen/doxygen.cfg

@@ -281,7 +281,7 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
 
-EXTENSION_MAPPING      = def=C
+EXTENSION_MAPPING      = def=C api=C
 
 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
 # according to the Markdown format, which allows for more readable
@@ -796,7 +796,7 @@ INPUT_ENCODING         = UTF-8
 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
 
-FILE_PATTERNS          = *.md *.c *.h *.def *.inc *.S *.dox
+FILE_PATTERNS          = *.md *.c *.h *.def *.inc *.S *.dox *.api
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -898,7 +898,9 @@ INPUT_FILTER           =
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # properly processed by doxygen.
 
-FILTER_PATTERNS        = *.c=$(ROOT)/doxygen/filter_c.py
+FILTER_PATTERNS        = \
+	*.c=$(ROOT)/doxygen/filter_c.py \
+	*.api=$(ROOT)/doxygen/filter_api.py
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 # INPUT_FILTER) will also be used to filter the input files that are used for

doxygen/filter_api.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Filter for vpe.api to make it Doxygenish.
+
+import sys, re
+
+if len(sys.argv) < 2:
+    sys.stderr.write("Usage: %s <filename>\n" % (sys.argv[0]))
+    sys.exit(1)
+
+patterns = [
+    # Search for "define" blocks and treat them as structs
+    ( re.compile(r"^.*(manual_.[^\s]+\s+)?define\s+(?P<name>[^\s]+)"), r"typedef struct vl_api_\g<name>_t"),
+
+    # For every "brief" statement at the start of a comment block, add an
+    # xref with whatever is on the same line. This gives us an index page
+    # with all the API methods in one place.
+    # XXX Commented out for now; works but duplicates the brief text in the
+    # struct documentation
+    #( re.compile(r"/\*\*\s*(?P<b>[\\@]brief)\s+(?P<c>.+)(\*/)$"), r'/** @xrefitem api "" "VPP API" \g<c> \g<b> \g<c>'),  # capture inline comment close
+    #( re.compile(r"/\*\*\s*(?P<b>[\\@]brief)\s+(?P<c>.+)$"), r'/** @xrefitem api "" "VPP API" \g<c> \g<b> \g<c>'),
+
+    # Since structs don't have params, replace @param with @tparam
+    ( re.compile("[\\@]param\\b"), "@tparam"),
+]
+
+with open(sys.argv[1]) as fd:
+    for line in fd:
+        str = line[:-1] # strip \n
+        for p in patterns:
+            str = p[0].sub(p[1], str)
+        sys.stdout.write(str+"\n")

doxygen/filter_c.py

@@ -1,4 +1,19 @@
 #!/usr/bin/env python
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Filter for .c files to make various preprocessor tricks Doxygenish
 
 import sys, re
 
@@ -31,7 +46,7 @@ patterns = [
 
 with open(sys.argv[1]) as fd:
     for line in fd:
-        str = line
+        str = line[:-1] # filter \n
         for p in patterns:
             str = p[0].sub(p[1], str)
-        sys.stdout.write(str)
+        sys.stdout.write(str+"\n")

svm/dir.dox

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /* Doxygen directory documentation */
 /**
 @dir

vlib/dir.dox

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /* Doxygen directory documentation */
 /**
 @dir

vlib/example/dir.dox

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /* Doxygen directory documentation */
 /**
 @dir

vlib/vlib/dir.dox

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /* Doxygen directory documentation */
 /**
 @dir

vnet/Makefile.am

@@ -58,6 +58,8 @@ libvnet_la_SOURCES +=				\
 
 nobase_include_HEADERS +=			\
   vnet/policer/police.h				\
+  vnet/policer/policer.h			\
+  vnet/policer/fix_types.h			\
   vnet/policer/xlate.h
 
 ########################################
@@ -396,30 +398,6 @@ nobase_include_HEADERS +=			\
  vnet/mpls-gre/error.def
 
 
-########################################
-# NSH Map: nsh
-########################################
- libvnet_la_SOURCES +=				\
-  vnet/nsh/nsh.c
-
- nobase_include_HEADERS +=			\
-  vnet/nsh/nsh_packet.h				\
-  vnet/nsh/nsh.h				\
-  vnet/nsh/nsh_error.def
-
-
-########################################
-# Tunnel protocol: nsh-gre
-########################################
-
-# libvnet_la_SOURCES +=				\
-#   vnet/nsh-gre/nsh_gre.c			\
-#   vnet/nsh-gre/encap.c				\
-#   vnet/nsh-gre/decap.c
-
-# nobase_include_HEADERS +=			\
-#   vnet/nsh-gre/nsh_gre.h				
-
 ########################################
 # Tunnel protocol: vxlan-gpe
 ########################################

vnet/etc/scripts/dhcp/left-ping-target.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# to obtain dhcp address from leftpeer
+dhclient -d -v eth1

vnet/etc/scripts/dhcp/ludd-cluster-2-sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-
-# to obtain dhcp address from ludd-cluster-1
-dhclient -d -v eth1

vnet/etc/scripts/dhcp/ludd-cluster-5-isc-dhcp-server

@@ -1,3 +0,0 @@
-# add eth6 to interfaces
-
-INTERFACES="eth6"

vnet/etc/scripts/leftpeer/leftpeer-ioam.conf

@@ -1,8 +1,8 @@
-comment { connects to ludd-cluster-2 eth1 addr db02::2/64 }
+comment { connects to linux ping source eth1 addr db02::2/64 }
 set int ip address GigabitEthernet2/2/0 db02::1/64
 set int state GigabitEthernet2/2/0 up
 
-comment { connects to ioam domain ludd-cluster-3 eth2 addr db03::3/64 }
+comment { connects to ioam domain rightpeer eth2 addr db03::3/64 }
 set int ip address GigabitEthernet2/3/0 db03::1/64
 set int state GigabitEthernet2/3/0 up
 

vnet/etc/scripts/leftpeer/leftpeer-l3vxlan.conf

@@ -1,4 +1,4 @@
-comment { tunnel to ludd-cluster-3 6.0.3.3 on vlan 101 }
+comment { tunnel to rightpeer 6.0.3.3 on vlan 101 }
 
 set int ip address GigabitEthernet2/3/0 6.0.3.1/24
 set int state GigabitEthernet2/3/0 up

vnet/etc/scripts/leftpeer/leftpeer-lisp.conf

@@ -6,7 +6,7 @@ comment { configure lc2 eth1 at e.g. 6.0.2.2/24 }
 set int ip address GigabitEthernet2/2/0 6.0.2.1/24
 set int state GigabitEthernet2/2/0 up
 
-comment { tunnel to ludd-cluster-3 on vlan 101 }
+comment { tunnel to rightpeer on vlan 101 }
 set int ip address GigabitEthernet2/3/0 6.0.3.1/24
 set int state GigabitEthernet2/3/0 up
 

vnet/etc/scripts/leftpeer/leftpeer-mpls.conf

@@ -7,7 +7,7 @@ set int ip table GigabitEthernet2/2/0 1
 set int ip address GigabitEthernet2/2/0 6.0.2.1/24
 set int state GigabitEthernet2/2/0 up
 
-comment { tunnel to ludd-cluster-3 on vlan 101 }
+comment { tunnel to rightpeer on vlan 101 }
 set int ip address GigabitEthernet2/3/0 6.0.3.1/24
 set int state GigabitEthernet2/3/0 up
 

vnet/etc/scripts/leftpeer/leftpeer-sr.conf

@@ -1,12 +1,12 @@
 comment { test sr segment chunk-offset on }
 test sr hmac validate on
 
-comment { trunk to ludd-cluster-3 }
+comment { trunk to rightpeer }
 set int ip address GigabitEthernet2/3/0 db03::2/64
 enable ip6 interface GigabitEthernet2/3/0
 set int state GigabitEthernet2/3/0 up
 
-comment { subscriber ludd-cluster-2 }
+comment { subscriber linux-ping-source }
 set int ip address GigabitEthernet2/2/0 db02::2/64
 enable ip6 interface GigabitEthernet2/2/0
 set int state GigabitEthernet2/2/0 up

vnet/etc/scripts/leftpeer/leftpeer-vxlan.conf

@@ -1,9 +1,9 @@
-comment { tunnel to ludd-cluster-3 6.0.3.3 on vlan 101 }
+comment { tunnel to rightpeer 6.0.3.3 on vlan 101 }
 
 set int ip address GigabitEthernet2/3/0 6.0.3.1/24
 set int state GigabitEthernet2/3/0 up
 
-comment { tunnel to ludd-cluster-5 6.0.5.5 on vlan 105 }
+comment { tunnel to thirdpeer 6.0.5.5 on vlan 105 }
 set int ip address GigabitEthernet2/7/0 6.0.5.1/24
 set int state GigabitEthernet2/7/0 up
 

vnet/etc/scripts/ludd-cluster-1/ludd-cluster-1-nsh.conf

@@ -1,18 +0,0 @@
-comment { vpe_phase2 configuration }
-
-comment { local client facing interface on vlan 100  }
-comment { configure lc2 eth1 at e.g. 6.0.2.2/24 }
-
-set int ip address GigabitEthernet2/2/0 6.0.2.1/24
-set int state GigabitEthernet2/2/0 up
-
-comment { tunnel to ludd-cluster-3 on vlan 101 }
-set int ip address GigabitEthernet2/3/0 6.0.3.1/24
-set int state GigabitEthernet2/3/0 up
-
-nsh gre tunnel src 6.0.3.1 dst 6.0.3.3 c1 1 c2 2 c3 3 c4 4 spi 1133 si 0 next-ip4
-set int ip address nsh_gre_tunnel0 6.0.4.1/24
-set int state nsh_gre_tunnel0 up
-
-nsh gre tunnel src 6.0.3.3 dst 6.0.3.1 c1 1 c2 2 c3 3 c4 4 spi 3311 si 0 next-ip4
-set int stat nsh_gre_tunnel1 up