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