Merge pull request #1663 from c-po/t4284-qos

QoS: T4284: re-implementation using XML and Python

13 files changed, 182 insertions, 105 deletions

diff --git a/interface-definitions/include/interface/mirror.xml.i b/interface-definitions/include/interface/mirror.xml.i
index 2959551f0..74a172b50 100644
--- a/interface-definitions/include/interface/mirror.xml.i
+++ b/interface-definitions/include/interface/mirror.xml.i
@@ -1,23 +1,31 @@
 <!-- include start from interface/mirror.xml.i -->
 <node name="mirror">
   <properties>
-    <help>Incoming/outgoing packet mirroring destination</help>
+    <help>Mirror ingress/egress packets</help>
   </properties>
   <children>
     <leafNode name="ingress">
       <properties>
-        <help>Mirror the ingress traffic of the interface to the destination interface</help>
+        <help>Mirror ingress traffic to destination interface</help>
         <completionHelp>
-            <script>${vyos_completion_dir}/list_interfaces.py</script>
+          <script>${vyos_completion_dir}/list_interfaces.py</script>
         </completionHelp>
+        <valueHelp>
+          <format>txt</format>
+          <description>Destination interface name</description>
+        </valueHelp>
       </properties>
     </leafNode>
     <leafNode name="egress">
       <properties>
-        <help>Mirror the egress traffic of the interface to the destination interface</help>
+        <help>Mirror egress traffic to destination interface</help>
         <completionHelp>
-            <script>${vyos_completion_dir}/list_interfaces.py</script>
+          <script>${vyos_completion_dir}/list_interfaces.py</script>
         </completionHelp>
+        <valueHelp>
+          <format>txt</format>
+          <description>Destination interface name</description>
+        </valueHelp>
       </properties>
     </leafNode>
   </children>
diff --git a/interface-definitions/include/interface/redirect.xml.i b/interface-definitions/include/interface/redirect.xml.i
index 8df8957ac..b01e486ce 100644
--- a/interface-definitions/include/interface/redirect.xml.i
+++ b/interface-definitions/include/interface/redirect.xml.i
@@ -1,13 +1,13 @@
 <!-- include start from interface/redirect.xml.i -->
 <leafNode name="redirect">
   <properties>
-    <help>Incoming packet redirection destination</help>
+    <help>Redirect incoming packet to destination</help>
     <completionHelp>
       <script>${vyos_completion_dir}/list_interfaces.py</script>
     </completionHelp>
     <valueHelp>
       <format>txt</format>
-      <description>Interface name</description>
+      <description>Destination interface name</description>
     </valueHelp>
     <constraint>
       #include <include/constraint/interface-name.xml.in>
diff --git a/interface-definitions/include/qos/bandwidth-auto.xml.i b/interface-definitions/include/qos/bandwidth-auto.xml.i
new file mode 100644
index 000000000..3780b7444
--- /dev/null
+++ b/interface-definitions/include/qos/bandwidth-auto.xml.i
@@ -0,0 +1,43 @@
+<!-- include start from qos/bandwidth-auto.xml.i -->
+<leafNode name="bandwidth">
+  <properties>
+    <help>Available bandwidth for this policy</help>
+    <completionHelp>
+      <list>auto</list>
+    </completionHelp>
+    <valueHelp>
+      <format>auto</format>
+      <description>Rate matches interface speed</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;</format>
+      <description>Bits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;bit</format>
+      <description>Bits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;kbit</format>
+      <description>Kilobits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;mbit</format>
+      <description>Megabits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;gbit</format>
+      <description>Gigabits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;tbit</format>
+      <description>Terabits per second</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--positive"/>
+      <regex>\d+(bit|kbit|mbit|gbit|tbit)</regex>
+    </constraint>
+  </properties>
+  <defaultValue>auto</defaultValue>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/qos/bandwidth.xml.i b/interface-definitions/include/qos/bandwidth.xml.i
index 82af22f42..62ea93b67 100644
--- a/interface-definitions/include/qos/bandwidth.xml.i
+++ b/interface-definitions/include/qos/bandwidth.xml.i
@@ -1,15 +1,35 @@
 <!-- include start from qos/bandwidth.xml.i -->
 <leafNode name="bandwidth">
   <properties>
