/
meta-flow.h
2377 lines (2212 loc) · 69.2 KB
/
meta-flow.h
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
/*
* Copyright (c) 2011-2017 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.
*/
#ifndef OPENVSWITCH_META_FLOW_H
#define OPENVSWITCH_META_FLOW_H 1
#include <limits.h>
#include <stdarg.h>
#include <string.h>
#include <sys/types.h>
#include <netinet/in.h>
#include <netinet/ip6.h>
#include "openvswitch/flow.h"
#include "openvswitch/ofp-errors.h"
#include "openvswitch/ofp-protocol.h"
#include "openvswitch/packets.h"
#include "openvswitch/util.h"
#ifdef __cplusplus
extern "C" {
#endif
struct ds;
struct match;
struct ofputil_port_map;
struct ofputil_tlv_table_mod;
/* Open vSwitch fields
* ===================
*
* Refer to ovs-fields(7) for a detailed introduction to Open vSwitch fields.
*
*
* Field specifications
* ====================
*
* Each of the enumeration values below represents a field. The comments
* preceding each enum must be in a stylized form that is parsed at compile
* time by the extract-ofp-fields program. The comment itself consists of a
* series of paragraphs separate by blank lines. The paragraphs consist of:
*
* - The first paragraph gives the user-visible name of the field as a
* quoted string. This is the name used for parsing and formatting the
* field.
*
* For historical reasons, some fields have an additional name that is
* accepted as an alternative in parsing. This name, when there is one,
* is given as a quoted string in parentheses along with "aka". For
* example:
*
* "tun_id" (aka "tunnel_id").
*
* New fields should have only one name.
*
* - Any number of paragraphs of free text that describe the field. These
* are kept brief because the main description is in meta-flow.xml.
*
* - A final paragraph that consists of a series of key-value pairs, one
* per line, in the form "key: value." where the period at the end of the
* line is a mandatory part of the syntax.
*
* Every field must specify the following key-value pairs:
*
* Type:
*
* The format and size of the field's value. Some possible values are
* generic:
*
* u8: A one-byte field.
* be16: A two-byte field.
* be32: A four-byte field.
* be64: An eight-byte field.
*
* The remaining values imply more about the value's semantics, though OVS
* does not currently take advantage of this additional information:
*
* MAC: A six-byte field whose value is an Ethernet address.
* IPv6: A 16-byte field whose value is an IPv6 address.
* tunnelMD: A variable length field, up to 124 bytes, that carries
* tunnel metadata.
*
* Maskable:
*
* Either "bitwise", if OVS supports matching any subset of bits in the
* field, or "no", if OVS only supports matching or wildcarding the entire
* field.
*
* Formatting:
*
* Explains how a field's value is formatted and parsed for human
* consumption. Some of the options are fairly generally useful:
*
* decimal: Formats the value as a decimal number. On parsing, accepts
* decimal (with no prefix), hexadecimal with 0x prefix, or octal
* with 0 prefix.
*
* hexadecimal: Same as decimal except nonzero values are formatted in
* hex with 0x prefix. The default for parsing is *not* hexadecimal:
* only with a 0x prefix is the input in hexadecimal.
*
* Ethernet: Formats and accepts the common format xx:xx:xx:xx:xx:xx.
* 6-byte fields only.
*
* IPv4: Formats and accepts the common format w.x.y.z. 4-byte fields
* only.
*
* IPv6: Formats and accepts the common IPv6 formats. 16-byte fields
* only.
*
* OpenFlow 1.0 port: Accepts an OpenFlow well-known port name
* (e.g. "IN_PORT") in uppercase or lowercase, or a 16-bit port
* number in decimal. Formats ports using their well-known names in
* uppercase, or in decimal otherwise. 2-byte fields only.
*
* OpenFlow 1.1+ port: Same syntax as for OpenFlow 1.0 ports but for
* 4-byte OpenFlow 1.1+ port number fields.
*
* Others are very specific to particular fields:
*
* frag: One of the strings "no", "first", "later", "yes", "not_later"
* describing which IPv4/v6 fragments are matched.
*
* tunnel flags: Any number of the strings "df", "csum", "key", or
* "oam" separated by "|".
*
* TCP flags: See the description of tcp_flags in ovs-fields(7).
*
* packet type: A pair of packet type namespace NS and NS_TYPE within
* that namespace "(NS,NS_TYPE)". NS and NS_TYPE are formatted in
* decimal or hexadecimal as and accept decimal and hexadecimal (with
* 0x prefix) at parsing.
*
* Prerequisites:
*
* The field's prerequisites. The values should be straightfoward.
*
* Access:
*
* Either "read-only", for a field that cannot be changed via OpenFlow, or
* "read/write" for a modifiable field.
*
* NXM:
*
* If the field has an NXM field assignment, then this specifies the NXM
* name of the field (e.g. "NXM_OF_ETH_SRC"), followed by its nxm_type in
* parentheses, followed by "since v<x>.<y>" specifying the version of Open
* vSwitch that first supported this field in NXM (e.g. "since v1.1" if it
* was introduced in Open vSwitch 1.1).
*
* The NXM name must begin with NXM_OF_ or NXM_NX_. This allows OVS to
* determine the correct NXM class.
*
* If the field does not have an NXM field assignment, specify "none".
*
* OXM:
*
* If the field has an OXM field assignment, then this specifies the OXM
* name of the field (e.g. "OXM_OF_ETH_SRC"), followed by its nxm_type in
* parentheses, followed by "since OF<a>.<b> v<x>.<y>" specifying the
* versions of OpenFlow and Open vSwitch that first supported this field in
* OXM (e.g. "since OF1.3 and v1.10" if it was introduced in OpenFlow 1.3
* and first supported by Open vSwitch in version 1.10).
*
* Some fields have more than one OXM field assignment. For example,
* actset_output has an experimenter OXM assignment in OpenFlow 1.3 and a
* standard OXM assignment in OpenFlow 1.5. In such a case, specify both,
* separated by commas.
*
* OVS uses the start of the OXM field name to determine the correct OXM
* class. To support a new OXM class, edit the mapping table in
* build-aux/extract-ofp-fields.
*
* If the field does not have an OXM field assignment, specify "none".
*
* The following key-value pairs are optional. Open vSwitch already supports
* all the fields to which they apply, so new fields should probably not
* include these pairs:
*
* OF1.0:
*
* Specify this as "exact match" if OpenFlow 1.0 can match or wildcard the
* entire field, or as "CIDR mask" if OpenFlow 1.0 can match any CIDR
* prefix of the field. (OpenFlow 1.0 did not support bitwise matching.)
* Omit, if OpenFlow 1.0 did not support this field.
*
* OF1.1:
*
* Specify this as "exact match" if OpenFlow 1.1 can match or wildcard the
* entire field, or as "bitwise" if OpenFlow 1.1 can match any subset of
* bits in the field. Omit, if OpenFlow 1.1 did not support this field.
*
* The following key-value pair is optional:
*
* Prefix lookup member:
*
* If this field makes sense for use with classifier_set_prefix_fields(),
* specify the name of the "struct flow" member that corresponds to the
* field.
*
* Finally, a few "register" fields have very similar names and purposes,
* e.g. MFF_REG0 through MFF_REG15. For these, the comments may be merged
* together using <N> as a metasyntactic variable for the numeric suffix.
* Lines in the comment that are specific to one of the particular fields by
* writing, e.g. <1>, to consider that line only for e.g. MFF_REG1.
*/
enum OVS_PACKED_ENUM mf_field_id {
/* ## -------- ## */
/* ## Metadata ## */
/* ## -------- ## */
/* "dp_hash".
*
* Flow hash computed in the datapath. Internal use only, not programmable
* from controller.
*
* The OXM code point for this is an attempt to test OXM experimenter
* support, which is otherwise difficult to test due to the dearth of use
* out in the wild. Because controllers can't add flows that match on
* dp_hash, this doesn't commit OVS to supporting this OXM experimenter
* code point in the future.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read-only.
* NXM: NXM_NX_DP_HASH(35) since v2.2.
* OXM: NXOXM_ET_DP_HASH(0) since v2.4.
*/
MFF_DP_HASH,
/* "recirc_id".
*
* ID for recirculation. The value 0 is reserved for initially received
* packets. Internal use only, not programmable from controller.
*
* Type: be32.
* Maskable: no.
* Formatting: decimal.
* Prerequisites: none.
* Access: read-only.
* NXM: NXM_NX_RECIRC_ID(36) since v2.2.
* OXM: none.
*/
MFF_RECIRC_ID,
/* "packet_type".
*
* Define the packet type in OpenFlow 1.5+.
*
* Type: be32.
* Maskable: no.
* Formatting: packet type.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: OXM_OF_PACKET_TYPE(44) since OF1.5 and v2.8.
*/
MFF_PACKET_TYPE,
/* "conj_id".
*
* ID for "conjunction" actions. Please refer to ovs-fields(7)
* documentation of "conjunction" for details.
*
* Type: be32.
* Maskable: no.
* Formatting: decimal.
* Prerequisites: none.
* Access: read-only.
* NXM: NXM_NX_CONJ_ID(37) since v2.4.
* OXM: none. */
MFF_CONJ_ID,
/* "tun_id" (aka "tunnel_id").
*
* The "key" or "tunnel ID" or "VNI" in a packet received via a keyed
* tunnel. For protocols in which the key is shorter than 64 bits, the key
* is stored in the low bits and the high bits are zeroed. For non-keyed
* tunnels and packets not received via a tunnel, the value is 0.
*
* Type: be64.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_ID(16) since v1.1.
* OXM: OXM_OF_TUNNEL_ID(38) since OF1.3 and v1.10.
* Prefix lookup member: tunnel.tun_id.
*/
MFF_TUN_ID,
/* "tun_src".
*
* The IPv4 source address in the outer IP header of a tunneled packet.
*
* For non-tunneled packets, the value is 0.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: IPv4.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_IPV4_SRC(31) since v2.0.
* OXM: none.
* Prefix lookup member: tunnel.ip_src.
*/
MFF_TUN_SRC,
/* "tun_dst".
*
* The IPv4 destination address in the outer IP header of a tunneled
* packet.
*
* For non-tunneled packets, the value is 0.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: IPv4.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_IPV4_DST(32) since v2.0.
* OXM: none.
* Prefix lookup member: tunnel.ip_dst.
*/
MFF_TUN_DST,
/* "tun_ipv6_src".
*
* The IPv6 source address in the outer IP header of a tunneled packet.
*
* For non-tunneled packets, the value is 0.
*
* Type: be128.
* Maskable: bitwise.
* Formatting: IPv6.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_IPV6_SRC(109) since v2.5.
* OXM: none.
* Prefix lookup member: tunnel.ipv6_src.
*/
MFF_TUN_IPV6_SRC,
/* "tun_ipv6_dst".
*
* The IPv6 destination address in the outer IP header of a tunneled
* packet.
*
* For non-tunneled packets, the value is 0.
*
* Type: be128.
* Maskable: bitwise.
* Formatting: IPv6.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_IPV6_DST(110) since v2.5.
* OXM: none.
* Prefix lookup member: tunnel.ipv6_dst.
*/
MFF_TUN_IPV6_DST,
/* "tun_flags".
*
* Flags representing aspects of tunnel behavior.
*
* For non-tunneled packets, the value is 0.
*
* Type: be16 (low 1 bits).
* Maskable: bitwise.
* Formatting: tunnel flags.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_FLAGS(104) since v2.5.
* OXM: none.
*/
MFF_TUN_FLAGS,
/* "tun_ttl".
*
* The TTL in the outer IP header of a tunneled packet. Internal use only,
* not programmable from controller.
*
* For non-tunneled packets, the value is 0.
*
* Type: u8.
* Maskable: no.
* Formatting: decimal.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: none.
*/
MFF_TUN_TTL,
/* "tun_tos".
*
* The ToS value in the outer IP header of a tunneled packet. Internal use
* only, not programmable from controller.
*
* Type: u8.
* Maskable: no.
* Formatting: decimal.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: none.
*/
MFF_TUN_TOS,
/* "tun_gbp_id".
*
* VXLAN Group Policy ID
*
* Type: be16.
* Maskable: bitwise.
* Formatting: decimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_GBP_ID(38) since v2.4.
* OXM: none.
*/
MFF_TUN_GBP_ID,
/* "tun_gbp_flags".
*
* VXLAN Group Policy flags
*
* Type: u8.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_GBP_FLAGS(39) since v2.4.
* OXM: none.
*/
MFF_TUN_GBP_FLAGS,
/* "tun_erspan_idx".
*
* ERSPAN index (direction/port number)
*
* Type: be32 (low 20 bits).
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: none.
* OXM: NXOXM_ET_ERSPAN_IDX(11) since v2.10.
*/
MFF_TUN_ERSPAN_IDX,
/* "tun_erspan_ver".
*
* ERSPAN version (v1 / v2)
*
* Type: u8 (low 4 bits).
* Maskable: bitwise.
* Formatting: decimal.
* Prerequisites: none.
* Access: read/write.
* NXM: none.
* OXM: NXOXM_ET_ERSPAN_VER(12) since v2.10.
*/
MFF_TUN_ERSPAN_VER,
/* "tun_erspan_dir".
*
* ERSPAN mirrored traffic's direction
*
* Type: u8 (low 1 bits).
* Maskable: bitwise.
* Formatting: decimal.
* Prerequisites: none.
* Access: read/write.
* NXM: none.
* OXM: NXOXM_ET_ERSPAN_DIR(13) since v2.10.
*/
MFF_TUN_ERSPAN_DIR,
/* "tun_erspan_hwid".
*
* ERSPAN Hardware ID
*
* Type: u8 (low 6 bits).
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: none.
* OXM: NXOXM_ET_ERSPAN_HWID(14) since v2.10.
*/
MFF_TUN_ERSPAN_HWID,
/* "tun_gtpu_flags".
*
* GTP-U tunnel flags.
*
* Type: u8.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: NXOXM_ET_GTPU_FLAGS(15) since v2.13.
*/
MFF_TUN_GTPU_FLAGS,
/* "tun_gtpu_msgtype".
*
* GTP-U tunnel message type.
*
* Type: u8.
* Maskable: bitwise.
* Formatting: decimal.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: NXOXM_ET_GTPU_MSGTYPE(16) since v2.13.
*/
MFF_TUN_GTPU_MSGTYPE,
#if TUN_METADATA_NUM_OPTS == 64
/* "tun_metadata<N>".
*
* Encapsulation metadata for tunnels.
*
* Each NXM can be dynamically mapped onto a particular tunnel field using
* OpenFlow commands. The individual NXMs can each carry up to 124 bytes
* of data and a combined total of 256 across all allocated fields.
*
* Type: tunnelMD.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_TUN_METADATA0(40) since v2.5. <0>
* NXM: NXM_NX_TUN_METADATA1(41) since v2.5. <1>
* NXM: NXM_NX_TUN_METADATA2(42) since v2.5. <2>
* NXM: NXM_NX_TUN_METADATA3(43) since v2.5. <3>
* NXM: NXM_NX_TUN_METADATA4(44) since v2.5. <4>
* NXM: NXM_NX_TUN_METADATA5(45) since v2.5. <5>
* NXM: NXM_NX_TUN_METADATA6(46) since v2.5. <6>
* NXM: NXM_NX_TUN_METADATA7(47) since v2.5. <7>
* NXM: NXM_NX_TUN_METADATA8(48) since v2.5. <8>
* NXM: NXM_NX_TUN_METADATA9(49) since v2.5. <9>
* NXM: NXM_NX_TUN_METADATA10(50) since v2.5. <10>
* NXM: NXM_NX_TUN_METADATA11(51) since v2.5. <11>
* NXM: NXM_NX_TUN_METADATA12(52) since v2.5. <12>
* NXM: NXM_NX_TUN_METADATA13(53) since v2.5. <13>
* NXM: NXM_NX_TUN_METADATA14(54) since v2.5. <14>
* NXM: NXM_NX_TUN_METADATA15(55) since v2.5. <15>
* NXM: NXM_NX_TUN_METADATA16(56) since v2.5. <16>
* NXM: NXM_NX_TUN_METADATA17(57) since v2.5. <17>
* NXM: NXM_NX_TUN_METADATA18(58) since v2.5. <18>
* NXM: NXM_NX_TUN_METADATA19(59) since v2.5. <19>
* NXM: NXM_NX_TUN_METADATA20(60) since v2.5. <20>
* NXM: NXM_NX_TUN_METADATA21(61) since v2.5. <21>
* NXM: NXM_NX_TUN_METADATA22(62) since v2.5. <22>
* NXM: NXM_NX_TUN_METADATA23(63) since v2.5. <23>
* NXM: NXM_NX_TUN_METADATA24(64) since v2.5. <24>
* NXM: NXM_NX_TUN_METADATA25(65) since v2.5. <25>
* NXM: NXM_NX_TUN_METADATA26(66) since v2.5. <26>
* NXM: NXM_NX_TUN_METADATA27(67) since v2.5. <27>
* NXM: NXM_NX_TUN_METADATA28(68) since v2.5. <28>
* NXM: NXM_NX_TUN_METADATA29(69) since v2.5. <29>
* NXM: NXM_NX_TUN_METADATA30(70) since v2.5. <30>
* NXM: NXM_NX_TUN_METADATA31(71) since v2.5. <31>
* NXM: NXM_NX_TUN_METADATA32(72) since v2.5. <32>
* NXM: NXM_NX_TUN_METADATA33(73) since v2.5. <33>
* NXM: NXM_NX_TUN_METADATA34(74) since v2.5. <34>
* NXM: NXM_NX_TUN_METADATA35(75) since v2.5. <35>
* NXM: NXM_NX_TUN_METADATA36(76) since v2.5. <36>
* NXM: NXM_NX_TUN_METADATA37(77) since v2.5. <37>
* NXM: NXM_NX_TUN_METADATA38(78) since v2.5. <38>
* NXM: NXM_NX_TUN_METADATA39(79) since v2.5. <39>
* NXM: NXM_NX_TUN_METADATA40(80) since v2.5. <40>
* NXM: NXM_NX_TUN_METADATA41(81) since v2.5. <41>
* NXM: NXM_NX_TUN_METADATA42(82) since v2.5. <42>
* NXM: NXM_NX_TUN_METADATA43(83) since v2.5. <43>
* NXM: NXM_NX_TUN_METADATA44(84) since v2.5. <44>
* NXM: NXM_NX_TUN_METADATA45(85) since v2.5. <45>
* NXM: NXM_NX_TUN_METADATA46(86) since v2.5. <46>
* NXM: NXM_NX_TUN_METADATA47(87) since v2.5. <47>
* NXM: NXM_NX_TUN_METADATA48(88) since v2.5. <48>
* NXM: NXM_NX_TUN_METADATA49(89) since v2.5. <49>
* NXM: NXM_NX_TUN_METADATA50(90) since v2.5. <50>
* NXM: NXM_NX_TUN_METADATA51(91) since v2.5. <51>
* NXM: NXM_NX_TUN_METADATA52(92) since v2.5. <52>
* NXM: NXM_NX_TUN_METADATA53(93) since v2.5. <53>
* NXM: NXM_NX_TUN_METADATA54(94) since v2.5. <54>
* NXM: NXM_NX_TUN_METADATA55(95) since v2.5. <55>
* NXM: NXM_NX_TUN_METADATA56(96) since v2.5. <56>
* NXM: NXM_NX_TUN_METADATA57(97) since v2.5. <57>
* NXM: NXM_NX_TUN_METADATA58(98) since v2.5. <58>
* NXM: NXM_NX_TUN_METADATA59(99) since v2.5. <59>
* NXM: NXM_NX_TUN_METADATA60(100) since v2.5. <60>
* NXM: NXM_NX_TUN_METADATA61(101) since v2.5. <61>
* NXM: NXM_NX_TUN_METADATA62(102) since v2.5. <62>
* NXM: NXM_NX_TUN_METADATA63(103) since v2.5. <63>
* OXM: none.
*/
MFF_TUN_METADATA0,
MFF_TUN_METADATA1,
MFF_TUN_METADATA2,
MFF_TUN_METADATA3,
MFF_TUN_METADATA4,
MFF_TUN_METADATA5,
MFF_TUN_METADATA6,
MFF_TUN_METADATA7,
MFF_TUN_METADATA8,
MFF_TUN_METADATA9,
MFF_TUN_METADATA10,
MFF_TUN_METADATA11,
MFF_TUN_METADATA12,
MFF_TUN_METADATA13,
MFF_TUN_METADATA14,
MFF_TUN_METADATA15,
MFF_TUN_METADATA16,
MFF_TUN_METADATA17,
MFF_TUN_METADATA18,
MFF_TUN_METADATA19,
MFF_TUN_METADATA20,
MFF_TUN_METADATA21,
MFF_TUN_METADATA22,
MFF_TUN_METADATA23,
MFF_TUN_METADATA24,
MFF_TUN_METADATA25,
MFF_TUN_METADATA26,
MFF_TUN_METADATA27,
MFF_TUN_METADATA28,
MFF_TUN_METADATA29,
MFF_TUN_METADATA30,
MFF_TUN_METADATA31,
MFF_TUN_METADATA32,
MFF_TUN_METADATA33,
MFF_TUN_METADATA34,
MFF_TUN_METADATA35,
MFF_TUN_METADATA36,
MFF_TUN_METADATA37,
MFF_TUN_METADATA38,
MFF_TUN_METADATA39,
MFF_TUN_METADATA40,
MFF_TUN_METADATA41,
MFF_TUN_METADATA42,
MFF_TUN_METADATA43,
MFF_TUN_METADATA44,
MFF_TUN_METADATA45,
MFF_TUN_METADATA46,
MFF_TUN_METADATA47,
MFF_TUN_METADATA48,
MFF_TUN_METADATA49,
MFF_TUN_METADATA50,
MFF_TUN_METADATA51,
MFF_TUN_METADATA52,
MFF_TUN_METADATA53,
MFF_TUN_METADATA54,
MFF_TUN_METADATA55,
MFF_TUN_METADATA56,
MFF_TUN_METADATA57,
MFF_TUN_METADATA58,
MFF_TUN_METADATA59,
MFF_TUN_METADATA60,
MFF_TUN_METADATA61,
MFF_TUN_METADATA62,
MFF_TUN_METADATA63,
#else
#error "Need to update MFF_TUN_METADATA* to match TUN_METADATA_NUM_OPTS"
#endif
/* "metadata".
*
* A scratch pad value standardized in OpenFlow 1.1+. Initially zero, at
* the beginning of the pipeline.
*
* Type: be64.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: none.
* OXM: OXM_OF_METADATA(2) since OF1.2 and v1.8.
* OF1.1: bitwise mask.
*/
MFF_METADATA,
/* "in_port".
*
* 16-bit (OpenFlow 1.0) view of the physical or virtual port on which the
* packet was received.
*
* Type: be16.
* Maskable: no.
* Formatting: OpenFlow 1.0 port.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_OF_IN_PORT(0) since v1.1.
* OXM: none.
* OF1.0: exact match.
* OF1.1: exact match.
*/
MFF_IN_PORT,
/* "in_port_oxm".
*
* 32-bit (OpenFlow 1.1+) view of the physical or virtual port on which the
* packet was received.
*
* Type: be32.
* Maskable: no.
* Formatting: OpenFlow 1.1+ port.
* Prerequisites: none.
* Access: read/write.
* NXM: none.
* OXM: OXM_OF_IN_PORT(0) since OF1.2 and v1.7.
* OF1.1: exact match.
*/
MFF_IN_PORT_OXM,
/* "actset_output".
*
* Type: be32.
* Maskable: no.
* Formatting: OpenFlow 1.1+ port.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: ONFOXM_ET_ACTSET_OUTPUT(43) since OF1.3 and v2.4,
* OXM_OF_ACTSET_OUTPUT(43) since OF1.5 and v2.4.
*/
MFF_ACTSET_OUTPUT,
/* "skb_priority".
*
* Designates the queue to which output will be directed. The value in
* this field is not necessarily the OpenFlow queue number; with the Linux
* kernel switch, it instead has a pair of subfields designating the
* "major" and "minor" numbers of a Linux kernel qdisc handle.
*
* This field is "semi-internal" in that it can be set with the "set_queue"
* action but not matched or read or written other ways.
*
* Type: be32.
* Maskable: no.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read-only.
* NXM: none.
* OXM: none.
*/
MFF_SKB_PRIORITY,
/* "pkt_mark".
*
* Packet metadata mark. The mark may be passed into other system
* components in order to facilitate interaction between subsystems. On
* Linux this corresponds to struct sk_buff's "skb_mark" member but the
* exact implementation is platform-dependent.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_PKT_MARK(33) since v2.0.
* OXM: none.
*/
MFF_PKT_MARK,
/* "ct_state".
*
* Connection tracking state. The field is populated by the NXAST_CT
* action.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: ct state.
* Prerequisites: none.
* Access: read-only.
* NXM: NXM_NX_CT_STATE(105) since v2.5.
* OXM: none.
*/
MFF_CT_STATE,
/* "ct_zone".
*
* Connection tracking zone. The field is populated by the
* NXAST_CT action.
*
* Type: be16.
* Maskable: no.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read-only.
* NXM: NXM_NX_CT_ZONE(106) since v2.5.
* OXM: none.
*/
MFF_CT_ZONE,
/* "ct_mark".
*
* Connection tracking mark. The mark is carried with the
* connection tracking state. On Linux this corresponds to the
* nf_conn's "mark" member but the exact implementation is
* platform-dependent.
*
* Writable only from nested actions within the NXAST_CT action.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_CT_MARK(107) since v2.5.
* OXM: none.
*/
MFF_CT_MARK,
/* "ct_label".
*
* Connection tracking label. The label is carried with the
* connection tracking state. On Linux this is held in the
* conntrack label extension but the exact implementation is
* platform-dependent.
*
* Writable only from nested actions within the NXAST_CT action.
*
* Type: be128.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_CT_LABEL(108) since v2.5.
* OXM: none.
*/
MFF_CT_LABEL,
/* "ct_nw_proto".
*
* The "protocol" byte in the IPv4 or IPv6 header for the original
* direction conntrack tuple, or of the parent conntrack entry, if the
* current connection is a related connection.
*
* The value is initially zero and populated by the CT action. The value
* remains zero after the CT action only if the packet can not be
* associated with a valid connection, in which case the prerequisites
* for matching this field ("CT") are not met.
*
* Type: u8.
* Maskable: no.
* Formatting: decimal.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_NW_PROTO(119) since v2.8.
* OXM: none.
*/
MFF_CT_NW_PROTO,
/* "ct_nw_src".
*
* IPv4 source address of the original direction tuple of the conntrack
* entry, or of the parent conntrack entry, if the current connection is a
* related connection.
*
* The value is populated by the CT action.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: IPv4.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_NW_SRC(120) since v2.8.
* OXM: none.
* Prefix lookup member: ct_nw_src.
*/
MFF_CT_NW_SRC,
/* "ct_nw_dst".
*
* IPv4 destination address of the original direction tuple of the
* conntrack entry, or of the parent conntrack entry, if the current
* connection is a related connection.
*
* The value is populated by the CT action.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: IPv4.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_NW_DST(121) since v2.8.
* OXM: none.
* Prefix lookup member: ct_nw_dst.
*/
MFF_CT_NW_DST,
/* "ct_ipv6_src".
*
* IPv6 source address of the original direction tuple of the conntrack
* entry, or of the parent conntrack entry, if the current connection is a
* related connection.
*
* The value is populated by the CT action.
*
* Type: be128.
* Maskable: bitwise.
* Formatting: IPv6.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_IPV6_SRC(122) since v2.8.
* OXM: none.
* Prefix lookup member: ct_ipv6_src.
*/
MFF_CT_IPV6_SRC,
/* "ct_ipv6_dst".
*
* IPv6 destination address of the original direction tuple of the
* conntrack entry, or of the parent conntrack entry, if the current
* connection is a related connection.
*
* The value is populated by the CT action.
*
* Type: be128.
* Maskable: bitwise.
* Formatting: IPv6.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_IPV6_DST(123) since v2.8.
* OXM: none.
* Prefix lookup member: ct_ipv6_dst.
*/
MFF_CT_IPV6_DST,
/* "ct_tp_src".
*
* Transport layer source port of the original direction tuple of the
* conntrack entry, or of the parent conntrack entry, if the current
* connection is a related connection.
*
* The value is populated by the CT action.
*
* Type: be16.
* Maskable: bitwise.
* Formatting: decimal.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_TP_SRC(124) since v2.8.
* OXM: none.
*/
MFF_CT_TP_SRC,
/* "ct_tp_dst".
*
* Transport layer destination port of the original direction tuple of the
* conntrack entry, or of the parent conntrack entry, if the current
* connection is a related connection.
*
* The value is populated by the CT action.
*
* Type: be16.
* Maskable: bitwise.
* Formatting: decimal.
* Prerequisites: CT.
* Access: read-only.
* NXM: NXM_NX_CT_TP_DST(125) since v2.8.
* OXM: none.
*/
MFF_CT_TP_DST,
#if FLOW_N_REGS == 16
/* "reg<N>".
*
* Nicira extension scratch pad register with initial value 0.
*
* Type: be32.
* Maskable: bitwise.
* Formatting: hexadecimal.
* Prerequisites: none.
* Access: read/write.
* NXM: NXM_NX_REG0(0) since v1.1. <0>
* NXM: NXM_NX_REG1(1) since v1.1. <1>
* NXM: NXM_NX_REG2(2) since v1.1. <2>
* NXM: NXM_NX_REG3(3) since v1.1. <3>
* NXM: NXM_NX_REG4(4) since v1.3. <4>
* NXM: NXM_NX_REG5(5) since v1.7. <5>