2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include <sys/types.h>
21 #include <netinet/in.h>
43 struct ofproto_controller_info {
48 const char *values[4];
55 uint64_t packet_count; /* Packets from subrules. */
56 uint64_t byte_count; /* Bytes from subrules. */
57 long long int used; /* Last-used time (0 if never used). */
60 struct ofproto_sflow_options {
62 uint32_t sampling_rate;
63 uint32_t polling_interval;
70 /* How the switch should act if the controller cannot be contacted. */
71 enum ofproto_fail_mode {
72 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
73 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
77 OFPROTO_IN_BAND, /* In-band connection to controller. */
78 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
81 struct ofproto_controller {
82 char *target; /* e.g. "tcp:127.0.0.1" */
83 int max_backoff; /* Maximum reconnection backoff, in seconds. */
84 int probe_interval; /* Max idle time before probing, in seconds. */
85 enum ofproto_band band; /* In-band or out-of-band? */
87 /* OpenFlow packet-in rate-limiting. */
88 int rate_limit; /* Max packet-in rate in packets per second. */
89 int burst_limit; /* Limit on accumulating packet credits. */
92 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
93 #define DEFAULT_HW_DESC "Open vSwitch"
94 #define DEFAULT_SW_DESC VERSION BUILDNR
95 #define DEFAULT_SERIAL_DESC "None"
96 #define DEFAULT_DP_DESC "None"
98 int ofproto_create(const char *datapath, const char *datapath_type,
99 const struct ofhooks *, void *aux,
100 struct ofproto **ofprotop);
101 void ofproto_destroy(struct ofproto *);
102 void ofproto_destroy_and_delete(struct ofproto *);
103 int ofproto_run(struct ofproto *);
104 int ofproto_run1(struct ofproto *);
105 int ofproto_run2(struct ofproto *, bool revalidate_all);
106 void ofproto_wait(struct ofproto *);
107 bool ofproto_is_alive(const struct ofproto *);
109 /* A port within an OpenFlow switch.
111 * 'name' and 'type' are suitable for passing to netdev_open(). */
112 struct ofproto_port {
113 char *name; /* Network device name, e.g. "eth0". */
114 char *type; /* Network device type, e.g. "system". */
115 uint16_t ofp_port; /* OpenFlow port number. */
117 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
118 void ofproto_port_destroy(struct ofproto_port *);
120 struct ofproto_port_dump {
121 const struct ofproto *ofproto;
125 void ofproto_port_dump_start(struct ofproto_port_dump *,
126 const struct ofproto *);
127 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
128 int ofproto_port_dump_done(struct ofproto_port_dump *);
130 /* Iterates through each DPIF_PORT in OFPROTO, using DUMP as state.
132 * Arguments all have pointer type.
134 * If you break out of the loop, then you need to free the dump structure by
135 * hand using ofproto_port_dump_done(). */
136 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
137 for (ofproto_port_dump_start(DUMP, OFPROTO); \
138 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
140 : (ofproto_port_dump_done(DUMP), false)); \
143 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
144 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
145 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
147 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
148 struct ofproto_port *);
150 /* Top-level configuration. */
151 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
152 void ofproto_set_controllers(struct ofproto *,
153 const struct ofproto_controller *, size_t n);
154 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
155 void ofproto_reconnect_controllers(struct ofproto *);
156 void ofproto_set_extra_in_band_remotes(struct ofproto *,
157 const struct sockaddr_in *, size_t n);
158 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
159 void ofproto_set_desc(struct ofproto *,
160 const char *mfr_desc, const char *hw_desc,
161 const char *sw_desc, const char *serial_desc,
162 const char *dp_desc);
163 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
164 int ofproto_set_netflow(struct ofproto *,
165 const struct netflow_options *nf_options);
166 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
168 /* Configuration of individual interfaces. */
169 void ofproto_port_clear_cfm(struct ofproto *, uint32_t port_no);
170 void ofproto_port_set_cfm(struct ofproto *, uint32_t port_no,
172 const uint16_t *remote_mps, size_t n_remote_mps);
173 const struct cfm *ofproto_port_get_cfm(struct ofproto *, uint32_t port_no);
175 /* Configuration querying. */
176 uint64_t ofproto_get_datapath_id(const struct ofproto *);
177 enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
178 void ofproto_get_listeners(const struct ofproto *, struct sset *);
179 bool ofproto_has_snoops(const struct ofproto *);
180 void ofproto_get_snoops(const struct ofproto *, struct sset *);
181 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
182 void ofproto_get_netflow_ids(const struct ofproto *,
183 uint8_t *engine_type, uint8_t *engine_id);
185 /* Hooks for ovs-vswitchd. */
187 bool (*normal_cb)(const struct flow *, const struct ofpbuf *packet,
188 struct ofpbuf *odp_actions, tag_type *,
189 uint16_t *nf_output_iface, void *aux);
190 bool (*special_cb)(const struct flow *flow, const struct ofpbuf *packet,
192 void (*account_flow_cb)(const struct flow *, tag_type tags,
193 const struct nlattr *odp_actions,
195 uint64_t n_bytes, void *aux);
196 void (*account_checkpoint_cb)(void *aux);
198 uint16_t (*autopath_cb)(const struct flow *, uint32_t id,
199 tag_type *, void *aux);
201 void ofproto_revalidate(struct ofproto *, tag_type);
202 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
204 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
205 void ofproto_free_ofproto_controller_info(struct shash *);
211 #endif /* ofproto.h */