ofproto: Add ofconn_get_miss_send_len(), ofconn_set_miss_send_len().
[sliver-openvswitch.git] / 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 "tag.h"
28
29 #ifdef  __cplusplus
30 extern "C" {
31 #endif
32
33 struct cls_rule;
34 struct nlattr;
35 struct ofhooks;
36 struct ofproto;
37 struct shash;
38 struct svec;
39
40 struct ofproto_controller_info {
41     bool is_connected;
42     enum nx_role role;
43     struct {
44         const char *keys[4];
45         const char *values[4];
46         size_t n;
47     } pairs;
48 };
49
50 struct ofexpired {
51     struct flow flow;
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). */
55 };
56
57 struct ofproto_sflow_options {
58     struct svec targets;
59     uint32_t sampling_rate;
60     uint32_t polling_interval;
61     uint32_t header_len;
62     uint32_t sub_id;
63     char *agent_device;
64     char *control_ip;
65 };
66
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. */
71 };
72
73 enum ofproto_band {
74     OFPROTO_IN_BAND,            /* In-band connection to controller. */
75     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
76 };
77
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? */
83
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. */
87 };
88
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"
94
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 *);
104
105 int ofproto_port_del(struct ofproto *, uint16_t odp_port);
106 bool ofproto_port_is_floodable(struct ofproto *, uint16_t odp_port);
107
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 *);
125
126 /* Configuration of individual interfaces. */
127 struct cfm;
128
129 void ofproto_iface_clear_cfm(struct ofproto *, uint32_t port_no);
130 void ofproto_iface_set_cfm(struct ofproto *, uint32_t port_no,
131                            const struct cfm *,
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);
134
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 *);
142
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 *);
150
151 /* Hooks for ovs-vswitchd. */
152 struct ofhooks {
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,
157                        void *aux);
158     void (*account_flow_cb)(const struct flow *, tag_type tags,
159                             const struct nlattr *odp_actions,
160                             size_t actions_len,
161                             uint64_t n_bytes, void *aux);
162     void (*account_checkpoint_cb)(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 */