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