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>
40 struct ofproto_controller_info {
45 const char *values[4];
52 uint64_t packet_count; /* Packets from subrules. */
53 uint64_t byte_count; /* Bytes from subrules. */
54 long long int used; /* Last-used time (0 if never used). */
57 struct ofproto_sflow_options {
59 uint32_t sampling_rate;
60 uint32_t polling_interval;
67 /* How the switch should act if the controller cannot be contacted. */
68 enum ofproto_fail_mode {
69 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
70 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
74 OFPROTO_IN_BAND, /* In-band connection to controller. */
75 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
78 struct ofproto_controller {
79 char *target; /* e.g. "tcp:127.0.0.1" */
80 int max_backoff; /* Maximum reconnection backoff, in seconds. */
81 int probe_interval; /* Max idle time before probing, in seconds. */
82 enum ofproto_band band; /* In-band or out-of-band? */
84 /* OpenFlow packet-in rate-limiting. */
85 int rate_limit; /* Max packet-in rate in packets per second. */
86 int burst_limit; /* Limit on accumulating packet credits. */
89 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
90 #define DEFAULT_HW_DESC "Open vSwitch"
91 #define DEFAULT_SW_DESC VERSION BUILDNR
92 #define DEFAULT_SERIAL_DESC "None"
93 #define DEFAULT_DP_DESC "None"
95 int ofproto_create(const char *datapath, const char *datapath_type,
96 const struct ofhooks *, void *aux,
97 struct ofproto **ofprotop);
98 void ofproto_destroy(struct ofproto *);
99 int ofproto_run(struct ofproto *);
100 int ofproto_run1(struct ofproto *);
101 int ofproto_run2(struct ofproto *, bool revalidate_all);
102 void ofproto_wait(struct ofproto *);
103 bool ofproto_is_alive(const struct ofproto *);
105 int ofproto_port_del(struct ofproto *, uint16_t odp_port);
106 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
108 /* Top-level configuration. */
109 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
110 void ofproto_set_controllers(struct ofproto *,
111 const struct ofproto_controller *, size_t n);
112 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
113 void ofproto_reconnect_controllers(struct ofproto *);
114 void ofproto_set_extra_in_band_remotes(struct ofproto *,
115 const struct sockaddr_in *, size_t n);
116 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
117 void ofproto_set_desc(struct ofproto *,
118 const char *mfr_desc, const char *hw_desc,
119 const char *sw_desc, const char *serial_desc,
120 const char *dp_desc);
121 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
122 int ofproto_set_netflow(struct ofproto *,
123 const struct netflow_options *nf_options);
124 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
126 /* Configuration of individual interfaces. */
129 void ofproto_iface_clear_cfm(struct ofproto *, uint32_t port_no);
130 void ofproto_iface_set_cfm(struct ofproto *, uint32_t port_no,
132 const uint16_t *remote_mps, size_t n_remote_mps);
133 const struct cfm *ofproto_iface_get_cfm(struct ofproto *, uint32_t port_no);
135 /* Configuration querying. */
136 uint64_t ofproto_get_datapath_id(const struct ofproto *);
137 bool ofproto_has_primary_controller(const struct ofproto *);
138 enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
139 void ofproto_get_listeners(const struct ofproto *, struct svec *);
140 void ofproto_get_snoops(const struct ofproto *, struct svec *);
141 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
143 /* Functions for use by ofproto implementation modules, not by clients. */
144 int ofproto_send_packet(struct ofproto *, uint32_t port_no, uint16_t vlan_tci,
145 const struct ofpbuf *);
146 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
147 const union ofp_action *, size_t n_actions);
148 void ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
149 void ofproto_flush_flows(struct ofproto *);
151 /* Hooks for ovs-vswitchd. */
153 bool (*normal_cb)(const struct flow *, const struct ofpbuf *packet,
154 struct ofpbuf *odp_actions, tag_type *,
155 uint16_t *nf_output_iface, void *aux);
156 bool (*special_cb)(const struct flow *flow, const struct ofpbuf *packet,
158 void (*account_flow_cb)(const struct flow *, tag_type tags,
159 const struct nlattr *odp_actions,
161 uint64_t n_bytes, void *aux);
162 void (*account_checkpoint_cb)(void *aux);
164 void ofproto_revalidate(struct ofproto *, tag_type);
165 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
167 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
168 void ofproto_free_ofproto_controller_info(struct shash *);
174 #endif /* ofproto.h */