ofproto/ofproto.h

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