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