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