-    <help>Traffic-limit used for this class</help>
+    <help>Available bandwidth for this policy</help>
     <valueHelp>
       <format>&lt;number&gt;</format>
-      <description>Rate in kbit (kilobit per second)</description>
+      <description>Bits per second</description>
     </valueHelp>
     <valueHelp>
-      <format>&lt;number&gt;&lt;suffix&gt;</format>
-      <description>Rate with scaling suffix (mbit, mbps, ...)</description>
+      <format>&lt;number&gt;bit</format>
+      <description>Bits per second</description>
     </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;kbit</format>
+      <description>Kilobits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;mbit</format>
+      <description>Megabits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;gbit</format>
+      <description>Gigabits per second</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;number&gt;tbit</format>
+      <description>Terabits per second</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--positive"/>
+      <regex>\d+(bit|kbit|mbit|gbit|tbit)</regex>
+    </constraint>
   </properties>
 </leafNode>
 <!-- include end -->
diff --git a/interface-definitions/include/qos/class-match-ipv4-address.xml.i b/interface-definitions/include/qos/class-match-ipv4-address.xml.i
new file mode 100644
index 000000000..8e84c988a
--- /dev/null
+++ b/interface-definitions/include/qos/class-match-ipv4-address.xml.i
@@ -0,0 +1,19 @@
+<!-- include start from qos/class-match-ipv4-address.xml.i -->
+<leafNode name="address">
+  <properties>
+    <help>IPv4 destination address for this match</help>
+    <valueHelp>
+      <format>ipv4</format>
+      <description>IPv4 address</description>
+    </valueHelp>
+    <valueHelp>
+      <format>ipv4net</format>
+      <description>IPv4 prefix</description>
+    </valueHelp>
+    <constraint>
+      <validator name="ipv4-address"/>
+      <validator name="ipv4-prefix"/>
+    </constraint>
+  </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/qos/class-match-ipv6-address.xml.i b/interface-definitions/include/qos/class-match-ipv6-address.xml.i
new file mode 100644
index 000000000..fd7388127
--- /dev/null
+++ b/interface-definitions/include/qos/class-match-ipv6-address.xml.i
@@ -0,0 +1,14 @@
+<!-- include start from qos/class-match-ipv6-address.xml.i -->
+<leafNode name="address">
+  <properties>
+    <help>IPv6 destination address for this match</help>
+    <valueHelp>
+      <format>ipv6net</format>
+      <description>IPv6 address and prefix length</description>
+    </valueHelp>
+    <constraint>
+      <validator name="ipv6"/>
+    </constraint>
+  </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/qos/match.xml.i b/interface-definitions/include/qos/class-match.xml.i
index 7d89e4460..d9c35731d 100644
--- a/interface-definitions/include/qos/match.xml.i
+++ b/interface-definitions/include/qos/class-match.xml.i
@@ -1,4 +1,4 @@
-<!-- include start from qos/match.xml.i -->
+<!-- include start from qos/class-match.xml.i -->
 <tagNode name="match">
   <properties>
     <help>Class matching rule name</help>
@@ -99,22 +99,11 @@
             <help>Match on destination port or address</help>
           </properties>
           <children>
-            <leafNode name="address">
-              <properties>
-                <help>IPv4 destination address for this match</help>
-                <valueHelp>
-                  <format>ipv4net</format>
-                  <description>IPv4 address and prefix length</description>
-                </valueHelp>
-                <constraint>
-                  <validator name="ipv4"/>
-                </constraint>
-              </properties>
-            </leafNode>
+            #include <include/qos/class-match-ipv4-address.xml.i>
             #include <include/port-number.xml.i>
           </children>
         </node>
-        #include <include/qos/dscp.xml.i>
+        #include <include/qos/match-dscp.xml.i>
         #include <include/qos/max-length.xml.i>
         #include <include/ip-protocol.xml.i>
         <node name="source">
@@ -122,18 +111,7 @@
             <help>Match on source port or address</help>
           </properties>
           <children>
