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 nlattr;
  37 struct ofhooks;
  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                    const struct ofhooks *, void *aux,
  98                    struct ofproto **ofprotop);
  99 void ofproto_destroy(struct ofproto *);
 100 int ofproto_run(struct ofproto *);
 101 int ofproto_run1(struct ofproto *);
 102 int ofproto_run2(struct ofproto *, bool revalidate_all);
 103 void ofproto_wait(struct ofproto *);
 104 bool ofproto_is_alive(const struct ofproto *);
 105
 106 int ofproto_port_del(struct ofproto *, uint16_t odp_port);
 107 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
 108
 109 /* Top-level configuration. */
 110 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
 111 void ofproto_set_controllers(struct ofproto *,
 112                              const struct ofproto_controller *, size_t n);
 113 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
 114 void ofproto_reconnect_controllers(struct ofproto *);
 115 void ofproto_set_extra_in_band_remotes(struct ofproto *,
 116                                        const struct sockaddr_in *, size_t n);
 117 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
 118 void ofproto_set_desc(struct ofproto *,
 119                       const char *mfr_desc, const char *hw_desc,
 120                       const char *sw_desc, const char *serial_desc,
 121                       const char *dp_desc);
 122 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
 123 int ofproto_set_netflow(struct ofproto *,
 124                         const struct netflow_options *nf_options);
 125 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
 126
 127 /* Configuration of individual interfaces. */
 128 void ofproto_iface_clear_cfm(struct ofproto *, uint32_t port_no);
 129 void ofproto_iface_set_cfm(struct ofproto *, uint32_t port_no,
 130                            const struct cfm *,
 131                            const uint16_t *remote_mps, size_t n_remote_mps);
 132 const struct cfm *ofproto_iface_get_cfm(struct ofproto *, uint32_t port_no);
 133
 134 /* Configuration querying. */
 135 uint64_t ofproto_get_datapath_id(const struct ofproto *);
 136 enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
 137 void ofproto_get_listeners(const struct ofproto *, struct sset *);
 138 bool ofproto_has_snoops(const struct ofproto *);
 139 void ofproto_get_snoops(const struct ofproto *, struct sset *);
 140 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
 141
 142 /* Functions for use by ofproto implementation modules, not by clients. */
 143 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
 144                       const union ofp_action *, size_t n_actions);
 145 void ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
 146 void ofproto_flush_flows(struct ofproto *);
 147
 148 /* Hooks for ovs-vswitchd. */
 149 struct ofhooks {
 150     bool (*normal_cb)(const struct flow *, const struct ofpbuf *packet,
 151                       struct ofpbuf *odp_actions, tag_type *,
 152                       uint16_t *nf_output_iface, void *aux);
 153     bool (*special_cb)(const struct flow *flow, const struct ofpbuf *packet,
 154                        void *aux);
 155     void (*account_flow_cb)(const struct flow *, tag_type tags,
 156                             const struct nlattr *odp_actions,
 157                             size_t actions_len,
 158                             uint64_t n_bytes, void *aux);
 159     void (*account_checkpoint_cb)(void *aux);
 160
 161     uint16_t (*autopath_cb)(const struct flow *, uint32_t id,
 162                             tag_type *, void *aux);
 163 };
 164 void ofproto_revalidate(struct ofproto *, tag_type);
 165 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
 166
 167 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
 168 void ofproto_free_ofproto_controller_info(struct shash *);
 169
 170 #ifdef  __cplusplus
 171 }
 172 #endif
 173
 174 #endif /* ofproto.h */