X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fofp-util.h;h=a3c12fc73e8e338b08b5cb7d42083c59a4e31c5f;hb=2be393edd3a94772ef430054dc72ec794c450981;hp=c2b0e2a005c5c29bbb1a914b3fb28c91c6d42b00;hpb=27527aa09ce456796eeea728cef9528aa5612b70;p=sliver-openvswitch.git diff --git a/lib/ofp-util.h b/lib/ofp-util.h index c2b0e2a00..a3c12fc73 100644 --- a/lib/ofp-util.h +++ b/lib/ofp-util.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,6 +23,7 @@ #include #include "classifier.h" #include "flow.h" +#include "netdev.h" #include "openflow/nicira-ext.h" #include "openvswitch/types.h" @@ -61,6 +62,7 @@ enum ofputil_msg_code { OFPUTIL_OFPST_TABLE_REQUEST, OFPUTIL_OFPST_PORT_REQUEST, OFPUTIL_OFPST_QUEUE_REQUEST, + OFPUTIL_OFPST_PORT_DESC_REQUEST, /* OFPST_* stat replies. */ OFPUTIL_OFPST_DESC_REPLY, @@ -69,6 +71,7 @@ enum ofputil_msg_code { OFPUTIL_OFPST_PORT_REPLY, OFPUTIL_OFPST_TABLE_REPLY, OFPUTIL_OFPST_AGGREGATE_REPLY, + OFPUTIL_OFPST_PORT_DESC_REPLY, /* NXT_* messages. */ OFPUTIL_NXT_ROLE_REQUEST, @@ -102,6 +105,9 @@ enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *); const char *ofputil_msg_type_name(const struct ofputil_msg_type *); /* Port numbers. */ +enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port); +ovs_be32 ofputil_port_to_ofp11(uint16_t ofp10_port); + enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports); bool ofputil_port_from_string(const char *, uint16_t *port); void ofputil_format_port(uint16_t port, struct ds *); @@ -147,6 +153,8 @@ extern enum ofputil_protocol ofputil_flow_dump_protocols[]; extern size_t ofputil_n_flow_dump_protocols; enum ofputil_protocol ofputil_protocol_from_ofp_version(int version); +uint8_t ofputil_protocol_to_ofp_version(enum ofputil_protocol); + bool ofputil_protocol_is_valid(enum ofputil_protocol); enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol, bool enable); @@ -287,7 +295,7 @@ struct ofputil_packet_in { const void *packet; size_t packet_len; - enum ofp_packet_in_reason reason; /* One of OFPRR_*. */ + enum ofp_packet_in_reason reason; /* One of OFPR_*. */ uint16_t controller_id; /* Controller ID to send to. */ uint8_t table_id; ovs_be64 cookie; @@ -308,12 +316,15 @@ const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason); bool ofputil_packet_in_reason_from_string(const char *, enum ofp_packet_in_reason *); -/* Abstract packet-out message. */ +/* Abstract packet-out message. + * + * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port + * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */ struct ofputil_packet_out { const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */ size_t packet_len; /* Length of packet data in bytes. */ uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */ - uint16_t in_port; /* Packet's input port or OFPP_NONE. */ + uint16_t in_port; /* Packet's input port. */ union ofp_action *actions; /* Actions. */ size_t n_actions; /* Number of elements in 'actions' array. */ }; @@ -322,6 +333,147 @@ enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *, const struct ofp_packet_out *); struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *); +enum ofputil_port_config { + /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */ + OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */ + OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */ + OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */ + OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */ + /* OpenFlow 1.0 only. */ + OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */ + OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */ + OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */ + /* There are no OpenFlow 1.1-only bits. */ +}; + +enum ofputil_port_state { + /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */ + OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */ + /* OpenFlow 1.1 only. */ + OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */ + OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */ + /* OpenFlow 1.0 only. */ + OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */ + OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */ + OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */ + OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */ + OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */ +}; + +/* Abstract ofp10_phy_port or ofp11_port. */ +struct ofputil_phy_port { + uint16_t port_no; + uint8_t hw_addr[OFP_ETH_ALEN]; + char name[OFP_MAX_PORT_NAME_LEN]; + enum ofputil_port_config config; + enum ofputil_port_state state; + + /* NETDEV_F_* feature bitmasks. */ + enum netdev_features curr; /* Current features. */ + enum netdev_features advertised; /* Features advertised by the port. */ + enum netdev_features supported; /* Features supported by the port. */ + enum netdev_features peer; /* Features advertised by peer. */ + + /* Speed. */ + uint32_t curr_speed; /* Current speed, in kbps. */ + uint32_t max_speed; /* Maximum supported speed, in kbps. */ +}; + +enum ofputil_capabilities { + /* OpenFlow 1.0 and 1.1 share these values for these capabilities. */ + OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */ + OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */ + OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */ + OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */ + OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */ + OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */ + + /* OpenFlow 1.0 only. */ + OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */ + + /* OpenFlow 1.1 only. */ + OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */ +}; + +enum ofputil_action_bitmap { + OFPUTIL_A_OUTPUT = 1 << 0, + OFPUTIL_A_SET_VLAN_VID = 1 << 1, + OFPUTIL_A_SET_VLAN_PCP = 1 << 2, + OFPUTIL_A_STRIP_VLAN = 1 << 3, + OFPUTIL_A_SET_DL_SRC = 1 << 4, + OFPUTIL_A_SET_DL_DST = 1 << 5, + OFPUTIL_A_SET_NW_SRC = 1 << 6, + OFPUTIL_A_SET_NW_DST = 1 << 7, + OFPUTIL_A_SET_NW_ECN = 1 << 8, + OFPUTIL_A_SET_NW_TOS = 1 << 9, + OFPUTIL_A_SET_TP_SRC = 1 << 10, + OFPUTIL_A_SET_TP_DST = 1 << 11, + OFPUTIL_A_ENQUEUE = 1 << 12, + OFPUTIL_A_COPY_TTL_OUT = 1 << 13, + OFPUTIL_A_COPY_TTL_IN = 1 << 14, + OFPUTIL_A_SET_MPLS_LABEL = 1 << 15, + OFPUTIL_A_SET_MPLS_TC = 1 << 16, + OFPUTIL_A_SET_MPLS_TTL = 1 << 17, + OFPUTIL_A_DEC_MPLS_TTL = 1 << 18, + OFPUTIL_A_PUSH_VLAN = 1 << 19, + OFPUTIL_A_POP_VLAN = 1 << 20, + OFPUTIL_A_PUSH_MPLS = 1 << 21, + OFPUTIL_A_POP_MPLS = 1 << 22, + OFPUTIL_A_SET_QUEUE = 1 << 23, + OFPUTIL_A_GROUP = 1 << 24, + OFPUTIL_A_SET_NW_TTL = 1 << 25, + OFPUTIL_A_DEC_NW_TTL = 1 << 26, +}; + +/* Abstract ofp_switch_features. */ +struct ofputil_switch_features { + uint64_t datapath_id; /* Datapath unique ID. */ + uint32_t n_buffers; /* Max packets buffered at once. */ + uint8_t n_tables; /* Number of tables supported by datapath. */ + enum ofputil_capabilities capabilities; + enum ofputil_action_bitmap actions; +}; + +enum ofperr ofputil_decode_switch_features(const struct ofp_switch_features *, + struct ofputil_switch_features *, + struct ofpbuf *); + +struct ofpbuf *ofputil_encode_switch_features( + const struct ofputil_switch_features *, enum ofputil_protocol, + ovs_be32 xid); +void ofputil_put_switch_features_port(const struct ofputil_phy_port *, + struct ofpbuf *); + +/* phy_port helper functions. */ +int ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *, + struct ofputil_phy_port *); +size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *); + +/* Abstract ofp_port_status. */ +struct ofputil_port_status { + enum ofp_port_reason reason; + struct ofputil_phy_port desc; +}; + +enum ofperr ofputil_decode_port_status(const struct ofp_port_status *, + struct ofputil_port_status *); +struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *, + enum ofputil_protocol); + +/* Abstract ofp_port_mod. */ +struct ofputil_port_mod { + uint16_t port_no; + uint8_t hw_addr[OFP_ETH_ALEN]; + enum ofputil_port_config config; + enum ofputil_port_config mask; + enum netdev_features advertise; +}; + +enum ofperr ofputil_decode_port_mod(const struct ofp_header *, + struct ofputil_port_mod *); +struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *, + enum ofputil_protocol); + /* OpenFlow protocol utility functions. */ void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **); void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **); @@ -352,6 +504,10 @@ void ofputil_start_stats_reply(const struct ofp_stats_msg *request, struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *); void *ofputil_append_stats_reply(size_t len, struct list *); +void ofputil_append_port_desc_stats_reply(uint8_t ofp_version, + const struct ofputil_phy_port *pp, + struct list *replies); + const void *ofputil_stats_body(const struct ofp_header *); size_t ofputil_stats_body_len(const struct ofp_header *); @@ -376,26 +532,27 @@ struct ofpbuf *ofputil_encode_barrier_request(void); const char *ofputil_frag_handling_to_string(enum ofp_config_flags); bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *); + /* Actions. */ /* The type of an action. * - * For each implemented OFPAT_* and NXAST_* action type, there is a + * For each implemented OFPAT10_* and NXAST_* action type, there is a * corresponding constant prefixed with OFPUTIL_, e.g.: * - * OFPUTIL_OFPAT_OUTPUT - * OFPUTIL_OFPAT_SET_VLAN_VID - * OFPUTIL_OFPAT_SET_VLAN_PCP - * OFPUTIL_OFPAT_STRIP_VLAN - * OFPUTIL_OFPAT_SET_DL_SRC - * OFPUTIL_OFPAT_SET_DL_DST - * OFPUTIL_OFPAT_SET_NW_SRC - * OFPUTIL_OFPAT_SET_NW_DST - * OFPUTIL_OFPAT_SET_NW_TOS - * OFPUTIL_OFPAT_SET_TP_SRC - * OFPUTIL_OFPAT_SET_TP_DST - * OFPUTIL_OFPAT_ENQUEUE + * OFPUTIL_OFPAT10_OUTPUT + * OFPUTIL_OFPAT10_SET_VLAN_VID + * OFPUTIL_OFPAT10_SET_VLAN_PCP + * OFPUTIL_OFPAT10_STRIP_VLAN + * OFPUTIL_OFPAT10_SET_DL_SRC + * OFPUTIL_OFPAT10_SET_DL_DST + * OFPUTIL_OFPAT10_SET_NW_SRC + * OFPUTIL_OFPAT10_SET_NW_DST + * OFPUTIL_OFPAT10_SET_NW_TOS + * OFPUTIL_OFPAT10_SET_TP_SRC + * OFPUTIL_OFPAT10_SET_TP_DST + * OFPUTIL_OFPAT10_ENQUEUE * OFPUTIL_NXAST_RESUBMIT * OFPUTIL_NXAST_SET_TUNNEL * OFPUTIL_NXAST_SET_QUEUE @@ -417,14 +574,14 @@ bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *); * (The above list helps developers who want to "grep" for these definitions.) */ enum ofputil_action_code { -#define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM, +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM, #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM, #include "ofp-util.def" }; /* The number of values of "enum ofputil_action_code". */ enum { -#define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1 +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1 OFPUTIL_N_ACTIONS = 0 #include "ofp-util.def" @@ -452,7 +609,7 @@ void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf); * Appends a new 'action', of length 'sizeof(struct )', to 'buf', * initializes it with ofputil_init_(), and returns it. */ -#define OFPAT_ACTION(ENUM, STRUCT, NAME) \ +#define OFPAT10_ACTION(ENUM, STRUCT, NAME) \ void ofputil_init_##ENUM(struct STRUCT *); \ struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *); #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \