X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fopenflow%2Fnicira-ext.h;h=e9790fd5772f14fccaeb0270f2458f39eeafb1d6;hb=e5f77cc3e33d68cf6467842073514cf4d008b852;hp=1104dbf8396e60da6e00ea940723b5647e7737a6;hpb=2b07c8b182b76e4e3a162796d3ae273ef51d4131;p=openvswitch diff --git a/include/openflow/nicira-ext.h b/include/openflow/nicira-ext.h index 1104dbf8..e9790fd5 100644 --- a/include/openflow/nicira-ext.h +++ b/include/openflow/nicira-ext.h @@ -73,74 +73,26 @@ struct nx_vendor_error { struct nicira_header { struct ofp_header header; ovs_be32 vendor; /* NX_VENDOR_ID. */ - ovs_be32 subtype; /* One of NXT_* below. */ + ovs_be32 subtype; /* See the NXT numbers in ofp-msgs.h. */ }; OFP_ASSERT(sizeof(struct nicira_header) == 16); -/* Values for the 'subtype' member of struct nicira_header. */ -enum nicira_type { - /* No longer used. */ - NXT_STATUS_REQUEST__OBSOLETE = 0, - NXT_STATUS_REPLY__OBSOLETE = 1, - NXT_ACT_SET_CONFIG__OBSOLETE = 2, - NXT_ACT_GET_CONFIG__OBSOLETE = 3, - NXT_COMMAND_REQUEST__OBSOLETE = 4, - NXT_COMMAND_REPLY__OBSOLETE = 5, - NXT_FLOW_END_CONFIG__OBSOLETE = 6, - NXT_FLOW_END__OBSOLETE = 7, - NXT_MGMT__OBSOLETE = 8, - NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9, - - /* Controller role support. The request body is struct nx_role_request. - * The reply echos the request. */ - NXT_ROLE_REQUEST = 10, - NXT_ROLE_REPLY = 11, - - /* Flexible flow specification (aka NXM = Nicira Extended Match). */ - NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */ - NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */ - NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */ - - /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to - * designate the table to which a flow is to be added? See the big comment - * on struct nx_flow_mod_table_id for more information. */ - NXT_FLOW_MOD_TABLE_ID = 15, - - /* Alternative PACKET_IN message formats. */ - NXT_SET_PACKET_IN_FORMAT = 16, /* Set Packet In format. */ - NXT_PACKET_IN = 17, /* Nicira Packet In. */ - - /* Are the idle_age and hard_age members in struct nx_flow_stats supported? - * If so, the switch does not reply to this message (which consists only of - * a "struct nicira_header"). If not, the switch sends an error reply. */ - NXT_FLOW_AGE = 18, - - NXT_SET_ASYNC_CONFIG = 19, /* struct nx_async_config. */ - NXT_SET_CONTROLLER_ID = 20, /* struct nx_controller_id. */ - - /* Flow table monitoring (see also NXST_FLOW_MONITOR). */ - NXT_FLOW_MONITOR_CANCEL = 21, /* struct nx_flow_monitor_cancel. */ - NXT_FLOW_MONITOR_PAUSED = 22, /* struct nicira_header. */ - NXT_FLOW_MONITOR_RESUMED = 23, /* struct nicira_header. */ -}; - -/* Header for Nicira vendor stats request and reply messages. */ -struct nicira_stats_msg { - struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */ +/* Header for Nicira vendor stats request and reply messages in OpenFlow + * 1.0. */ +struct nicira10_stats_msg { + struct ofp10_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */ ovs_be32 subtype; /* One of NXST_* below. */ uint8_t pad[4]; /* Align to 64-bits. */ }; -OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24); - -/* Values for the 'subtype' member of struct nicira_stats_msg. */ -enum nicira_stats_type { - /* Flexible flow specification (aka NXM = Nicira Extended Match). */ - NXST_FLOW, /* Analogous to OFPST_FLOW. */ - NXST_AGGREGATE, /* Analogous to OFPST_AGGREGATE. */ +OFP_ASSERT(sizeof(struct nicira10_stats_msg) == 24); - /* Flow table monitoring. */ - NXST_FLOW_MONITOR, +/* Header for Nicira vendor stats request and reply messages in OpenFlow + * 1.1. */ +struct nicira11_stats_msg { + struct ofp11_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */ + ovs_be32 subtype; /* One of NXST_* below. */ }; +OFP_ASSERT(sizeof(struct nicira11_stats_msg) == 24); /* Fields to use when hashing flows. */ enum nx_hash_fields { @@ -166,7 +118,7 @@ enum nx_hash_fields { * instead of having the switch decide which table is most appropriate as * required by OpenFlow 1.0. By default, the extension is disabled. * - * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's + * When this feature is enabled, Open vSwitch treats struct ofp10_flow_mod's * 16-bit 'command' member as two separate fields. The upper 8 bits are used * as the table ID, the lower 8 bits specify the command as usual. A table ID * of 0xff is treated like a wildcarded table ID. @@ -177,10 +129,9 @@ enum nx_hash_fields { * table. If an identical flow already exists in that table only, then it * is replaced. If the flow cannot be placed in the specified table, * either because the table is full or because the table cannot support - * flows of the given type, the switch replies with an - * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these - * cases by comparing the current and maximum number of entries reported - * in ofp_table_stats.) + * flows of the given type, the switch replies with an OFPFMFC_TABLE_FULL + * error. (A controller can distinguish these cases by comparing the + * current and maximum number of entries reported in ofp_table_stats.) * * If the table ID is wildcarded, the switch picks an appropriate table * itself. If an identical flow already exist in the selected flow table, @@ -200,13 +151,10 @@ enum nx_hash_fields { * table match, then none is modified or deleted. */ struct nx_flow_mod_table_id { - struct ofp_header header; - ovs_be32 vendor; /* NX_VENDOR_ID. */ - ovs_be32 subtype; /* NXT_FLOW_MOD_TABLE_ID. */ uint8_t set; /* Nonzero to enable, zero to disable. */ uint8_t pad[7]; }; -OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 24); +OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 8); enum nx_packet_in_format { NXPIF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */ @@ -215,37 +163,44 @@ enum nx_packet_in_format { /* NXT_SET_PACKET_IN_FORMAT request. */ struct nx_set_packet_in_format { - struct nicira_header nxh; ovs_be32 format; /* One of NXPIF_*. */ }; -OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 20); +OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 4); /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN). * - * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN - * with some minor tweaks. Most notably NXT_PACKET_IN includes the cookie of - * the rule which triggered the NXT_PACKET_IN message, and the match fields are - * in NXM format. + * NXT_PACKET_IN is similar to the OpenFlow 1.2 OFPT_PACKET_IN. The + * differences are: + * + * - NXT_PACKET_IN includes the cookie of the rule that triggered the + * message. (OpenFlow 1.3 OFPT_PACKET_IN also includes the cookie.) + * + * - The metadata fields use NXM (instead of OXM) field numbers. + * + * Open vSwitch 1.9.0 and later omits metadata fields that are zero (as allowed + * by OpenFlow 1.2). Earlier versions included all implemented metadata + * fields. * - * The match fields in the NXT_PACKET_IN are intended to contain flow - * processing metadata collected at the time the NXT_PACKET_IN message was - * triggered. It is minimally required to contain the NXM_OF_IN_PORT of the - * packet, but may include other NXM headers such as flow registers. The match - * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc). - * However, this information can typically be found in the packet directly, so - * it may be redundant. + * Open vSwitch does not include non-metadata in the nx_match, because by + * definition that information can be found in the packet itself. The format + * and the standards allow this, however, so controllers should be prepared to + * tolerate future changes. + * + * The NXM format is convenient for reporting metadata values, but it is + * important not to interpret the format as matching against a flow, because it + * does not. Nothing is being matched; arbitrary metadata masks would not be + * meaningful. * * Whereas in most cases a controller can expect to only get back NXM fields * that it set up itself (e.g. flow dumps will ordinarily report only NXM * fields from flows that the controller added), NXT_PACKET_IN messages might * contain fields that the controller does not understand, because the switch * might support fields (new registers, new protocols, etc.) that the - * controller does not.  The controller must prepared to tolerate these. + * controller does not. The controller must prepared to tolerate these. * * The 'cookie' and 'table_id' fields have no meaning when 'reason' is * OFPR_NO_MATCH. In this case they should be set to 0. */ struct nx_packet_in { - struct nicira_header nxh; ovs_be32 buffer_id; /* ID assigned by datapath. */ ovs_be16 total_len; /* Full length of frame. */ uint8_t reason; /* Reason packet is sent (one of OFPR_*). */ @@ -263,11 +218,11 @@ struct nx_packet_in { * The padding bytes preceding the Ethernet frame ensure that the IP * header (if any) following the Ethernet header is 32-bit aligned. */ - /* uint8_t nxm_fields[...]; */ /* Match. */ + /* uint8_t nxm_fields[...]; */ /* NXM headers. */ /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */ /* uint8_t data[0]; */ /* Ethernet frame. */ }; -OFP_ASSERT(sizeof(struct nx_packet_in) == 40); +OFP_ASSERT(sizeof(struct nx_packet_in) == 24); /* Configures the "role" of the sending controller. The default role is: * @@ -289,10 +244,9 @@ OFP_ASSERT(sizeof(struct nx_packet_in) == 40); * messages, but they do receive OFPT_PORT_STATUS messages. */ struct nx_role_request { - struct nicira_header nxh; ovs_be32 role; /* One of NX_ROLE_*. */ }; -OFP_ASSERT(sizeof(struct nx_role_request) == 20); +OFP_ASSERT(sizeof(struct nx_role_request) == 4); enum nx_role { NX_ROLE_OTHER, /* Default role, full access. */ @@ -318,12 +272,11 @@ enum nx_role { * miss_send_len from default of zero to OFP_DEFAULT_MISS_SEND_LEN (128). */ struct nx_async_config { - struct nicira_header nxh; ovs_be32 packet_in_mask[2]; /* Bitmasks of OFPR_* values. */ ovs_be32 port_status_mask[2]; /* Bitmasks of OFPRR_* values. */ ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */ }; -OFP_ASSERT(sizeof(struct nx_async_config) == 40); +OFP_ASSERT(sizeof(struct nx_async_config) == 24); /* Nicira vendor flow actions. */ @@ -339,7 +292,7 @@ enum nx_action_subtype { NXAST_NOTE, /* struct nx_action_note */ NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */ NXAST_MULTIPATH, /* struct nx_action_multipath */ - NXAST_AUTOPATH, /* struct nx_action_autopath */ + NXAST_AUTOPATH__DEPRECATED, /* struct nx_action_autopath */ NXAST_BUNDLE, /* struct nx_action_bundle */ NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */ NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */ @@ -349,6 +302,8 @@ enum nx_action_subtype { NXAST_DEC_TTL, /* struct nx_action_header */ NXAST_FIN_TIMEOUT, /* struct nx_action_fin_timeout */ NXAST_CONTROLLER, /* struct nx_action_controller */ + NXAST_DEC_TTL_CNT_IDS, /* struct nx_action_cnt_ids */ + NXAST_WRITE_METADATA, /* struct nx_action_write_metadata */ }; /* Header for Nicira-defined actions. */ @@ -548,6 +503,10 @@ OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16); * The switch will reject actions for which src_ofs+n_bits is greater than the * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT. + * + * This action behaves properly when 'src' overlaps with 'dst', that is, it + * behaves as if 'src' were copied out to a temporary buffer, then the + * temporary buffer copied to 'dst'. */ struct nx_action_reg_move { ovs_be16 type; /* OFPAT_VENDOR. */ @@ -1115,6 +1074,35 @@ enum nx_bd_algorithm { * Uses the 'fields' and 'basis' parameters. */ NX_BD_ALG_HRW /* Highest Random Weight. */ }; + + +/* Action structure for NXAST_DEC_TTL_CNT_IDS. + * + * If the packet is not IPv4 or IPv6, does nothing. For IPv4 or IPv6, if the + * TTL or hop limit is at least 2, decrements it by 1. Otherwise, if TTL or + * hop limit is 0 or 1, sends a packet-in to the controllers with each of the + * 'n_controllers' controller IDs specified in 'cnt_ids'. + * + * (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is + * sent only to controllers with id 0.) + */ +struct nx_action_cnt_ids { + ovs_be16 type; /* OFPAT_VENDOR. */ + ovs_be16 len; /* Length including slaves. */ + ovs_be32 vendor; /* NX_VENDOR_ID. */ + ovs_be16 subtype; /* NXAST_DEC_TTL_CNT_IDS. */ + + ovs_be16 n_controllers; /* Number of controllers. */ + uint8_t zeros[4]; /* Must be zero. */ + + /* Followed by 1 or more controller ids. + * + * uint16_t cnt_ids[]; // Controller ids. + * uint8_t pad[]; // Must be 0 to 8-byte align cnt_ids[]. + */ +}; +OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16); + /* Action structure for NXAST_OUTPUT_REG. * @@ -1779,15 +1767,15 @@ OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24); enum nx_flow_format { NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */ - NXFF_NXM = 2 /* Nicira extended match. */ + NXFF_NXM = 2, /* Nicira extended match. */ + NXFF_OPENFLOW12 = 3 /* OpenFlow 1.2 format. */ }; /* NXT_SET_FLOW_FORMAT request. */ struct nx_set_flow_format { - struct nicira_header nxh; ovs_be32 format; /* One of NXFF_*. */ }; -OFP_ASSERT(sizeof(struct nx_set_flow_format) == 20); +OFP_ASSERT(sizeof(struct nx_set_flow_format) == 4); /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). * @@ -1796,7 +1784,6 @@ OFP_ASSERT(sizeof(struct nx_set_flow_format) == 20); * is used only to add or modify flow cookies. */ struct nx_flow_mod { - struct nicira_header nxh; ovs_be64 cookie; /* Opaque controller-issued identifier. */ ovs_be16 command; /* One of OFPFC_*. */ ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */ @@ -1819,11 +1806,10 @@ struct nx_flow_mod { * multiple of 8). */ }; -OFP_ASSERT(sizeof(struct nx_flow_mod) == 48); +OFP_ASSERT(sizeof(struct nx_flow_mod) == 32); /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */ struct nx_flow_removed { - struct nicira_header nxh; ovs_be64 cookie; /* Opaque controller-issued identifier. */ ovs_be16 priority; /* Priority level of flow entry. */ uint8_t reason; /* One of OFPRR_*. */ @@ -1840,7 +1826,7 @@ struct nx_flow_removed { * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of * all-zero bytes. */ }; -OFP_ASSERT(sizeof(struct nx_flow_removed) == 56); +OFP_ASSERT(sizeof(struct nx_flow_removed) == 40); /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW * request). @@ -1849,7 +1835,6 @@ OFP_ASSERT(sizeof(struct nx_flow_removed) == 56); * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches. */ struct nx_flow_stats_request { - struct nicira_stats_msg nsm; ovs_be16 out_port; /* Require matching entries to include this as an output port. A value of OFPP_NONE indicates no restriction. */ @@ -1864,7 +1849,7 @@ struct nx_flow_stats_request { * message. */ }; -OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32); +OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 8); /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to * OFPST_FLOW reply). @@ -1915,9 +1900,11 @@ struct nx_flow_stats { OFP_ASSERT(sizeof(struct nx_flow_stats) == 48); /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to - * OFPST_AGGREGATE request). */ + * OFPST_AGGREGATE request). + * + * The reply format is identical to the reply format for OFPST_AGGREGATE, + * except for the header. */ struct nx_aggregate_stats_request { - struct nicira_stats_msg nsm; ovs_be16 out_port; /* Require matching entries to include this as an output port. A value of OFPP_NONE indicates no restriction. */ @@ -1932,18 +1919,7 @@ struct nx_aggregate_stats_request { * message. */ }; -OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32); - -/* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to - * OFPST_AGGREGATE reply). */ -struct nx_aggregate_stats_reply { - struct nicira_stats_msg nsm; - ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */ - ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */ - ovs_be32 flow_count; /* Number of flows. */ - uint8_t pad[4]; /* Align to 64 bits. */ -}; -OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48); +OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 8); /* NXT_SET_CONTROLLER_ID. * @@ -1955,11 +1931,10 @@ OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48); * The NXAST_CONTROLLER action is the only current user of controller * connection IDs. */ struct nx_controller_id { - struct nicira_header nxh; uint8_t zero[6]; /* Must be zero. */ ovs_be16 controller_id; /* New controller connection ID. */ }; -OFP_ASSERT(sizeof(struct nx_controller_id) == 24); +OFP_ASSERT(sizeof(struct nx_controller_id) == 8); /* Action structure for NXAST_CONTROLLER. * @@ -2202,10 +2177,10 @@ OFP_ASSERT(sizeof(struct nx_flow_update_full) == 24); * change in future versions of Open vSwitch. * * OVS will always send the notifications for a given flow table change before - * the reply to a OFPT_BARRIER_REQUEST request that precedes the flow table - * change. Thus, if the controller does not receive an abbreviated - * notification for a flow_mod before the next OFPT_BARRIER_REPLY, it will - * never receive one. */ + * the reply to a OFPT_BARRIER_REQUEST request that follows the flow table + * change. Thus, if the controller does not receive an abbreviated (or + * unabbreviated) notification for a flow_mod before the next + * OFPT_BARRIER_REPLY, it will never receive one. */ struct nx_flow_update_abbrev { ovs_be16 length; /* Length is 8. */ ovs_be16 event; /* NXFME_ABBREV. */ @@ -2213,11 +2188,26 @@ struct nx_flow_update_abbrev { }; OFP_ASSERT(sizeof(struct nx_flow_update_abbrev) == 8); -/* Used by a controller to cancel an outstanding monitor. */ +/* NXT_FLOW_MONITOR_CANCEL. + * + * Used by a controller to cancel an outstanding monitor. */ struct nx_flow_monitor_cancel { - struct nicira_header nxh; /* Type NXT_FLOW_MONITOR_CANCEL. */ ovs_be32 id; /* 'id' from nx_flow_monitor_request. */ }; -OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 20); +OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 4); + +/* Action structure for NXAST_WRITE_METADATA. + * + * Modifies the 'mask' bits of the metadata value. */ +struct nx_action_write_metadata { + ovs_be16 type; /* OFPAT_VENDOR. */ + ovs_be16 len; /* Length is 32. */ + ovs_be32 vendor; /* NX_VENDOR_ID. */ + ovs_be16 subtype; /* NXAST_WRITE_METADATA. */ + uint8_t zeros[6]; /* Must be zero. */ + ovs_be64 metadata; /* Metadata register. */ + ovs_be64 mask; /* Metadata mask. */ +}; +OFP_ASSERT(sizeof(struct nx_action_write_metadata) == 32); #endif /* openflow/nicira-ext.h */