mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 01:51:26 +00:00
Code Issues Releases Wiki Activity
ovs/ofproto/ofproto.h
Adrian Moreno 5b99ebc268 ofproto: Add ofproto-dpif-lsample. 
Add a new resource in ofproto-dpif and the corresponding API in
ofproto_provider.h to represent and local sampling configuration.

Acked-by: Eelco Chaudron <echaudro@redhat.com>
Signed-off-by: Adrian Moreno <amorenoz@redhat.com>
Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
2024-07-15 11:15:30 +02:00

598 lines
23 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) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 OFPROTO_H
#define OFPROTO_H 1
#include <sys/types.h>
#include <netinet/in.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "cfm.h"
#include "classifier.h"
#include "flow.h"
#include "openvswitch/meta-flow.h"
#include "netflow.h"
#include "rstp.h"
#include "smap.h"
#include "sset.h"
#include "stp.h"
#include "lacp.h"
#ifdef __cplusplus
extern "C" {
#endif
struct bfd_cfg;
struct cfm_settings;
struct cls_rule;
struct netdev;
struct netdev_stats;
struct ofport;
struct ofproto;
struct shash;
struct simap;
struct smap;
struct netdev_stats;
struct ovs_list;
struct lldp_status;
struct aa_settings;
struct aa_mapping_settings;
/* Needed for the lock annotations. */
extern struct ovs_mutex ofproto_mutex;
struct ofproto_controller_info {
bool is_connected;
enum ofp12_controller_role role;
struct smap pairs;
};
struct ofproto_sflow_options {
struct sset targets;
uint32_t sampling_rate;
uint32_t polling_interval;
uint32_t header_len;
uint32_t sub_id;
char *agent_device;
char *control_ip;
};
/* When using UDP, IPFIX Template Records must be re-sent regularly.
* The standard default interval is 10 minutes (600 seconds).
* Cf. IETF RFC 5101 Section 10.3.6. */
#define OFPROTO_IPFIX_DEFAULT_TEMPLATE_INTERVAL 600
struct ofproto_ipfix_bridge_exporter_options {
struct sset targets;
uint32_t sampling_rate;
uint32_t obs_domain_id; /* Bridge-wide Observation Domain ID. */
uint32_t obs_point_id; /* Bridge-wide Observation Point ID. */
uint32_t cache_active_timeout;
uint32_t cache_max_flows;
uint32_t template_interval;
uint32_t stats_interval;
bool enable_tunnel_sampling;
bool enable_input_sampling;
bool enable_output_sampling;
char *virtual_obs_id;
};
struct ofproto_ipfix_flow_exporter_options {
uint32_t collector_set_id;
struct sset targets;
uint32_t cache_active_timeout;
uint32_t cache_max_flows;
uint32_t template_interval;
uint32_t stats_interval;
bool enable_tunnel_sampling;
char *virtual_obs_id;
};
struct ofproto_lsample_options {
uint32_t collector_set_id;
uint32_t group_id;
};
struct ofproto_rstp_status {
bool enabled; /* If false, ignore other members. */
rstp_identifier root_id;
rstp_identifier bridge_id;
rstp_identifier designated_id;
uint32_t root_path_cost;
uint16_t designated_port_id;
uint16_t bridge_port_id;
};
struct ofproto_rstp_settings {
rstp_identifier address;
uint16_t priority;
uint32_t ageing_time;
enum rstp_force_protocol_version force_protocol_version;
uint16_t bridge_forward_delay;
uint16_t bridge_max_age;
uint16_t transmit_hold_count;
};
struct ofproto_port_rstp_status {
bool enabled; /* If false, ignore other members. */
uint16_t port_id;
enum rstp_port_role role;
enum rstp_state state;
rstp_identifier designated_bridge_id;
uint16_t designated_port_id;
uint32_t designated_path_cost;
int tx_count; /* Number of BPDUs transmitted. */
int rx_count; /* Number of valid BPDUs received. */
int error_count; /* Number of bad BPDUs received. */
int uptime;
};
struct ofproto_port_rstp_settings {
bool enable;
uint16_t port_num; /* In the range 1-4095, inclusive. */
uint8_t priority;
uint32_t path_cost;
bool admin_edge_port;
bool auto_edge;
bool mcheck;
uint8_t admin_p2p_mac_state;
bool admin_port_state;
};
struct ofproto_stp_settings {
stp_identifier system_id;
uint16_t priority;
uint16_t hello_time;
uint16_t max_age;
uint16_t fwd_delay;
};
struct ofproto_stp_status {
bool enabled; /* If false, ignore other members. */
stp_identifier bridge_id;
stp_identifier designated_root;
int root_path_cost;
};
struct ofproto_port_stp_settings {
bool enable;
uint8_t port_num; /* In the range 1-255, inclusive. */
uint8_t priority;
uint16_t path_cost;
};
struct ofproto_port_stp_status {
bool enabled; /* If false, ignore other members. */
int port_id;
enum stp_state state;
unsigned int sec_in_state;
enum stp_role role;
};
struct ofproto_port_stp_stats {
bool enabled; /* If false, ignore other members. */
int tx_count; /* Number of BPDUs transmitted. */
int rx_count; /* Number of valid BPDUs received. */
int error_count; /* Number of bad BPDUs received. */
};
struct ofproto_port_queue {
uint32_t queue; /* Queue ID. */
uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
};
struct ofproto_mcast_snooping_settings {
bool flood_unreg; /* If true, flood unregistered packets to all
all ports. If false, send only to ports
connected to multicast routers. */
unsigned int idle_time; /* Entry is removed after the idle time
* in seconds. */
unsigned int max_entries; /* Size of the multicast snooping table. */
};
struct ofproto_mcast_snooping_port_settings {
bool flood; /* If true, flood multicast traffic */
bool flood_reports; /* If true, flood Reports traffic */
};
/* How the switch should act if the controller cannot be contacted. */
enum ofproto_fail_mode {
OFPROTO_FAIL_SECURE, /* Preserve flow table. */
OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
};
enum ofproto_band {
OFPROTO_IN_BAND, /* In-band connection to controller. */
OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
};
/* ofproto supports two kinds of OpenFlow connections:
*
* - "Primary" connections to ordinary OpenFlow controllers. ofproto
* maintains persistent connections to these controllers and by default
* sends them asynchronous messages such as packet-ins.
*
* - "Service" connections, e.g. from ovs-ofctl. When these connections
* drop, it is the other side's responsibility to reconnect them if
* necessary. ofproto does not send them asynchronous messages by default.
*/
enum ofconn_type {
OFCONN_PRIMARY, /* An ordinary OpenFlow controller. */
OFCONN_SERVICE /* A service connection, e.g. "ovs-ofctl". */
};
const char *ofconn_type_to_string(enum ofconn_type);
/* Configuration for an OpenFlow controller. */
struct ofproto_controller {
enum ofconn_type type; /* Primary or service controller. */
int max_backoff; /* Maximum reconnection backoff, in seconds. */
int probe_interval; /* Max idle time before probing, in seconds. */
enum ofproto_band band; /* In-band or out-of-band? */
bool enable_async_msgs; /* Initially enable asynchronous messages? */
uint32_t allowed_versions; /* OpenFlow protocol versions that may
* be negotiated for a session. */
/* OpenFlow packet-in rate-limiting. */
int max_pktq_size; /* Maximum number of packet-in to be queued. */
int rate_limit; /* Max packet-in rate in packets per second. */
int burst_limit; /* Limit on accumulating packet credits. */
uint8_t dscp; /* DSCP value for controller connection. */
};
void ofproto_enumerate_types(struct sset *types);
const char *ofproto_normalize_type(const char *);
int ofproto_enumerate_names(const char *type, struct sset *names);
void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
/* An interface hint element, which is used by ofproto_init() to
* describe the caller's understanding of the startup state. */
struct iface_hint {
char *br_name; /* Name of owning bridge. */
char *br_type; /* Type of owning bridge. */
ofp_port_t ofp_port; /* OpenFlow port number. */
};
void ofproto_init(const struct shash *iface_hints);
int ofproto_type_run(const char *datapath_type);
void ofproto_type_wait(const char *datapath_type);
int ofproto_create(const char *datapath, const char *datapath_type,
struct ofproto **ofprotop)
OVS_EXCLUDED(ofproto_mutex);
void ofproto_destroy(struct ofproto *, bool del);
int ofproto_delete(const char *name, const char *type);
int ofproto_run(struct ofproto *);
void ofproto_wait(struct ofproto *);
bool ofproto_is_alive(const struct ofproto *);
void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
/* A port within an OpenFlow switch.
*
* 'name' and 'type' are suitable for passing to netdev_open(). */
struct ofproto_port {
char *name; /* Network device name, e.g. "eth0". */
char *type; /* Network device type, e.g. "system". */
ofp_port_t ofp_port; /* OpenFlow port number. */
};
void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
void ofproto_port_destroy(struct ofproto_port *);
struct ofproto_port_dump {
const struct ofproto *ofproto;
int error;
void *state;
};
void ofproto_port_dump_start(struct ofproto_port_dump *,
const struct ofproto *);
bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
int ofproto_port_dump_done(struct ofproto_port_dump *);
/* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
*
* Arguments all have pointer type.
*
* If you break out of the loop, then you need to free the dump structure by
* hand using ofproto_port_dump_done(). */
#define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
for (ofproto_port_dump_start(DUMP, OFPROTO); \
(ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
? true \
: (ofproto_port_dump_done(DUMP), false)); \
)
#define OFPROTO_FLOW_LIMIT_DEFAULT 200000
#define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
#define OFPROTO_MAX_REVALIDATOR_DEFAULT 500 /* ms */
#define OFPROTO_MIN_REVALIDATE_PPS_DEFAULT 5
#define OFPROTO_OFFLOADED_STATS_DELAY 2000 /* ms */
const char *ofproto_port_open_type(const struct ofproto *,
const char *port_type);
int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
void ofproto_port_set_config(struct ofproto *, ofp_port_t ofp_port,
const struct smap *cfg);
int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
int ofproto_vport_get_status(const struct ofproto *, ofp_port_t ofp_port,
char **errp);
int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
struct ofproto_port *);
/* Top-level configuration. */
uint64_t ofproto_get_datapath_id(const struct ofproto *);
void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
void ofproto_set_controllers(struct ofproto *, struct shash *controllers);
void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
void ofproto_reconnect_controllers(struct ofproto *);
void ofproto_set_extra_in_band_remotes(struct ofproto *,
const struct sockaddr_in *, size_t n);
void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
void ofproto_set_bundle_idle_timeout(unsigned timeout);
void ofproto_set_flow_limit(unsigned limit);
void ofproto_set_max_idle(unsigned max_idle);
void ofproto_set_max_revalidator(unsigned max_revalidator);
void ofproto_set_min_revalidate_pps(unsigned min_revalidate_pps);
void ofproto_set_offloaded_stats_delay(unsigned offloaded_stats_delay);
void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
size_t max_entries);
int ofproto_set_mcast_snooping(struct ofproto *ofproto,
const struct ofproto_mcast_snooping_settings *s);
int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
const struct ofproto_mcast_snooping_port_settings *s);
void ofproto_set_threads(int n_handlers, int n_revalidators);
void ofproto_type_set_config(const char *type,
const struct smap *other_config);
void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
void ofproto_set_serial_desc(struct ofproto *p, const char *serial_desc);
int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
int ofproto_set_netflow(struct ofproto *,
const struct netflow_options *nf_options);
int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
int ofproto_set_ipfix(struct ofproto *,
const struct ofproto_ipfix_bridge_exporter_options *,
const struct ofproto_ipfix_flow_exporter_options *,
size_t);
int ofproto_set_local_sample(struct ofproto *ofproto,
const struct ofproto_lsample_options *,
size_t n_options);
void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
bool ofproto_get_flow_restore_wait(void);
int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *);
int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *);
void ofproto_set_vlan_limit(int vlan_limit);
void ofproto_ct_set_zone_timeout_policy(const char *datapath_type,
uint16_t zone,
struct simap *timeout_policy);
void ofproto_ct_del_zone_timeout_policy(const char *datapath_type,
uint16_t zone);
void ofproto_ct_zone_limit_update(const char *datapath_type, int32_t zone_id,
int64_t *limit);
void ofproto_ct_zone_limit_protection_update(const char *datapath_type,
bool protected);
void ofproto_get_datapath_cap(const char *datapath_type,
struct smap *dp_cap);
/* Configuration of ports. */
void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
const struct cfm_settings *);
void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
const struct smap *cfg);
bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port);
int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
struct smap *);
int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
int ofproto_port_get_lacp_stats(const struct ofport *,
struct lacp_member_stats *);
int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
const struct ofproto_port_stp_settings *);
int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
struct ofproto_port_stp_status *);
int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
struct ofproto_port_stp_stats *);
int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
const struct ofproto_port_queue *,
size_t n_queues);
int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port,
struct ofproto_port_rstp_status *);
int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port,
const struct ofproto_port_rstp_settings *);
/* The behaviour of the port regarding VLAN handling */
enum port_vlan_mode {
/* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
* ignored. */
PORT_VLAN_ACCESS,
/* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
* ignored. */
PORT_VLAN_TRUNK,
/* Untagged incoming packets are part of 'vlan', as are incoming packets
* tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
* Other VLANs in 'trunks' are trunked. */
PORT_VLAN_NATIVE_TAGGED,
/* Untagged incoming packets are part of 'vlan', as are incoming packets
* tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
* Other VLANs in 'trunks' are trunked. */
PORT_VLAN_NATIVE_UNTAGGED,
/* 802.1q tunnel port. Incoming packets are added an outer vlan tag
* 'vlan'. If 'cvlans' is set, only allows VLANs in 'cvlans'. */
PORT_VLAN_DOT1Q_TUNNEL
};
/* The behaviour of the port regarding priority tags */
enum port_priority_tags_mode {
PORT_PRIORITY_TAGS_NEVER = 0,
PORT_PRIORITY_TAGS_IF_NONZERO,
PORT_PRIORITY_TAGS_ALWAYS,
};
/* The behaviour of the port regarding priority tags */
/* Configuration of bundles. */
struct ofproto_bundle_settings {
char *name; /* For use in log messages. */
ofp_port_t *members; /* OpenFlow port numbers for members. */
size_t n_members;
enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
uint16_t qinq_ethtype;
int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
unsigned long *cvlans;
enum port_priority_tags_mode use_priority_tags;
/* Use 802.1p tag for frames in VLAN 0? */
struct bond_settings *bond; /* Must be nonnull iff if n_members > 1. */
struct lacp_settings *lacp; /* Nonnull to enable LACP. */
struct lacp_member_settings *lacp_members; /* Array of n_members elements. */
bool protected; /* Protected port mode */
};
int ofproto_bundle_register(struct ofproto *, void *aux,
const struct ofproto_bundle_settings *);
int ofproto_bundle_unregister(struct ofproto *, void *aux);
/* Configuration of mirrors. */
struct ofproto_mirror_settings {
/* Name for log messages. */
char *name;
/* Bundles that select packets for mirroring upon ingress. */
void **srcs; /* A set of registered ofbundle handles. */
size_t n_srcs;
/* Bundles that select packets for mirroring upon egress. */
void **dsts; /* A set of registered ofbundle handles. */
size_t n_dsts;
/* VLANs of packets to select for mirroring. */
unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
/* Output (mutually exclusive). */
void *out_bundle; /* A registered ofbundle handle or NULL. */
uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
uint16_t snaplen; /* Max packet size of a mirrored packet
in byte, set to 0 equals 65535. */
};
int ofproto_mirror_register(struct ofproto *, void *aux,
const struct ofproto_mirror_settings *);
int ofproto_mirror_unregister(struct ofproto *, void *aux);
int ofproto_mirror_get_stats(struct ofproto *, void *aux,
uint64_t *packets, uint64_t *bytes);
void ofproto_port_set_lldp(struct ofproto *ofproto, ofp_port_t ofp_port,
const struct smap *cfg);
int ofproto_set_aa(struct ofproto *ofproto, void *aux,
const struct aa_settings *s);
int ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
const struct aa_mapping_settings *s);
int ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux);
int ofproto_aa_vlan_get_queued(struct ofproto *ofproto, struct ovs_list *list);
unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto);
int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
/* Configuration of OpenFlow tables. */
struct ofproto_table_settings {
char *name; /* Name exported via OpenFlow or NULL. */
unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
/* These members, together with OpenFlow OFPT_TABLE_MOD, determine the
* handling of an attempt to add a flow that would cause the table to have
* more than 'max_flows' flows:
*
* - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable
* eviction, overflows will be rejected with an error.
*
* - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an
* overflow will cause a flow to be removed. The flow to be removed
* is chosen to give fairness among groups distinguished by different
* values for the 'n_groups' subfields within 'groups'. */
bool enable_eviction;
struct mf_subfield *groups;
size_t n_groups;
/*
* Fields for which prefix trie lookup is maintained.
*/
unsigned int n_prefix_fields;
enum mf_field_id prefix_fields[CLS_MAX_TRIES];
};
extern const enum mf_field_id default_prefix_fields[2];
BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES);
int ofproto_get_n_tables(const struct ofproto *);
uint8_t ofproto_get_n_visible_tables(const struct ofproto *);
void ofproto_configure_table(struct ofproto *, int table_id,
const struct ofproto_table_settings *);
/* Configuration querying. */
bool ofproto_has_snoops(const struct ofproto *);
void ofproto_get_snoops(const struct ofproto *, struct sset *);
void ofproto_get_all_flows(struct ofproto *p, struct ds *, bool);
void ofproto_get_netflow_ids(const struct ofproto *,
uint8_t *engine_type, uint8_t *engine_id);
void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
void ofproto_free_ofproto_controller_info(struct shash *);
bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port);
int ofproto_port_get_cfm_status(const struct ofproto *,
ofp_port_t ofp_port,
struct cfm_status *);
/* Table configuration */
enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *,
uint8_t table_id);
void ofproto_ref(struct ofproto *);
void ofproto_unref(struct ofproto *);
bool ofproto_try_ref(struct ofproto *);
#ifdef __cplusplus
}
#endif
#endif /* ofproto.h */
Reference in New Issue View Git Blame Copy Permalink