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