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