-            <leafNode name="address">
-              <properties>
-                <help>IPv4 source address for this match</help>
-                <valueHelp>
-                  <format>ipv4net</format>
-                  <description>IPv4 address and prefix length</description>
-                </valueHelp>
-                <constraint>
-                  <validator name="ipv4"/>
-                </constraint>
-              </properties>
-            </leafNode>
+            #include <include/qos/class-match-ipv4-address.xml.i>
             #include <include/port-number.xml.i>
           </children>
         </node>
@@ -150,22 +128,11 @@
             <help>Match on destination port or address</help>
           </properties>
           <children>
-            <leafNode name="address">
-              <properties>
-                <help>IPv6 destination address for this match</help>
-                <valueHelp>
-                  <format>ipv6net</format>
-                  <description>IPv6 address and prefix length</description>
-                </valueHelp>
-                <constraint>
-                  <validator name="ipv6"/>
-                </constraint>
-              </properties>
-            </leafNode>
+            #include <include/qos/class-match-ipv6-address.xml.i>
             #include <include/port-number.xml.i>
           </children>
         </node>
-        #include <include/qos/dscp.xml.i>
+        #include <include/qos/match-dscp.xml.i>
         #include <include/qos/max-length.xml.i>
         #include <include/ip-protocol.xml.i>
         <node name="source">
@@ -173,18 +140,7 @@
             <help>Match on source port or address</help>
           </properties>
           <children>
-            <leafNode name="address">
-              <properties>
-                <help>IPv6 source address for this match</help>
-                <valueHelp>
-                  <format>ipv6net</format>
-                  <description>IPv6 address and prefix length</description>
-                </valueHelp>
-                <constraint>
-                  <validator name="ipv6"/>
-                </constraint>
-              </properties>
-            </leafNode>
+            #include <include/qos/class-match-ipv6-address.xml.i>
             #include <include/port-number.xml.i>
           </children>
         </node>
diff --git a/interface-definitions/include/qos/limiter-actions.xml.i b/interface-definitions/include/qos/class-police-exceed.xml.i
index a993423aa..ee2ce16a8 100644
--- a/interface-definitions/include/qos/limiter-actions.xml.i
+++ b/interface-definitions/include/qos/class-police-exceed.xml.i
@@ -1,13 +1,13 @@
-<!-- include start from qos/limiter-actions.xml.i -->
-<leafNode name="exceed-action">
+<!-- include start from qos/police.xml.i -->
+<leafNode name="exceed">
   <properties>
-    <help>Default action for packets exceeding the limiter (default: drop)</help>
+    <help>Default action for packets exceeding the limiter</help>
     <completionHelp>
       <list>continue drop ok reclassify pipe</list>
     </completionHelp>
     <valueHelp>
       <format>continue</format>
-      <description>Don't do anything, just continue with the next action in line</description>
+      <description>Do not do anything, just continue with the next action in line</description>
     </valueHelp>
     <valueHelp>
       <format>drop</format>
@@ -31,15 +31,15 @@
   </properties>
   <defaultValue>drop</defaultValue>
 </leafNode>
-<leafNode name="notexceed-action">
+<leafNode name="not-exceed">
   <properties>
-    <help>Default action for packets not exceeding the limiter (default: ok)</help>
+    <help>Default action for packets not exceeding the limiter</help>
     <completionHelp>
       <list>continue drop ok reclassify pipe</list>
     </completionHelp>
     <valueHelp>
       <format>continue</format>
-      <description>Don't do anything, just continue with the next action in line</description>
+      <description>Do not do anything, just continue with the next action in line</description>
     </valueHelp>
     <valueHelp>
       <format>drop</format>
diff --git a/interface-definitions/include/qos/class-priority.xml.i b/interface-definitions/include/qos/class-priority.xml.i
new file mode 100644
index 000000000..3fd848c93
--- /dev/null
+++ b/interface-definitions/include/qos/class-priority.xml.i
@@ -0,0 +1,15 @@
+<!-- include start from qos/class-priority.xml.i -->
+<leafNode name="priority">
+  <properties>
+    <help>Priority for rule evaluation</help>
+    <valueHelp>
+      <format>u32:0-20</format>
+      <description>Priority for match rule evaluation</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--range 0-20"/>
+    </constraint>
+    <constraintErrorMessage>Priority must be between 0 and 20</constraintErrorMessage>
+  </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/qos/dscp.xml.i b/interface-definitions/include/qos/match-dscp.xml.i
index bb90850ac..1323fc033 100644
--- a/interface-definitions/include/qos/dscp.xml.i
+++ b/interface-definitions/include/qos/match-dscp.xml.i
@@ -1,9 +1,9 @@
-<!-- include start from qos/dscp.xml.i -->
+<!-- include start from qos/match-dscp.xml.i -->
 <leafNode name="dscp">
   <properties>
     <help>Match on Differentiated Services Codepoint (DSCP)</help>
     <completionHelp>
