280
280
OFP_ASSERT(sizeof(struct nx_async_config) == 24);
282
/* Nicira vendor flow actions. */
284
enum nx_action_subtype {
285
NXAST_SNAT__OBSOLETE, /* No longer used. */
286
NXAST_RESUBMIT, /* struct nx_action_resubmit */
287
NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
288
NXAST_DROP_SPOOFED_ARP__OBSOLETE,
289
NXAST_SET_QUEUE, /* struct nx_action_set_queue */
290
NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
291
NXAST_REG_MOVE, /* struct nx_action_reg_move */
292
NXAST_REG_LOAD, /* struct nx_action_reg_load */
293
NXAST_NOTE, /* struct nx_action_note */
294
NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
295
NXAST_MULTIPATH, /* struct nx_action_multipath */
296
NXAST_AUTOPATH__OBSOLETE, /* No longer used. */
297
NXAST_BUNDLE, /* struct nx_action_bundle */
298
NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
299
NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
300
NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
301
NXAST_LEARN, /* struct nx_action_learn */
302
NXAST_EXIT, /* struct nx_action_header */
303
NXAST_DEC_TTL, /* struct nx_action_header */
304
NXAST_FIN_TIMEOUT, /* struct nx_action_fin_timeout */
305
NXAST_CONTROLLER, /* struct nx_action_controller */
306
NXAST_DEC_TTL_CNT_IDS, /* struct nx_action_cnt_ids */
307
NXAST_WRITE_METADATA, /* struct nx_action_write_metadata */
308
NXAST_PUSH_MPLS, /* struct nx_action_push_mpls */
309
NXAST_POP_MPLS, /* struct nx_action_pop_mpls */
310
NXAST_SET_MPLS_TTL, /* struct nx_action_ttl */
311
NXAST_DEC_MPLS_TTL, /* struct nx_action_header */
312
NXAST_STACK_PUSH, /* struct nx_action_stack */
313
NXAST_STACK_POP, /* struct nx_action_stack */
314
NXAST_SAMPLE, /* struct nx_action_sample */
315
NXAST_SET_MPLS_LABEL, /* struct nx_action_ttl */
316
NXAST_SET_MPLS_TC, /* struct nx_action_ttl */
319
/* Header for Nicira-defined actions. */
320
struct nx_action_header {
321
ovs_be16 type; /* OFPAT_VENDOR. */
322
ovs_be16 len; /* Length is 16. */
323
ovs_be32 vendor; /* NX_VENDOR_ID. */
324
ovs_be16 subtype; /* NXAST_*. */
327
OFP_ASSERT(sizeof(struct nx_action_header) == 16);
329
/* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
331
* These actions search one of the switch's flow tables:
333
* - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
334
* it specifies the table to search.
336
* - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
337
* NXAST_RESUBMIT regardless of 'table'), it searches the current flow
338
* table, that is, the OpenFlow flow table that contains the flow from
339
* which this action was obtained. If this action did not come from a
340
* flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
341
* is the current table.
343
* The flow table lookup uses a flow that may be slightly modified from the
346
* - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
347
* is used as the flow's in_port.
349
* - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
350
* then its value is used as the flow's in_port. Otherwise, the original
353
* - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
354
* resubmit action, then the flow is updated with the new values.
356
* Following the lookup, the original in_port is restored.
358
* If the modified flow matched in the flow table, then the corresponding
359
* actions are executed. Afterward, actions following the resubmit in the
360
* original set of actions, if any, are executed; any changes made to the
361
* packet (e.g. changes to VLAN) by secondary actions persist when those
362
* actions are executed, although the original in_port is restored.
364
* Resubmit actions may be used any number of times within a set of actions.
366
* Resubmit actions may nest to an implementation-defined depth. Beyond this
367
* implementation-defined depth, further resubmit actions are simply ignored.
369
* NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
370
* 'pad' to be all-bits-zero.
372
* Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
373
* before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
375
struct nx_action_resubmit {
376
ovs_be16 type; /* OFPAT_VENDOR. */
377
ovs_be16 len; /* Length is 16. */
378
ovs_be32 vendor; /* NX_VENDOR_ID. */
379
ovs_be16 subtype; /* NXAST_RESUBMIT. */
380
ovs_be16 in_port; /* New in_port for checking flow table. */
381
uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
384
OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
386
/* Action structure for NXAST_SET_TUNNEL.
388
* Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
389
* bits of the tunnel ID are set to 0. */
390
struct nx_action_set_tunnel {
391
ovs_be16 type; /* OFPAT_VENDOR. */
392
ovs_be16 len; /* Length is 16. */
393
ovs_be32 vendor; /* NX_VENDOR_ID. */
394
ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
396
ovs_be32 tun_id; /* Tunnel ID. */
398
OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
400
/* Action structure for NXAST_SET_TUNNEL64.
402
* Sets the encapsulating tunnel ID to a 64-bit value. */
403
struct nx_action_set_tunnel64 {
404
ovs_be16 type; /* OFPAT_VENDOR. */
405
ovs_be16 len; /* Length is 24. */
406
ovs_be32 vendor; /* NX_VENDOR_ID. */
407
ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
409
ovs_be64 tun_id; /* Tunnel ID. */
411
OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
413
/* Action structure for NXAST_SET_QUEUE.
415
* Set the queue that should be used when packets are output. This is similar
416
* to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
417
* an argument. This allows the queue to be defined before the port is
419
struct nx_action_set_queue {
420
ovs_be16 type; /* OFPAT_VENDOR. */
421
ovs_be16 len; /* Length is 16. */
422
ovs_be32 vendor; /* NX_VENDOR_ID. */
423
ovs_be16 subtype; /* NXAST_SET_QUEUE. */
425
ovs_be32 queue_id; /* Where to enqueue packets. */
427
OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
429
/* Action structure for NXAST_POP_QUEUE.
431
* Restores the queue to the value it was before any NXAST_SET_QUEUE actions
432
* were used. Only the original queue can be restored this way; no stack is
434
struct nx_action_pop_queue {
435
ovs_be16 type; /* OFPAT_VENDOR. */
436
ovs_be16 len; /* Length is 16. */
437
ovs_be32 vendor; /* NX_VENDOR_ID. */
438
ovs_be16 subtype; /* NXAST_POP_QUEUE. */
441
OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
443
/* Action structure for NXAST_REG_MOVE.
445
* Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
446
* a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
447
* bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
448
* the next most significant bit, and so on.
450
* 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
451
* sense to use nxm_hasmask=1 because the action does not do any kind of
452
* matching; it uses the actual value of a field.)
454
* The following nxm_header values are potentially acceptable as 'src':
477
* - NXM_NX_ICMPV6_TYPE
478
* - NXM_NX_ICMPV6_CODE
481
* - NXM_NX_REG(idx) for idx in the switch's accepted range.
483
* - NXM_NX_TUN_IPV4_SRC
484
* - NXM_NX_TUN_IPV4_DST
486
* The following nxm_header values are potentially acceptable as 'dst':
502
* Modifying any of the above fields changes the corresponding packet
507
* - NXM_NX_REG(idx) for idx in the switch's accepted range.
511
* - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
512
* packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
513
* header (if any), ignoring the other bits. Setting a value with CFI=1
514
* adds or modifies the 802.1Q header appropriately, setting the TCI field
515
* to the field's new value (with the CFI bit masked out).
517
* - NXM_NX_TUN_ID, NXM_NX_TUN_IPV4_SRC, NXM_NX_TUN_IPV4_DST. Modifying
518
* any of these values modifies the corresponding tunnel header field used
519
* for the packet's next tunnel encapsulation, if allowed by the
520
* configuration of the output tunnel port.
522
* A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
523
* nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
524
* used only if the flow's nx_match includes an nxm_entry that specifies
525
* nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
527
* The switch will reject actions for which src_ofs+n_bits is greater than the
528
* width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
529
* error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
531
* This action behaves properly when 'src' overlaps with 'dst', that is, it
532
* behaves as if 'src' were copied out to a temporary buffer, then the
533
* temporary buffer copied to 'dst'.
535
struct nx_action_reg_move {
536
ovs_be16 type; /* OFPAT_VENDOR. */
537
ovs_be16 len; /* Length is 24. */
538
ovs_be32 vendor; /* NX_VENDOR_ID. */
539
ovs_be16 subtype; /* NXAST_REG_MOVE. */
540
ovs_be16 n_bits; /* Number of bits. */
541
ovs_be16 src_ofs; /* Starting bit offset in source. */
542
ovs_be16 dst_ofs; /* Starting bit offset in destination. */
543
ovs_be32 src; /* Source register. */
544
ovs_be32 dst; /* Destination register. */
546
OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
548
/* Action structure for NXAST_REG_LOAD.
550
* Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
551
* within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
552
* starts at 0 for the least-significant bit, 1 for the next most significant
555
* 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
556
* NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
559
* The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
560
* to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
561
* take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
562
* also stored as one less than its true value:
565
* +------------------------------+------------------+
566
* | ofs | n_bits - 1 |
567
* +------------------------------+------------------+
569
* The switch will reject actions for which ofs+n_bits is greater than the
570
* width of 'dst', or in which any bits in 'value' with value 2**n_bits or
571
* greater are set to 1, with error type OFPET_BAD_ACTION, code
572
* OFPBAC_BAD_ARGUMENT.
574
struct nx_action_reg_load {
575
ovs_be16 type; /* OFPAT_VENDOR. */
576
ovs_be16 len; /* Length is 24. */
577
ovs_be32 vendor; /* NX_VENDOR_ID. */
578
ovs_be16 subtype; /* NXAST_REG_LOAD. */
579
ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
580
ovs_be32 dst; /* Destination register. */
581
ovs_be64 value; /* Immediate value. */
583
OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
585
/* Action structure for NXAST_STACK_PUSH and NXAST_STACK_POP.
587
* Pushes (or pops) field[offset: offset + n_bits] to (or from)
590
struct nx_action_stack {
591
ovs_be16 type; /* OFPAT_VENDOR. */
592
ovs_be16 len; /* Length is 16. */
593
ovs_be32 vendor; /* NX_VENDOR_ID. */
594
ovs_be16 subtype; /* NXAST_STACK_PUSH or NXAST_STACK_POP. */
595
ovs_be16 offset; /* Bit offset into the field. */
596
ovs_be32 field; /* The field used for push or pop. */
597
ovs_be16 n_bits; /* (n_bits + 1) bits of the field. */
598
uint8_t zero[6]; /* Reserved, must be zero. */
600
OFP_ASSERT(sizeof(struct nx_action_stack) == 24);
602
/* Action structure for NXAST_NOTE.
604
* This action has no effect. It is variable length. The switch does not
605
* attempt to interpret the user-defined 'note' data in any way. A controller
606
* can use this action to attach arbitrary metadata to a flow.
608
* This action might go away in the future.
610
struct nx_action_note {
611
ovs_be16 type; /* OFPAT_VENDOR. */
612
ovs_be16 len; /* A multiple of 8, but at least 16. */
613
ovs_be32 vendor; /* NX_VENDOR_ID. */
614
ovs_be16 subtype; /* NXAST_NOTE. */
615
uint8_t note[6]; /* Start of user-defined data. */
616
/* Possibly followed by additional user-defined data. */
618
OFP_ASSERT(sizeof(struct nx_action_note) == 16);
620
/* Action structure for NXAST_MULTIPATH.
622
* This action performs the following steps in sequence:
624
* 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
625
* Refer to the definition of "enum nx_mp_fields" for details.
627
* The 'basis' value is used as a universal hash parameter, that is,
628
* different values of 'basis' yield different hash functions. The
629
* particular universal hash function used is implementation-defined.
631
* The hashed fields' values are drawn from the current state of the
632
* flow, including all modifications that have been made by actions up to
635
* 2. Applies the multipath link choice algorithm specified by 'algorithm',
636
* one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
639
* The output of the algorithm is 'link', an unsigned integer less than
640
* or equal to 'max_link'.
642
* Some algorithms use 'arg' as an additional argument.
644
* 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
645
* 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
648
* The switch will reject actions that have an unknown 'fields', or an unknown
649
* 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
650
* in which 'max_link' is greater than or equal to 2**n_bits, with error type
651
* OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
653
struct nx_action_multipath {
654
ovs_be16 type; /* OFPAT_VENDOR. */
655
ovs_be16 len; /* Length is 32. */
656
ovs_be32 vendor; /* NX_VENDOR_ID. */
657
ovs_be16 subtype; /* NXAST_MULTIPATH. */
659
/* What fields to hash and how. */
660
ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
661
ovs_be16 basis; /* Universal hash parameter. */
664
/* Multipath link choice algorithm to apply to hash value. */
665
ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
666
ovs_be16 max_link; /* Number of output links, minus 1. */
667
ovs_be32 arg; /* Algorithm-specific argument. */
670
/* Where to store the result. */
671
ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
672
ovs_be32 dst; /* Destination. */
674
OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
676
/* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
678
* In the descriptions below, 'n_links' is max_link + 1. */
679
enum nx_mp_algorithm {
680
/* link = hash(flow) % n_links.
682
* Redistributes all traffic when n_links changes. O(1) performance. See
685
* Use UINT16_MAX for max_link to get a raw hash value. */
688
/* link = hash(flow) / (MAX_HASH / n_links).
690
* Redistributes between one-quarter and one-half of traffic when n_links
691
* changes. O(1) performance. See RFC 2992.
693
NX_MP_ALG_HASH_THRESHOLD,
695
/* for i in [0,n_links):
696
* weights[i] = hash(flow, i)
697
* link = { i such that weights[i] >= weights[j] for all j != i }
699
* Redistributes 1/n_links of traffic when n_links changes. O(n_links)
700
* performance. If n_links is greater than a threshold (currently 64, but
701
* subject to change), Open vSwitch will substitute another algorithm
702
* automatically. See RFC 2992. */
703
NX_MP_ALG_HRW, /* Highest Random Weight. */
708
* link = hash(flow, i) % arg
709
* while link > max_link
711
* Redistributes 1/n_links of traffic when n_links changes. O(1)
712
* performance when arg/max_link is bounded by a constant.
714
* Redistributes all traffic when arg changes.
716
* arg must be greater than max_link and for best performance should be no
717
* more than approximately max_link * 2. If arg is outside the acceptable
718
* range, Open vSwitch will automatically substitute the least power of 2
719
* greater than max_link.
721
* This algorithm is specific to Open vSwitch.
723
NX_MP_ALG_ITER_HASH /* Iterative Hash. */
726
/* Action structure for NXAST_LEARN.
728
* This action adds or modifies a flow in an OpenFlow table, similar to
729
* OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
730
* specified idle timeout, hard timeout, priority, cookie, and flags. The new
731
* flow's match criteria and actions are built by applying each of the series
732
* of flow_mod_spec elements included as part of the action.
734
* A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
735
* a no-op used for padding the action as a whole to a multiple of 8 bytes in
736
* length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
737
* bits from a source to a destination. In this case, the header contains
740
* 15 14 13 12 11 10 0
741
* +------+---+------+---------------------------------+
742
* | 0 |src| dst | n_bits |
743
* +------+---+------+---------------------------------+
745
* The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
746
* following table summarizes the meaning of each possible combination.
747
* Details follow the table:
750
* --- --- ----------------------------------------------------------
751
* 0 0 Add match criteria based on value in a field.
752
* 1 0 Add match criteria based on an immediate value.
753
* 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
754
* 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
755
* 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
756
* All other combinations are undefined and not allowed.
758
* The flow_mod_spec header is followed by a source specification and a
759
* destination specification. The format and meaning of the source
760
* specification depends on 'src':
762
* - If 'src' is 0, the source bits are taken from a field in the flow to
763
* which this action is attached. (This should be a wildcarded field. If
764
* its value is fully specified then the source bits being copied have
767
* The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
768
* 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
769
* offset within that field. The source bits are field[ofs:ofs+n_bits-1].
770
* 'field' and 'ofs' are subject to the same restrictions as the source
771
* field in NXAST_REG_MOVE.
773
* - If 'src' is 1, the source bits are a constant value. The source
774
* specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
775
* number in network order, the source bits are the 'n_bits'
776
* least-significant bits. The switch will report an error if other bits
777
* in the constant are nonzero.
779
* The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
780
* ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
781
* nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
782
* meaning of the flow_mod_spec depends on 'dst':
784
* - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
785
* flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
786
* packet equal the source bits. 'field' may be any nxm_header with
787
* nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
789
* Order is significant. Earlier flow_mod_specs must satisfy any
790
* prerequisites for matching fields specified later, by copying constant
791
* values into prerequisite fields.
793
* The switch will reject flow_mod_specs that do not satisfy NXM masking
796
* - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
797
* the new flow. The new flow copies the source bits into
798
* field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
801
* A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
802
* greater than 64 yields multiple NXAST_REG_LOAD actions.
804
* The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
805
* empty. It has the following meaning:
807
* - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
808
* The new flow outputs to the OpenFlow port specified by the source field.
809
* Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
810
* OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
813
* Resource Management
814
* -------------------
816
* A switch has a finite amount of flow table space available for learning.
817
* When this space is exhausted, no new learning table entries will be learned
818
* until some existing flow table entries expire. The controller should be
819
* prepared to handle this by flooding (which can be implemented as a
820
* low-priority flow).
822
* If a learned flow matches a single TCP stream with a relatively long
823
* timeout, one may make the best of resource constraints by setting
824
* 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
825
* both, to shorter timeouts. When either of these is specified as a nonzero
826
* value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
832
* The following examples give a prose description of the flow_mod_specs along
833
* with informal notation for how those would be represented and a hex dump of
834
* the bytes that would be required.
836
* These examples could work with various nx_action_learn parameters. Typical
837
* values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
838
* priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
840
* 1. Learn input port based on the source MAC, with lookup into
841
* NXM_NX_REG1[16:31] by resubmit to in_port=99:
843
* Match on in_port=99:
844
* ovs_be16(src=1, dst=0, n_bits=16), 20 10
845
* ovs_be16(99), 00 63
846
* ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
848
* Match Ethernet destination on Ethernet source from packet:
849
* ovs_be16(src=0, dst=0, n_bits=48), 00 30
850
* ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
851
* ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
853
* Set NXM_NX_REG1[16:31] to the packet's input port:
854
* ovs_be16(src=0, dst=1, n_bits=16), 08 10
855
* ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
856
* ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
858
* Given a packet that arrived on port A with Ethernet source address B,
859
* this would set up the flow "in_port=99, dl_dst=B,
860
* actions=load:A->NXM_NX_REG1[16..31]".
862
* In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
863
* NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
864
* load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
866
* 2. Output to input port based on the source MAC and VLAN VID, with lookup
867
* into NXM_NX_REG1[16:31]:
869
* Match on same VLAN ID as packet:
870
* ovs_be16(src=0, dst=0, n_bits=12), 00 0c
871
* ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
872
* ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
874
* Match Ethernet destination on Ethernet source from packet:
875
* ovs_be16(src=0, dst=0, n_bits=48), 00 30
876
* ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
877
* ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
879
* Output to the packet's input port:
880
* ovs_be16(src=0, dst=2, n_bits=16), 10 10
881
* ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
883
* Given a packet that arrived on port A with Ethernet source address B in
884
* VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
887
* In syntax accepted by ovs-ofctl, this action is:
888
* learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
889
* output:NXM_OF_IN_PORT[])
891
* 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
892
* 10-second MAC expiration time to make it easier to see what's going on
894
* ovs-vsctl del-controller br0
895
* ovs-ofctl del-flows br0
896
* ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
897
hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
898
NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
899
output:NXM_OF_IN_PORT[]), resubmit(,1)"
900
* ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
902
* You can then dump the MAC learning table with:
904
* ovs-ofctl dump-flows br0 table=1
909
* For best performance, segregate learned flows into a table that is not used
910
* for any other flows except possibly for a lowest-priority "catch-all" flow
911
* (a flow with no match criteria). If different learning actions specify
912
* different match criteria, use different tables for the learned flows.
914
* The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
915
* These timeouts apply to the flow that is added, which means that a flow with
916
* an idle timeout will expire when no traffic has been sent *to* the learned
917
* address. This is not usually the intent in MAC learning; instead, we want
918
* the MAC learn entry to expire when no traffic has been sent *from* the
919
* learned address. Use a hard timeout for that.
921
struct nx_action_learn {
922
ovs_be16 type; /* OFPAT_VENDOR. */
923
ovs_be16 len; /* At least 24. */
924
ovs_be32 vendor; /* NX_VENDOR_ID. */
925
ovs_be16 subtype; /* NXAST_LEARN. */
926
ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
927
ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
928
ovs_be16 priority; /* Priority level of flow entry. */
929
ovs_be64 cookie; /* Cookie for new flow. */
930
ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
931
uint8_t table_id; /* Table to insert flow entry. */
932
uint8_t pad; /* Must be zero. */
933
ovs_be16 fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
934
ovs_be16 fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
935
/* Followed by a sequence of flow_mod_spec elements, as described above,
936
* until the end of the action is reached. */
938
OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
940
#define NX_LEARN_N_BITS_MASK 0x3ff
942
#define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
943
#define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
944
#define NX_LEARN_SRC_MASK (1 << 13)
946
#define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
947
#define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
948
#define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
949
#define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
950
#define NX_LEARN_DST_MASK (3 << 11)
952
/* Action structure for NXAST_FIN_TIMEOUT.
954
* This action changes the idle timeout or hard timeout, or both, of this
955
* OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
956
* When such a packet is observed, the action reduces the rule's idle timeout
957
* to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'. This
958
* action has no effect on an existing timeout that is already shorter than the
959
* one that the action specifies. A 'fin_idle_timeout' or 'fin_hard_timeout'
960
* of zero has no effect on the respective timeout.
962
* 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
963
* 'fin_hard_timeout' specifies time since the flow's creation, not since the
964
* receipt of the FIN or RST.
966
* This is useful for quickly discarding learned TCP flows that otherwise will
967
* take a long time to expire.
969
* This action is intended for use with an OpenFlow rule that matches only a
970
* single TCP flow. If the rule matches multiple TCP flows (e.g. it wildcards
971
* all TCP traffic, or all TCP traffic to a particular port), then any FIN or
972
* RST in any of those flows will cause the entire OpenFlow rule to expire
973
* early, which is not normally desirable.
975
struct nx_action_fin_timeout {
976
ovs_be16 type; /* OFPAT_VENDOR. */
977
ovs_be16 len; /* 16. */
978
ovs_be32 vendor; /* NX_VENDOR_ID. */
979
ovs_be16 subtype; /* NXAST_FIN_TIMEOUT. */
980
ovs_be16 fin_idle_timeout; /* New idle timeout, if nonzero. */
981
ovs_be16 fin_hard_timeout; /* New hard timeout, if nonzero. */
982
ovs_be16 pad; /* Must be zero. */
984
OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
986
/* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
988
* The bundle actions choose a slave from a supplied list of options.
989
* NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
990
* selection to a register.
992
* The list of possible slaves follows the nx_action_bundle structure. The size
993
* of each slave is governed by its type as indicated by the 'slave_type'
994
* parameter. The list of slaves should be padded at its end with zeros to make
995
* the total length of the action a multiple of 8.
997
* Switches infer from the 'slave_type' parameter the size of each slave. All
998
* implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
999
* that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
1000
* 2 byte width. Switches should reject actions which indicate unknown or
1001
* unsupported slave types.
1003
* Switches use a strategy dictated by the 'algorithm' parameter to choose a
1004
* slave. If the switch does not support the specified 'algorithm' parameter,
1005
* it should reject the action.
1007
* Several algorithms take into account liveness when selecting slaves. The
1008
* liveness of a slave is implementation defined (with one exception), but will
1009
* generally take into account things like its carrier status and the results
1010
* of any link monitoring protocols which happen to be running on it. In order
1011
* to give controllers a place-holder value, the OFPP_NONE port is always
1014
* Some slave selection strategies require the use of a hash function, in which
1015
* case the 'fields' and 'basis' parameters should be populated. The 'fields'
1016
* parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1017
* hash. Refer to the definition of "enum nx_hash_fields" for details. The
1018
* 'basis' parameter is used as a universal hash parameter. Different values
1019
* of 'basis' yield different hash results.
1021
* The 'zero' parameter at the end of the action structure is reserved for
1022
* future use. Switches are required to reject actions which have nonzero
1023
* bytes in the 'zero' field.
1025
* NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
1026
* should reject actions which have nonzero bytes in either of these fields.
1028
* NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1029
* dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
1030
* similar to those for the NXAST_REG_LOAD action. */
1031
struct nx_action_bundle {
1032
ovs_be16 type; /* OFPAT_VENDOR. */
1033
ovs_be16 len; /* Length including slaves. */
1034
ovs_be32 vendor; /* NX_VENDOR_ID. */
1035
ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1037
/* Slave choice algorithm to apply to hash value. */
1038
ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
1040
/* What fields to hash and how. */
1041
ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
1042
ovs_be16 basis; /* Universal hash parameter. */
1044
ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
1045
ovs_be16 n_slaves; /* Number of slaves. */
1047
ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1048
ovs_be32 dst; /* Destination. */
1050
uint8_t zero[4]; /* Reserved. Must be zero. */
1052
OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1054
/* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1056
* In the descriptions below, 'slaves' is the list of possible slaves in the
1057
* order they appear in the OpenFlow action. */
1058
enum nx_bd_algorithm {
1059
/* Chooses the first live slave listed in the bundle.
1061
* O(n_slaves) performance. */
1062
NX_BD_ALG_ACTIVE_BACKUP,
1064
/* for i in [0,n_slaves):
1065
* weights[i] = hash(flow, i)
1066
* slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1068
* Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1069
* O(n_slaves) performance.
1071
* Uses the 'fields' and 'basis' parameters. */
1072
NX_BD_ALG_HRW /* Highest Random Weight. */
1076
/* Action structure for NXAST_DEC_TTL_CNT_IDS.
1078
* If the packet is not IPv4 or IPv6, does nothing. For IPv4 or IPv6, if the
1079
* TTL or hop limit is at least 2, decrements it by 1. Otherwise, if TTL or
1080
* hop limit is 0 or 1, sends a packet-in to the controllers with each of the
1081
* 'n_controllers' controller IDs specified in 'cnt_ids'.
1083
* (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is
1084
* sent only to controllers with id 0.)
1086
struct nx_action_cnt_ids {
1087
ovs_be16 type; /* OFPAT_VENDOR. */
1088
ovs_be16 len; /* Length including slaves. */
1089
ovs_be32 vendor; /* NX_VENDOR_ID. */
1090
ovs_be16 subtype; /* NXAST_DEC_TTL_CNT_IDS. */
1092
ovs_be16 n_controllers; /* Number of controllers. */
1093
uint8_t zeros[4]; /* Must be zero. */
1095
/* Followed by 1 or more controller ids.
1097
* uint16_t cnt_ids[]; // Controller ids.
1098
* uint8_t pad[]; // Must be 0 to 8-byte align cnt_ids[].
1101
OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16);
1104
/* Action structure for NXAST_OUTPUT_REG.
1106
* Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1108
* The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1109
* the NXAST_REG_LOAD action.
1111
* The acceptable nxm_header values for 'src' are the same as the acceptable
1112
* nxm_header values for the 'src' field of NXAST_REG_MOVE.
1114
* The 'max_len' field indicates the number of bytes to send when the chosen
1115
* port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1116
* field of OFPAT_OUTPUT.
1118
* The 'zero' field is required to be zeroed for forward compatibility. */
1119
struct nx_action_output_reg {
1120
ovs_be16 type; /* OFPAT_VENDOR. */
1121
ovs_be16 len; /* 24. */
1122
ovs_be32 vendor; /* NX_VENDOR_ID. */
1123
ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1125
ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1126
ovs_be32 src; /* Source. */
1128
ovs_be16 max_len; /* Max length to send to controller. */
1130
uint8_t zero[6]; /* Reserved, must be zero. */
1132
OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1136
* Discontinues action processing.
1138
* The NXAST_EXIT action causes the switch to immediately halt processing
1139
* actions for the flow. Any actions which have already been processed are
1140
* executed by the switch. However, any further actions, including those which
1141
* may be in different tables, or different levels of the NXAST_RESUBMIT
1142
* hierarchy, will be ignored.
1144
* Uses the nx_action_header structure. */
1146
282
/* Flexible flow specifications (aka NXM = Nicira Extended Match).
1148
284
* OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches. This
1331
472
* nx_match error.
1334
#define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1335
(((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1336
#define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1337
NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1338
#define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1339
NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1340
#define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1341
#define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1342
#define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1343
#define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1344
#define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1346
#define NXM_MAKE_WILD_HEADER(HEADER) \
1347
NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1349
/* ## ------------------------------- ## */
1350
/* ## OpenFlow 1.0-compatible fields. ## */
1351
/* ## ------------------------------- ## */
1353
/* Physical or virtual port on which the packet was received.
1357
* Format: 16-bit integer in network byte order.
1359
* Masking: Not maskable. */
1360
#define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1362
/* Source or destination address in Ethernet header.
1366
* Format: 48-bit Ethernet MAC address.
1368
* Masking: Fully maskable, in versions 1.8 and later. Earlier versions only
1369
* supported the following masks for NXM_OF_ETH_DST_W: 00:00:00:00:00:00,
1370
* fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, ff:ff:ff:ff:ff:ff. */
1371
#define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1372
#define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1373
#define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1374
#define NXM_OF_ETH_SRC_W NXM_HEADER_W(0x0000, 2, 6)
1376
/* Packet's Ethernet type.
1378
* For an Ethernet II packet this is taken from the Ethernet header. For an
1379
* 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1380
* A packet that has neither format has value 0x05ff
1381
* (OFP_DL_TYPE_NOT_ETH_TYPE).
1383
* For a packet with an 802.1Q header, this is the type of the encapsulated
1388
* Format: 16-bit integer in network byte order.
1390
* Masking: Not maskable. */
1391
#define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1395
* For a packet with an 802.1Q header, this is the Tag Control Information
1396
* (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1397
* header, this has value 0.
1401
* Format: 16-bit integer in network byte order.
1403
* Masking: Arbitrary masks.
1405
* This field can be used in various ways:
1407
* - If it is not constrained at all, the nx_match matches packets without
1408
* an 802.1Q header or with an 802.1Q header that has any TCI value.
1410
* - Testing for an exact match with 0 matches only packets without an
1413
* - Testing for an exact match with a TCI value with CFI=1 matches packets
1414
* that have an 802.1Q header with a specified VID and PCP.
1416
* - Testing for an exact match with a nonzero TCI value with CFI=0 does
1417
* not make sense. The switch may reject this combination.
1419
* - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1420
* packets that have an 802.1Q header with that VID (and any PCP).
1422
* - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1423
* packets that have an 802.1Q header with that PCP (and any VID).
1425
* - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1426
* header or with an 802.1Q header with a VID of 0.
1428
* - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1429
* header or with an 802.1Q header with a PCP of 0.
1431
* - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1432
* header or with an 802.1Q header with both VID and PCP of 0.
1434
#define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1435
#define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1437
/* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1439
* Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1441
* Format: 8-bit integer with 2 least-significant bits forced to 0.
1443
* Masking: Not maskable. */
1444
#define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1446
/* The "protocol" byte in the IP header.
1448
* Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1450
* Format: 8-bit integer.
1452
* Masking: Not maskable. */
1453
#define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1455
/* The source or destination address in the IP header.
1457
* Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1459
* Format: 32-bit integer in network byte order.
1461
* Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
1462
* versions, only CIDR masks are allowed, that is, masks that consist of N
1463
* high-order bits set to 1 and the other 32-N bits set to 0. */
1464
#define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1465
#define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1466
#define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1467
#define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1469
/* The source or destination port in the TCP header.
1472
* NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1473
* NXM_OF_IP_PROTO must match 6 exactly.
1475
* Format: 16-bit integer in network byte order.
1477
* Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1478
* earlier versions. */
1479
#define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1480
#define NXM_OF_TCP_SRC_W NXM_HEADER_W(0x0000, 9, 2)
1481
#define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1482
#define NXM_OF_TCP_DST_W NXM_HEADER_W(0x0000, 10, 2)
1484
/* The source or destination port in the UDP header.
1487
* NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1488
* NXM_OF_IP_PROTO must match 17 exactly.
1490
* Format: 16-bit integer in network byte order.
1492
* Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1493
* earlier versions. */
1494
#define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1495
#define NXM_OF_UDP_SRC_W NXM_HEADER_W(0x0000, 11, 2)
1496
#define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1497
#define NXM_OF_UDP_DST_W NXM_HEADER_W(0x0000, 12, 2)
1499
/* The type or code in the ICMP header.
1502
* NXM_OF_ETH_TYPE must match 0x0800 exactly.
1503
* NXM_OF_IP_PROTO must match 1 exactly.
1505
* Format: 8-bit integer.
1507
* Masking: Not maskable. */
1508
#define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1509
#define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1513
* For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1514
* otherwise. Only ARP opcodes between 1 and 255 should be specified for
1517
* Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1519
* Format: 16-bit integer in network byte order.
1521
* Masking: Not maskable. */
1522
#define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1524
/* For an Ethernet+IP ARP packet, the source or target protocol address
1525
* in the ARP header. Always 0 otherwise.
1527
* Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1529
* Format: 32-bit integer in network byte order.
1531
* Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
1532
* versions, only CIDR masks are allowed, that is, masks that consist of N
1533
* high-order bits set to 1 and the other 32-N bits set to 0. */
1534
#define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1535
#define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1536
#define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1537
#define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1539
/* ## ------------------------ ## */
1540
/* ## Nicira match extensions. ## */
1541
/* ## ------------------------ ## */
1543
/* Metadata registers.
1545
* Registers initially have value 0. Actions allow register values to be
1550
* Format: Array of 32-bit integer registers. Space is reserved for up to
1551
* NXM_NX_MAX_REGS registers, but switches may implement fewer.
1553
* Masking: Arbitrary masks. */
475
/* Number of registers allocated NXM field IDs. */
1554
476
#define NXM_NX_MAX_REGS 16
1555
#define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1556
#define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1557
#define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1558
#define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1559
#define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1560
#define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1561
#define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1562
#define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1563
#define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1564
#define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1565
#define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1566
#define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1567
#define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1568
#define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1569
#define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1570
#define NXM_NX_REG5 NXM_HEADER (0x0001, 5, 4)
1571
#define NXM_NX_REG5_W NXM_HEADER_W(0x0001, 5, 4)
1572
#define NXM_NX_REG6 NXM_HEADER (0x0001, 6, 4)
1573
#define NXM_NX_REG6_W NXM_HEADER_W(0x0001, 6, 4)
1574
#define NXM_NX_REG7 NXM_HEADER (0x0001, 7, 4)
1575
#define NXM_NX_REG7_W NXM_HEADER_W(0x0001, 7, 4)
1579
* For a packet received via a GRE, VXLAN or LISP tunnel including a (32-bit)
1580
* key, the key is stored in the low 32-bits and the high bits are zeroed. For
1581
* other packets, the value is 0.
1583
* All zero bits, for packets not received via a keyed tunnel.
1587
* Format: 64-bit integer in network byte order.
1589
* Masking: Arbitrary masks. */
1590
#define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1591
#define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1593
/* For an Ethernet+IP ARP packet, the source or target hardware address
1594
* in the ARP header. Always 0 otherwise.
1596
* Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1598
* Format: 48-bit Ethernet MAC address.
1600
* Masking: Not maskable. */
1601
#define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1602
#define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1604
/* The source or destination address in the IPv6 header.
1606
* Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1608
* Format: 128-bit IPv6 address.
1610
* Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
1611
* versions, only CIDR masks are allowed, that is, masks that consist of N
1612
* high-order bits set to 1 and the other 128-N bits set to 0. */
1613
#define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1614
#define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1615
#define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1616
#define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1618
/* The type or code in the ICMPv6 header.
1621
* NXM_OF_ETH_TYPE must match 0x86dd exactly.
1622
* NXM_OF_IP_PROTO must match 58 exactly.
1624
* Format: 8-bit integer.
1626
* Masking: Not maskable. */
1627
#define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1628
#define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1630
/* The target address in an IPv6 Neighbor Discovery message.
1633
* NXM_OF_ETH_TYPE must match 0x86dd exactly.
1634
* NXM_OF_IP_PROTO must match 58 exactly.
1635
* NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1637
* Format: 128-bit IPv6 address.
1639
* Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
1640
* versions, only CIDR masks are allowed, that is, masks that consist of N
1641
* high-order bits set to 1 and the other 128-N bits set to 0. */
1642
#define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1643
#define NXM_NX_ND_TARGET_W NXM_HEADER_W (0x0001, 23, 16)
1645
/* The source link-layer address option in an IPv6 Neighbor Discovery
1649
* NXM_OF_ETH_TYPE must match 0x86dd exactly.
1650
* NXM_OF_IP_PROTO must match 58 exactly.
1651
* NXM_OF_ICMPV6_TYPE must be exactly 135.
1653
* Format: 48-bit Ethernet MAC address.
1655
* Masking: Not maskable. */
1656
#define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1658
/* The target link-layer address option in an IPv6 Neighbor Discovery
1662
* NXM_OF_ETH_TYPE must match 0x86dd exactly.
1663
* NXM_OF_IP_PROTO must match 58 exactly.
1664
* NXM_OF_ICMPV6_TYPE must be exactly 136.
1666
* Format: 48-bit Ethernet MAC address.
1668
* Masking: Not maskable. */
1669
#define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1671
/* IP fragment information.
1674
* NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1676
* Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1678
* Masking: Fully maskable.
1680
* This field has three possible values:
1682
* - A packet that is not an IP fragment has value 0.
1684
* - A packet that is an IP fragment with offset 0 (the first fragment) has
1685
* bit 0 set and thus value 1.
1687
* - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1690
* NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1691
* the meanings of bits 0 and 1.
1693
* The switch may reject matches against values that can never appear.
1695
* It is important to understand how this field interacts with the OpenFlow IP
1696
* fragment handling mode:
1698
* - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1699
* before they reach the flow table, so every packet that is available for
1700
* matching will have value 0 in this field.
1702
* - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1703
* IP fragments would be reassembled before they reached the flow table and
1704
* again every packet available for matching would always have value 0.
1706
* - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1707
* 1.0 says that fragments' transport ports are always 0, even for the
1708
* first fragment, so this does not provide much extra information.
1710
* - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1711
* fragments with offset 0, Open vSwitch makes L4 header information
1714
#define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1715
#define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1717
478
/* Bits in the value of NXM_NX_IP_FRAG. */
1718
479
#define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1719
480
#define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1721
/* The flow label in the IPv6 header.
1723
* Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1725
* Format: 20-bit IPv6 flow label in least-significant bits.
1727
* Masking: Fully maskable. */
1728
#define NXM_NX_IPV6_LABEL NXM_HEADER (0x0001, 27, 4)
1729
#define NXM_NX_IPV6_LABEL_W NXM_HEADER_W(0x0001, 27, 4)
1731
/* The ECN of the IP header.
1733
* Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1735
* Format: ECN in the low-order 2 bits.
1737
* Masking: Not maskable. */
1738
#define NXM_NX_IP_ECN NXM_HEADER (0x0001, 28, 1)
1740
/* The time-to-live/hop limit of the IP header.
1742
* Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1744
* Format: 8-bit integer.
1746
* Masking: Not maskable. */
1747
#define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
1751
* This may be used to gain the OpenFlow 1.1-like ability to restrict
1752
* certain NXM-based Flow Mod and Flow Stats Request messages to flows
1753
* with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
1754
* structure definitions for more details. This match is otherwise not
1759
* Format: 64-bit integer in network byte order.
1761
* Masking: Arbitrary masks. */
1762
#define NXM_NX_COOKIE NXM_HEADER (0x0001, 30, 8)
1763
#define NXM_NX_COOKIE_W NXM_HEADER_W(0x0001, 30, 8)
1765
/* The source or destination address in the outer IP header of a tunneled
1768
* For non-tunneled packets, the value is 0.
1772
* Format: 32-bit integer in network byte order.
1774
* Masking: Fully maskable. */
1775
#define NXM_NX_TUN_IPV4_SRC NXM_HEADER (0x0001, 31, 4)
1776
#define NXM_NX_TUN_IPV4_SRC_W NXM_HEADER_W(0x0001, 31, 4)
1777
#define NXM_NX_TUN_IPV4_DST NXM_HEADER (0x0001, 32, 4)
1778
#define NXM_NX_TUN_IPV4_DST_W NXM_HEADER_W(0x0001, 32, 4)
1780
/* Metadata marked onto the packet in a system-dependent manner.
1782
* The packet mark may be used to carry contextual information
1783
* to other parts of the system outside of Open vSwitch. As a
1784
* result, the semantics depend on system in use.
1788
* Format: 32-bit integer in network byte order.
1790
* Masking: Fully maskable. */
1791
#define NXM_NX_PKT_MARK NXM_HEADER (0x0001, 33, 4)
1792
#define NXM_NX_PKT_MARK_W NXM_HEADER_W(0x0001, 33, 4)
1794
/* The flags in the TCP header.
1797
* NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1798
* NXM_OF_IP_PROTO must match 6 exactly.
1800
* Format: 16-bit integer with 4 most-significant bits forced to 0.
1802
* Masking: Bits 0-11 fully maskable. */
1803
#define NXM_NX_TCP_FLAGS NXM_HEADER (0x0001, 34, 2)
1804
#define NXM_NX_TCP_FLAGS_W NXM_HEADER_W(0x0001, 34, 2)
1806
/* Metadata dp_hash.
1808
* Internal use only, not programable from controller.
1810
* The dp_hash is used to carry the flow hash computed in the
1815
* Format: 32-bit integer in network byte order.
1817
* Masking: Fully maskable. */
1818
#define NXM_NX_DP_HASH NXM_HEADER (0x0001, 35, 4)
1819
#define NXM_NX_DP_HASH_W NXM_HEADER_W(0x0001, 35, 4)
1821
/* Metadata recirc_id.
1823
* Internal use only, not programable from controller.
1825
* The recirc_id used for recirculation. 0 is reserved
1826
* for initially received packet.
1830
* Format: 32-bit integer in network byte order.
1832
* Masking: not maskable. */
1833
#define NXM_NX_RECIRC_ID NXM_HEADER (0x0001, 36, 4)
1835
482
/* ## --------------------- ## */
1836
483
/* ## Requests and replies. ## */
1837
484
/* ## --------------------- ## */
added
removed
include/openflow/nicira-ext.h
