X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fopenflow%2Fopenflow-1.0.h;h=002c75d46014a523f504016100cd0e8d5e916682;hb=HEAD;hp=d71b007e809610af0cd61f28e553eff43802226e;hpb=0c4365191170504d5bbdc8a3256bcee65ce1515a;p=sliver-openvswitch.git diff --git a/include/openflow/openflow-1.0.h b/include/openflow/openflow-1.0.h index d71b007e8..002c75d46 100644 --- a/include/openflow/openflow-1.0.h +++ b/include/openflow/openflow-1.0.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,76 +21,29 @@ #include "openflow/openflow-common.h" -/* Port numbering. Physical ports are numbered starting from 1. */ -enum ofp_port { - /* Maximum number of physical switch ports. */ - OFPP_MAX = 0xff00, - - /* Fake output "ports". */ - OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This - virtual port must be explicitly used - in order to send back out of the input - port. */ - OFPP_TABLE = 0xfff9, /* Perform actions in flow table. - NB: This can only be the destination - port for packet-out messages. */ - OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */ - OFPP_FLOOD = 0xfffb, /* All physical ports except input port and - those disabled by STP. */ - OFPP_ALL = 0xfffc, /* All physical ports except input port. */ - OFPP_CONTROLLER = 0xfffd, /* Send to controller. */ - OFPP_LOCAL = 0xfffe, /* Local openflow "port". */ - OFPP_NONE = 0xffff /* Not associated with a physical port. */ -}; - -/* OpenFlow 1.0 specific message types, in addition to the common message - * types. */ -enum ofp10_type { - /* Controller command messages. */ - OFPT10_PORT_MOD = 15, /* Controller/switch message */ - - /* Statistics messages. */ - OFPT10_STATS_REQUEST, /* Controller/switch message */ - OFPT10_STATS_REPLY, /* Controller/switch message */ - - /* Barrier messages. */ - OFPT10_BARRIER_REQUEST, /* Controller/switch message */ - OFPT10_BARRIER_REPLY, /* Controller/switch message */ - - /* Queue Configuration messages. */ - OFPT10_QUEUE_GET_CONFIG_REQUEST, /* Controller/switch message */ - OFPT10_QUEUE_GET_CONFIG_REPLY /* Controller/switch message */ -}; - -/* OFPT_HELLO. This message has an empty body, but implementations must - * ignore any data included in the body, to allow for future extensions. */ -struct ofp_hello { - struct ofp_header header; -}; - -#define OFP_DEFAULT_MISS_SEND_LEN 128 - -enum ofp_config_flags { - /* Handling of IP fragments. */ - OFPC_FRAG_NORMAL = 0, /* No special handling for fragments. */ - OFPC_FRAG_DROP = 1, /* Drop fragments. */ - OFPC_FRAG_REASM = 2, /* Reassemble (only if OFPC_IP_REASM set). */ - OFPC_FRAG_NX_MATCH = 3, /* Make first fragments available for matching. */ - OFPC_FRAG_MASK = 3, - - /* TTL processing - applicable for IP and MPLS packets. */ - OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL - to the controller. */ -}; +/* Port number(s) meaning + * --------------- -------------------------------------- + * 0x0000 not assigned a meaning by OpenFlow 1.0 + * 0x0001...0xfeff "physical" ports + * 0xff00...0xfff7 "reserved" but not assigned a meaning by OpenFlow 1.0 + * 0xfff8...0xffff "reserved" OFPP_* ports with assigned meanings + */ -/* Switch configuration. */ -struct ofp_switch_config { - struct ofp_header header; - ovs_be16 flags; /* OFPC_* flags. */ - ovs_be16 miss_send_len; /* Max bytes of new flow that datapath should - send to the controller. */ -}; -OFP_ASSERT(sizeof(struct ofp_switch_config) == 12); +/* Ranges. */ +#define OFPP_MAX OFP_PORT_C(0xff00) /* Max # of switch ports. */ +#define OFPP_FIRST_RESV OFP_PORT_C(0xfff8) /* First assigned reserved port. */ +#define OFPP_LAST_RESV OFP_PORT_C(0xffff) /* Last assigned reserved port. */ + +/* Reserved output "ports". */ +#define OFPP_IN_PORT OFP_PORT_C(0xfff8) /* Where the packet came in. */ +#define OFPP_TABLE OFP_PORT_C(0xfff9) /* Perform actions in flow table. */ +#define OFPP_NORMAL OFP_PORT_C(0xfffa) /* Process with normal L2/L3. */ +#define OFPP_FLOOD OFP_PORT_C(0xfffb) /* All ports except input port and + * ports disabled by STP. */ +#define OFPP_ALL OFP_PORT_C(0xfffc) /* All ports except input port. */ +#define OFPP_CONTROLLER OFP_PORT_C(0xfffd) /* Send to controller. */ +#define OFPP_LOCAL OFP_PORT_C(0xfffe) /* Local openflow "port". */ +#define OFPP_NONE OFP_PORT_C(0xffff) /* Not associated with any port. */ /* OpenFlow 1.0 specific capabilities supported by the datapath (struct * ofp_switch_features, member capabilities). */ @@ -159,7 +112,6 @@ OFP_ASSERT(sizeof(struct ofp10_phy_port) == 48); /* Modify behavior of the physical port */ struct ofp10_port_mod { - struct ofp_header header; ovs_be16 port_no; uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not configurable. This is used to @@ -174,30 +126,36 @@ struct ofp10_port_mod { bits to prevent any action taking place. */ uint8_t pad[4]; /* Pad to 64-bits. */ }; -OFP_ASSERT(sizeof(struct ofp10_port_mod) == 32); +OFP_ASSERT(sizeof(struct ofp10_port_mod) == 24); + +struct ofp10_packet_queue { + ovs_be32 queue_id; /* id for the specific queue. */ + ovs_be16 len; /* Length in bytes of this queue desc. */ + uint8_t pad[2]; /* 64-bit alignment. */ + /* Followed by any number of queue properties expressed using + * ofp_queue_prop_header, to fill out a total of 'len' bytes. */ +}; +OFP_ASSERT(sizeof(struct ofp10_packet_queue) == 8); /* Query for port queue configuration. */ struct ofp10_queue_get_config_request { - struct ofp_header header; ovs_be16 port; /* Port to be queried. Should refer to a valid physical port (i.e. < OFPP_MAX) */ uint8_t pad[2]; /* 32-bit alignment. */ }; -OFP_ASSERT(sizeof(struct ofp10_queue_get_config_request) == 12); +OFP_ASSERT(sizeof(struct ofp10_queue_get_config_request) == 4); /* Queue configuration for a given port. */ struct ofp10_queue_get_config_reply { - struct ofp_header header; ovs_be16 port; uint8_t pad[6]; /* struct ofp10_packet_queue queues[0]; List of configured queues. */ }; -OFP_ASSERT(sizeof(struct ofp10_queue_get_config_reply) == 16); +OFP_ASSERT(sizeof(struct ofp10_queue_get_config_reply) == 8); /* Packet received on port (datapath -> controller). */ -struct ofp_packet_in { - struct ofp_header header; +struct ofp10_packet_in { ovs_be32 buffer_id; /* ID assigned by datapath. */ ovs_be16 total_len; /* Full length of frame. */ ovs_be16 in_port; /* Port on which frame was received. */ @@ -210,7 +168,7 @@ struct ofp_packet_in { offsetof(struct ofp_packet_in, data) == sizeof(struct ofp_packet_in) - 2. */ }; -OFP_ASSERT(sizeof(struct ofp_packet_in) == 20); +OFP_ASSERT(sizeof(struct ofp10_packet_in) == 12); enum ofp10_action_type { OFPAT10_OUTPUT, /* Output to switch port. */ @@ -240,30 +198,8 @@ struct ofp10_action_output { }; OFP_ASSERT(sizeof(struct ofp10_action_output) == 8); -/* Action header for OFPAT10_VENDOR. The rest of the body is vendor-defined. */ -struct ofp_action_vendor_header { - ovs_be16 type; /* OFPAT10_VENDOR. */ - ovs_be16 len; /* Length is a multiple of 8. */ - ovs_be32 vendor; /* Vendor ID, which takes the same form - as in "struct ofp_vendor_header". */ -}; -OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8); - -/* Action header that is common to all actions. The length includes the - * header and any padding used to make the action 64-bit aligned. - * NB: The length of an action *must* always be a multiple of eight. */ -struct ofp_action_header { - ovs_be16 type; /* One of OFPAT10_*. */ - ovs_be16 len; /* Length of action, including this - header. This is the length of action, - including any padding to make it - 64-bit aligned. */ - uint8_t pad[4]; -}; -OFP_ASSERT(sizeof(struct ofp_action_header) == 8); - /* OFPAT10_ENQUEUE action struct: send packets to given queue on port. */ -struct ofp_action_enqueue { +struct ofp10_action_enqueue { ovs_be16 type; /* OFPAT10_ENQUEUE. */ ovs_be16 len; /* Len is 16. */ ovs_be16 port; /* Port that queue belongs. Should @@ -272,24 +208,10 @@ struct ofp_action_enqueue { uint8_t pad[6]; /* Pad for 64-bit alignment. */ ovs_be32 queue_id; /* Where to enqueue the packets. */ }; -OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16); - -union ofp_action { - ovs_be16 type; - struct ofp_action_header header; - struct ofp_action_vendor_header vendor; - struct ofp10_action_output output10; - struct ofp_action_vlan_vid vlan_vid; - struct ofp_action_vlan_pcp vlan_pcp; - struct ofp_action_nw_addr nw_addr; - struct ofp_action_nw_tos nw_tos; - struct ofp_action_tp_port tp_port; -}; -OFP_ASSERT(sizeof(union ofp_action) == 8); +OFP_ASSERT(sizeof(struct ofp10_action_enqueue) == 16); /* Send packet (controller -> datapath). */ -struct ofp_packet_out { - struct ofp_header header; +struct ofp10_packet_out { ovs_be32 buffer_id; /* ID assigned by datapath or UINT32_MAX. */ ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */ ovs_be16 actions_len; /* Size of action array in bytes. */ @@ -300,18 +222,10 @@ struct ofp_packet_out { * of the message length. */ }; -OFP_ASSERT(sizeof(struct ofp_packet_out) == 16); - -enum ofp_flow_mod_command { - OFPFC_ADD, /* New flow. */ - OFPFC_MODIFY, /* Modify all matching flows. */ - OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */ - OFPFC_DELETE, /* Delete all matching flows. */ - OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */ -}; +OFP_ASSERT(sizeof(struct ofp10_packet_out) == 8); /* Flow wildcards. */ -enum ofp_flow_wildcards { +enum ofp10_flow_wildcards { OFPFW10_IN_PORT = 1 << 0, /* Switch input port. */ OFPFW10_DL_VLAN = 1 << 1, /* VLAN vid. */ OFPFW10_DL_SRC = 1 << 2, /* Ethernet source address. */ @@ -350,19 +264,8 @@ enum ofp_flow_wildcards { #define OFPFW10_ICMP_TYPE OFPFW10_TP_SRC #define OFPFW10_ICMP_CODE OFPFW10_TP_DST -/* Values below this cutoff are 802.3 packets and the two bytes - * following MAC addresses are used as a frame length. Otherwise, the - * two bytes are used as the Ethernet type. - */ -#define OFP_DL_TYPE_ETH2_CUTOFF 0x0600 - -/* Value of dl_type to indicate that the frame does not include an - * Ethernet type. - */ -#define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff - /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate - * special conditions. All ones indicates that no VLAN id was set. + * special conditions. All ones indicates that 802.1Q header is not present. */ #define OFP10_VLAN_NONE 0xffff @@ -387,23 +290,12 @@ struct ofp10_match { }; OFP_ASSERT(sizeof(struct ofp10_match) == 40); -/* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry - * is permanent. */ -#define OFP_FLOW_PERMANENT 0 - -/* By default, choose a priority in the middle. */ -#define OFP_DEFAULT_PRIORITY 0x8000 - -enum ofp_flow_mod_flags { - OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow - * expires or is deleted. */ - OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */ - OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */ +enum ofp10_flow_mod_flags { + OFPFF10_EMERG = 1 << 2 /* Part of "emergency flow cache". */ }; /* Flow setup and teardown (controller -> datapath). */ -struct ofp_flow_mod { - struct ofp_header header; +struct ofp10_flow_mod { struct ofp10_match match; /* Fields to match */ ovs_be64 cookie; /* Opaque controller-issued identifier. */ @@ -423,11 +315,10 @@ struct ofp_flow_mod { from the length field in the header. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72); +OFP_ASSERT(sizeof(struct ofp10_flow_mod) == 64); /* Flow removed (datapath -> controller). */ -struct ofp_flow_removed { - struct ofp_header header; +struct ofp10_flow_removed { struct ofp10_match match; /* Description of fields. */ ovs_be64 cookie; /* Opaque controller-issued identifier. */ @@ -443,50 +334,19 @@ struct ofp_flow_removed { ovs_be64 packet_count; ovs_be64 byte_count; }; -OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88); - -/* OFPT_ERROR: Error message (datapath -> controller). */ -struct ofp_error_msg { - struct ofp_header header; - - ovs_be16 type; - ovs_be16 code; - uint8_t data[0]; /* Variable-length data. Interpreted based - on the type and code. */ -}; -OFP_ASSERT(sizeof(struct ofp_error_msg) == 12); +OFP_ASSERT(sizeof(struct ofp10_flow_removed) == 80); /* Statistics request or reply message. */ -struct ofp_stats_msg { +struct ofp10_stats_msg { struct ofp_header header; ovs_be16 type; /* One of the OFPST_* constants. */ ovs_be16 flags; /* Requests: always 0. * Replies: 0 or OFPSF_REPLY_MORE. */ }; -OFP_ASSERT(sizeof(struct ofp_stats_msg) == 12); - -enum ofp_stats_reply_flags { - OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */ -}; - -#define DESC_STR_LEN 256 -#define SERIAL_NUM_LEN 32 -/* Reply to OFPST_DESC request. Each entry is a NULL-terminated ASCII - * string. */ -struct ofp_desc_stats { - struct ofp_stats_msg osm; - char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */ - char hw_desc[DESC_STR_LEN]; /* Hardware description. */ - char sw_desc[DESC_STR_LEN]; /* Software description. */ - char serial_num[SERIAL_NUM_LEN]; /* Serial number. */ - char dp_desc[DESC_STR_LEN]; /* Human readable description of - the datapath. */ -}; -OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1068); +OFP_ASSERT(sizeof(struct ofp10_stats_msg) == 12); /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */ -struct ofp_flow_stats_request { - struct ofp_stats_msg osm; +struct ofp10_flow_stats_request { struct ofp10_match match; /* Fields to match. */ uint8_t table_id; /* ID of table to read (from ofp_table_stats) or 0xff for all tables. */ @@ -495,10 +355,10 @@ struct ofp_flow_stats_request { as an output port. A value of OFPP_NONE indicates no restriction. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 56); +OFP_ASSERT(sizeof(struct ofp10_flow_stats_request) == 44); /* Body of reply to OFPST_FLOW request. */ -struct ofp_flow_stats { +struct ofp10_flow_stats { ovs_be16 length; /* Length of this entry. */ uint8_t table_id; /* ID of table flow came from. */ uint8_t pad; @@ -516,20 +376,10 @@ struct ofp_flow_stats { ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */ struct ofp_action_header actions[0]; /* Actions. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88); - -/* Reply to OFPST_AGGREGATE request. */ -struct ofp_aggregate_stats_reply { - struct ofp_stats_msg osm; - ovs_32aligned_be64 packet_count; /* Number of packets in flows. */ - ovs_32aligned_be64 byte_count; /* Number of bytes in flows. */ - ovs_be32 flow_count; /* Number of flows. */ - uint8_t pad[4]; /* Align to 64 bits. */ -}; -OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 36); +OFP_ASSERT(sizeof(struct ofp10_flow_stats) == 88); /* Body of reply to OFPST_TABLE request. */ -struct ofp_table_stats { +struct ofp10_table_stats { uint8_t table_id; /* Identifier of table. Lower numbered tables are consulted first. */ uint8_t pad[3]; /* Align to 32-bits. */ @@ -541,21 +391,20 @@ struct ofp_table_stats { ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */ ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */ }; -OFP_ASSERT(sizeof(struct ofp_table_stats) == 64); +OFP_ASSERT(sizeof(struct ofp10_table_stats) == 64); /* Stats request of type OFPST_PORT. */ -struct ofp_port_stats_request { - struct ofp_stats_msg osm; +struct ofp10_port_stats_request { ovs_be16 port_no; /* OFPST_PORT message may request statistics for a single port (specified with port_no) or for all ports (port_no == OFPP_NONE). */ uint8_t pad[6]; }; -OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 20); +OFP_ASSERT(sizeof(struct ofp10_port_stats_request) == 8); /* Body of reply to OFPST_PORT request. If a counter is unsupported, set * the field to all ones. */ -struct ofp_port_stats { +struct ofp10_port_stats { ovs_be16 port_no; uint8_t pad[6]; /* Align to 64-bits. */ ovs_32aligned_be64 rx_packets; /* Number of received packets. */ @@ -575,23 +424,22 @@ struct ofp_port_stats { ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */ ovs_32aligned_be64 collisions; /* Number of collisions. */ }; -OFP_ASSERT(sizeof(struct ofp_port_stats) == 104); +OFP_ASSERT(sizeof(struct ofp10_port_stats) == 104); /* All ones is used to indicate all queues in a port (for stats retrieval). */ #define OFPQ_ALL 0xffffffff /* Body for stats request of type OFPST_QUEUE. */ -struct ofp_queue_stats_request { - struct ofp_stats_msg osm; +struct ofp10_queue_stats_request { ovs_be16 port_no; /* All ports if OFPP_ALL. */ uint8_t pad[2]; /* Align to 32-bits. */ ovs_be32 queue_id; /* All queues if OFPQ_ALL. */ }; -OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 20); +OFP_ASSERT(sizeof(struct ofp10_queue_stats_request) == 8); /* Body for stats reply of type OFPST_QUEUE consists of an array of this * structure type. */ -struct ofp_queue_stats { +struct ofp10_queue_stats { ovs_be16 port_no; uint8_t pad[2]; /* Align to 32-bits. */ ovs_be32 queue_id; /* Queue id. */ @@ -599,28 +447,17 @@ struct ofp_queue_stats { ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */ ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */ }; -OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32); +OFP_ASSERT(sizeof(struct ofp10_queue_stats) == 32); /* Vendor extension stats message. */ -struct ofp_vendor_stats_msg { - struct ofp_stats_msg osm; /* Type OFPST_VENDOR. */ +struct ofp10_vendor_stats_msg { + struct ofp10_stats_msg osm; /* Type OFPST_VENDOR. */ ovs_be32 vendor; /* Vendor ID: * - MSB 0: low-order bytes are IEEE OUI. * - MSB != 0: defined by OpenFlow * consortium. */ /* Followed by vendor-defined arbitrary additional data. */ }; -OFP_ASSERT(sizeof(struct ofp_vendor_stats_msg) == 16); - -/* Vendor extension. */ -struct ofp_vendor_header { - struct ofp_header header; /* Type OFPT_VENDOR. */ - ovs_be32 vendor; /* Vendor ID: - * - MSB 0: low-order bytes are IEEE OUI. - * - MSB != 0: defined by OpenFlow - * consortium. */ - /* Vendor-defined arbitrary additional data. */ -}; -OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12); +OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg) == 16); #endif /* openflow/openflow-1.0.h */