mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
Code Issues Releases Wiki Activity
ovs/lib/ofp-util.h
Thomas Graf ca6ba70092 list: Rename struct list to struct ovs_list 
struct list is a common name and can't be used in public headers.

Signed-off-by: Thomas Graf <tgraf@noironetworks.com>
Acked-by: Ben Pfaff <blp@nicira.com>
2014-12-15 14:15:12 +01:00

1109 lines
45 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef OFP_UTIL_H
#define OFP_UTIL_H 1
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "bitmap.h"
#include "compiler.h"
#include "flow.h"
#include "list.h"
#include "match.h"
#include "meta-flow.h"
#include "netdev.h"
#include "openflow/nicira-ext.h"
#include "openvswitch/types.h"
#include "type-props.h"
struct ofpbuf;
union ofp_action;
struct ofpact_set_field;
/* Port numbers. */
enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
ofp_port_t *ofp10_port);
ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
bool ofputil_port_from_string(const char *, ofp_port_t *portp);
void ofputil_format_port(ofp_port_t port, struct ds *);
void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
size_t bufsize);
/* Group numbers. */
enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
bool ofputil_group_from_string(const char *, uint32_t *group_id);
void ofputil_format_group(uint32_t group_id, struct ds *);
void ofputil_group_to_string(uint32_t group_id,
char namebuf[MAX_GROUP_NAME_LEN + 1],
size_t bufsize);
/* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
* to and from IP bitmasks. */
ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
int ofputil_netmask_to_wcbits(ovs_be32 netmask);
/* Protocols.
*
* A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
* a bit extra about the flow match format in use.
*
* These are arranged from most portable to least portable, or alternatively
* from least powerful to most powerful. Protocols earlier on the list are
* more likely to be understood for the purpose of making requests, but
* protocol later on the list are more likely to accurately describe a flow
* within a switch.
*
* On any given OpenFlow connection, a single protocol is in effect at any
* given time. These values use separate bits only because that makes it easy
* to test whether a particular protocol is within a given set of protocols and
* to implement set union and intersection.
*/
enum ofputil_protocol {
/* OpenFlow 1.0 protocols.
*
* The "STD" protocols use the standard OpenFlow 1.0 flow format.
* The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
*
* The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
* extension has been enabled. The other protocols have it disabled.
*/
#define OFPUTIL_P_NONE 0
OFPUTIL_P_OF10_STD = 1 << 0,
OFPUTIL_P_OF10_STD_TID = 1 << 1,
OFPUTIL_P_OF10_NXM = 1 << 2,
OFPUTIL_P_OF10_NXM_TID = 1 << 3,
#define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
#define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
#define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY)
/* OpenFlow 1.1 protocol.
*
* We only support the standard OpenFlow 1.1 flow format.
*
* OpenFlow 1.1 always operates with an equivalent of the
* nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
* variant. */
OFPUTIL_P_OF11_STD = 1 << 4,
/* OpenFlow 1.2+ protocols (only one variant each).
*
* These use the standard OpenFlow Extensible Match (OXM) flow format.
*
* OpenFlow 1.2+ always operates with an equivalent of the
* nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
* variant. */
OFPUTIL_P_OF12_OXM = 1 << 5,
OFPUTIL_P_OF13_OXM = 1 << 6,
OFPUTIL_P_OF14_OXM = 1 << 7,
OFPUTIL_P_OF15_OXM = 1 << 8,
#define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | \
OFPUTIL_P_OF13_OXM | \
OFPUTIL_P_OF14_OXM | \
OFPUTIL_P_OF15_OXM)
#define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
OFPUTIL_P_ANY_OXM)
#define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
#define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
#define OFPUTIL_P_OF12_UP (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_UP)
#define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM | OFPUTIL_P_OF14_UP)
#define OFPUTIL_P_OF14_UP (OFPUTIL_P_OF14_OXM | OFPUTIL_P_OF15_UP)
#define OFPUTIL_P_OF15_UP OFPUTIL_P_OF15_OXM
/* All protocols. */
#define OFPUTIL_P_ANY ((1 << 9) - 1)
/* Protocols in which a specific table may be specified in flow_mods. */
#define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
OFPUTIL_P_OF10_NXM_TID | \
OFPUTIL_P_OF11_STD | \
OFPUTIL_P_ANY_OXM)
};
/* Protocols to use for flow dumps, from most to least preferred. */
extern enum ofputil_protocol ofputil_flow_dump_protocols[];
extern size_t ofputil_n_flow_dump_protocols;
enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
enum ofp_version 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);
enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
enum ofputil_protocol ofputil_protocol_set_base(
enum ofputil_protocol cur, enum ofputil_protocol new_base);
const char *ofputil_protocol_to_string(enum ofputil_protocol);
char *ofputil_protocols_to_string(enum ofputil_protocol);
enum ofputil_protocol ofputil_protocols_from_string(const char *);
void ofputil_format_version(struct ds *, enum ofp_version);
void ofputil_format_version_name(struct ds *, enum ofp_version);
/* A bitmap of version numbers
*
* Bit offsets correspond to ofp_version numbers which in turn correspond to
* wire-protocol numbers for OpenFlow versions, e.g. (1u << OFP11_VERSION)
* is the mask for OpenFlow 1.1. If the bit for a version is set then it is
* allowed, otherwise it is disallowed. */
void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
enum ofp_version ofputil_version_from_string(const char *s);
uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
/* Bitmaps of OpenFlow versions that Open vSwitch supports, and that it enables
* by default. When Open vSwitch has experimental or incomplete support for
* newer versions of OpenFlow, those versions should not be supported by
* default and thus should be omitted from the latter bitmap. */
#define OFPUTIL_SUPPORTED_VERSIONS ((1u << OFP10_VERSION) | \
(1u << OFP11_VERSION) | \
(1u << OFP12_VERSION) | \
(1u << OFP13_VERSION))
#define OFPUTIL_DEFAULT_VERSIONS OFPUTIL_SUPPORTED_VERSIONS
enum ofputil_protocol ofputil_protocols_from_string(const char *s);
const char *ofputil_version_to_string(enum ofp_version ofp_version);
uint32_t ofputil_versions_from_string(const char *s);
uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
bool ofputil_decode_hello(const struct ofp_header *,
uint32_t *allowed_versions);
struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
enum ofputil_protocol want,
enum ofputil_protocol *next);
/* nx_flow_format */
struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
/* Work with ofp10_match. */
void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
void ofputil_match_from_ofp10_match(const struct ofp10_match *,
struct match *);
void ofputil_normalize_match(struct match *);
void ofputil_normalize_match_quiet(struct match *);
void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
/* Work with ofp11_match. */
enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
uint16_t *padded_match_len);
enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
struct match *);
int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
enum ofputil_protocol);
void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
int ofputil_match_typical_len(enum ofputil_protocol);
/* dl_type translation between OpenFlow and 'struct flow' format. */
ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
/* PACKET_IN. */
bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
int ofputil_packet_in_format_from_string(const char *);
const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
enum nx_packet_in_format);
/* NXT_FLOW_MOD_TABLE_ID extension. */
struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
/* Protocol-independent flow_mod flags. */
enum ofputil_flow_mod_flags {
/* Flags that are maintained with a flow as part of its state.
*
* (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
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. */
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+. */
/* Flags that are only set by OVS for its internal use. Cannot be set via
* OpenFlow. */
OFPUTIL_FF_HIDDEN_FIELDS = 1 << 6, /* Allow hidden match fields to be
set or modified. */
OFPUTIL_FF_NO_READONLY = 1 << 7, /* Allow rules within read only tables
to be modified */
};
/* Protocol-independent flow_mod.
*
* The handling of cookies across multiple versions of OpenFlow is a bit
* confusing. See DESIGN for the details. */
struct ofputil_flow_mod {
struct ovs_list list_node; /* For queuing flow_mods. */
struct match match;
int priority;
/* Cookie matching. The flow_mod affects only flows that have cookies that
* bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
*
* 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
ovs_be64 cookie; /* Cookie bits to match. */
ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
/* Cookie changes.
*
* OFPFC_ADD uses 'new_cookie' as the new flow's cookie. 'new_cookie'
* should not be UINT64_MAX.
*
* OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
*
* - If one or more matching flows exist and 'modify_cookie' is true,
* then the flow_mod changes the existing flows' cookies to
* 'new_cookie'. 'new_cookie' should not be UINT64_MAX.
*
* - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
* 'cookie_mask' is 0, then the flow_mod adds a new flow with
* 'new_cookie' as its cookie.
*/
ovs_be64 new_cookie; /* New cookie to install or UINT64_MAX. */
bool modify_cookie; /* Set cookie of existing flow to 'new_cookie'? */
uint8_t table_id;
uint16_t command;
uint16_t idle_timeout;
uint16_t hard_timeout;
uint32_t buffer_id;
ofp_port_t out_port;
uint32_t out_group;
enum ofputil_flow_mod_flags flags;
uint16_t importance; /* Eviction precedence. */
struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
size_t ofpacts_len; /* Length of ofpacts, in bytes. */
/* Reason for delete; ignored for non-delete commands */
enum ofp_flow_removed_reason delete_reason;
};
enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
const struct ofp_header *,
enum ofputil_protocol,
struct ofpbuf *ofpacts,
ofp_port_t max_port,
uint8_t max_table);
struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
enum ofputil_protocol);
/* Flow stats or aggregate stats request, independent of protocol. */
struct ofputil_flow_stats_request {
bool aggregate; /* Aggregate results? */
struct match match;
ovs_be64 cookie;
ovs_be64 cookie_mask;
ofp_port_t out_port;
uint32_t out_group;
uint8_t table_id;
};
enum ofperr ofputil_decode_flow_stats_request(
struct ofputil_flow_stats_request *, const struct ofp_header *);
struct ofpbuf *ofputil_encode_flow_stats_request(
const struct ofputil_flow_stats_request *, enum ofputil_protocol);
/* Flow stats reply, independent of protocol. */
struct ofputil_flow_stats {
struct match match;
ovs_be64 cookie;
uint8_t table_id;
uint16_t priority;
uint16_t idle_timeout;
uint16_t hard_timeout;
uint32_t duration_sec;
uint32_t duration_nsec;
int idle_age; /* Seconds since last packet, -1 if unknown. */
int hard_age; /* Seconds since last change, -1 if unknown. */
uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
const struct ofpact *ofpacts;
size_t ofpacts_len;
enum ofputil_flow_mod_flags flags;
uint16_t importance; /* Eviction precedence. */
};
int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
struct ofpbuf *msg,
bool flow_age_extension,
struct ofpbuf *ofpacts);
void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
struct ovs_list *replies);
/* Aggregate stats reply, independent of protocol. */
struct ofputil_aggregate_stats {
uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
uint32_t flow_count;
};
struct ofpbuf *ofputil_encode_aggregate_stats_reply(
const struct ofputil_aggregate_stats *stats,
const struct ofp_header *request);
enum ofperr ofputil_decode_aggregate_stats_reply(
struct ofputil_aggregate_stats *,
const struct ofp_header *reply);
/* Flow removed message, independent of protocol. */
struct ofputil_flow_removed {
struct match match;
ovs_be64 cookie;
uint16_t priority;
uint8_t reason; /* One of OFPRR_*. */
uint8_t table_id; /* 255 if message didn't include table ID. */
uint32_t duration_sec;
uint32_t duration_nsec;
uint16_t idle_timeout;
uint16_t hard_timeout;
uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
};
enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
const struct ofp_header *);
struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
enum ofputil_protocol);
/* Abstract packet-in message. */
struct ofputil_packet_in {
/* Packet data and metadata.
*
* To save bandwidth, in some cases a switch may send only the first
* several bytes of a packet, indicated by 'packet_len < total_len'. When
* the full packet is included, 'packet_len == total_len'. */
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;
/* Identifies a buffer in the switch that contains the full packet, to
* allow the controller to reference it later without having to send the
* entire packet back to the switch.
*
* UINT32_MAX indicates that the packet is not buffered in the switch. A
* switch should only use UINT32_MAX when it sends the entire packet. */
uint32_t buffer_id;
/* Reason that the packet-in is being sent. */
enum ofp_packet_in_reason reason; /* One of OFPR_*. */
/* Information about the OpenFlow flow that triggered the packet-in.
*
* A packet-in triggered by a flow table miss has no associated flow. In
* that case, 'cookie' is UINT64_MAX. */
uint8_t table_id; /* OpenFlow table ID. */
ovs_be64 cookie; /* Flow's cookie. */
};
enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
const struct ofp_header *);
struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
enum ofputil_protocol protocol,
enum nx_packet_in_format);
enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
char *reasonbuf,
size_t bufsize);
bool ofputil_packet_in_reason_from_string(const char *,
enum ofp_packet_in_reason *);
/* 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. */
ofp_port_t in_port; /* Packet's input port. */
struct ofpact *ofpacts; /* Actions. */
size_t ofpacts_len; /* Size of ofpacts in bytes. */
};
enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
const struct ofp_header *,
struct ofpbuf *ofpacts);
struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
enum ofputil_protocol protocol);
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 {
ofp_port_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, 1.1, 1.2, and 1.3 share these capability values. */
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. */
/* OpenFlow 1.0 and 1.1 share this capability. */
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, 1.2, and 1.3 share this capability. */
OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
/* OpenFlow 1.2 and 1.3 share this capability */
OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
};
/* 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. */
uint8_t auxiliary_id; /* Identify auxiliary connections */
enum ofputil_capabilities capabilities;
uint64_t ofpacts; /* Bitmap of OFPACT_* bits. */
};
enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
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 *);
bool ofputil_switch_features_has_ports(struct ofpbuf *b);
/* phy_port helper functions. */
int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
struct ofputil_phy_port *);
/* 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_header *,
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 {
ofp_port_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 *, bool loose);
struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
enum ofputil_protocol);
/* Abstract version of OFPTC11_TABLE_MISS_*.
*
* OpenFlow 1.0 always sends packets that miss to the next flow table, or to
* the controller if they miss in the last flow table.
*
* OpenFlow 1.1 and 1.2 can configure table miss behavior via a "table-mod"
* that specifies "send to controller", "miss", or "drop".
*
* OpenFlow 1.3 and later never sends packets that miss to the controller.
*/
enum ofputil_table_miss {
/* Protocol-specific default behavior. On OpenFlow 1.0 through 1.2
* connections, the packet is sent to the controller, and on OpenFlow 1.3
* and later connections, the packet is dropped.
*
* This is also used as a result of decoding OpenFlow 1.3+ "config" values
* in table-mods, to indicate that no table-miss was specified. */
OFPUTIL_TABLE_MISS_DEFAULT, /* Protocol default behavior. */
/* These constants have the same meanings as those in OpenFlow with the
* same names. */
OFPUTIL_TABLE_MISS_CONTROLLER, /* Send to controller. */
OFPUTIL_TABLE_MISS_CONTINUE, /* Go to next table. */
OFPUTIL_TABLE_MISS_DROP, /* Drop the packet. */
};
ovs_be32 ofputil_table_miss_to_config(enum ofputil_table_miss,
enum ofp_version);
/* 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;
};
enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
struct ofputil_table_mod *);
struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
enum ofputil_protocol);
/* Abstract ofp_table_features. */
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. */
/* Table features related to instructions. There are two instances:
*
* - 'miss' reports features available in the table miss flow.
*
* - 'nonmiss' reports features available in other flows. */
struct ofputil_table_instruction_features {
/* Tables that "goto-table" may jump to. */
unsigned long int next[BITMAP_N_LONGS(255)];
/* Bitmap of OVSINST_* for supported instructions. */
uint32_t instructions;
/* Table features related to actions. There are two instances:
*
* - 'write' reports features available in a "write_actions"
* instruction.
*
* - 'apply' reports features available in an "apply_actions"
* instruction. */
struct ofputil_table_action_features {
uint64_t ofpacts; /* Bitmap of supported OFPACT_*. */
struct mf_bitmap set_fields; /* Fields for "set-field". */
} write, apply;
} nonmiss, miss;
/* MFF_* bitmaps.
*
* For any given field the following combinations are valid:
*
* - match=0, wildcard=0, mask=0: Flows in this table cannot match on
* this field.
*
* - match=1, wildcard=0, mask=0: Flows in this table must match on all
* the bits in this field.
*
* - match=1, wildcard=1, mask=0: Flows in this table must either match
* on all the bits in the field or wildcard the field entirely.
*
* - match=1, wildcard=1, mask=1: Flows in this table may arbitrarily
* mask this field (as special cases, they may match on all the bits
* or wildcard it entirely).
*
* Other combinations do not make sense.
*/
struct mf_bitmap match; /* Fields that may be matched. */
struct mf_bitmap mask; /* Subset of 'match' that may have masks. */
struct mf_bitmap wildcard; /* Subset of 'match' that may be wildcarded. */
};
int ofputil_decode_table_features(struct ofpbuf *,
struct ofputil_table_features *, bool loose);
struct ofpbuf *ofputil_encode_table_features_request(enum ofp_version);
void ofputil_append_table_features_reply(
const struct ofputil_table_features *tf, struct ovs_list *replies);
/* Meter band configuration for all supported band types. */
struct ofputil_meter_band {
uint16_t type;
uint8_t prec_level; /* Non-zero if type == OFPMBT_DSCP_REMARK. */
uint32_t rate;
uint32_t burst_size;
};
struct ofputil_meter_band_stats {
uint64_t packet_count;
uint64_t byte_count;
};
struct ofputil_meter_config {
uint32_t meter_id;
uint16_t flags;
uint16_t n_bands;
struct ofputil_meter_band *bands;
};
/* Abstract ofp_meter_mod. */
struct ofputil_meter_mod {
uint16_t command;
struct ofputil_meter_config meter;
};
struct ofputil_meter_stats {
uint32_t meter_id;
uint32_t flow_count;
uint64_t packet_in_count;
uint64_t byte_in_count;
uint32_t duration_sec;
uint32_t duration_nsec;
uint16_t n_bands;
struct ofputil_meter_band_stats *bands;
};
struct ofputil_meter_features {
uint32_t max_meters; /* Maximum number of meters. */
uint32_t band_types; /* Can support max 32 band types. */
uint32_t capabilities; /* Supported flags. */
uint8_t max_bands;
uint8_t max_color;
};
enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
struct ofputil_meter_mod *,
struct ofpbuf *bands);
struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
const struct ofputil_meter_mod *);
void ofputil_decode_meter_features(const struct ofp_header *,
struct ofputil_meter_features *);
struct ofpbuf *ofputil_encode_meter_features_reply(const struct
ofputil_meter_features *,
const struct ofp_header *
request);
void ofputil_decode_meter_request(const struct ofp_header *,
uint32_t *meter_id);
void ofputil_append_meter_config(struct ovs_list *replies,
const struct ofputil_meter_config *);
void ofputil_append_meter_stats(struct ovs_list *replies,
const struct ofputil_meter_stats *);
enum ofputil_meter_request_type {
OFPUTIL_METER_FEATURES,
OFPUTIL_METER_CONFIG,
OFPUTIL_METER_STATS
};
struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
enum ofputil_meter_request_type,
uint32_t meter_id);
int ofputil_decode_meter_stats(struct ofpbuf *,
struct ofputil_meter_stats *,
struct ofpbuf *bands);
int ofputil_decode_meter_config(struct ofpbuf *,
struct ofputil_meter_config *,
struct ofpbuf *bands);
/* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
typedef struct { uint32_t uint32; } ofproto_meter_id;
/* Abstract ofp_role_request and reply. */
struct ofputil_role_request {
enum ofp12_controller_role role;
bool have_generation_id;
uint64_t generation_id;
};
struct ofputil_role_status {
enum ofp12_controller_role role;
enum ofp14_controller_role_reason reason;
uint64_t generation_id;
};
enum ofperr ofputil_decode_role_message(const struct ofp_header *,
struct ofputil_role_request *);
struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
const struct ofputil_role_request *);
struct ofpbuf *ofputil_encode_role_status(
const struct ofputil_role_status *status,
enum ofputil_protocol protocol);
enum ofperr ofputil_decode_role_status(const struct ofp_header *oh,
struct ofputil_role_status *rs);
/* Abstract table stats.
*
* This corresponds to the OpenFlow 1.3 table statistics structure, which only
* includes actual statistics. In earlier versions of OpenFlow, several
* members describe table features, so this structure has to be paired with
* struct ofputil_table_features to get all information. */
struct ofputil_table_stats {
uint8_t table_id; /* Identifier of table. */
uint32_t active_count; /* Number of active entries. */
uint64_t lookup_count; /* Number of packets looked up in table. */
uint64_t matched_count; /* Number of packets that hit table. */
};
struct ofpbuf *ofputil_encode_table_stats_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 *);
int ofputil_decode_table_stats_reply(struct ofpbuf *reply,
struct ofputil_table_stats *,
struct ofputil_table_features *);
/* Queue configuration request. */
struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version,
ofp_port_t port);
enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *,
ofp_port_t *port);
/* Queue configuration reply. */
struct ofputil_queue_config {
uint32_t queue_id;
/* Each of these optional values is expressed in tenths of a percent.
* Values greater than 1000 indicate that the feature is disabled.
* UINT16_MAX indicates that the value is omitted. */
uint16_t min_rate;
uint16_t max_rate;
};
struct ofpbuf *ofputil_encode_queue_get_config_reply(
const struct ofp_header *request);
void ofputil_append_queue_get_config_reply(
struct ofpbuf *reply, const struct ofputil_queue_config *);
enum ofperr ofputil_decode_queue_get_config_reply(struct ofpbuf *reply,
ofp_port_t *);
int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
struct ofputil_queue_config *);
/* Abstract nx_flow_monitor_request. */
struct ofputil_flow_monitor_request {
uint32_t id;
enum nx_flow_monitor_flags flags;
ofp_port_t out_port;
uint8_t table_id;
struct match match;
};
int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
struct ofpbuf *msg);
void ofputil_append_flow_monitor_request(
const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
/* Abstract nx_flow_update. */
struct ofputil_flow_update {
enum nx_flow_update_event event;
/* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
enum ofp_flow_removed_reason reason;
uint16_t idle_timeout;
uint16_t hard_timeout;
uint8_t table_id;
uint16_t priority;
ovs_be64 cookie;
struct match *match;
const struct ofpact *ofpacts;
size_t ofpacts_len;
/* Used only for NXFME_ABBREV. */
ovs_be32 xid;
};
int ofputil_decode_flow_update(struct ofputil_flow_update *,
struct ofpbuf *msg, struct ofpbuf *ofpacts);
void ofputil_start_flow_update(struct ovs_list *replies);
void ofputil_append_flow_update(const struct ofputil_flow_update *,
struct ovs_list *replies);
/* Abstract nx_flow_monitor_cancel. */
uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
/* Port desc stats requests and replies. */
enum ofperr ofputil_decode_port_desc_stats_request(const struct ofp_header *,
ofp_port_t *portp);
struct ofpbuf *ofputil_encode_port_desc_stats_request(
enum ofp_version ofp_version, ofp_port_t);
void ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
struct ovs_list *replies);
/* Encoding simple OpenFlow messages. */
struct ofpbuf *make_echo_request(enum ofp_version);
struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
/* Actions. */
bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
union ofp_action **, size_t *);
bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
const union ofp_action *b, size_t n_b);
union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
/* Handy utility for parsing flows and actions. */
bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
struct ofputil_port_stats {
ofp_port_t port_no;
struct netdev_stats stats;
uint32_t duration_sec; /* UINT32_MAX if unknown. */
uint32_t duration_nsec;
};
struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
ofp_port_t port);
void ofputil_append_port_stat(struct ovs_list *replies,
const struct ofputil_port_stats *ops);
size_t ofputil_count_port_stats(const struct ofp_header *);
int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
ofp_port_t *ofp10_port);
struct ofputil_queue_stats_request {
ofp_port_t port_no; /* OFPP_ANY means "all ports". */
uint32_t queue_id;
};
enum ofperr
ofputil_decode_queue_stats_request(const struct ofp_header *request,
struct ofputil_queue_stats_request *oqsr);
struct ofpbuf *
ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
const struct ofputil_queue_stats_request *oqsr);
struct ofputil_queue_stats {
ofp_port_t port_no;
uint32_t queue_id;
/* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
uint64_t tx_bytes;
uint64_t tx_packets;
uint64_t tx_errors;
/* UINT32_MAX if unknown. */
uint32_t duration_sec;
uint32_t duration_nsec;
};
size_t ofputil_count_queue_stats(const struct ofp_header *);
int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
void ofputil_append_queue_stat(struct ovs_list *replies,
const struct ofputil_queue_stats *oqs);
struct bucket_counter {
uint64_t packet_count; /* Number of packets processed by bucket. */
uint64_t byte_count; /* Number of bytes processed by bucket. */
};
/* Bucket for use in groups. */
struct ofputil_bucket {
struct ovs_list list_node;
uint16_t weight; /* Relative weight, for "select" groups. */
ofp_port_t watch_port; /* Port whose state affects whether this bucket
* is live. Only required for fast failover
* groups. */
uint32_t watch_group; /* Group whose state affects whether this
* bucket is live. Only required for fast
* failover groups. */
uint32_t bucket_id; /* Bucket Id used to identify bucket*/
struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
size_t ofpacts_len; /* Length of ofpacts, in bytes. */
struct bucket_counter stats;
};
/* Protocol-independent group_mod. */
struct ofputil_group_mod {
uint16_t command; /* One of OFPGC15_*. */
uint8_t type; /* One of OFPGT11_*. */
uint32_t group_id; /* Group identifier. */
uint32_t command_bucket_id; /* Bucket Id used as part of
* OFPGC15_INSERT_BUCKET and
* OFPGC15_REMOVE_BUCKET commands
* execution.*/
struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
};
/* Group stats reply, independent of protocol. */
struct ofputil_group_stats {
uint32_t group_id; /* Group identifier. */
uint32_t ref_count;
uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
uint32_t duration_sec; /* UINT32_MAX if unknown. */
uint32_t duration_nsec;
uint32_t n_buckets;
struct bucket_counter *bucket_stats;
};
/* Group features reply, independent of protocol.
*
* Only OF1.2 and later support group features replies. */
struct ofputil_group_features {
uint32_t types; /* Bitmap of OFPGT_* values supported. */
uint32_t capabilities; /* Bitmap of OFPGFC12_* capability supported. */
uint32_t max_groups[4]; /* Maximum number of groups for each type. */
uint64_t ofpacts[4]; /* Bitmaps of supported OFPACT_* */
};
/* Group desc reply, independent of protocol. */
struct ofputil_group_desc {
uint8_t type; /* One of OFPGT_*. */
uint32_t group_id; /* Group identifier. */
struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
};
void ofputil_bucket_list_destroy(struct ovs_list *buckets);
void ofputil_bucket_clone_list(struct ovs_list *dest,
const struct ovs_list *src,
const struct ofputil_bucket *);
struct ofputil_bucket *ofputil_bucket_find(const struct ovs_list *,
uint32_t bucket_id);
bool ofputil_bucket_check_duplicate_id(const struct ovs_list *);
struct ofputil_bucket *ofputil_bucket_list_front(const struct ovs_list *);
struct ofputil_bucket *ofputil_bucket_list_back(const struct ovs_list *);
static inline bool
ofputil_bucket_has_liveness(const struct ofputil_bucket *bucket)
{
return (bucket->watch_port != OFPP_ANY ||
bucket->watch_group != OFPG_ANY);
}
struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
uint32_t group_id);
enum ofperr ofputil_decode_group_stats_request(
const struct ofp_header *request, uint32_t *group_id);
void ofputil_append_group_stats(struct ovs_list *replies,
const struct ofputil_group_stats *);
struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
struct ofpbuf *ofputil_encode_group_features_reply(
const struct ofputil_group_features *, const struct ofp_header *request);
void ofputil_decode_group_features_reply(const struct ofp_header *,
struct ofputil_group_features *);
struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
const struct ofputil_group_mod *gm);
enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
struct ofputil_group_mod *);
int ofputil_decode_group_stats_reply(struct ofpbuf *,
struct ofputil_group_stats *);
uint32_t ofputil_decode_group_desc_request(const struct ofp_header *);
struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version,
uint32_t group_id);
int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
struct ofpbuf *, enum ofp_version);
void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
struct ovs_list *buckets,
struct ovs_list *replies);
struct ofputil_bundle_ctrl_msg {
uint32_t bundle_id;
uint16_t type;
uint16_t flags;
};
struct ofputil_bundle_add_msg {
uint32_t bundle_id;
uint16_t flags;
const struct ofp_header *msg;
};
enum ofperr ofputil_decode_bundle_ctrl(const struct ofp_header *,
struct ofputil_bundle_ctrl_msg *);
struct ofpbuf *ofputil_encode_bundle_ctrl_reply(const struct ofp_header *,
struct ofputil_bundle_ctrl_msg *);
struct ofpbuf *ofputil_encode_bundle_add(enum ofp_version ofp_version,
struct ofputil_bundle_add_msg *msg);
enum ofperr ofputil_decode_bundle_add(const struct ofp_header *,
struct ofputil_bundle_add_msg *);
#endif /* ofp-util.h */
Reference in New Issue View Git Blame Copy Permalink