/*
- * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
-#define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM \
- | OFPUTIL_FF_NO_PKT_COUNTS \
- | OFPUTIL_FF_NO_BYT_COUNTS)
- /* Flags that affect flow_mod behavior but are not part of flow state. */
+ /* These flags primarily affects flow_mod behavior. They are not
+ * particularly useful as part of flow state. We include them in flow
+ * state only because OpenFlow implies that they should be. */
OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
- OFPUTIL_FF_EMERG = 1 << 4, /* OpenFlow 1.0 only. */
- OFPUTIL_FF_RESET_COUNTS = 1 << 5, /* OpenFlow 1.2+. */
+ OFPUTIL_FF_RESET_COUNTS = 1 << 4, /* OpenFlow 1.2+. */
+
+ /* Not supported by OVS. */
+ OFPUTIL_FF_EMERG = 1 << 5, /* OpenFlow 1.0 only. */
+
+ /* The set of flags maintained as part of a flow table entry. */
+#define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM \
+ | OFPUTIL_FF_NO_PKT_COUNTS \
+ | OFPUTIL_FF_NO_BYT_COUNTS \
+ | OFPUTIL_FF_CHECK_OVERLAP \
+ | OFPUTIL_FF_RESET_COUNTS)
/* Flags that are only set by OVS for its internal use. Cannot be set via
* OpenFlow. */
const void *packet;
size_t packet_len; /* Number of bytes in 'packet'. */
size_t total_len; /* Size of packet, pre-truncation. */
- struct flow_metadata fmd;
+ struct match flow_metadata;
/* Identifies a buffer in the switch that contains the full packet, to
* allow the controller to reference it later without having to send the
/* Abstract ofp10_phy_port or ofp11_port. */
struct ofputil_phy_port {
ofp_port_t port_no;
- uint8_t hw_addr[OFP_ETH_ALEN];
+ struct eth_addr hw_addr;
char name[OFP_MAX_PORT_NAME_LEN];
enum ofputil_port_config config;
enum ofputil_port_state state;
/* Abstract ofp_port_mod. */
struct ofputil_port_mod {
ofp_port_t port_no;
- uint8_t hw_addr[OFP_ETH_ALEN];
+ struct eth_addr hw_addr;
enum ofputil_port_config config;
enum ofputil_port_config mask;
enum netdev_features advertise;
OFPUTIL_TABLE_MISS_DROP, /* Drop the packet. */
};
-ovs_be32 ofputil_table_miss_to_config(enum ofputil_table_miss,
- enum ofp_version);
+/* Abstract version of OFPTC14_EVICTION.
+ *
+ * OpenFlow 1.0 through 1.3 don't know anything about eviction, so decoding a
+ * message for one of these protocols always yields
+ * OFPUTIL_TABLE_EVICTION_DEFAULT. */
+enum ofputil_table_eviction {
+ OFPUTIL_TABLE_EVICTION_DEFAULT, /* No value. */
+ OFPUTIL_TABLE_EVICTION_ON, /* Enable eviction. */
+ OFPUTIL_TABLE_EVICTION_OFF /* Disable eviction. */
+};
+
+/* Abstract version of OFPTC14_VACANCY_EVENTS.
+ *
+ * OpenFlow 1.0 through 1.3 don't know anything about vacancy events, so
+ * decoding a message for one of these protocols always yields
+ * OFPUTIL_TABLE_VACANCY_DEFAULT. */
+enum ofputil_table_vacancy {
+ OFPUTIL_TABLE_VACANCY_DEFAULT, /* No value. */
+ OFPUTIL_TABLE_VACANCY_ON, /* Enable vacancy events. */
+ OFPUTIL_TABLE_VACANCY_OFF /* Disable vacancy events. */
+};
+
+/* Abstract version of OFPTMPT_VACANCY.
+ *
+ * Openflow 1.4+ defines vacancy events.
+ * The fields vacancy_down and vacancy_up are the threshold for generating
+ * vacancy events that should be configured on the flow table, expressed as
+ * a percent.
+ * The vacancy field is only used when this property in included in a
+ * OFPMP_TABLE_DESC multipart reply or a OFPT_TABLE_STATUS message and
+ * represent the current vacancy of the table, expressed as a percent. In
+ * OFP_TABLE_MOD requests, this field must be set to 0 */
+struct ofputil_table_mod_prop_vacancy {
+ uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
+ uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
+ uint8_t vacancy; /* Current vacancy (%). */
+};
/* Abstract ofp_table_mod. */
struct ofputil_table_mod {
uint8_t table_id; /* ID of the table, 0xff indicates all tables. */
- enum ofputil_table_miss miss_config;
+
+ /* OpenFlow 1.1 and 1.2 only. For other versions, ignored on encoding,
+ * decoded to OFPUTIL_TABLE_MISS_DEFAULT. */
+ enum ofputil_table_miss miss;
+
+ /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
+ * OFPUTIL_TABLE_EVICTION_DEFAULT. */
+ enum ofputil_table_eviction eviction;
+
+ /* OpenFlow 1.4+ only and optional even there; UINT32_MAX indicates
+ * absence. For other versions, ignored on encoding, decoded to
+ * UINT32_MAX.*/
+ uint32_t eviction_flags; /* OFPTMPEF14_*. */
+
+ /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
+ * OFPUTIL_TABLE_VACANCY_DEFAULT. */
+ enum ofputil_table_vacancy vacancy;
+
+ /* Openflow 1.4+ only. Defines threshold values of vacancy expressed as
+ * percent, value of current vacancy is set to zero for table-mod.
+ * For other versions, ignored on encoding, all values decoded to
+ * zero. */
+ struct ofputil_table_mod_prop_vacancy table_vacancy;
+};
+
+/* Abstract ofp14_table_desc. */
+struct ofputil_table_desc {
+ uint8_t table_id; /* ID of the table. */
+ enum ofputil_table_eviction eviction;
+ uint32_t eviction_flags; /* UINT32_MAX if not present. */
+ enum ofputil_table_vacancy vacancy;
+ struct ofputil_table_mod_prop_vacancy table_vacancy;
};
enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
enum ofputil_protocol);
-/* Abstract ofp_table_features. */
+/* Abstract ofp_table_features.
+ *
+ * This is used for all versions of OpenFlow, even though ofp_table_features
+ * was only introduced in OpenFlow 1.3, because earlier versions of OpenFlow
+ * include support for a subset of ofp_table_features through OFPST_TABLE (aka
+ * OFPMP_TABLE). */
struct ofputil_table_features {
uint8_t table_id; /* Identifier of table. Lower numbered tables
are consulted first. */
char name[OFP_MAX_TABLE_NAME_LEN];
ovs_be64 metadata_match; /* Bits of metadata table can match. */
ovs_be64 metadata_write; /* Bits of metadata table can write. */
- enum ofputil_table_miss miss_config;
uint32_t max_entries; /* Max number of entries supported. */
+ /* Flags.
+ *
+ * 'miss_config' is relevant for OpenFlow 1.1 and 1.2 only, because those
+ * versions include OFPTC_MISS_* flags in OFPST_TABLE. For other versions,
+ * it is decoded to OFPUTIL_TABLE_MISS_DEFAULT and ignored for encoding.
+ *
+ * 'supports_eviction' and 'supports_vacancy_events' are relevant only for
+ * OpenFlow 1.4 and later only. For OF1.4, they are boolean: 1 if
+ * supported, otherwise 0. For other versions, they are decoded as -1 and
+ * ignored for encoding.
+ *
+ * See the section "OFPTC_* Table Configuration" in DESIGN.md for more
+ * details of how OpenFlow has changed in this area.
+ */
+ enum ofputil_table_miss miss_config; /* OF1.1 and 1.2 only. */
+ int supports_eviction; /* OF1.4+ only. */
+ int supports_vacancy_events; /* OF1.4+ only. */
+
/* Table features related to instructions. There are two instances:
*
* - 'miss' reports features available in the table miss flow.
int ofputil_decode_table_features(struct ofpbuf *,
struct ofputil_table_features *, bool loose);
+
+int ofputil_decode_table_desc(struct ofpbuf *,
+ struct ofputil_table_desc *,
+ enum ofp_version);
+
struct ofpbuf *ofputil_encode_table_features_request(enum ofp_version);
+struct ofpbuf *ofputil_encode_table_desc_request(enum ofp_version);
+
void ofputil_append_table_features_reply(
const struct ofputil_table_features *tf, struct ovs_list *replies);
+void ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
+ struct ovs_list *replies,
+ enum ofp_version);
+
/* Meter band configuration for all supported band types. */
struct ofputil_meter_band {
uint16_t type;
};
struct ofpbuf *ofputil_encode_table_stats_reply(const struct ofp_header *rq);
+
+struct ofpbuf *ofputil_encode_table_desc_reply(const struct ofp_header *rq);
+
void ofputil_append_table_stats_reply(struct ofpbuf *reply,
const struct ofputil_table_stats *,
const struct ofputil_table_features *);
const struct ofp_header *msg;
};
+enum ofptype;
+
enum ofperr ofputil_decode_bundle_ctrl(const struct ofp_header *,
struct ofputil_bundle_ctrl_msg *);
+struct ofpbuf *ofputil_encode_bundle_ctrl_request(enum ofp_version,
+ struct ofputil_bundle_ctrl_msg *);
struct ofpbuf *ofputil_encode_bundle_ctrl_reply(const struct ofp_header *,
struct ofputil_bundle_ctrl_msg *);
struct ofputil_bundle_add_msg *msg);
enum ofperr ofputil_decode_bundle_add(const struct ofp_header *,
- struct ofputil_bundle_add_msg *);
+ struct ofputil_bundle_add_msg *,
+ enum ofptype *type);
+
+struct ofputil_geneve_map {
+ struct ovs_list list_node;
+
+ uint16_t option_class;
+ uint8_t option_type;
+ uint8_t option_len;
+ uint16_t index;
+};
+
+struct ofputil_geneve_table_mod {
+ uint16_t command;
+ struct ovs_list mappings; /* Contains "struct ofputil_geneve_map"s. */
+};
+
+struct ofputil_geneve_table_reply {
+ uint32_t max_option_space;
+ uint16_t max_fields;
+ struct ovs_list mappings; /* Contains "struct ofputil_geneve_map"s. */
+};
+
+struct ofpbuf *ofputil_encode_geneve_table_mod(enum ofp_version ofp_version,
+ struct ofputil_geneve_table_mod *);
+enum ofperr ofputil_decode_geneve_table_mod(const struct ofp_header *,
+ struct ofputil_geneve_table_mod *);
+struct ofpbuf *ofputil_encode_geneve_table_reply(const struct ofp_header *,
+ struct ofputil_geneve_table_reply *);
+enum ofperr ofputil_decode_geneve_table_reply(const struct ofp_header *,
+ struct ofputil_geneve_table_reply *);
+void ofputil_uninit_geneve_table(struct ovs_list *mappings);
+
+enum ofputil_async_msg_type {
+ OAM_PACKET_IN, /* OFPT_PACKET_IN or NXT_PACKET_IN. */
+ OAM_PORT_STATUS, /* OFPT_PORT_STATUS. */
+ OAM_FLOW_REMOVED, /* OFPT_FLOW_REMOVED or
+ * NXT_FLOW_REMOVED. */
+ OAM_ROLE_STATUS, /* OFPT_ROLE_STATUS. */
+ OAM_TABLE_STATUS, /* OFPT_TABLE_STATUS. */
+ OAM_REQUESTFORWARD, /* OFPT_REQUESTFORWARD. */
+ OAM_N_TYPES
+};
+
+enum ofperr ofputil_decode_set_async_config(const struct ofp_header *,
+ uint32_t master[OAM_N_TYPES],
+ uint32_t slave[OAM_N_TYPES],
+ bool loose);
+
+struct ofpbuf *ofputil_encode_get_async_config(const struct ofp_header *,
+ uint32_t master[OAM_N_TYPES],
+ uint32_t slave[OAM_N_TYPES]);
+
+struct ofputil_requestforward {
+ ovs_be32 xid;
+ enum ofp14_requestforward_reason reason;
+ union {
+ /* reason == OFPRFR_METER_MOD. */
+ struct {
+ struct ofputil_meter_mod *meter_mod;
+ struct ofpbuf bands;
+ };
+
+ /* reason == OFPRFR_GROUP_MOD. */
+ struct ofputil_group_mod *group_mod;
+ };
+};
+
+struct ofpbuf *ofputil_encode_requestforward(
+ const struct ofputil_requestforward *, enum ofputil_protocol);
+enum ofperr ofputil_decode_requestforward(const struct ofp_header *,
+ struct ofputil_requestforward *);
+void ofputil_destroy_requestforward(struct ofputil_requestforward *);
+
#endif /* ofp-util.h */
projects / cascardo / ovs.git / blobdiff