-      <list>default reliability throughput lowdelay priority immediate flash flash-override critical internet network AF11 AF12 AF13 AF21 AF22 AF23 AF31 AF32 AF33 AF41 AF42 AF43 CS1 CS2 CS3 CS4 CS5 CS6 CS7 EF</list>
+      <list>default reliability throughput lowdelay priority immediate flash flash-override critical internet network af11 af12 af13 af21 af22 af23 af31 af32 af33 af41 af42 af43 cs1 cs2 cs3 cs4 cs5 cs6 cs7 ef</list>
     </completionHelp>
     <valueHelp>
       <format>u32:0-63</format>
@@ -54,90 +54,89 @@
       <description>match DSCP (111000)</description>
     </valueHelp>
     <valueHelp>
-      <format>AF11</format>
+      <format>af11</format>
       <description>High-throughput data</description>
     </valueHelp>
     <valueHelp>
-      <format>AF12</format>
+      <format>af12</format>
       <description>High-throughput data</description>
     </valueHelp>
     <valueHelp>
-      <format>AF13</format>
+      <format>af13</format>
       <description>High-throughput data</description>
     </valueHelp>
     <valueHelp>
-      <format>AF21</format>
+      <format>af21</format>
       <description>Low-latency data</description>
     </valueHelp>
     <valueHelp>
-      <format>AF22</format>
+      <format>af22</format>
       <description>Low-latency data</description>
     </valueHelp>
     <valueHelp>
-      <format>AF23</format>
+      <format>af23</format>
       <description>Low-latency data</description>
     </valueHelp>
     <valueHelp>
-      <format>AF31</format>
+      <format>af31</format>
       <description>Multimedia streaming</description>
     </valueHelp>
     <valueHelp>
-      <format>AF32</format>
+      <format>af32</format>
       <description>Multimedia streaming</description>
     </valueHelp>
     <valueHelp>
-      <format>AF33</format>
+      <format>af33</format>
       <description>Multimedia streaming</description>
     </valueHelp>
     <valueHelp>
-      <format>AF41</format>
+      <format>af41</format>
       <description>Multimedia conferencing</description>
     </valueHelp>
     <valueHelp>
-      <format>AF42</format>
+      <format>af42</format>
       <description>Multimedia conferencing</description>
     </valueHelp>
     <valueHelp>
-      <format>AF43</format>
+      <format>af43</format>
       <description>Multimedia conferencing</description>
     </valueHelp>
     <valueHelp>
-      <format>CS1</format>
+      <format>cs1</format>
       <description>Low-priority data</description>
     </valueHelp>
     <valueHelp>
-      <format>CS2</format>
+      <format>cs2</format>
       <description>OAM</description>
     </valueHelp>
     <valueHelp>
-      <format>CS3</format>
+      <format>cs3</format>
       <description>Broadcast video</description>
     </valueHelp>
     <valueHelp>
-      <format>CS4</format>
+      <format>cs4</format>
       <description>Real-time interactive</description>
     </valueHelp>
     <valueHelp>
-      <format>CS5</format>
+      <format>cs5</format>
       <description>Signaling</description>
     </valueHelp>
     <valueHelp>
-      <format>CS6</format>
+      <format>cs6</format>
       <description>Network control</description>
     </valueHelp>
     <valueHelp>
-      <format>CS7</format>
+      <format>cs7</format>
       <description></description>
     </valueHelp>
     <valueHelp>
-      <format>EF</format>
+      <format>ef</format>
       <description>Expedited Forwarding</description>
     </valueHelp>
     <constraint>
       <validator name="numeric" argument="--range 0-63"/>
