ofproto/ofproto.h

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