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