/
nicira_ext.py
3078 lines (2936 loc) · 149 KB
/
nicira_ext.py
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
'''
Created on 2015/8/3
:author: hubo
'''
'''
/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
*
* 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.
*/
'''
from . import common
from namedstruct import *
from vlcp.utils.ethernet import mac_addr, ip4_addr, ethertype, ip4_addr_bytes, mac_addr_bytes, \
ip6_addr, ip6_addr_bytes
from namedstruct.namedstruct import StructDefWarning
import warnings as _warnings
with _warnings.catch_warnings():
_warnings.filterwarnings('ignore', '^padding', StructDefWarning)
'''
/* The following vendor extensions, proposed by Nicira, are not yet
* standardized, so they are not included in openflow.h. Some of them may be
* suitable for standardization; others we never expect to standardize. */
'''
'''
/* Nicira vendor-specific error messages extension.
*
* OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
* are specific to each type). It does not have any provision for
* vendor-specific error codes, and it does not even provide "generic" error
* codes that can apply to problems not anticipated by the OpenFlow
* specification authors.
*
* This extension attempts to address the problem by adding a generic "error
* vendor extension". The extension works as follows: use NXET_VENDOR as type
* and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
* vendor-specific details, followed by at least 64 bytes of the failed
* request.
*
* It would be better to have a type-specific vendor extension, e.g. so that
* OFPET_BAD_ACTION could be used with vendor-specific code values. But
* OFPET_BAD_ACTION and most other standardized types already specify that
* their 'data' values are (the start of) the OpenFlow message being replied
* to, so there is no room to insert a vendor ID.
*
* Currently this extension is only implemented by Open vSwitch, but it seems
* like a reasonable candidate for future standardization.
*/
'''
'''
/* This is a random number to avoid accidental collision with any other
* vendor's extension. */
'''
nxt_subtype = enum('nxt_subtype', globals(), uint32,
NXT_ROLE_REQUEST = 10,
NXT_ROLE_REPLY = 11,
NXT_SET_FLOW_FORMAT = 12,
NXT_FLOW_MOD = 13,
NXT_FLOW_REMOVED = 14,
NXT_FLOW_MOD_TABLE_ID = 15,
NXT_SET_PACKET_IN_FORMAT = 16,
NXT_PACKET_IN = 17,
NXT_FLOW_AGE = 18,
NXT_SET_ASYNC_CONFIG = 19,
NXT_SET_CONTROLLER_ID = 20,
NXT_FLOW_MONITOR_CANCEL = 21,
NXT_FLOW_MONITOR_PAUSED = 22,
NXT_FLOW_MONITOR_RESUMED = 23
)
'''
/* Fields to use when hashing flows. */
'''
nx_hash_fields = enum('nx_hash_fields', globals(), uint16,
# /* Ethernet source address (NXM_OF_ETH_SRC) only. */
NX_HASH_FIELDS_ETH_SRC = 0,
#===========================================================================
# /* L2 through L4, symmetric across src/dst. Specifically, each of the
# * following fields, if present, is hashed (slashes separate symmetric
# * pairs):
# *
# * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
# * - NXM_OF_ETH_TYPE
# * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
# * - NXM_OF_IP_PROTO
# * - NXM_OF_IP_SRC / NXM_OF_IP_DST
# * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
# */
#===========================================================================
NX_HASH_FIELDS_SYMMETRIC_L4 = 1
)
nx_packet_in_format = enum('nx_packet_in_format', globals(), uint32,
NXPIF_OPENFLOW10 = 0, # /* Standard OpenFlow 1.0 compatible. */
NXPIF_NXM = 1 # /* Nicira Extended. */
)
nx_role = enum('nx_role', globals(), uint32,
NX_ROLE_OTHER = 0, # /* Default role, full access. */
NX_ROLE_MASTER = 1, # /* Full access, at most one. */
NX_ROLE_SLAVE = 2 # /* Read-only access. */
)
'''
/* Flexible flow specifications (aka NXM = Nicira Extended Match).
*
* OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches. This
* structure is fixed-length and hence difficult to extend. This section
* describes a more flexible, variable-length flow match, called "nx_match" for
* short, that is also supported by Open vSwitch. This section also defines a
* replacement for each OpenFlow message that includes struct ofp10_match.
*
*
* Format
* ======
*
* An nx_match is a sequence of zero or more "nxm_entry"s, which are
* type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
* "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
* first 4 bytes of an nxm_entry are its "header", followed by the entry's
* "body".
*
* An nxm_entry's header is interpreted as a 32-bit word in network byte order:
*
* |<-------------------- nxm_type ------------------>|
* | |
* |31 16 15 9| 8 7 0
* +----------------------------------+---------------+--+------------------+
* | nxm_vendor | nxm_field |hm| nxm_length |
* +----------------------------------+---------------+--+------------------+
*
* The most-significant 23 bits of the header are collectively "nxm_type".
* Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
* 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
* designates a protocol header, such as the Ethernet type, but it can also
* refer to packet metadata, such as the switch port on which a packet arrived.
*
* Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
* of this bit is explained later.
*
* The least-significant 8 bits are "nxm_length", a positive integer. The
* length of the nxm_entry, including the header, is exactly 4 + nxm_length
* bytes.
*
* For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
* constant. It is included only to allow software to minimally parse
* "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
* nxm_field, and nxm_length, nxm_hasmask is a constant.)
*
*
* Semantics
* =========
*
* A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
*
* An nxm_entry places a constraint on the packets matched by the nx_match:
*
* - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
* field, called "nxm_value". The nx_match matches only packets in which
* the field equals nxm_value.
*
* - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
* field (nxm_value), followed by a bitmask of the same length as the
* value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
* nx_match matches only packets for which bit J in the given field's value
* matches bit J in nxm_value. A 0-bit in nxm_mask causes the
* corresponding bit in nxm_value is ignored (it should be 0; Open vSwitch
* may enforce this someday), as is the corresponding bit in the field's
* value. (The sense of the nxm_mask bits is the opposite of that used by
* the "wildcards" member of struct ofp10_match.)
*
* When nxm_hasmask is 1, nxm_length is always even.
*
* An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
* entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
* nxm_hasmask.
*
* When there are multiple "nxm_entry"s, all of the constraints must be met.
*
*
* Mask Restrictions
* =================
*
* Masks may be restricted:
*
* - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
* must always be 0 when these fields are specified. For example, the
* field that identifies the port on which a packet was received may not be
* masked.
*
* - Some nxm_types that do support masked wildcards may only support certain
* nxm_mask patterns. For example, fields that have IPv4 address values
* may be restricted to CIDR masks.
*
* These restrictions should be noted in specifications for individual fields.
* A switch may accept an nxm_hasmask or nxm_mask value that the specification
* disallows, if the switch correctly implements support for that nxm_hasmask
* or nxm_mask value. A switch must reject an attempt to set up a flow that
* contains a nxm_hasmask or nxm_mask value that it does not support.
*
*
* Prerequisite Restrictions
* =========================
*
* The presence of an nxm_entry with a given nxm_type may be restricted based
* on the presence of or values of other "nxm_entry"s. For example:
*
* - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
* preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
* and nxm_value=0x0800. That is, matching on the IP source address is
* allowed only if the Ethernet type is explicitly set to IP.
*
* - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
* preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
* nxm_value either 0x0800 or 0x86dd, and another with
* nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
* That is, matching on the TCP source port is allowed only if the Ethernet
* type is IP or IPv6 and the IP protocol is TCP.
*
* These restrictions should be noted in specifications for individual fields.
* A switch may implement relaxed versions of these restrictions. A switch
* must reject an attempt to set up a flow that violates its restrictions.
*
*
* Ordering Restrictions
* =====================
*
* An nxm_entry that has prerequisite restrictions must appear after the
* "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
* nx_match is not otherwise constrained.
*
* Any given nxm_type may appear in an nx_match at most once.
*
*
* nxm_entry Examples
* ==================
*
* These examples show the format of a single nxm_entry with particular
* nxm_hasmask and nxm_length values. The diagrams are labeled with field
* numbers and byte indexes.
*
*
* 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
*
* 0 3 4 5
* +------------+---+---+
* | header | v | m |
* +------------+---+---+
*
*
* 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
*
* 0 3 4 5
* +------------+------+
* | header | value|
* +------------+------+
*
*
* 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
*
* 0 3 4 7
* +------------+-------------+
* | header | nxm_value |
* +------------+-------------+
*
*
* 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
*
* 0 3 4 9
* +------------+------------------+
* | header | nxm_value |
* +------------+------------------+
*
*
* 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
*
* 0 3 4 9 10 15
* +------------+------------------+------------------+
* | header | nxm_value | nxm_mask |
* +------------+------------------+------------------+
*
*
* Error Reporting
* ===============
*
* A switch should report an error in an nx_match using error type
* OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
* should report a specific error code, if one is assigned for the particular
* problem, but NXBRC_NXM_INVALID is also available to report a generic
* nx_match error.
*/
'''
def NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH):
return (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
def NXM_HEADER(VENDOR, FIELD, LENGTH):
return NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
def NXM_HEADER_W(VENDOR, FIELD, LENGTH):
return NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
def NXM_VENDOR(HEADER):
return ((HEADER) >> 16)
def NXM_FIELD(HEADER):
return (((HEADER) >> 9) & 0x7f)
def NXM_TYPE(HEADER):
return (((HEADER) >> 9) & 0x7fffff)
def NXM_HASMASK(HEADER):
return (((HEADER) >> 8) & 1)
def NXM_LENGTH(HEADER):
return ((HEADER) & 0xff)
def NXM_MAKE_WILD_HEADER(HEADER):
return NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
nx_ip_frag = enum('nx_ip_frag', globals(), uint8, True,
NX_IP_FRAG_ANY = (1 << 0), # /* Is this a fragment? */
NX_IP_FRAG_LATER = (1 << 1), # /* Is this a fragment with nonzero offset? */
)
nxm_header = enum('nxm_header', globals(), uint32,
#===============================================================================
# /* ## ------------------------------- ## */
# /* ## OpenFlow 1.0-compatible fields. ## */
# /* ## ------------------------------- ## */
#
# /* Physical or virtual port on which the packet was received.
# *
# * Prereqs: None.
# *
# * Format: 16-bit integer in network byte order.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_OF_IN_PORT = NXM_HEADER (0x0000, 0, 2),
#===============================================================================
# /* Source or destination address in Ethernet header.
# *
# * Prereqs: None.
# *
# * Format: 48-bit Ethernet MAC address.
# *
# * Masking: Fully maskable, in versions 1.8 and later. Earlier versions only
# * supported the following masks for NXM_OF_ETH_DST_W: 00:00:00:00:00:00,
# * fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, ff:ff:ff:ff:ff:ff. */
#===============================================================================
NXM_OF_ETH_DST = NXM_HEADER (0x0000, 1, 6),
NXM_OF_ETH_DST_W = NXM_HEADER_W(0x0000, 1, 6),
NXM_OF_ETH_SRC = NXM_HEADER (0x0000, 2, 6),
NXM_OF_ETH_SRC_W = NXM_HEADER_W(0x0000, 2, 6),
#===============================================================================
# /* Packet's Ethernet type.
# *
# * For an Ethernet II packet this is taken from the Ethernet header. For an
# * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
# * A packet that has neither format has value 0x05ff
# * (OFP_DL_TYPE_NOT_ETH_TYPE).
# *
# * For a packet with an 802.1Q header, this is the type of the encapsulated
# * frame.
# *
# * Prereqs: None.
# *
# * Format: 16-bit integer in network byte order.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_OF_ETH_TYPE = NXM_HEADER (0x0000, 3, 2),
#===============================================================================
# /* 802.1Q TCI.
# *
# * For a packet with an 802.1Q header, this is the Tag Control Information
# * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
# * header, this has value 0.
# *
# * Prereqs: None.
# *
# * Format: 16-bit integer in network byte order.
# *
# * Masking: Arbitrary masks.
# *
# * This field can be used in various ways:
# *
# * - If it is not constrained at all, the nx_match matches packets without
# * an 802.1Q header or with an 802.1Q header that has any TCI value.
# *
# * - Testing for an exact match with 0 matches only packets without an
# * 802.1Q header.
# *
# * - Testing for an exact match with a TCI value with CFI=1 matches packets
# * that have an 802.1Q header with a specified VID and PCP.
# *
# * - Testing for an exact match with a nonzero TCI value with CFI=0 does
# * not make sense. The switch may reject this combination.
# *
# * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
# * packets that have an 802.1Q header with that VID (and any PCP).
# *
# * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
# * packets that have an 802.1Q header with that PCP (and any VID).
# *
# * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
# * header or with an 802.1Q header with a VID of 0.
# *
# * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
# * header or with an 802.1Q header with a PCP of 0.
# *
# * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
# * header or with an 802.1Q header with both VID and PCP of 0.
# */
#===============================================================================
NXM_OF_VLAN_TCI = NXM_HEADER (0x0000, 4, 2),
NXM_OF_VLAN_TCI_W = NXM_HEADER_W(0x0000, 4, 2),
#===============================================================================
# /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
# *
# * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# *
# * Format: 8-bit integer with 2 least-significant bits forced to 0.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_OF_IP_TOS = NXM_HEADER (0x0000, 5, 1),
#===============================================================================
# /* The "protocol" byte in the IP header.
# *
# * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# *
# * Format: 8-bit integer.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_OF_IP_PROTO = NXM_HEADER (0x0000, 6, 1),
#===============================================================================
# /* The source or destination address in the IP header.
# *
# * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
# *
# * Format: 32-bit integer in network byte order.
# *
# * Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
# * versions, only CIDR masks are allowed, that is, masks that consist of N
# * high-order bits set to 1 and the other 32-N bits set to 0. */
#===============================================================================
NXM_OF_IP_SRC = NXM_HEADER (0x0000, 7, 4),
NXM_OF_IP_SRC_W = NXM_HEADER_W(0x0000, 7, 4),
NXM_OF_IP_DST = NXM_HEADER (0x0000, 8, 4),
NXM_OF_IP_DST_W = NXM_HEADER_W(0x0000, 8, 4),
#===============================================================================
# /* The source or destination port in the TCP header.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# * NXM_OF_IP_PROTO must match 6 exactly.
# *
# * Format: 16-bit integer in network byte order.
# *
# * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
# * earlier versions. */
#===============================================================================
NXM_OF_TCP_SRC = NXM_HEADER (0x0000, 9, 2),
NXM_OF_TCP_SRC_W = NXM_HEADER_W(0x0000, 9, 2),
NXM_OF_TCP_DST = NXM_HEADER (0x0000, 10, 2),
NXM_OF_TCP_DST_W = NXM_HEADER_W(0x0000, 10, 2),
#===============================================================================
# /* The source or destination port in the UDP header.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
# * NXM_OF_IP_PROTO must match 17 exactly.
# *
# * Format: 16-bit integer in network byte order.
# *
# * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
# * earlier versions. */
#===============================================================================
NXM_OF_UDP_SRC = NXM_HEADER (0x0000, 11, 2),
NXM_OF_UDP_SRC_W = NXM_HEADER_W(0x0000, 11, 2),
NXM_OF_UDP_DST = NXM_HEADER (0x0000, 12, 2),
NXM_OF_UDP_DST_W = NXM_HEADER_W(0x0000, 12, 2),
#===============================================================================
# /* The type or code in the ICMP header.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must match 0x0800 exactly.
# * NXM_OF_IP_PROTO must match 1 exactly.
# *
# * Format: 8-bit integer.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_OF_ICMP_TYPE = NXM_HEADER (0x0000, 13, 1),
NXM_OF_ICMP_CODE = NXM_HEADER (0x0000, 14, 1),
#===============================================================================
# /* ARP opcode.
# *
# * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
# * otherwise. Only ARP opcodes between 1 and 255 should be specified for
# * matching.
# *
# * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
# *
# * Format: 16-bit integer in network byte order.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_OF_ARP_OP = NXM_HEADER (0x0000, 15, 2),
#===============================================================================
# /* For an Ethernet+IP ARP packet, the source or target protocol address
# * in the ARP header. Always 0 otherwise.
# *
# * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
# *
# * Format: 32-bit integer in network byte order.
# *
# * Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
# * versions, only CIDR masks are allowed, that is, masks that consist of N
# * high-order bits set to 1 and the other 32-N bits set to 0. */
#===============================================================================
NXM_OF_ARP_SPA = NXM_HEADER (0x0000, 16, 4),
NXM_OF_ARP_SPA_W = NXM_HEADER_W(0x0000, 16, 4),
NXM_OF_ARP_TPA = NXM_HEADER (0x0000, 17, 4),
NXM_OF_ARP_TPA_W = NXM_HEADER_W(0x0000, 17, 4),
#===============================================================================
# /* ## ------------------------ ## */
# /* ## Nicira match extensions. ## */
# /* ## ------------------------ ## */
#
# /* Metadata registers.
# *
# * Registers initially have value 0. Actions allow register values to be
# * manipulated.
# *
# * Prereqs: None.
# *
# * Format: Array of 32-bit integer registers. Space is reserved for up to
# * NXM_NX_MAX_REGS registers, but switches may implement fewer.
# *
# * Masking: Arbitrary masks. */
#===============================================================================
NXM_NX_REG0 = NXM_HEADER (0x0001, 0, 4),
NXM_NX_REG0_W = NXM_HEADER_W(0x0001, 0, 4),
NXM_NX_REG1 = NXM_HEADER (0x0001, 1, 4),
NXM_NX_REG1_W = NXM_HEADER_W(0x0001, 1, 4),
NXM_NX_REG2 = NXM_HEADER (0x0001, 2, 4),
NXM_NX_REG2_W = NXM_HEADER_W(0x0001, 2, 4),
NXM_NX_REG3 = NXM_HEADER (0x0001, 3, 4),
NXM_NX_REG3_W = NXM_HEADER_W(0x0001, 3, 4),
NXM_NX_REG4 = NXM_HEADER (0x0001, 4, 4),
NXM_NX_REG4_W = NXM_HEADER_W(0x0001, 4, 4),
NXM_NX_REG5 = NXM_HEADER (0x0001, 5, 4),
NXM_NX_REG5_W = NXM_HEADER_W(0x0001, 5, 4),
NXM_NX_REG6 = NXM_HEADER (0x0001, 6, 4),
NXM_NX_REG6_W = NXM_HEADER_W(0x0001, 6, 4),
NXM_NX_REG7 = NXM_HEADER (0x0001, 7, 4),
NXM_NX_REG7_W = NXM_HEADER_W(0x0001, 7, 4),
#===============================================================================
# /* Tunnel ID.
# *
# * For a packet received via a GRE, VXLAN or LISP tunnel including a (32-bit)
# * key, the key is stored in the low 32-bits and the high bits are zeroed. For
# * other packets, the value is 0.
# *
# * All zero bits, for packets not received via a keyed tunnel.
# *
# * Prereqs: None.
# *
# * Format: 64-bit integer in network byte order.
# *
# * Masking: Arbitrary masks. */
#===============================================================================
NXM_NX_TUN_ID = NXM_HEADER (0x0001, 16, 8),
NXM_NX_TUN_ID_W = NXM_HEADER_W(0x0001, 16, 8),
#===============================================================================
# /* For an Ethernet+IP ARP packet, the source or target hardware address
# * in the ARP header. Always 0 otherwise.
# *
# * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
# *
# * Format: 48-bit Ethernet MAC address.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_NX_ARP_SHA = NXM_HEADER (0x0001, 17, 6),
NXM_NX_ARP_THA = NXM_HEADER (0x0001, 18, 6),
#===============================================================================
# /* The source or destination address in the IPv6 header.
# *
# * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
# *
# * Format: 128-bit IPv6 address.
# *
# * Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
# * versions, only CIDR masks are allowed, that is, masks that consist of N
# * high-order bits set to 1 and the other 128-N bits set to 0. */
#===============================================================================
NXM_NX_IPV6_SRC = NXM_HEADER (0x0001, 19, 16),
NXM_NX_IPV6_SRC_W = NXM_HEADER_W(0x0001, 19, 16),
NXM_NX_IPV6_DST = NXM_HEADER (0x0001, 20, 16),
NXM_NX_IPV6_DST_W = NXM_HEADER_W(0x0001, 20, 16),
#===============================================================================
# /* The type or code in the ICMPv6 header.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must match 0x86dd exactly.
# * NXM_OF_IP_PROTO must match 58 exactly.
# *
# * Format: 8-bit integer.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_NX_ICMPV6_TYPE = NXM_HEADER (0x0001, 21, 1),
NXM_NX_ICMPV6_CODE = NXM_HEADER (0x0001, 22, 1),
#===============================================================================
# /* The target address in an IPv6 Neighbor Discovery message.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must match 0x86dd exactly.
# * NXM_OF_IP_PROTO must match 58 exactly.
# * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
# *
# * Format: 128-bit IPv6 address.
# *
# * Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
# * versions, only CIDR masks are allowed, that is, masks that consist of N
# * high-order bits set to 1 and the other 128-N bits set to 0. */
#===============================================================================
NXM_NX_ND_TARGET = NXM_HEADER (0x0001, 23, 16),
NXM_NX_ND_TARGET_W = NXM_HEADER_W (0x0001, 23, 16),
#===============================================================================
# /* The source link-layer address option in an IPv6 Neighbor Discovery
# * message.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must match 0x86dd exactly.
# * NXM_OF_IP_PROTO must match 58 exactly.
# * NXM_OF_ICMPV6_TYPE must be exactly 135.
# *
# * Format: 48-bit Ethernet MAC address.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_NX_ND_SLL = NXM_HEADER (0x0001, 24, 6),
#===============================================================================
# /* The target link-layer address option in an IPv6 Neighbor Discovery
# * message.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must match 0x86dd exactly.
# * NXM_OF_IP_PROTO must match 58 exactly.
# * NXM_OF_ICMPV6_TYPE must be exactly 136.
# *
# * Format: 48-bit Ethernet MAC address.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_NX_ND_TLL = NXM_HEADER (0x0001, 25, 6),
#===============================================================================
# /* IP fragment information.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# *
# * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
# *
# * Masking: Fully maskable.
# *
# * This field has three possible values:
# *
# * - A packet that is not an IP fragment has value 0.
# *
# * - A packet that is an IP fragment with offset 0 (the first fragment) has
# * bit 0 set and thus value 1.
# *
# * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
# * and thus value 3.
# *
# * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
# * the meanings of bits 0 and 1.
# *
# * The switch may reject matches against values that can never appear.
# *
# * It is important to understand how this field interacts with the OpenFlow IP
# * fragment handling mode:
# *
# * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
# * before they reach the flow table, so every packet that is available for
# * matching will have value 0 in this field.
# *
# * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
# * IP fragments would be reassembled before they reached the flow table and
# * again every packet available for matching would always have value 0.
# *
# * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
# * 1.0 says that fragments' transport ports are always 0, even for the
# * first fragment, so this does not provide much extra information.
# *
# * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
# * fragments with offset 0, Open vSwitch makes L4 header information
# * available.
# */
#===============================================================================
NXM_NX_IP_FRAG = NXM_HEADER (0x0001, 26, 1),
NXM_NX_IP_FRAG_W = NXM_HEADER_W(0x0001, 26, 1),
#===============================================================================
# /* Bits in the value of NXM_NX_IP_FRAG. */
#===============================================================================
#===============================================================================
# /* The flow label in the IPv6 header.
# *
# * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
# *
# * Format: 20-bit IPv6 flow label in least-significant bits.
# *
# * Masking: Fully maskable. */
#===============================================================================
NXM_NX_IPV6_LABEL = NXM_HEADER (0x0001, 27, 4),
NXM_NX_IPV6_LABEL_W = NXM_HEADER_W(0x0001, 27, 4),
#===============================================================================
# /* The ECN of the IP header.
# *
# * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# *
# * Format: ECN in the low-order 2 bits.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_NX_IP_ECN = NXM_HEADER (0x0001, 28, 1),
#===============================================================================
# /* The time-to-live/hop limit of the IP header.
# *
# * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# *
# * Format: 8-bit integer.
# *
# * Masking: Not maskable. */
#===============================================================================
NXM_NX_IP_TTL = NXM_HEADER (0x0001, 29, 1),
#===============================================================================
# /* Flow cookie.
# *
# * This may be used to gain the OpenFlow 1.1-like ability to restrict
# * certain NXM-based Flow Mod and Flow Stats Request messages to flows
# * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
# * structure definitions for more details. This match is otherwise not
# * allowed.
# *
# * Prereqs: None.
# *
# * Format: 64-bit integer in network byte order.
# *
# * Masking: Arbitrary masks. */
#===============================================================================
NXM_NX_COOKIE = NXM_HEADER (0x0001, 30, 8),
NXM_NX_COOKIE_W = NXM_HEADER_W(0x0001, 30, 8),
#===============================================================================
# /* The source or destination address in the outer IP header of a tunneled
# * packet.
# *
# * For non-tunneled packets, the value is 0.
# *
# * Prereqs: None.
# *
# * Format: 32-bit integer in network byte order.
# *
# * Masking: Fully maskable. */
#===============================================================================
NXM_NX_TUN_IPV4_SRC = NXM_HEADER (0x0001, 31, 4),
NXM_NX_TUN_IPV4_SRC_W = NXM_HEADER_W(0x0001, 31, 4),
NXM_NX_TUN_IPV4_DST = NXM_HEADER (0x0001, 32, 4),
NXM_NX_TUN_IPV4_DST_W = NXM_HEADER_W(0x0001, 32, 4),
#===============================================================================
# /* Metadata marked onto the packet in a system-dependent manner.
# *
# * The packet mark may be used to carry contextual information
# * to other parts of the system outside of Open vSwitch. As a
# * result, the semantics depend on system in use.
# *
# * Prereqs: None.
# *
# * Format: 32-bit integer in network byte order.
# *
# * Masking: Fully maskable. */
#===============================================================================
NXM_NX_PKT_MARK = NXM_HEADER (0x0001, 33, 4),
NXM_NX_PKT_MARK_W = NXM_HEADER_W(0x0001, 33, 4),
#===============================================================================
# /* The flags in the TCP header.
# *
# * Prereqs:
# * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
# * NXM_OF_IP_PROTO must match 6 exactly.
# *
# * Format: 16-bit integer with 4 most-significant bits forced to 0.
# *
# * Masking: Bits 0-11 fully maskable. */
#===============================================================================
NXM_NX_TCP_FLAGS = NXM_HEADER (0x0001, 34, 2),
NXM_NX_TCP_FLAGS_W = NXM_HEADER_W(0x0001, 34, 2),
#===============================================================================
# /* Metadata dp_hash.
# *
# * Internal use only, not programable from controller.
# *
# * The dp_hash is used to carry the flow hash computed in the
# * datapath.
# *
# * Prereqs: None.
# *
# * Format: 32-bit integer in network byte order.
# *
# * Masking: Fully maskable. */
#===============================================================================
NXM_NX_DP_HASH = NXM_HEADER (0x0001, 35, 4),
NXM_NX_DP_HASH_W = NXM_HEADER_W(0x0001, 35, 4),
#===============================================================================
# /* Metadata recirc_id.
# *
# * Internal use only, not programable from controller.
# *
# * The recirc_id used for recirculation. 0 is reserved
# * for initially received packet.
# *
# * Prereqs: None.
# *
# * Format: 32-bit integer in network byte order.
# *
# * Masking: not maskable. */
#===============================================================================
NXM_NX_RECIRC_ID = NXM_HEADER (0x0001, 36, 4),
)
NXM_NX_MAX_REGS = 16
def NXM_NX_REG(IDX):
return NXM_HEADER (0x0001, IDX, 4),
def NXM_NX_REG_W(IDX):
return NXM_HEADER_W(0x0001, IDX, 4),
def NXM_NX_REG_IDX(HEADER):
return NXM_FIELD(HEADER),
def NXM_IS_NX_REG(HEADER):
return (not ((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
def NXM_IS_NX_REG_W(HEADER):
return (not ((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
nx_action_subtype = enum('nx_action_subtype', globals(), uint16,
NXAST_SNAT__OBSOLETE = 0, # /* No longer used. */
NXAST_RESUBMIT = 1, # /* struct nx_action_resubmit */
NXAST_SET_TUNNEL = 2, # /* struct nx_action_set_tunnel */
NXAST_DROP_SPOOFED_ARP__OBSOLETE = 3,
NXAST_SET_QUEUE = 4, # /* struct nx_action_set_queue */
NXAST_POP_QUEUE = 5, # /* struct nx_action_pop_queue */
NXAST_REG_MOVE = 6, # /* struct nx_action_reg_move */
NXAST_REG_LOAD = 7, # /* struct nx_action_reg_load */
NXAST_NOTE = 8, # /* struct nx_action_note */
NXAST_SET_TUNNEL64 = 9, # /* struct nx_action_set_tunnel64 */
NXAST_MULTIPATH = 10, # /* struct nx_action_multipath */
NXAST_AUTOPATH__OBSOLETE = 11, # /* No longer used. */
NXAST_BUNDLE = 12, # /* struct nx_action_bundle */
NXAST_BUNDLE_LOAD = 13, # /* struct nx_action_bundle */
NXAST_RESUBMIT_TABLE = 14, # /* struct nx_action_resubmit */
NXAST_OUTPUT_REG = 15, # /* struct nx_action_output_reg */
NXAST_LEARN = 16, # /* struct nx_action_learn */
NXAST_EXIT = 17, # /* struct nx_action_header */
NXAST_DEC_TTL = 18, # /* struct nx_action_header */
NXAST_FIN_TIMEOUT = 19, # /* struct nx_action_fin_timeout */
NXAST_CONTROLLER = 20, # /* struct nx_action_controller */
NXAST_DEC_TTL_CNT_IDS = 21, # /* struct nx_action_cnt_ids */
NXAST_WRITE_METADATA = 22, # /* struct nx_action_write_metadata */
NXAST_PUSH_MPLS = 23, # /* struct nx_action_push_mpls */
NXAST_POP_MPLS = 24, # /* struct nx_action_pop_mpls */
NXAST_SET_MPLS_TTL = 25, # /* struct nx_action_ttl */
NXAST_DEC_MPLS_TTL = 26, # /* struct nx_action_header */
NXAST_STACK_PUSH = 27, # /* struct nx_action_stack */
NXAST_STACK_POP = 28, # /* struct nx_action_stack */
NXAST_SAMPLE = 29, # /* struct nx_action_sample */
NXAST_SET_MPLS_LABEL = 30, # /* struct nx_action_ttl */
NXAST_SET_MPLS_TC = 31 # /* struct nx_action_ttl */
)
nx_stats_subtype = enum('nx_stats_subtype', globals(), uint32,
NXST_FLOW = 0,
NXST_AGGREGATE = 1,
NXST_FLOW_MONITOR = 2
)
def create_ofs_nbits(ofs, n_bits):
return (ofs << 6) | (n_bits - 1)
'''
/* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
*
* In the descriptions below, 'n_links' is max_link + 1. */
'''
nx_mp_algorithm = enum('nx_mp_algorithm', globals(), uint16,
#===========================================================================
# /* link = hash(flow) % n_links.
# *
# * Redistributes all traffic when n_links changes. O(1) performance. See
# * RFC 2992.
# *
# * Use UINT16_MAX for max_link to get a raw hash value. */
#===========================================================================
NX_MP_ALG_MODULO_N = 0,
#===========================================================================
# /* link = hash(flow) / (MAX_HASH / n_links).
# *
# * Redistributes between one-quarter and one-half of traffic when n_links
# * changes. O(1) performance. See RFC 2992.
# */
#===========================================================================
NX_MP_ALG_HASH_THRESHOLD = 1,
#===========================================================================
# /* for i in [0,n_links):
# * weights[i] = hash(flow, i)
# * link = { i such that weights[i] >= weights[j] for all j != i }
# *
# * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
# * performance. If n_links is greater than a threshold (currently 64, but
# * subject to change), Open vSwitch will substitute another algorithm
# * automatically. See RFC 2992. */
#===========================================================================
NX_MP_ALG_HRW = 2, # /* Highest Random Weight. */
#===========================================================================
# /* i = 0
# * repeat:
# * i = i + 1
# * link = hash(flow, i) % arg
# * while link > max_link
# *
# * Redistributes 1/n_links of traffic when n_links changes. O(1)
# * performance when arg/max_link is bounded by a constant.
# *
# * Redistributes all traffic when arg changes.
# *
# * arg must be greater than max_link and for best performance should be no
# * more than approximately max_link * 2. If arg is outside the acceptable
# * range, Open vSwitch will automatically substitute the least power of 2
# * greater than max_link.
# *
# * This algorithm is specific to Open vSwitch.
# */
#===========================================================================
NX_MP_ALG_ITER_HASH = 3 # /* Iterative Hash. */
)
# Isn't it 0x7ff if it has 11 bits?
NX_LEARN_N_BITS_MASK = 0x3ff
NX_LEARN_SRC_MASK = (1 << 13)
NX_LEARN_DST_MASK = (3 << 11)
NX_LEARN_SRC_FIELD = (0 << 13) # /* Copy from field. */
NX_LEARN_DST_MATCH = (0 << 11) # /* Add match criterion. */
nx_flow_mod_spec_header = enum('nx_flow_mod_spec_header', globals(), uint16, True,
NX_LEARN_SRC_IMMEDIATE = (1 << 13), # /* Copy from immediate value. */