X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ofproto%2Fofproto.h;h=e4abe523d4873f5389dbdf31a4ef0e23d042c88a;hb=refs%2Fheads%2Fmanual;hp=2fb951a23743b29f40629e3484a58dfdbfbc11cd;hpb=892815f564700501888139823ad282355a691e10;p=openvswitch diff --git a/ofproto/ofproto.h b/ofproto/ofproto.h index 2fb951a2..e4abe523 100644 --- a/ofproto/ofproto.h +++ b/ofproto/ofproto.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, 2011 Nicira Networks. + * Copyright (c) 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. @@ -22,20 +22,25 @@ #include #include #include +#include "cfm.h" #include "flow.h" #include "netflow.h" #include "sset.h" +#include "stp.h" #include "tag.h" #ifdef __cplusplus extern "C" { #endif -struct cfm; +struct cfm_settings; struct cls_rule; struct netdev; struct ofproto; +struct ofport; struct shash; +struct simap; +struct netdev_stats; struct ofproto_controller_info { bool is_connected; @@ -64,6 +69,44 @@ struct ofproto_sflow_options { char *control_ip; }; +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; + 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]). */ +}; + /* How the switch should act if the controller cannot be contacted. */ enum ofproto_fail_mode { OFPROTO_FAIL_SECURE, /* Preserve flow table. */ @@ -79,28 +122,54 @@ struct ofproto_controller { char *target; /* e.g. "tcp:127.0.0.1" */ 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? */ + enum ofproto_band band; /* In-band or out-of-band? */ + bool enable_async_msgs; /* Initially enable asynchronous messages? */ /* OpenFlow packet-in rate-limiting. */ 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. */ }; -#define DEFAULT_MFR_DESC "Nicira Networks, Inc." +#define DEFAULT_MFR_DESC "Nicira, Inc." #define DEFAULT_HW_DESC "Open vSwitch" -#define DEFAULT_SW_DESC VERSION BUILDNR +#define DEFAULT_SW_DESC VERSION #define DEFAULT_SERIAL_DESC "None" #define DEFAULT_DP_DESC "None" +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. */ + uint16_t ofp_port; /* OpenFlow port number. */ +}; + +void ofproto_init(const struct shash *iface_hints); + +int ofproto_type_run(const char *datapath_type); +int ofproto_type_run_fast(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); void ofproto_destroy(struct ofproto *); +int ofproto_delete(const char *name, const char *type); + int ofproto_run(struct ofproto *); +int ofproto_run_fast(struct ofproto *); void ofproto_wait(struct ofproto *); bool ofproto_is_alive(const struct ofproto *); +void ofproto_get_memory_usage(const struct ofproto *, struct simap *); + /* A port within an OpenFlow switch. * * 'name' and 'type' are suitable for passing to netdev_open(). */ @@ -135,21 +204,32 @@ int ofproto_port_dump_done(struct ofproto_port_dump *); : (ofproto_port_dump_done(DUMP), false)); \ ) +#define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 1000 +#define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100 + +const char *ofproto_port_open_type(const char *datapath_type, + const char *port_type); int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp); int ofproto_port_del(struct ofproto *, uint16_t ofp_port); +int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats); 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 *, - const struct ofproto_controller *, size_t n); + const struct ofproto_controller *, size_t n, + uint32_t allowed_versions); 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_flow_eviction_threshold(struct ofproto *, unsigned threshold); +void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu); +void ofproto_set_mac_idle_time(struct ofproto *, unsigned idle_time); void ofproto_set_desc(struct ofproto *, const char *mfr_desc, const char *hw_desc, const char *sw_desc, const char *serial_desc, @@ -157,18 +237,45 @@ void ofproto_set_desc(struct ofproto *, int ofproto_set_snoops(struct ofproto *, const struct sset *snoops); int ofproto_set_netflow(struct ofproto *, const struct netflow_options *nf_options); -void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *); +int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *); +int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *); +int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *); /* Configuration of ports. */ - void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port); void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port); void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port, - const struct cfm *, - const uint16_t *remote_mps, size_t n_remote_mps); -const struct cfm *ofproto_port_get_cfm(struct ofproto *, uint16_t ofp_port); + const struct cfm_settings *); int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port); +int ofproto_port_set_stp(struct ofproto *, uint16_t ofp_port, + const struct ofproto_port_stp_settings *); +int ofproto_port_get_stp_status(struct ofproto *, uint16_t ofp_port, + struct ofproto_port_stp_status *); +int ofproto_port_set_queues(struct ofproto *, uint16_t ofp_port, + const struct ofproto_port_queue *, + size_t n_queues); + +/* 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 +}; /* Configuration of bundles. */ struct ofproto_bundle_settings { @@ -177,18 +284,29 @@ struct ofproto_bundle_settings { uint16_t *slaves; /* OpenFlow port numbers for slaves. */ size_t n_slaves; - int vlan; /* VLAN if access port, -1 if trunk port. */ - unsigned long *trunks; /* vlan_bitmap, NULL to trunk all VLANs. */ + enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */ + int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */ + unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */ + bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */ struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */ + uint32_t *bond_stable_ids; /* Array of n_slaves elements. */ struct lacp_settings *lacp; /* Nonnull to enable LACP. */ struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */ + + /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.) + * + * This is deprecated. It is only for compatibility with broken device + * drivers in old versions of Linux that do not properly support VLANs when + * VLAN devices are not used. When broken device drivers are no longer in + * widespread use, we will delete these interfaces. */ + uint16_t realdev_ofp_port; /* OpenFlow port number of real device. */ }; -void ofproto_bundle_register(struct ofproto *, void *aux, - const struct ofproto_bundle_settings *); -void ofproto_bundle_unregister(struct ofproto *, void *aux); +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 { @@ -211,12 +329,35 @@ struct ofproto_mirror_settings { uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */ }; -void ofproto_mirror_register(struct ofproto *, void *aux, - const struct ofproto_mirror_settings *); -void ofproto_mirror_unregister(struct ofproto *, void *aux); +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); + +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 determine the handling of an attempt to add a flow that + * would cause the table to have more than 'max_flows' flows. + * + * If 'groups' is NULL, overflows will be rejected with an error. + * + * If 'groups' is nonnull, 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 subfields within 'groups'. */ + struct mf_subfield *groups; + size_t n_groups; +}; -void ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans); -bool ofproto_is_mirror_output_bundle(struct ofproto *, void *aux); +int ofproto_get_n_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 *); @@ -224,9 +365,27 @@ void ofproto_get_snoops(const struct ofproto *, struct sset *); void ofproto_get_all_flows(struct ofproto *p, struct ds *); void ofproto_get_netflow_ids(const struct ofproto *, uint8_t *engine_type, uint8_t *engine_id); - +int ofproto_port_get_cfm_fault(const struct ofproto *, uint16_t ofp_port); +int ofproto_port_get_cfm_opup(const struct ofproto *, uint16_t ofp_port); +int ofproto_port_get_cfm_remote_mpids(const struct ofproto *, + uint16_t ofp_port, const uint64_t **rmps, + size_t *n_rmps); +int ofproto_port_get_cfm_health(const struct ofproto *ofproto, + uint16_t ofp_port); void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *); void ofproto_free_ofproto_controller_info(struct shash *); + +/* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.) + * + * This is deprecated. It is only for compatibility with broken device drivers + * in old versions of Linux that do not properly support VLANs when VLAN + * devices are not used. When broken device drivers are no longer in + * widespread use, we will delete these interfaces. */ + +void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap); +bool ofproto_has_vlan_usage_changed(const struct ofproto *); +int ofproto_port_set_realdev(struct ofproto *, uint16_t vlandev_ofp_port, + uint16_t realdev_ofp_port, int vid); #ifdef __cplusplus }