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