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 "flow.h"
  26 #include "netflow.h"
  27 #include "sset.h"
  28 #include "tag.h"
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 struct cfm;
  35 struct cls_rule;
  36 struct dpif_port;
  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_parse_name(const char *name, char **dp_name, char **dp_type);
  97
  98 int ofproto_create(const char *datapath, const char *datapath_type,
  99                    struct ofproto **ofprotop);
 100 void ofproto_destroy(struct ofproto *);
 101 int ofproto_run(struct ofproto *);
 102 void ofproto_wait(struct ofproto *);
 103 bool ofproto_is_alive(const struct ofproto *);
 104
 105 /* A port within an OpenFlow switch.
 106  *
 107  * 'name' and 'type' are suitable for passing to netdev_open(). */
 108 struct ofproto_port {
 109     char *name;                 /* Network device name, e.g. "eth0". */
 110     char *type;                 /* Network device type, e.g. "system". */
 111     uint16_t ofp_port;          /* OpenFlow port number. */
 112 };
 113 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
 114 void ofproto_port_destroy(struct ofproto_port *);
 115
 116 struct ofproto_port_dump {
 117     const struct ofproto *ofproto;
 118     int error;
 119     void *state;
 120 };
 121 void ofproto_port_dump_start(struct ofproto_port_dump *,
 122                              const struct ofproto *);
 123 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
 124 int ofproto_port_dump_done(struct ofproto_port_dump *);
 125
 126 /* Iterates through each DPIF_PORT in OFPROTO, using DUMP as state.
 127  *
 128  * Arguments all have pointer type.
 129  *
 130  * If you break out of the loop, then you need to free the dump structure by
 131  * hand using ofproto_port_dump_done(). */
 132 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
 133     for (ofproto_port_dump_start(DUMP, OFPROTO);            \
 134          (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
 135           ? true                                            \
 136           : (ofproto_port_dump_done(DUMP), false));         \
 137         )
 138
 139 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
 140 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
 141
 142 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
 143                                struct ofproto_port *);
 144
 145 /* Top-level configuration. */
 146 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 147 void ofproto_set_controllers(struct ofproto *,
 148                              const struct ofproto_controller *, size_t n);
 149 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
 150 void ofproto_reconnect_controllers(struct ofproto *);
 151 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 152                                        const struct sockaddr_in *, size_t n);
 153 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
 154 void ofproto_set_desc(struct ofproto *,
 155                       const char *mfr_desc, const char *hw_desc,
 156                       const char *sw_desc, const char *serial_desc,
 157                       const char *dp_desc);
 158 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
 159 int ofproto_set_netflow(struct ofproto *,
 160                         const struct netflow_options *nf_options);
 161 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 162
 163 /* Configuration of ports. */
 164
 165 void ofproto_port_unregister(struct ofproto *, uint32_t port_no);
 166
 167 void ofproto_port_clear_cfm(struct ofproto *, uint32_t port_no);
 168 void ofproto_port_set_cfm(struct ofproto *, uint32_t port_no,
 169                           const struct cfm *,
 170                           const uint16_t *remote_mps, size_t n_remote_mps);
 171 const struct cfm *ofproto_port_get_cfm(struct ofproto *, uint32_t port_no);
 172 int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
 173
 174 /* Configuration of bundles. */
 175 struct ofproto_bundle_settings {
 176     char *name;                 /* For use in log messages. */
 177
 178     uint32_t *slaves;           /* OpenFlow port numbers for slaves. */
 179     size_t n_slaves;
 180
 181     int vlan;                   /* VLAN if access port, -1 if trunk port. */
 182     unsigned long *trunks;      /* vlan_bitmap, NULL to trunk all VLANs. */
 183
 184     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
 185
 186     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
 187     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
 188 };
 189
 190 void ofproto_bundle_register(struct ofproto *, void *aux,
 191                              const struct ofproto_bundle_settings *);
 192 void ofproto_bundle_unregister(struct ofproto *, void *aux);
 193
 194 /* Configuration of mirrors. */
 195 struct ofproto_mirror_settings {
 196     /* Name for log messages. */
 197     char *name;
 198
 199     /* Bundles that select packets for mirroring upon ingress.  */
 200     void **srcs;                /* A set of registered ofbundle handles. */
 201     size_t n_srcs;
 202
 203     /* Bundles that select packets for mirroring upon egress.  */
 204     void **dsts;                /* A set of registered ofbundle handles. */
 205     size_t n_dsts;
 206
 207     /* VLANs of packets to select for mirroring. */
 208     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
 209
 210     /* Output (mutually exclusive). */
 211     void *out_bundle;           /* A registered ofbundle handle or NULL. */
 212     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
 213 };
 214
 215 void ofproto_mirror_register(struct ofproto *, void *aux,
 216                              const struct ofproto_mirror_settings *);
 217 void ofproto_mirror_unregister(struct ofproto *, void *aux);
 218
 219 void ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
 220 bool ofproto_is_mirror_output_bundle(struct ofproto *, void *aux);
 221
 222 /* Configuration querying. */
 223 bool ofproto_has_snoops(const struct ofproto *);
 224 void ofproto_get_snoops(const struct ofproto *, struct sset *);
 225 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 226 void ofproto_get_netflow_ids(const struct ofproto *,
 227                              uint8_t *engine_type, uint8_t *engine_id);
 228
 229 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
 230 void ofproto_free_ofproto_controller_info(struct shash *);
 231
 232 #ifdef  __cplusplus
 233 }
 234 #endif
 235
 236 #endif /* ofproto.h */