X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fopenflow%2Fopenflow.h;h=9ac2377699ae397836478b09b22fdfae966dac5d;hb=9b2aa0d23fcf623c433e5c757779d710791b4803;hp=1f1837071327d154e0578ead5d05f39f698cdce5;hpb=e7e3f48570f1115e020413fe3ed7460a22fdad91;p=sliver-openvswitch.git diff --git a/include/openflow/openflow.h b/include/openflow/openflow.h index 1f1837071..9ac237769 100644 --- a/include/openflow/openflow.h +++ b/include/openflow/openflow.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009 Nicira Networks. + * Copyright (c) 2008, 2009, 2010 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -46,7 +46,7 @@ /* The most significant bit being set in the version field indicates an * experimental OpenFlow version. */ -#define OFP_VERSION 0x97 +#define OFP_VERSION 0x98 #define OFP_MAX_TABLE_NAME_LEN 32 #define OFP_MAX_PORT_NAME_LEN 16 @@ -56,7 +56,7 @@ #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */ -/* Port numbering. Physical ports are numbered starting from 0. */ +/* Port numbering. Physical ports are numbered starting from 1. */ enum ofp_port { /* Maximum number of physical switch ports. */ OFPP_MAX = 0xff00, @@ -95,7 +95,7 @@ enum ofp_type { /* Asynchronous messages. */ OFPT_PACKET_IN, /* Async message */ - OFPT_FLOW_EXPIRED, /* Async message */ + OFPT_FLOW_REMOVED, /* Async message */ OFPT_PORT_STATUS, /* Async message */ /* Controller command messages. */ @@ -105,7 +105,15 @@ enum ofp_type { /* Statistics messages. */ OFPT_STATS_REQUEST, /* Controller/switch message */ - OFPT_STATS_REPLY /* Controller/switch message */ + OFPT_STATS_REPLY, /* Controller/switch message */ + + /* Barrier messages. */ + OFPT_BARRIER_REQUEST, /* Controller/switch message */ + OFPT_BARRIER_REPLY, /* Controller/switch message */ + + /* Queue Configuration messages. */ + OFPT_QUEUE_GET_CONFIG_REQUEST, /* Controller/switch message */ + OFPT_QUEUE_GET_CONFIG_REPLY /* Controller/switch message */ }; /* Header on all OpenFlow packets. */ @@ -128,9 +136,6 @@ struct ofp_hello { #define OFP_DEFAULT_MISS_SEND_LEN 128 enum ofp_config_flags { - /* Tells datapath to notify the controller of expired flow entries. */ - OFPC_SEND_FLOW_EXP = 1 << 0, - /* Handling of IP fragments. */ OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */ OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */ @@ -155,7 +160,10 @@ enum ofp_capabilities { OFPC_STP = 1 << 3, /* 802.1d spanning tree. */ OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple physical interfaces */ - OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */ + OFPC_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */ + OFPC_QUEUE_STATS = 1 << 6, /* Queue statistics. */ + OFPC_ARP_MATCH_IP = 1 << 7 /* Match IP addresses in ARP + pkts. */ }; /* Flags to indicate behavior of the physical port. These flags are @@ -166,7 +174,8 @@ enum ofp_port_config { OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */ OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */ - OFPPC_NO_RECV = 1 << 2, /* Drop most packets received on port. */ + OFPPC_NO_RECV = 1 << 2, /* Drop all packets except 802.1D + spanning tree packets. */ OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */ OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */ OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */ @@ -227,8 +236,9 @@ OFP_ASSERT(sizeof(struct ofp_phy_port) == 48); /* Switch features. */ struct ofp_switch_features { struct ofp_header header; - uint64_t datapath_id; /* Datapath unique ID. Only the lower 48-bits - are meaningful. */ + uint64_t datapath_id; /* Datapath unique ID. The lower 48-bits are for + a MAC address, while the upper 16-bits are + implementer-defined. */ uint32_t n_buffers; /* Max packets buffered at once. */ @@ -313,8 +323,10 @@ enum ofp_action_type { OFPAT_SET_DL_DST, /* Ethernet destination address. */ OFPAT_SET_NW_SRC, /* IP source address. */ OFPAT_SET_NW_DST, /* IP destination address. */ + OFPAT_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */ OFPAT_SET_TP_SRC, /* TCP/UDP source port. */ OFPAT_SET_TP_DST, /* TCP/UDP destination port. */ + OFPAT_ENQUEUE, /* Output to queue. */ OFPAT_VENDOR = 0xffff }; @@ -370,6 +382,15 @@ struct ofp_action_nw_addr { }; OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8); +/* Action structure for OFPAT_SET_NW_TOS. */ +struct ofp_action_nw_tos { + uint16_t type; /* OFPAT_SET_TW_TOS. */ + uint16_t len; /* Length is 8. */ + uint8_t nw_tos; /* IP TOS (DSCP field, 6 bits). */ + uint8_t pad[3]; +}; +OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8); + /* Action structure for OFPAT_SET_TP_SRC/DST. */ struct ofp_action_tp_port { uint16_t type; /* OFPAT_SET_TP_SRC/DST. */ @@ -409,6 +430,7 @@ union ofp_action { 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); @@ -436,14 +458,14 @@ enum ofp_flow_mod_command { /* Flow wildcards. */ enum ofp_flow_wildcards { - OFPFW_IN_PORT = 1 << 0, /* Switch input port. */ - OFPFW_DL_VLAN = 1 << 1, /* VLAN. */ - OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */ - OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */ - OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */ - OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */ - OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */ - OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */ + OFPFW_IN_PORT = 1 << 0, /* Switch input port. */ + OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */ + OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */ + OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */ + OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */ + OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */ + OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */ + OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */ /* IP source address wildcard bit count. 0 is exact match, 1 ignores the * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard @@ -460,8 +482,11 @@ enum ofp_flow_wildcards { OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT, OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT, + OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */ + OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */ + /* Wildcard all fields. */ - OFPFW_ALL = ((1 << 20) - 1) + OFPFW_ALL = ((1 << 22) - 1) }; /* The wildcards for ICMP type and code fields use the transport source @@ -492,15 +517,19 @@ struct ofp_match { uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */ uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */ uint16_t dl_vlan; /* Input VLAN. */ + uint8_t dl_vlan_pcp; /* Input VLAN priority. */ + uint8_t pad1[1]; /* Align to 64-bits. */ uint16_t dl_type; /* Ethernet frame type. */ - uint8_t nw_proto; /* IP protocol. */ - uint8_t pad; /* Align to 32-bits. */ + uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */ + uint8_t nw_proto; /* IP protocol or lower 8 bits of + ARP opcode. */ + uint8_t pad2[2]; /* Align to 64-bits. */ uint32_t nw_src; /* IP source address. */ uint32_t nw_dst; /* IP destination address. */ uint16_t tp_src; /* TCP/UDP source port. */ uint16_t tp_dst; /* TCP/UDP destination port. */ }; -OFP_ASSERT(sizeof(struct ofp_match) == 36); +OFP_ASSERT(sizeof(struct ofp_match) == 40); /* The match fields for ICMP type and code use the transport source and * destination port fields, respectively. */ @@ -514,10 +543,18 @@ OFP_ASSERT(sizeof(struct ofp_match) == 36); /* 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. */ +}; + /* Flow setup and teardown (controller -> datapath). */ struct ofp_flow_mod { struct ofp_header header; struct ofp_match match; /* Fields to match */ + uint64_t cookie; /* Opaque controller-issued identifier. */ /* Flow actions. */ uint16_t command; /* One of OFPFC_*. */ @@ -530,35 +567,39 @@ struct ofp_flow_mod { matching entries to include this as an output port. A value of OFPP_NONE indicates no restriction. */ - uint8_t pad[2]; /* Align to 32-bits. */ - uint32_t reserved; /* Reserved for future use. */ + uint16_t flags; /* One of OFPFF_*. */ struct ofp_action_header actions[0]; /* The action length is inferred from the length field in the header. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_mod) == 64); +OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72); -/* Why did this flow expire? */ -enum ofp_flow_expired_reason { - OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */ - OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */ +/* Why was this flow removed? */ +enum ofp_flow_removed_reason { + OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */ + OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */ + OFPRR_DELETE /* Evicted by a DELETE flow mod. */ }; -/* Flow expiration (datapath -> controller). */ -struct ofp_flow_expired { +/* Flow removed (datapath -> controller). */ +struct ofp_flow_removed { struct ofp_header header; struct ofp_match match; /* Description of fields. */ + uint64_t cookie; /* Opaque controller-issued identifier. */ uint16_t priority; /* Priority level of flow entry. */ - uint8_t reason; /* One of OFPER_*. */ + uint8_t reason; /* One of OFPRR_*. */ uint8_t pad[1]; /* Align to 32-bits. */ - uint32_t duration; /* Time flow was alive in seconds. */ - uint8_t pad2[4]; /* Align to 64-bits. */ + uint32_t duration_sec; /* Time flow was alive in seconds. */ + uint32_t duration_nsec; /* Time flow was alive in nanoseconds beyond + duration_sec. */ + uint16_t idle_timeout; /* Idle timeout from original flow mod. */ + uint8_t pad2[2]; /* Align to 64-bits. */ uint64_t packet_count; uint64_t byte_count; }; -OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72); +OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88); /* Values for 'type' in ofp_error_message. These values are immutable: they * will not change in future versions of the protocol (although new values may @@ -568,13 +609,15 @@ enum ofp_error_type { OFPET_BAD_REQUEST, /* Request was not understood. */ OFPET_BAD_ACTION, /* Error in action description. */ OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */ - OFPET_PORT_MOD_FAILED /* OFPT_PORT_MOD failed. */ + OFPET_PORT_MOD_FAILED, /* OFPT_PORT_MOD failed. */ + OFPET_QUEUE_OP_FAILED /* Queue operation failed. */ }; /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an * ASCII text string that may give failure details. */ enum ofp_hello_failed_code { - OFPHFC_INCOMPATIBLE /* No compatible version. */ + OFPHFC_INCOMPATIBLE, /* No compatible version. */ + OFPHFC_EPERM /* Permissions error. */ }; /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least @@ -586,9 +629,10 @@ enum ofp_bad_request_code { OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header * or ofp_stats_request or ofp_stats_reply). */ OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */ - OFPBRC_BAD_LENGTH, /* Wrong request length for type. */ + OFPBRC_EPERM, /* Permissions error. */ + OFPBRC_BAD_LEN, /* Wrong request length for type. */ OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */ - OFPBRC_BAD_COOKIE /* Specified buffer does not exist. */ + OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */ }; /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least @@ -600,14 +644,23 @@ enum ofp_bad_action_code { OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */ OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */ OFPBAC_BAD_ARGUMENT, /* Bad action argument. */ - OFPBAC_TOO_MANY /* Can't handle this many actions. */ + OFPBAC_EPERM, /* Permissions error. */ + OFPBAC_TOO_MANY, /* Can't handle this many actions. */ + OFPBAC_BAD_QUEUE /* Problem validating output queue. */ }; /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains * at least the first 64 bytes of the failed request. */ enum ofp_flow_mod_failed_code { OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */ - OFPFMFC_BAD_COMMAND /* Unknown command. */ + OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with + * CHECK_OVERLAP flag set. */ + OFPFMFC_EPERM, /* Permissions error. */ + OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard + * timeout. */ + OFPFMFC_BAD_COMMAND, /* Unknown command. */ + OFPFMFC_UNSUPPORTED /* Unsupported action list - cannot process in + the order specified. */ }; /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains @@ -617,6 +670,14 @@ enum ofp_port_mod_failed_code { OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */ }; +/* ofp_error msg 'code' values for OFPET_QUEUE_OP_FAILED. 'data' contains + * at least the first 64 bytes of the failed request */ +enum ofp_queue_op_failed_code { + OFPQOFC_BAD_PORT, /* Invalid port (or port does not exist). */ + OFPQOFC_BAD_QUEUE, /* Queue does not exist. */ + OFPQOFC_EPERM /* Permissions error. */ +}; + /* OFPT_ERROR: Error message (datapath -> controller). */ struct ofp_error_msg { struct ofp_header header; @@ -650,10 +711,15 @@ enum ofp_stats_types { OFPST_TABLE, /* Physical port statistics. - * The request body is empty. + * The request body is struct ofp_port_stats_request. * The reply body is an array of struct ofp_port_stats. */ OFPST_PORT, + /* Queue statistics for a port + * The request body defines the port + * The reply body is an array of struct ofp_queue_stats */ + OFPST_QUEUE, + /* Vendor extension. * The request and reply bodies begin with a 32-bit vendor ID, which takes * the same form as in "struct ofp_vendor_header". The request and reply @@ -690,8 +756,10 @@ struct ofp_desc_stats { 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) == 800); +OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056); /* Body for ofp_stats_request of type OFPST_FLOW. */ struct ofp_flow_stats_request { @@ -703,7 +771,7 @@ 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) == 40); +OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 44); /* Body of reply to OFPST_FLOW request. */ struct ofp_flow_stats { @@ -711,17 +779,20 @@ struct ofp_flow_stats { uint8_t table_id; /* ID of table flow came from. */ uint8_t pad; struct ofp_match match; /* Description of fields. */ - uint32_t duration; /* Time flow has been alive in seconds. */ + uint32_t duration_sec; /* Time flow has been alive in seconds. */ + uint32_t duration_nsec; /* Time flow has been alive in nanoseconds + beyond duration_sec. */ uint16_t priority; /* Priority of the entry. Only meaningful when this is not an exact-match entry. */ uint16_t idle_timeout; /* Number of seconds idle before expiration. */ uint16_t hard_timeout; /* Number of seconds before expiration. */ - uint16_t pad2[3]; /* Pad to 64 bits. */ + uint8_t pad2[6]; /* Align to 64 bits. */ + uint64_t cookie; /* Opaque controller-issued identifier. */ uint64_t packet_count; /* Number of packets in flow. */ uint64_t byte_count; /* Number of bytes in flow. */ struct ofp_action_header actions[0]; /* Actions. */ }; -OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72); +OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88); /* Body for ofp_stats_request of type OFPST_AGGREGATE. */ struct ofp_aggregate_stats_request { @@ -733,7 +804,7 @@ struct ofp_aggregate_stats_request { as an output port. A value of OFPP_NONE indicates no restriction. */ }; -OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40); +OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 44); /* Body of reply to OFPST_AGGREGATE request. */ struct ofp_aggregate_stats_reply { @@ -759,6 +830,15 @@ struct ofp_table_stats { }; OFP_ASSERT(sizeof(struct ofp_table_stats) == 64); +/* Body for ofp_stats_request of type OFPST_PORT. */ +struct ofp_port_stats_request { + uint16_t 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) == 8); + /* Body of reply to OFPST_PORT request. If a counter is unsupported, set * the field to all ones. */ struct ofp_port_stats {