2 * Copyright (c) 2009, 2010 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>
45 uint64_t packet_count; /* Packets from subrules. */
46 uint64_t byte_count; /* Bytes from subrules. */
47 long long int used; /* Last-used time (0 if never used). */
50 struct ofproto_sflow_options {
52 uint32_t sampling_rate;
53 uint32_t polling_interval;
60 /* How the switch should act if the controller cannot be contacted. */
61 enum ofproto_fail_mode {
62 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
63 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
67 OFPROTO_IN_BAND, /* In-band connection to controller. */
68 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
71 struct ofproto_controller {
72 char *target; /* e.g. "tcp:127.0.0.1" */
73 int max_backoff; /* Maximum reconnection backoff, in seconds. */
74 int probe_interval; /* Max idle time before probing, in seconds. */
75 enum ofproto_band band; /* In-band or out-of-band? */
77 /* Discovery options. */
78 char *accept_re; /* Regexp for acceptable controllers. */
79 bool update_resolv_conf; /* Update /etc/resolv.conf? */
81 /* OpenFlow packet-in rate-limiting. */
82 int rate_limit; /* Max packet-in rate in packets per second. */
83 int burst_limit; /* Limit on accumulating packet credits. */
86 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
87 #define DEFAULT_HW_DESC "Open vSwitch"
88 #define DEFAULT_SW_DESC VERSION BUILDNR
89 #define DEFAULT_SERIAL_DESC "None"
90 #define DEFAULT_DP_DESC "None"
92 int ofproto_create(const char *datapath, const char *datapath_type,
93 const struct ofhooks *, void *aux,
94 struct ofproto **ofprotop);
95 void ofproto_destroy(struct ofproto *);
96 int ofproto_run(struct ofproto *);
97 int ofproto_run1(struct ofproto *);
98 int ofproto_run2(struct ofproto *, bool revalidate_all);
99 void ofproto_wait(struct ofproto *);
100 bool ofproto_is_alive(const struct ofproto *);
103 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
104 void ofproto_set_controllers(struct ofproto *,
105 const struct ofproto_controller *, size_t n);
106 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
107 void ofproto_reconnect_controllers(struct ofproto *);
108 void ofproto_set_extra_in_band_remotes(struct ofproto *,
109 const struct sockaddr_in *, size_t n);
110 void ofproto_set_desc(struct ofproto *,
111 const char *mfr_desc, const char *hw_desc,
112 const char *sw_desc, const char *serial_desc,
113 const char *dp_desc);
114 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
115 int ofproto_set_netflow(struct ofproto *,
116 const struct netflow_options *nf_options);
117 void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
119 /* Configuration querying. */
120 uint64_t ofproto_get_datapath_id(const struct ofproto *);
121 bool ofproto_has_primary_controller(const struct ofproto *);
122 enum ofproto_fail_mode ofproto_get_fail_mode(const struct ofproto *);
123 void ofproto_get_listeners(const struct ofproto *, struct svec *);
124 void ofproto_get_snoops(const struct ofproto *, struct svec *);
125 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
127 /* Functions for use by ofproto implementation modules, not by clients. */
128 int ofproto_send_packet(struct ofproto *, const flow_t *,
129 const union ofp_action *, size_t n_actions,
130 const struct ofpbuf *);
131 void ofproto_add_flow(struct ofproto *, const flow_t *, uint32_t wildcards,
132 unsigned int priority,
133 const union ofp_action *, size_t n_actions,
135 void ofproto_delete_flow(struct ofproto *, const flow_t *, uint32_t wildcards,
136 unsigned int priority);
137 void ofproto_flush_flows(struct ofproto *);
139 /* Hooks for ovs-vswitchd. */
141 void (*port_changed_cb)(enum ofp_port_reason, const struct ofp_phy_port *,
143 bool (*normal_cb)(const flow_t *, const struct ofpbuf *packet,
144 struct odp_actions *, tag_type *,
145 uint16_t *nf_output_iface, void *aux);
146 void (*account_flow_cb)(const flow_t *, tag_type tags,
147 const union odp_action *, size_t n_actions,
148 unsigned long long int n_bytes, void *aux);
149 void (*account_checkpoint_cb)(void *aux);
151 void ofproto_revalidate(struct ofproto *, tag_type);
152 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
158 #endif /* ofproto.h */