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