summaryrefslogtreecommitdiff
path: root/scripts/VyattaQosUtil.pm
blob: 9782961ea192cf93966223f1554d20abe4ecef52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
package VyattaQosUtil;
use POSIX;
require Exporter;
@EXPORT	= qw/getRate getSize getProtocol getDsfield getIfIndex interfaceRate/;
use strict;

sub get_num  {
    my ($str) = @_;
    
    # clear errno
    $! = 0;
    my ($num, $unparsed) = POSIX::strtod($str);
    if (($str eq '') || $!) {
	return;	# undefined (bad input)
    }

    if ($unparsed > 0) { return $num, substr($str, -$unparsed); }
    else	       { return $num; }
}

## get_rate("10mbit")
# convert rate specification to number
# from tc/tc_util.c
sub getRate {
    my $rate = shift;
    my ($num, $suffix) = get_num($rate);

    defined $num or die "Invald bandwith string: $rate\n";

    if (defined $suffix) {
      SWITCH: {
	  ($suffix eq 'bit')	&& do { last SWITCH; };
	  ($suffix eq 'kibit')	&& do { $num *= 1024.; last SWITCH };
	  ($suffix eq 'kbit')	&& do { $num *= 1000.,; last SWITCH; };
	  ($suffix eq 'mibit')	&& do { $num *= 1048576.,; last SWITCH; };
	  ($suffix eq 'mbit')	&& do { $num *= 1000000.,; last SWITCH; };
	  ($suffix eq 'gibit')	&& do { $num *= 1073741824.,; last SWITCH; };
	  ($suffix eq 'gbit')	&& do { $num *= 1000000000.,; last SWITCH; };
	  ($suffix eq 'tibit')	&& do { $num *= 1099511627776.,; last SWITCH; };
	  ($suffix eq 'tbit')	&& do { $num *= 1000000000000.,; last SWITCH; };
	  ($suffix eq 'bps')	&& do { $num *= 8.,; last SWITCH; };
	  ($suffix eq 'kibps')	&& do { $num *= 8192.,; last SWITCH; };
	  ($suffix eq 'kbps')	&& do { $num *= 8000.,; last SWITCH; };
	  ($suffix eq 'mibps')	&& do { $num *= 8388608.,; last SWITCH; };
	  ($suffix eq 'mbps')	&& do { $num *= 8000000.,; last SWITCH; };
	  ($suffix eq 'gibps')	&& do { $num *= 8589934592.,; last SWITCH; };
	  ($suffix eq 'gbps')	&& do { $num *= 8000000000.,; last SWITCH; };
	  ($suffix eq 'tibps')	&& do { $num *= 8796093022208.,; last SWITCH; };
	  ($suffix eq 'tbps')	&& do { $num *= 8000000000000.,; last SWITCH; };

	  die "Unknown bandwidth suffix \"$suffix\"\n";
	}
    } else {
	# No suffix implies Kbps just as IOS
	$num *= 1000;
    }
    
    ($num >= 0) or die "Negative bandwidth not allowed\n";
    return $num;
}

sub getSize {
    my $size = shift;
    my ($num, $suffix) = get_num($size);

    defined $num or die "Invald size string: $size\n";

    if (defined $suffix) {
      SWITCH: {
	  ($suffix eq 'b')		&& do { $num *= 1.,; last SWITCH; };
	  ($suffix eq 'k')		&& do { $num *= 1024.,; last SWITCH; };
	  ($suffix eq 'kb')		&& do { $num *= 1024.,; last SWITCH; };
	  ($suffix eq 'kbit')	&& do { $num *= 128.,; last SWITCH; };
	  ($suffix eq 'm')		&& do { $num *= 1048576.,; last SWITCH; };
	  ($suffix eq 'mb')		&& do { $num *= 1048576.,; last SWITCH; };
	  ($suffix eq 'mbit')	&& do { $num *= 131072.,; last SWITCH; };
	  ($suffix eq 'g')		&& do { $num *= 1073741824.,; last SWITCH; };
	  ($suffix eq 'gb')		&& do { $num *= 1073741824.,; last SWITCH; };
	  ($suffix eq 'gbit')	&& do { $num *= 134217728.,; last SWITCH; };
	  
	  die "Unknown suffix suffix \"$suffix\"\n";
	}
    }
    
    $num >= 0 or  die "Negative size not allowed\n";
    return $num;
}

sub getProtocol {
    my ($str) = @_;

    defined $str or return;
    if ($str =~ /^([0-9]+)|(0x[0-9a-fA-F]+)$/) {
	if ($str < 0 || $str > 255) {
	    die "$str is not a valid protocol number\n";
	}
	return $str;
    }

    my ($name, $aliases, $proto) =  getprotobyname($str);
    (defined $proto)  or die "\"$str\" unknown protocol\n";
    return $proto;
}

# Parse /etc/iproute/rt_dsfield 
# return a hex string "0x10" or undefined
sub getDsfield {
    my ($str) = @_;
    my $match = undef;
    my $dsFileName = '/etc/iproute2/rt_dsfield';
    
    defined $str or return;

    # match number (or hex)
    if ($str =~ /^([0-9]+)|(0x[0-9a-fA-F]+)$/) {
	if ($str < 0 || $str > 63) {
	    die "$str is not a valid dscp value\n";
	}
	# convert DSCP value to header value used by iproute
	return $str << 2;
    }

    open my $ds, '<', $dsFileName || die "Can't open $dsFileName, $!\n";
    while (<$ds>) {
	next if /^#/;
	chomp;
	my ($value, $name) = split;
	if ($str eq $name) {
	    $match = $value;
	    last;
	}
    }
    close($ds) or die "read $dsFileName error\n";
    
    (defined $match) or die "\"$str\" unknown dsfield value\n";
    return $match;
}

sub getIfIndex {
    my ($str) = @_;

    defined $str or return;
    open my $sysfs, "<", "/sys/class/net/$str/ifindex" || die "Unknown interface $str\n";
    my $ifindex = <$sysfs>;
    close($sysfs) or die "read sysfs error\n";
    chomp $ifindex;
    return $ifindex;
}


## interfaceRate("eth0")
# return result in bits per second
sub interfaceRate {
    my ($interface) = @_;
    my $config = new VyattaConfig;

    $config->setLevel("interfaces ethernet");
    if ($config->exists("$interface")) {
	my $speed  = $config->returnValue("$interface speed");
	if (defined($speed) && $speed ne "auto") {
	    return $speed * 1000000;
	}
    } 

    return ethtoolRate($interface);
}

## ethtoolRate("eth0")
# Fetch actual rate using ethtool and format to valid tc rate
sub ethtoolRate {
    my ($dev) = @_;
    my $rate = undef;

    open my $ethtool, "-|" 
	or exec 'sudo', 'ethtool', $dev
 	or die "ethtool failed: $!\n";

    # ethtool produces:
    #
    # Settings for eth1:
    # Supported ports: [ TP ]
    # ...
    # Speed: 1000Mb/s
    while (<$ethtool>) {
	my @line = split;
	if ($line[0] =~ /^Speed:/) {
	    $rate = $line[1];
	    $rate =~ s#Mb/s#000000#;
	    last;
	}
    }
    close $ethtool;
    return $rate;
}