ofproto/ofproto.h

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