Add priority policy support

New policy allowing strict priority traffic assignment

32 files changed, 292 insertions, 0 deletions

diff --git a/lib/Vyatta/Qos/Priority.pm b/lib/Vyatta/Qos/Priority.pm
new file mode 100644
index 0000000..f4f01da
--- /dev/null
+++ b/lib/Vyatta/Qos/Priority.pm
@@ -0,0 +1,131 @@
+# Strict Priority
+# This is a deficit round robin scheduler
+#
+# **** License ****
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+#
+# This program 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.
+#
+# This code was originally developed by Vyatta, Inc.
+# Portions created by Vyatta are Copyright (C) 2008 Vyatta, Inc.
+# All Rights Reserved.
+# **** End License ****
+
+package Vyatta::Qos::Priority;
+use strict;
+use warnings;
+
+require Vyatta::Config;
+require Vyatta::Qos::ShaperClass;
+
+# Create a new instance based on config information
+sub new {
+    my ( $that, $config, $name ) = @_;
+
+    my @classes = _getClasses( $config->setLevel() );
+    my $self    = {};
+    my $class   = ref($that) || $that;
+    bless $self, $class;
+    $self->{_classes} = \@classes;
+
+    return $self;
+}
+
+sub _getClasses {
+    my $level = shift;
+    my @classes;
+    my $config = new Vyatta::Config;
+
+    $config->setLevel($level);
+    my $default;
+    if ( $config->exists("default") ) {
+        $config->setLevel("$level default");
+        $default = new Vyatta::Qos::ShaperClass($config);
+        $config->setLevel($level);
+    }
+    else {
+        $default = new Vyatta::Qos::ShaperClass;
+    }
+    push @classes, $default;
+    $default->{id} = 1;
+
+    foreach my $id ( $config->listNodes("class") ) {
+        $config->setLevel("$level class $id");
+        push @classes, new Vyatta::Qos::ShaperClass( $config, $id );
+    }
+
+    return @classes;
+}
+
+sub commands {
+    my ( $self, $dev ) = @_;
+    my $classes = $self->{_classes};
+    my $parent  = 1;
+
+    printf "qdisc add dev %s s handle %x: prio limit %d\n",
+      $dev, 'root', $parent, $self->{_limit};
+
+    foreach my $class (@$classes) {
+        $class->gen_leaf( $dev, $parent );
+        foreach my $match ( $class->matchRules() ) {
+            $match->filter( $dev, $parent, 1 );
+            printf " parent %x:%x\n", $parent, $class->{id};
+        }
+    }
+}
+
+# Walk configuration tree and look for changed nodes
+# The configuration system should do this but doesn't do it right
+sub isChanged {
+    my ( $self, $name ) = @_;
+    my $config = new Vyatta::Config;
+
+    $config->setLevel("qos-policy priority-queue $name");
+
+    foreach my $attr (qw(queue-limit queue-type)) {
+        return "default $attr" if ( $config->isChanged("default $attr") );
+    }
+
+    my %classNodes = $config->listNodeStatus('class');
+    while ( my ( $class, $status ) = each %classNodes ) {
+        return "class $class" if ( $status ne 'static' );
+
+        foreach my $attr (qw(queue-limit queue-type)) {
+            return "class $class $attr"
+              if ( $config->isChanged("class $class $attr") );
+        }
+
+        my %matchNodes = $config->listNodeStatus("class $class match");
+        while ( my ( $match, $status ) = each %matchNodes ) {
+            my $level = "class $class match $match";
+            if ( $status ne 'static' ) {
+                return $level;
+            }
+
+            foreach my $parm (
+                (
+                    'vif',
+                    'interface',
+                    'ip protocol',
+                    'ip source address',
+                    'ip destination address',
+                    'ip source port',
+                    'ip destination port'
+                )
+              )
+            {
+                return "$level $parm"
+                  if ( $config->isChanged("$level $parm") );
+            }
+        }
+    }
+
+    return;    # false
+}
+
+1;
diff --git a/templates/qos-policy/priority-queue/node.def b/templates/qos-policy/priority-queue/node.def
new file mode 100644
index 0000000..21f04d9
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.def
@@ -0,0 +1,8 @@
+tag:
+type: txt
+help: Set priority-queue policy
+syntax:expression: pattern $VAR(@) "^[[:alnum:]][-_[:alnum:]]*$"
+                   ; "only alpha-numeric policy name allowed"
+create: /opt/vyatta/sbin/vyatta-qos.pl --create-policy "$VAR(.)" "$VAR(@)"
+delete: /opt/vyatta/sbin/vyatta-qos.pl --delete-policy "$VAR(@)"
+end: /opt/vyatta/sbin/vyatta-qos.pl --apply-policy "$VAR(@)"
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.def
new file mode 100644
index 0000000..d606de1
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.def
@@ -0,0 +1,6 @@
+tag:
+type: u32
+help: Set class handle
+syntax:expression: $VAR(@) > 1 && $VAR(@) < 4096; "Class identifier must be between 3 and 4095"
+comp_help: possible completions
+ <2-4095>	Class ID
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/description/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/description/node.def
new file mode 100644
index 0000000..d4241e7
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/description/node.def
@@ -0,0 +1,2 @@
+type: txt
+help: Set description for this traffic class
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.def
new file mode 100644
index 0000000..2a5d021
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.def
@@ -0,0 +1,4 @@
+tag:
+type: txt
+syntax:expression: pattern $VAR(@) "^[^-]" ; "Match queue name cannot start with \"-\""
+help: Set class matching rule name
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/description/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/description/node.def
new file mode 100644
index 0000000..a56c59c
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/description/node.def
@@ -0,0 +1,2 @@
+type: txt
+help: Set description for this match
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/interface/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/interface/node.def
new file mode 100644
index 0000000..bb0c1e3
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/interface/node.def
@@ -0,0 +1,7 @@
+type: txt
+help: Set interface name for this match
+syntax:expression: exec "[ -f /sys/class/net/$VAR(@)/ifindex ]" ; "Interface must already exist"
+allowed: local -a array
+	 array=( /sys/class/net/* )
+         echo -n ${array[@]##*/}
+
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/address/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/address/node.def
new file mode 100644
index 0000000..ccd2d14
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/address/node.def
@@ -0,0 +1,2 @@
+type: ipv4net
+help: Set IP destination address for this match
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/node.def
new file mode 100644
index 0000000..54eef5b
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/node.def
@@ -0,0 +1 @@
+help: Match on destination port or address
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/port/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/port/node.def
new file mode 100644
index 0000000..561899c
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/destination/port/node.def
@@ -0,0 +1,3 @@
+type: u32
+help: Set IP destination port for this match
+syntax:expression: ($VAR(@) > 0 && $VAR(@) < 65536) ; "port must be between 1 and 65535"
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/dscp/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/dscp/node.def
new file mode 100644
index 0000000..4f3f18e
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/dscp/node.def
@@ -0,0 +1,18 @@
+type: txt
+help: Match on Differentiated Services Codepoint (DSCP)
+syntax:expression: exec "/opt/vyatta/sbin/vyatta-qos-util.pl --dscp \"$VAR(@)\""
+allowed: awk '
+	/^#/ { next }
+	     { printf "%s ", $2 }' </etc/iproute2/rt_dsfield
+comp_help: <0-63> Differentiated Services Codepoint (DSCP) value
+    default  		match DSCP (000000)
+    reliability		match DSCP (000001)
+    throughput		match DSCP (000010)
+    lowdelay		match DSCP (000100)
+    priority		match DSCP (001000)
+    immediate		match DSCP (010000)
+    flash       	match DSCP (011000)
+    flash-override 	match DSCP (100000)
+    critical 		match DSCP (101000)
+    internet		match DSCP (110000)
+    network		match DSCP (111000)
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/protocol/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/protocol/node.def
new file mode 100644
index 0000000..1938d04
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/protocol/node.def
@@ -0,0 +1,17 @@
+type: txt
+help: Match IP protocol name or number
+syntax:expression: exec "/opt/vyatta/sbin/vyatta-qos-util.pl --protocol \"$VAR(@)\"" 
+allowed: awk '
+	/^#/ { next }
+	     { printf "%s ", $1 }' </etc/protocols
+comp_help: <0-255> IP protocol value or name
+Common names:
+	icmp	 Internet Control Message Protocol
+	igmp	 Internet Group Management Protocol
+	ggp	 Gateway-Gateway protocol
+	tcp	 Transmission Control Protocol
+	egp	 Exterior Gateway Protocol
+	udp	 User Datagram Protocol
+	gre	 General Routing Encapsulation
+	ospf	 Open Shortest Path First IGP
+	sctp	 Stream Control Transmission Protocol
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/address/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/address/node.def
new file mode 100644
index 0000000..0bc690a
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/address/node.def
@@ -0,0 +1,2 @@
+type: ipv4net
+help: Set IP source address for this match
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/node.def
new file mode 100644
index 0000000..4271b94
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/node.def
@@ -0,0 +1 @@
+help: Match on source port or address
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/port/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/port/node.def
new file mode 100644
index 0000000..ecd96ab
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ip/source/port/node.def
@@ -0,0 +1,3 @@
+type: u32
+help: Set IP source port for this match
+syntax:expression: ($VAR(@) > 0 && $VAR(@) < 65536) ; "port must be between 1 and 65535"
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/address/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/address/node.def
new file mode 100644
index 0000000..2f608f8
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/address/node.def
@@ -0,0 +1,2 @@
+type: ipv6net
+help: Set IP destination address for this match
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/node.def
new file mode 100644
index 0000000..54eef5b
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/node.def
@@ -0,0 +1 @@
+help: Match on destination port or address
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/port/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/port/node.def
new file mode 100644
index 0000000..561899c
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/destination/port/node.def
@@ -0,0 +1,3 @@
+type: u32
+help: Set IP destination port for this match
+syntax:expression: ($VAR(@) > 0 && $VAR(@) < 65536) ; "port must be between 1 and 65535"
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/dscp/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/dscp/node.def
new file mode 100644
index 0000000..4f3f18e
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/dscp/node.def
@@ -0,0 +1,18 @@
+type: txt
+help: Match on Differentiated Services Codepoint (DSCP)
+syntax:expression: exec "/opt/vyatta/sbin/vyatta-qos-util.pl --dscp \"$VAR(@)\""
+allowed: awk '
+	/^#/ { next }
+	     { printf "%s ", $2 }' </etc/iproute2/rt_dsfield
+comp_help: <0-63> Differentiated Services Codepoint (DSCP) value
+    default  		match DSCP (000000)
+    reliability		match DSCP (000001)
+    throughput		match DSCP (000010)
+    lowdelay		match DSCP (000100)
+    priority		match DSCP (001000)
+    immediate		match DSCP (010000)
+    flash       	match DSCP (011000)
+    flash-override 	match DSCP (100000)
+    critical 		match DSCP (101000)
+    internet		match DSCP (110000)
+    network		match DSCP (111000)
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/protocol/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/protocol/node.def
new file mode 100644
index 0000000..1938d04
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/protocol/node.def
@@ -0,0 +1,17 @@
+type: txt
+help: Match IP protocol name or number
+syntax:expression: exec "/opt/vyatta/sbin/vyatta-qos-util.pl --protocol \"$VAR(@)\"" 
+allowed: awk '
+	/^#/ { next }
+	     { printf "%s ", $1 }' </etc/protocols
+comp_help: <0-255> IP protocol value or name
+Common names:
+	icmp	 Internet Control Message Protocol
+	igmp	 Internet Group Management Protocol
+	ggp	 Gateway-Gateway protocol
+	tcp	 Transmission Control Protocol
+	egp	 Exterior Gateway Protocol
+	udp	 User Datagram Protocol
+	gre	 General Routing Encapsulation
+	ospf	 Open Shortest Path First IGP
+	sctp	 Stream Control Transmission Protocol
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/address/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/address/node.def
new file mode 100644
index 0000000..23c96c2
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/address/node.def
@@ -0,0 +1,2 @@
+type: ipv6net
+help: Set IP source address for this match
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/node.def
new file mode 100644
index 0000000..4271b94
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/node.def
@@ -0,0 +1 @@
+help: Match on source port or address
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/port/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/port/node.def
new file mode 100644
index 0000000..ecd96ab
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/ipv6/source/port/node.def
@@ -0,0 +1,3 @@
+type: u32
+help: Set IP source port for this match
+syntax:expression: ($VAR(@) > 0 && $VAR(@) < 65536) ; "port must be between 1 and 65535"
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/vif/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/vif/node.def
new file mode 100644
index 0000000..e22250d
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/match/node.tag/vif/node.def
@@ -0,0 +1,5 @@
+type: u32
+help: Set Virtual Local Area Network (VLAN) ID for this match
+syntax:expression: $VAR(@) >= 0 && $VAR(@) <= 4095; "VLAN ID must be between 0 and 4095"
+comp_help: possible completions:
+ <0-4095>           Set VLAN ID
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/priority/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/priority/node.def
new file mode 100644
index 0000000..4dfdff6
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/priority/node.def
@@ -0,0 +1,4 @@
+type: u32
+help: Set priority 
+syntax:expression: $VAR(@) >= 0 && $VAR(@) < 8 ; "priority must be between 0 than 7"
+help: Priority value
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/queue-limit/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/queue-limit/node.def
new file mode 100644
index 0000000..49c47b4
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/queue-limit/node.def
@@ -0,0 +1,2 @@
+type: u32
+help: Set maximum queue size (packets)
diff --git a/templates/qos-policy/priority-queue/node.tag/class/node.tag/queue-type/node.def b/templates/qos-policy/priority-queue/node.tag/class/node.tag/queue-type/node.def
new file mode 100644
index 0000000..bb3a24e
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/class/node.tag/queue-type/node.def
@@ -0,0 +1,9 @@
+type: txt
+default: "fair-queue"
+syntax:expression: $VAR(@) in "fair-queue", "drop-tail", "random-detect"; "Unknown queue-type"
+help: Set the queue type for this class
+comp_help:Possible completions
+  fair-queue\tStochastic Fair Queue (SFQ)
+  drop-tail\tFirst-In-First-Out (FIFO)
+  random-detect\tRandom Early Detection (RED)
+
diff --git a/templates/qos-policy/priority-queue/node.tag/default/node.def b/templates/qos-policy/priority-queue/node.tag/default/node.def
new file mode 100644
index 0000000..de9cd5c
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/default/node.def
@@ -0,0 +1 @@
+help: Set default policy
diff --git a/templates/qos-policy/priority-queue/node.tag/default/priority/node.def b/templates/qos-policy/priority-queue/node.tag/default/priority/node.def
new file mode 100644
index 0000000..4dfdff6
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/default/priority/node.def
@@ -0,0 +1,4 @@
+type: u32
+help: Set priority 
+syntax:expression: $VAR(@) >= 0 && $VAR(@) < 8 ; "priority must be between 0 than 7"
+help: Priority value
diff --git a/templates/qos-policy/priority-queue/node.tag/default/queue-limit/node.def b/templates/qos-policy/priority-queue/node.tag/default/queue-limit/node.def
new file mode 100644
index 0000000..49c47b4
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/default/queue-limit/node.def
@@ -0,0 +1,2 @@
+type: u32
+help: Set maximum queue size (packets)
diff --git a/templates/qos-policy/priority-queue/node.tag/default/queue-type/node.def b/templates/qos-policy/priority-queue/node.tag/default/queue-type/node.def
new file mode 100644
index 0000000..bb3a24e
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/default/queue-type/node.def
@@ -0,0 +1,9 @@
+type: txt
+default: "fair-queue"
+syntax:expression: $VAR(@) in "fair-queue", "drop-tail", "random-detect"; "Unknown queue-type"
+help: Set the queue type for this class
+comp_help:Possible completions
+  fair-queue\tStochastic Fair Queue (SFQ)
+  drop-tail\tFirst-In-First-Out (FIFO)
+  random-detect\tRandom Early Detection (RED)
+
diff --git a/templates/qos-policy/priority-queue/node.tag/description/node.def b/templates/qos-policy/priority-queue/node.tag/description/node.def
new file mode 100644
index 0000000..1e8e64f
--- /dev/null
+++ b/templates/qos-policy/priority-queue/node.tag/description/node.def
@@ -0,0 +1,2 @@
+type: txt
+help: Set description for this queuing policy