ofproto/ofproto.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OFPROTO_H
  18 #define OFPROTO_H 1
  19
  20 #include <sys/types.h>
  21 #include <netinet/in.h>
  22 #include <stdbool.h>
  23 #include <stddef.h>
  24 #include <stdint.h>
  25 #include "cfm.h"
  26 #include "classifier.h"
  27 #include "flow.h"
  28 #include "openvswitch/meta-flow.h"
  29 #include "netflow.h"
  30 #include "rstp.h"
  31 #include "smap.h"
  32 #include "sset.h"
  33 #include "stp.h"
  34 #include "lacp.h"
  35
  36 #ifdef  __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct bfd_cfg;
  41 struct cfm_settings;
  42 struct cls_rule;
  43 struct netdev;
  44 struct netdev_stats;
  45 struct ofport;
  46 struct ofproto;
  47 struct shash;
  48 struct simap;
  49 struct smap;
  50 struct netdev_stats;
  51 struct ovs_list;
  52 struct lldp_status;
  53 struct aa_settings;
  54 struct aa_mapping_settings;
  55
  56 /* Needed for the lock annotations. */
  57 extern struct ovs_mutex ofproto_mutex;
  58
  59 struct ofproto_controller_info {
  60     bool is_connected;
  61     enum ofp12_controller_role role;
  62     struct smap pairs;
  63 };
  64
  65 struct ofproto_sflow_options {
  66     struct sset targets;
  67     uint32_t sampling_rate;
  68     uint32_t polling_interval;
  69     uint32_t header_len;
  70     uint32_t sub_id;
  71     char *agent_device;
  72     char *control_ip;
  73 };
  74
  75 struct ofproto_ipfix_bridge_exporter_options {
  76     struct sset targets;
  77     uint32_t sampling_rate;
  78     uint32_t obs_domain_id;  /* Bridge-wide Observation Domain ID. */
  79     uint32_t obs_point_id;  /* Bridge-wide Observation Point ID. */
  80     uint32_t cache_active_timeout;
  81     uint32_t cache_max_flows;
  82     bool enable_tunnel_sampling;
  83     bool enable_input_sampling;
  84     bool enable_output_sampling;
  85 };
  86
  87 struct ofproto_ipfix_flow_exporter_options {
  88     uint32_t collector_set_id;
  89     struct sset targets;
  90     uint32_t cache_active_timeout;
  91     uint32_t cache_max_flows;
  92     bool enable_tunnel_sampling;
  93 };
  94
  95 struct ofproto_rstp_status {
  96     bool enabled;               /* If false, ignore other members. */
  97     rstp_identifier root_id;
  98     rstp_identifier bridge_id;
  99     rstp_identifier designated_id;
 100     uint32_t root_path_cost;
 101     uint16_t designated_port_id;
 102     uint16_t bridge_port_id;
 103 };
 104
 105 struct ofproto_rstp_settings {
 106     rstp_identifier address;
 107     uint16_t priority;
 108     uint32_t ageing_time;
 109     enum rstp_force_protocol_version force_protocol_version;
 110     uint16_t bridge_forward_delay;
 111     uint16_t bridge_max_age;
 112     uint16_t transmit_hold_count;
 113 };
 114
 115 struct ofproto_port_rstp_status {
 116     bool enabled;               /* If false, ignore other members. */
 117     uint16_t port_id;
 118     enum rstp_port_role role;
 119     enum rstp_state state;
 120     rstp_identifier designated_bridge_id;
 121     uint16_t designated_port_id;
 122     uint32_t designated_path_cost;
 123     int tx_count;               /* Number of BPDUs transmitted. */
 124     int rx_count;               /* Number of valid BPDUs received. */
 125     int error_count;            /* Number of bad BPDUs received. */
 126     int uptime;
 127 };
 128
 129 struct ofproto_port_rstp_settings {
 130     bool enable;
 131     uint16_t port_num;           /* In the range 1-4095, inclusive. */
 132     uint8_t priority;
 133     uint32_t path_cost;
 134     bool admin_edge_port;
 135     bool auto_edge;
 136     bool mcheck;
 137     uint8_t admin_p2p_mac_state;
 138     bool admin_port_state;
 139 };
 140
 141 struct ofproto_stp_settings {
 142     stp_identifier system_id;
 143     uint16_t priority;
 144     uint16_t hello_time;
 145     uint16_t max_age;
 146     uint16_t fwd_delay;
 147 };
 148
 149 struct ofproto_stp_status {
 150     bool enabled;               /* If false, ignore other members. */
 151     stp_identifier bridge_id;
 152     stp_identifier designated_root;
 153     int root_path_cost;
 154 };
 155
 156 struct ofproto_port_stp_settings {
 157     bool enable;
 158     uint8_t port_num;           /* In the range 1-255, inclusive. */
 159     uint8_t priority;
 160     uint16_t path_cost;
 161 };
 162
 163 struct ofproto_port_stp_status {
 164     bool enabled;               /* If false, ignore other members. */
 165     int port_id;
 166     enum stp_state state;
 167     unsigned int sec_in_state;
 168     enum stp_role role;
 169 };
 170
 171 struct ofproto_port_stp_stats {
 172     bool enabled;               /* If false, ignore other members. */
 173     int tx_count;               /* Number of BPDUs transmitted. */
 174     int rx_count;               /* Number of valid BPDUs received. */
 175     int error_count;            /* Number of bad BPDUs received. */
 176 };
 177
 178 struct ofproto_port_queue {
 179     uint32_t queue;             /* Queue ID. */
 180     uint8_t dscp;               /* DSCP bits (e.g. [0, 63]). */
 181 };
 182
 183 struct ofproto_mcast_snooping_settings {
 184     bool flood_unreg;           /* If true, flood unregistered packets to all
 185                                    all ports. If false, send only to ports
 186                                    connected to multicast routers. */
 187     unsigned int idle_time;     /* Entry is removed after the idle time
 188                                  * in seconds. */
 189     unsigned int max_entries;   /* Size of the multicast snooping table. */
 190 };
 191
 192 struct ofproto_mcast_snooping_port_settings {
 193     bool flood;                 /* If true, flood multicast traffic */
 194     bool flood_reports;         /* If true, flood Reports traffic */
 195 };
 196
 197 /* How the switch should act if the controller cannot be contacted. */
 198 enum ofproto_fail_mode {
 199     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
 200     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
 201 };
 202
 203 enum ofproto_band {
 204     OFPROTO_IN_BAND,            /* In-band connection to controller. */
 205     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
 206 };
 207
 208 struct ofproto_controller {
 209     char *target;               /* e.g. "tcp:127.0.0.1" */
 210     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
 211     int probe_interval;         /* Max idle time before probing, in seconds. */
 212     enum ofproto_band band;     /* In-band or out-of-band? */
 213     bool enable_async_msgs;     /* Initially enable asynchronous messages? */
 214
 215     /* OpenFlow packet-in rate-limiting. */
 216     int rate_limit;             /* Max packet-in rate in packets per second. */
 217     int burst_limit;            /* Limit on accumulating packet credits. */
 218
 219     uint8_t dscp;               /* DSCP value for controller connection. */
 220 };
 221
 222 void ofproto_enumerate_types(struct sset *types);
 223 const char *ofproto_normalize_type(const char *);
 224
 225 int ofproto_enumerate_names(const char *type, struct sset *names);
 226 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
 227
 228 /* An interface hint element, which is used by ofproto_init() to
 229  * describe the caller's understanding of the startup state. */
 230 struct iface_hint {
 231     char *br_name;              /* Name of owning bridge. */
 232     char *br_type;              /* Type of owning bridge. */
 233     ofp_port_t ofp_port;        /* OpenFlow port number. */
 234 };
 235
 236 void ofproto_init(const struct shash *iface_hints);
 237
 238 int ofproto_type_run(const char *datapath_type);
 239 void ofproto_type_wait(const char *datapath_type);
 240
 241 int ofproto_create(const char *datapath, const char *datapath_type,
 242                    struct ofproto **ofprotop);
 243 void ofproto_destroy(struct ofproto *, bool del);
 244 int ofproto_delete(const char *name, const char *type);
 245
 246 int ofproto_run(struct ofproto *);
 247 void ofproto_wait(struct ofproto *);
 248 bool ofproto_is_alive(const struct ofproto *);
 249
 250 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
 251 void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
 252
 253 /* A port within an OpenFlow switch.
 254  *
 255  * 'name' and 'type' are suitable for passing to netdev_open(). */
 256 struct ofproto_port {
 257     char *name;                 /* Network device name, e.g. "eth0". */
 258     char *type;                 /* Network device type, e.g. "system". */
 259     ofp_port_t ofp_port;        /* OpenFlow port number. */
 260 };
 261 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
 262 void ofproto_port_destroy(struct ofproto_port *);
 263
 264 struct ofproto_port_dump {
 265     const struct ofproto *ofproto;
 266     int error;
 267     void *state;
 268 };
 269 void ofproto_port_dump_start(struct ofproto_port_dump *,
 270                              const struct ofproto *);
 271 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
 272 int ofproto_port_dump_done(struct ofproto_port_dump *);
 273
 274 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
 275  *
 276  * Arguments all have pointer type.
 277  *
 278  * If you break out of the loop, then you need to free the dump structure by
 279  * hand using ofproto_port_dump_done(). */
 280 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
 281     for (ofproto_port_dump_start(DUMP, OFPROTO);            \
 282          (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
 283           ? true                                            \
 284           : (ofproto_port_dump_done(DUMP), false));         \
 285         )
 286
 287 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
 288 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
 289
 290 const char *ofproto_port_open_type(const char *datapath_type,
 291                                    const char *port_type);
 292 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
 293 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
 294 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
 295
 296 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
 297                                struct ofproto_port *);
 298
 299 /* Top-level configuration. */
 300 uint64_t ofproto_get_datapath_id(const struct ofproto *);
 301 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 302 void ofproto_set_controllers(struct ofproto *,
 303                              const struct ofproto_controller *, size_t n,
 304                              uint32_t allowed_versions);
 305 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
 306 void ofproto_reconnect_controllers(struct ofproto *);
 307 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 308                                        const struct sockaddr_in *, size_t n);
 309 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
 310 void ofproto_set_flow_limit(unsigned limit);
 311 void ofproto_set_max_idle(unsigned max_idle);
 312 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
 313 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
 314                                   size_t max_entries);
 315 int ofproto_set_mcast_snooping(struct ofproto *ofproto,
 316                               const struct ofproto_mcast_snooping_settings *s);
 317 int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
 318                           const struct ofproto_mcast_snooping_port_settings *s);
 319 void ofproto_set_threads(int n_handlers, int n_revalidators);
 320 void ofproto_set_cpu_mask(const char *cmask);
 321 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
 322 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
 323 int ofproto_set_netflow(struct ofproto *,
 324                         const struct netflow_options *nf_options);
 325 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 326 int ofproto_set_ipfix(struct ofproto *,
 327                       const struct ofproto_ipfix_bridge_exporter_options *,
 328                       const struct ofproto_ipfix_flow_exporter_options *,
 329                       size_t);
 330 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
 331 bool ofproto_get_flow_restore_wait(void);
 332 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
 333 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
 334
 335 int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *);
 336 int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *);
 337
 338 /* Configuration of ports. */
 339 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
 340
 341 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
 342 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
 343                           const struct cfm_settings *);
 344 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
 345                           const struct smap *cfg);
 346 bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port);
 347 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
 348                                 struct smap *);
 349 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
 350 int ofproto_port_get_lacp_stats(const struct ofport *, struct lacp_slave_stats *);
 351 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
 352                          const struct ofproto_port_stp_settings *);
 353 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
 354                                 struct ofproto_port_stp_status *);
 355 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
 356                                struct ofproto_port_stp_stats *);
 357 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
 358                             const struct ofproto_port_queue *,
 359                             size_t n_queues);
 360 int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port,
 361                                 struct ofproto_port_rstp_status *);
 362
 363 int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port,
 364         const struct ofproto_port_rstp_settings *);
 365
 366 /* The behaviour of the port regarding VLAN handling */
 367 enum port_vlan_mode {
 368     /* This port is an access port.  'vlan' is the VLAN ID.  'trunks' is
 369      * ignored. */
 370     PORT_VLAN_ACCESS,
 371
 372     /* This port is a trunk.  'trunks' is the set of trunks. 'vlan' is
 373      * ignored. */
 374     PORT_VLAN_TRUNK,
 375
 376     /* Untagged incoming packets are part of 'vlan', as are incoming packets
 377      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' stay tagged.
 378      * Other VLANs in 'trunks' are trunked. */
 379     PORT_VLAN_NATIVE_TAGGED,
 380
 381     /* Untagged incoming packets are part of 'vlan', as are incoming packets
 382      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' are untagged.
 383      * Other VLANs in 'trunks' are trunked. */
 384     PORT_VLAN_NATIVE_UNTAGGED
 385 };
 386
 387 /* Configuration of bundles. */
 388 struct ofproto_bundle_settings {
 389     char *name;                 /* For use in log messages. */
 390
 391     ofp_port_t *slaves;         /* OpenFlow port numbers for slaves. */
 392     size_t n_slaves;
 393
 394     enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
 395     int vlan;                   /* VLAN VID, except for PORT_VLAN_TRUNK. */
 396     unsigned long *trunks;      /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
 397     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
 398
 399     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
 400
 401     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
 402     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
 403 };
 404
 405 int ofproto_bundle_register(struct ofproto *, void *aux,
 406                             const struct ofproto_bundle_settings *);
 407 int ofproto_bundle_unregister(struct ofproto *, void *aux);
 408
 409 /* Configuration of mirrors. */
 410 struct ofproto_mirror_settings {
 411     /* Name for log messages. */
 412     char *name;
 413
 414     /* Bundles that select packets for mirroring upon ingress.  */
 415     void **srcs;                /* A set of registered ofbundle handles. */
 416     size_t n_srcs;
 417
 418     /* Bundles that select packets for mirroring upon egress.  */
 419     void **dsts;                /* A set of registered ofbundle handles. */
 420     size_t n_dsts;
 421
 422     /* VLANs of packets to select for mirroring. */
 423     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
 424
 425     /* Output (mutually exclusive). */
 426     void *out_bundle;           /* A registered ofbundle handle or NULL. */
 427     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
 428 };
 429
 430 int ofproto_mirror_register(struct ofproto *, void *aux,
 431                             const struct ofproto_mirror_settings *);
 432 int ofproto_mirror_unregister(struct ofproto *, void *aux);
 433 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
 434                              uint64_t *packets, uint64_t *bytes);
 435
 436 void ofproto_port_set_lldp(struct ofproto *ofproto, ofp_port_t ofp_port,
 437                            const struct smap *cfg);
 438 int ofproto_set_aa(struct ofproto *ofproto, void *aux,
 439                    const struct aa_settings *s);
 440 int ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
 441                              const struct aa_mapping_settings *s);
 442 int ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux);
 443 int ofproto_aa_vlan_get_queued(struct ofproto *ofproto, struct ovs_list *list);
 444 unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto);
 445
 446 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
 447 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
 448
 449 /* Configuration of OpenFlow tables. */
 450 struct ofproto_table_settings {
 451     char *name;                 /* Name exported via OpenFlow or NULL. */
 452     unsigned int max_flows;     /* Maximum number of flows or UINT_MAX. */
 453
 454     /* These members, together with OpenFlow OFPT_TABLE_MOD, determine the
 455      * handling of an attempt to add a flow that would cause the table to have
 456      * more than 'max_flows' flows:
 457      *
 458      *    - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable
 459      *      eviction, overflows will be rejected with an error.
 460      *
 461      *    - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an
 462      *      overflow will cause a flow to be removed.  The flow to be removed
 463      *      is chosen to give fairness among groups distinguished by different
 464      *      values for the 'n_groups' subfields within 'groups'. */
 465     bool enable_eviction;
 466     struct mf_subfield *groups;
 467     size_t n_groups;
 468
 469     /*
 470      * Fields for which prefix trie lookup is maintained.
 471      */
 472     unsigned int n_prefix_fields;
 473     enum mf_field_id prefix_fields[CLS_MAX_TRIES];
 474 };
 475
 476 extern const enum mf_field_id default_prefix_fields[2];
 477 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES);
 478
 479 int ofproto_get_n_tables(const struct ofproto *);
 480 uint8_t ofproto_get_n_visible_tables(const struct ofproto *);
 481 void ofproto_configure_table(struct ofproto *, int table_id,
 482                              const struct ofproto_table_settings *);
 483
 484 /* Configuration querying. */
 485 bool ofproto_has_snoops(const struct ofproto *);
 486 void ofproto_get_snoops(const struct ofproto *, struct sset *);
 487 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 488 void ofproto_get_netflow_ids(const struct ofproto *,
 489                              uint8_t *engine_type, uint8_t *engine_id);
 490
 491 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
 492 void ofproto_free_ofproto_controller_info(struct shash *);
 493
 494 bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port);
 495
 496 int ofproto_port_get_cfm_status(const struct ofproto *,
 497                                 ofp_port_t ofp_port,
 498                                 struct cfm_status *);
 499 \f
 500 /* Table configuration */
 501
 502 enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *,
 503                                                       uint8_t table_id);
 504
 505 #ifdef  __cplusplus
 506 }
 507 #endif
 508
 509 #endif /* ofproto.h */