Merge "next" branch into "master".
[openvswitch] / tests / flowgen.pl
1 #! /usr/bin/perl
2
3 # Copyright (c) 2009, 2010 Nicira Networks.
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at:
8 #
9 #     http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 use strict;
18 use warnings;
19
20 open(FLOWS, ">&=3");# or die "failed to open fd 3 for writing: $!\n";
21 open(PACKETS, ">&=4");# or die "failed to open fd 4 for writing: $!\n";
22
23 # Print pcap file header.
24 print PACKETS pack('NnnNNNN',
25                    0xa1b2c3d4,  # magic number
26                    2,           # major version
27                    4,           # minor version
28                    0,           # time zone offset
29                    0,           # time stamp accuracy
30                    1518,        # snaplen
31                    1);          # Ethernet
32
33 output(DL_HEADER => '802.2');
34
35 for my $dl_header qw(802.2+SNAP Ethernet) {
36     my %a = (DL_HEADER => $dl_header);
37     for my $dl_vlan qw(none zero nonzero) {
38         my %b = (%a, DL_VLAN => $dl_vlan);
39
40         # Non-IP case.
41         output(%b, DL_TYPE => 'non-ip');
42
43         for my $ip_options qw(no yes) {
44             my %c = (%b, DL_TYPE => 'ip', IP_OPTIONS => $ip_options);
45             for my $ip_fragment qw(no first middle last) {
46                 my %d = (%c, IP_FRAGMENT => $ip_fragment);
47                 for my $tp_proto qw(TCP TCP+options UDP ICMP other) {
48                     output(%d, TP_PROTO => $tp_proto);
49                 }
50             }
51         }
52     }
53 }
54
55 sub output {
56     my (%attrs) = @_;
57
58     # Compose flow.
59     my (%flow);
60     $flow{DL_SRC} = "00:02:e3:0f:80:a4";
61     $flow{DL_DST} = "00:1a:92:40:ac:05";
62     $flow{NW_PROTO} = 0;
63     $flow{NW_TOS} = 0;
64     $flow{NW_SRC} = '0.0.0.0';
65     $flow{NW_DST} = '0.0.0.0';
66     $flow{TP_SRC} = 0;
67     $flow{TP_DST} = 0;
68     if (defined($attrs{DL_VLAN})) {
69         my (%vlan_map) = ('none' => 0xffff,
70                           'zero' => 0,
71                           'nonzero' => 0x0123);
72         $flow{DL_VLAN} = $vlan_map{$attrs{DL_VLAN}};
73     } else {
74         $flow{DL_VLAN} = 0xffff; # OFP_VLAN_NONE
75     }
76     if ($attrs{DL_HEADER} eq '802.2') {
77         $flow{DL_TYPE} = 0x5ff; # OFP_DL_TYPE_NOT_ETH_TYPE
78     } elsif ($attrs{DL_TYPE} eq 'ip') {
79         $flow{DL_TYPE} = 0x0800; # ETH_TYPE_IP
80         $flow{NW_SRC} = '10.0.2.15';
81         $flow{NW_DST} = '192.168.1.20';
82         $flow{NW_TOS} = 44;
83         if ($attrs{TP_PROTO} eq 'other') {
84             $flow{NW_PROTO} = 42;
85         } elsif ($attrs{TP_PROTO} eq 'TCP' ||
86                  $attrs{TP_PROTO} eq 'TCP+options') {
87             $flow{NW_PROTO} = 6; # IP_TYPE_TCP
88             $flow{TP_SRC} = 6667;
89             $flow{TP_DST} = 9998;
90         } elsif ($attrs{TP_PROTO} eq 'UDP') {
91             $flow{NW_PROTO} = 17; # IP_TYPE_UDP
92             $flow{TP_SRC} = 1112;
93             $flow{TP_DST} = 2223;
94         } elsif ($attrs{TP_PROTO} eq 'ICMP') {
95             $flow{NW_PROTO} = 1; # IP_TYPE_ICMP
96             $flow{TP_SRC} = 8;   # echo request
97             $flow{TP_DST} = 0;   # code
98         } else {
99             die;
100         }
101         if ($attrs{IP_FRAGMENT} ne 'no') {
102             $flow{TP_SRC} = $flow{TP_DST} = 0;
103         }
104     } elsif ($attrs{DL_TYPE} eq 'non-ip') {
105         $flow{DL_TYPE} = 0x5678;
106     } else {
107         die;
108     }
109
110     # Compose packet.
111     my $packet = '';
112     $packet .= pack_ethaddr($flow{DL_DST});
113     $packet .= pack_ethaddr($flow{DL_SRC});
114     $packet .= pack('n', 0) if $attrs{DL_HEADER} =~ /^802.2/;
115     if ($attrs{DL_HEADER} eq '802.2') {
116         $packet .= pack('CCC', 0x42, 0x42, 0x03); # LLC for 802.1D STP.
117     } else {
118         if ($attrs{DL_HEADER} eq '802.2+SNAP') {
119             $packet .= pack('CCC', 0xaa, 0xaa, 0x03); # LLC for SNAP.
120             $packet .= pack('CCC', 0, 0, 0);          # SNAP OUI.
121         }
122         if ($attrs{DL_VLAN} ne 'none') {
123             $packet .= pack('nn', 0x8100, $flow{DL_VLAN});
124         }
125         $packet .= pack('n', $flow{DL_TYPE});
126         if ($attrs{DL_TYPE} eq 'ip') {
127             my $ip = pack('CCnnnCCnNN',
128                           (4 << 4) | 5,    # version, hdrlen
129                           $flow{NW_TOS},   # type of service
130                           0,               # total length (filled in later)
131                           65432,           # id
132                           0,               # frag offset
133                           64,              # ttl
134                           $flow{NW_PROTO}, # protocol
135                           0,               # checksum
136                           0x0a00020f,      # source
137                           0xc0a80114);     # dest
138             if ($attrs{IP_OPTIONS} eq 'yes') {
139                 substr($ip, 0, 1) = pack('C', (4 << 4) | 8);
140                 $ip .= pack('CCnnnCCCx',
141                             130,       # type
142                             11,        # length
143                             0x6bc5,    # top secret
144                             0xabcd,
145                             0x1234,
146                             1,
147                             2,
148                             3);
149             }
150             if ($attrs{IP_FRAGMENT} ne 'no') {
151                 my (%frag_map) = ('first' => 0x2000, # more frags, ofs 0
152                                   'middle' => 0x2111, # more frags, ofs 0x888
153                                   'last' => 0x0222); # last frag, ofs 0x1110
154                 substr($ip, 6, 2)
155                   = pack('n', $frag_map{$attrs{IP_FRAGMENT}});
156             }
157
158             if ($attrs{TP_PROTO} =~ '^TCP') {
159                 my $tcp = pack('nnNNnnnn',
160                                $flow{TP_SRC},           # source port
161                                $flow{TP_DST},           # dest port
162                                87123455,                # seqno
163                                712378912,               # ackno
164                                (5 << 12) | 0x02 | 0x10, # hdrlen, SYN, ACK
165                                5823,                    # window size
166                                18923,                   # checksum
167                                12893);                  # urgent pointer
168                 if ($attrs{TP_PROTO} eq 'TCP+options') {
169                     substr($tcp, 12, 2) = pack('n', (6 << 12) | 0x02 | 0x10);
170                     $tcp .= pack('CCn', 2, 4, 1975); # MSS option
171                 }
172                 $tcp .= 'payload';
173                 $ip .= $tcp;
174             } elsif ($attrs{TP_PROTO} eq 'UDP') {
175                 my $len = 15;
176                 my $udp = pack('nnnn', $flow{TP_SRC}, $flow{TP_DST}, $len, 0);
177                 $udp .= chr($len) while length($udp) < $len;
178                 $ip .= $udp;
179             } elsif ($attrs{TP_PROTO} eq 'ICMP') {
180                 $ip .= pack('CCnnn',
181                             8,    # echo request
182                             0,    # code
183                             0,    # checksum
184                             736,  # identifier
185                             931); # sequence number
186             } elsif ($attrs{TP_PROTO} eq 'other') {
187                 $ip .= 'other header';
188             } else {
189                 die;
190             }
191
192             substr($ip, 2, 2) = pack('n', length($ip));
193             $packet .= $ip;
194         }
195     }
196     substr($packet, 12, 2) = pack('n', length($packet))
197       if $attrs{DL_HEADER} =~ /^802.2/;
198
199     print join(' ', map("$_=$attrs{$_}", keys(%attrs))), "\n";
200     print join(' ', map("$_=$flow{$_}", keys(%flow))), "\n";
201     print "\n";
202
203     print FLOWS pack('Nn',
204                      0,         # wildcards
205                      1);        # in_port
206     print FLOWS pack_ethaddr($flow{DL_SRC});
207     print FLOWS pack_ethaddr($flow{DL_DST});
208     print FLOWS pack('nCxnCCxxNNnn',
209                      $flow{DL_VLAN},
210                      0,          # DL_VLAN_PCP
211                      $flow{DL_TYPE},
212                      $flow{NW_TOS},
213                      $flow{NW_PROTO},
214                      inet_aton($flow{NW_SRC}),
215                      inet_aton($flow{NW_DST}),
216                      $flow{TP_SRC},
217                      $flow{TP_DST});
218
219     print PACKETS pack('NNNN',
220                        0,                # timestamp seconds
221                        0,                # timestamp microseconds
222                        length($packet),  # bytes saved
223                        length($packet)), # total length
224                   $packet;
225 }
226
227 sub pack_ethaddr {
228     local ($_) = @_;
229     my $xx = '([0-9a-fA-F][0-9a-fA-F])';
230     my (@octets) = /$xx:$xx:$xx:$xx:$xx:$xx/;
231     @octets == 6 or die $_;
232     my ($out) = '';
233     $out .= pack('C', hex($_)) foreach @octets;
234     return $out;
235 }
236
237 sub inet_aton {
238     local ($_) = @_;
239     my ($a, $b, $c, $d) = /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/;
240     defined $d or die $_;
241     return ($a << 24) | ($b << 16) | ($c << 8) | $d;
242 }