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>
41 struct ofproto_controller_info {
46 const char *values[4];
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). */
58 struct ofproto_sflow_options {
60 uint32_t sampling_rate;
61 uint32_t polling_interval;
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. */
75 OFPROTO_IN_BAND, /* In-band connection to controller. */
76 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
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? */
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. */
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"
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 *);
106 int ofproto_port_del(struct ofproto *, uint16_t odp_port);
107 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
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 *);
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,
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);
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 *);
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 *);
148 /* Hooks for ovs-vswitchd. */
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,
155 void (*account_flow_cb)(const struct flow *, tag_type tags,
156 const struct nlattr *odp_actions,
158 uint64_t n_bytes, void *aux);
159 void (*account_checkpoint_cb)(void *aux);
161 uint16_t (*autopath_cb)(const struct flow *, uint32_t id,
162 tag_type *, 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 */