-      <regex>(default|reliability|throughput|lowdelay|priority|immediate|flash|flash-override|critical|internet|network|AF11|AF12|AF13|AF21|AF22|AF23|AF31|AF32|AF33|AF41|AF42|AF43|CS1|CS2|CS3|CS4|CS5|CS6|CS7|EF)</regex>
+      <regex>(default|reliability|throughput|lowdelay|priority|immediate|flash|flash-override|critical|internet|network|af11|af12|af13|af21|af22|af23|af31|af32|af33|af41|af42|af43|cs1|cs2|cs3|cs4|cs5|cs6|cs7|ef)</regex>
     </constraint>
-    <constraintErrorMessage>Priority must be between 0 and 63</constraintErrorMessage>
   </properties>
 </leafNode>
 <!-- include end -->
diff --git a/interface-definitions/include/qos/max-length.xml.i b/interface-definitions/include/qos/max-length.xml.i
index 4cc20f8c4..64cdd02ec 100644
--- a/interface-definitions/include/qos/max-length.xml.i
+++ b/interface-definitions/include/qos/max-length.xml.i
@@ -1,15 +1,15 @@
 <!-- include start from qos/max-length.xml.i -->
 <leafNode name="max-length">
   <properties>
-    <help>Maximum packet length (ipv4)</help>
+    <help>Maximum packet length</help>
     <valueHelp>
-      <format>u32:0-65535</format>
+      <format>u32:1-65535</format>
       <description>Maximum packet/payload length</description>
     </valueHelp>
     <constraint>
-      <validator name="numeric" argument="--range 0-65535"/>
+      <validator name="numeric" argument="--range 1-65535"/>
     </constraint>
-    <constraintErrorMessage>Maximum IPv4 total packet length is 65535</constraintErrorMessage>
+    <constraintErrorMessage>Maximum packet length is 65535</constraintErrorMessage>
   </properties>
 </leafNode>
 <!-- include end -->
diff --git a/interface-definitions/include/qos/queue-type.xml.i b/interface-definitions/include/qos/queue-type.xml.i
index 634f61024..c7d4cde82 100644
--- a/interface-definitions/include/qos/queue-type.xml.i
+++ b/interface-definitions/include/qos/queue-type.xml.i
@@ -3,28 +3,31 @@
   <properties>
     <help>Queue type for default traffic</help>
     <completionHelp>
-      <list>fq-codel fair-queue drop-tail random-detect</list>
+      <list>drop-tail fair-queue fq-codel priority random-detect</list>
     </completionHelp>
     <valueHelp>
-      <format>fq-codel</format>
-      <description>Fair Queue Codel</description>
+      <format>drop-tail</format>
+      <description>First-In-First-Out (FIFO)</description>
     </valueHelp>
     <valueHelp>
       <format>fair-queue</format>
       <description>Stochastic Fair Queue (SFQ)</description>
     </valueHelp>
     <valueHelp>
-      <format>drop-tail</format>
-      <description>First-In-First-Out (FIFO)</description>
+      <format>fq-codel</format>
+      <description>Fair Queue Codel</description>
+    </valueHelp>
+    <valueHelp>
+      <format>priority</format>
+      <description>Priority queuing</description>
     </valueHelp>
     <valueHelp>
       <format>random-detect</format>
       <description>Random Early Detection (RED)</description>
     </valueHelp>
     <constraint>
-      <regex>(fq-codel|fair-queue|drop-tail|random-detect)</regex>
+      <regex>(drop-tail|fair-queue|fq-codel|priority|random-detect)</regex>
     </constraint>
   </properties>
-  <defaultValue>drop-tail</defaultValue>
 </leafNode>
 <!-- include end -->
diff --git a/interface-definitions/include/version/qos-version.xml.i b/interface-definitions/include/version/qos-version.xml.i
index e4d139349..c67e61e91 100644
--- a/interface-definitions/include/version/qos-version.xml.i
+++ b/interface-definitions/include/version/qos-version.xml.i
@@ -1,3 +1,3 @@
 <!-- include start from include/version/qos-version.xml.i -->
-<syntaxVersion component='qos' version='1'></syntaxVersion>
+<syntaxVersion component='qos' version='2'></syntaxVersion>
 <!-- include end -->