ofproto/ofproto.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 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 "sset.h"
  31 #include "stp.h"
  32
  33 #ifdef  __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bfd_cfg;
  38 struct cfm_settings;
  39 struct cls_rule;
  40 struct netdev;
  41 struct netdev_stats;
  42 struct ofport;
  43 struct ofproto;
  44 struct shash;
  45 struct simap;
  46 struct smap;
  47
  48 struct ofproto_controller_info {
  49     bool is_connected;
  50     enum ofp12_controller_role role;
  51     struct {
  52         const char *keys[4];
  53         const char *values[4];
  54         size_t n;
  55     } 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 };
  76
  77 struct ofproto_ipfix_flow_exporter_options {
  78     uint32_t collector_set_id;
  79     struct sset targets;
  80     uint32_t cache_active_timeout;
  81     uint32_t cache_max_flows;
  82 };
  83
  84 struct ofproto_stp_settings {
  85     stp_identifier system_id;
  86     uint16_t priority;
  87     uint16_t hello_time;
  88     uint16_t max_age;
  89     uint16_t fwd_delay;
  90 };
  91
  92 struct ofproto_stp_status {
  93     bool enabled;               /* If false, ignore other members. */
  94     stp_identifier bridge_id;
  95     stp_identifier designated_root;
  96     int root_path_cost;
  97 };
  98
  99 struct ofproto_port_stp_settings {
 100     bool enable;
 101     uint8_t port_num;           /* In the range 1-255, inclusive. */
 102     uint8_t priority;
 103     uint16_t path_cost;
 104 };
 105
 106 struct ofproto_port_stp_status {
 107     bool enabled;               /* If false, ignore other members. */
 108     int port_id;
 109     enum stp_state state;
 110     unsigned int sec_in_state;
 111     enum stp_role role;
 112 };
 113
 114 struct ofproto_port_stp_stats {
 115     bool enabled;               /* If false, ignore other members. */
 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 };
 120
 121 struct ofproto_port_queue {
 122     uint32_t queue;             /* Queue ID. */
 123     uint8_t dscp;               /* DSCP bits (e.g. [0, 63]). */
 124 };
 125
 126 /* How the switch should act if the controller cannot be contacted. */
 127 enum ofproto_fail_mode {
 128     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
 129     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
 130 };
 131
 132 enum ofproto_band {
 133     OFPROTO_IN_BAND,            /* In-band connection to controller. */
 134     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
 135 };
 136
 137 struct ofproto_controller {
 138     char *target;               /* e.g. "tcp:127.0.0.1" */
 139     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
 140     int probe_interval;         /* Max idle time before probing, in seconds. */
 141     enum ofproto_band band;     /* In-band or out-of-band? */
 142     bool enable_async_msgs;     /* Initially enable asynchronous messages? */
 143
 144     /* OpenFlow packet-in rate-limiting. */
 145     int rate_limit;             /* Max packet-in rate in packets per second. */
 146     int burst_limit;            /* Limit on accumulating packet credits. */
 147
 148     uint8_t dscp;               /* DSCP value for controller connection. */
 149 };
 150
 151 void ofproto_enumerate_types(struct sset *types);
 152 const char *ofproto_normalize_type(const char *);
 153
 154 int ofproto_enumerate_names(const char *type, struct sset *names);
 155 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
 156
 157 /* An interface hint element, which is used by ofproto_init() to
 158  * describe the caller's understanding of the startup state. */
 159 struct iface_hint {
 160     char *br_name;              /* Name of owning bridge. */
 161     char *br_type;              /* Type of owning bridge. */
 162     ofp_port_t ofp_port;        /* OpenFlow port number. */
 163 };
 164
 165 void ofproto_init(const struct shash *iface_hints);
 166
 167 int ofproto_type_run(const char *datapath_type);
 168 void ofproto_type_wait(const char *datapath_type);
 169
 170 int ofproto_create(const char *datapath, const char *datapath_type,
 171                    struct ofproto **ofprotop);
 172 void ofproto_destroy(struct ofproto *);
 173 int ofproto_delete(const char *name, const char *type);
 174
 175 int ofproto_run(struct ofproto *);
 176 void ofproto_wait(struct ofproto *);
 177 bool ofproto_is_alive(const struct ofproto *);
 178
 179 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
 180 void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
 181
 182 /* A port within an OpenFlow switch.
 183  *
 184  * 'name' and 'type' are suitable for passing to netdev_open(). */
 185 struct ofproto_port {
 186     char *name;                 /* Network device name, e.g. "eth0". */
 187     char *type;                 /* Network device type, e.g. "system". */
 188     ofp_port_t ofp_port;        /* OpenFlow port number. */
 189 };
 190 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
 191 void ofproto_port_destroy(struct ofproto_port *);
 192
 193 struct ofproto_port_dump {
 194     const struct ofproto *ofproto;
 195     int error;
 196     void *state;
 197 };
 198 void ofproto_port_dump_start(struct ofproto_port_dump *,
 199                              const struct ofproto *);
 200 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
 201 int ofproto_port_dump_done(struct ofproto_port_dump *);
 202
 203 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
 204  *
 205  * Arguments all have pointer type.
 206  *
 207  * If you break out of the loop, then you need to free the dump structure by
 208  * hand using ofproto_port_dump_done(). */
 209 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
 210     for (ofproto_port_dump_start(DUMP, OFPROTO);            \
 211          (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
 212           ? true                                            \
 213           : (ofproto_port_dump_done(DUMP), false));         \
 214         )
 215
 216 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT  2500
 217 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
 218
 219 /* How flow misses should be handled in ofproto-dpif */
 220 enum ofproto_flow_miss_model {
 221     OFPROTO_HANDLE_MISS_AUTO,           /* Based on flow eviction threshold. */
 222     OFPROTO_HANDLE_MISS_WITH_FACETS,    /* Always create facets. */
 223     OFPROTO_HANDLE_MISS_WITHOUT_FACETS  /* Always handle without facets.*/
 224 };
 225
 226 const char *ofproto_port_open_type(const char *datapath_type,
 227                                    const char *port_type);
 228 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
 229 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
 230 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
 231
 232 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
 233                                struct ofproto_port *);
 234
 235 /* Top-level configuration. */
 236 uint64_t ofproto_get_datapath_id(const struct ofproto *);
 237 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 238 void ofproto_set_controllers(struct ofproto *,
 239                              const struct ofproto_controller *, size_t n,
 240                              uint32_t allowed_versions);
 241 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
 242 void ofproto_reconnect_controllers(struct ofproto *);
 243 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 244                                        const struct sockaddr_in *, size_t n);
 245 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
 246 void ofproto_set_flow_eviction_threshold(unsigned threshold);
 247 void ofproto_set_flow_miss_model(unsigned model);
 248 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
 249 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
 250                                   size_t max_entries);
 251 void ofproto_set_n_handler_threads(unsigned limit);
 252 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
 253 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
 254 int ofproto_set_netflow(struct ofproto *,
 255                         const struct netflow_options *nf_options);
 256 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 257 int ofproto_set_ipfix(struct ofproto *,
 258                       const struct ofproto_ipfix_bridge_exporter_options *,
 259                       const struct ofproto_ipfix_flow_exporter_options *,
 260                       size_t);
 261 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
 262 bool ofproto_get_flow_restore_wait(void);
 263 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
 264 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
 265
 266 /* Configuration of ports. */
 267 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
 268
 269 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
 270 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
 271                           const struct cfm_settings *);
 272 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
 273                           const struct smap *cfg);
 274 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
 275                                 struct smap *);
 276 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
 277 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
 278                          const struct ofproto_port_stp_settings *);
 279 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
 280                                 struct ofproto_port_stp_status *);
 281 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
 282                                struct ofproto_port_stp_stats *);
 283 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
 284                             const struct ofproto_port_queue *,
 285                             size_t n_queues);
 286
 287 /* The behaviour of the port regarding VLAN handling */
 288 enum port_vlan_mode {
 289     /* This port is an access port.  'vlan' is the VLAN ID.  'trunks' is
 290      * ignored. */
 291     PORT_VLAN_ACCESS,
 292
 293     /* This port is a trunk.  'trunks' is the set of trunks. 'vlan' is
 294      * ignored. */
 295     PORT_VLAN_TRUNK,
 296
 297     /* Untagged incoming packets are part of 'vlan', as are incoming packets
 298      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' stay tagged.
 299      * Other VLANs in 'trunks' are trunked. */
 300     PORT_VLAN_NATIVE_TAGGED,
 301
 302     /* Untagged incoming packets are part of 'vlan', as are incoming packets
 303      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' are untagged.
 304      * Other VLANs in 'trunks' are trunked. */
 305     PORT_VLAN_NATIVE_UNTAGGED
 306 };
 307
 308 /* Configuration of bundles. */
 309 struct ofproto_bundle_settings {
 310     char *name;                 /* For use in log messages. */
 311
 312     ofp_port_t *slaves;         /* OpenFlow port numbers for slaves. */
 313     size_t n_slaves;
 314
 315     enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
 316     int vlan;                   /* VLAN VID, except for PORT_VLAN_TRUNK. */
 317     unsigned long *trunks;      /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
 318     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
 319
 320     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
 321
 322     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
 323     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
 324
 325     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 326      *
 327      * This is deprecated.  It is only for compatibility with broken device
 328      * drivers in old versions of Linux that do not properly support VLANs when
 329      * VLAN devices are not used.  When broken device drivers are no longer in
 330      * widespread use, we will delete these interfaces. */
 331     ofp_port_t realdev_ofp_port;/* OpenFlow port number of real device. */
 332 };
 333
 334 int ofproto_bundle_register(struct ofproto *, void *aux,
 335                             const struct ofproto_bundle_settings *);
 336 int ofproto_bundle_unregister(struct ofproto *, void *aux);
 337
 338 /* Configuration of mirrors. */
 339 struct ofproto_mirror_settings {
 340     /* Name for log messages. */
 341     char *name;
 342
 343     /* Bundles that select packets for mirroring upon ingress.  */
 344     void **srcs;                /* A set of registered ofbundle handles. */
 345     size_t n_srcs;
 346
 347     /* Bundles that select packets for mirroring upon egress.  */
 348     void **dsts;                /* A set of registered ofbundle handles. */
 349     size_t n_dsts;
 350
 351     /* VLANs of packets to select for mirroring. */
 352     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
 353
 354     /* Output (mutually exclusive). */
 355     void *out_bundle;           /* A registered ofbundle handle or NULL. */
 356     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
 357 };
 358
 359 int ofproto_mirror_register(struct ofproto *, void *aux,
 360                             const struct ofproto_mirror_settings *);
 361 int ofproto_mirror_unregister(struct ofproto *, void *aux);
 362 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
 363                              uint64_t *packets, uint64_t *bytes);
 364
 365 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
 366 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
 367
 368 /* Configuration of OpenFlow tables. */
 369 struct ofproto_table_settings {
 370     char *name;                 /* Name exported via OpenFlow or NULL. */
 371     unsigned int max_flows;     /* Maximum number of flows or UINT_MAX. */
 372
 373     /* These members determine the handling of an attempt to add a flow that
 374      * would cause the table to have more than 'max_flows' flows.
 375      *
 376      * If 'groups' is NULL, overflows will be rejected with an error.
 377      *
 378      * If 'groups' is nonnull, an overflow will cause a flow to be removed.
 379      * The flow to be removed is chosen to give fairness among groups
 380      * distinguished by different values for the subfields within 'groups'. */
 381     struct mf_subfield *groups;
 382     size_t n_groups;
 383
 384     /*
 385      * Fields for which prefix trie lookup is maintained.
 386      */
 387     unsigned int n_prefix_fields;
 388     enum mf_field_id prefix_fields[CLS_MAX_TRIES];
 389 };
 390
 391 int ofproto_get_n_tables(const struct ofproto *);
 392 void ofproto_configure_table(struct ofproto *, int table_id,
 393                              const struct ofproto_table_settings *);
 394
 395 /* Configuration querying. */
 396 bool ofproto_has_snoops(const struct ofproto *);
 397 void ofproto_get_snoops(const struct ofproto *, struct sset *);
 398 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 399 void ofproto_get_netflow_ids(const struct ofproto *,
 400                              uint8_t *engine_type, uint8_t *engine_id);
 401
 402 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
 403 void ofproto_free_ofproto_controller_info(struct shash *);
 404
 405 /* CFM status query. */
 406 struct ofproto_cfm_status {
 407     /* 0 if not faulted, otherwise a combination of one or more reasons. */
 408     enum cfm_fault_reason faults;
 409
 410     /* 0 if the remote CFM endpoint is operationally down,
 411      * 1 if the remote CFM endpoint is operationally up,
 412      * -1 if we don't know because the remote CFM endpoint is not in extended
 413      * mode. */
 414     int remote_opstate;
 415
 416     uint64_t flap_count;
 417
 418     /* Ordinarily a "health status" in the range 0...100 inclusive, with 0
 419      * being worst and 100 being best, or -1 if the health status is not
 420      * well-defined. */
 421     int health;
 422
 423     /* MPIDs of remote maintenance points whose CCMs have been received. */
 424     uint64_t *rmps;
 425     size_t n_rmps;
 426 };
 427
 428 bool ofproto_port_get_cfm_status(const struct ofproto *,
 429                                  ofp_port_t ofp_port,
 430                                  struct ofproto_cfm_status *);
 431 \f
 432 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
 433  *
 434  * This is deprecated.  It is only for compatibility with broken device drivers
 435  * in old versions of Linux that do not properly support VLANs when VLAN
 436  * devices are not used.  When broken device drivers are no longer in
 437  * widespread use, we will delete these interfaces. */
 438
 439 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
 440 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
 441 int ofproto_port_set_realdev(struct ofproto *, ofp_port_t vlandev_ofp_port,
 442                              ofp_port_t realdev_ofp_port, int vid);
 443
 444 #ifdef  __cplusplus
 445 }
 446 #endif
 447
 448 #endif /* ofproto.h */