]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
1a6f1e2a | 2 | * Copyright (c) 2009, 2010 Nicira Networks. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef OFPROTO_H | |
18 | #define OFPROTO_H 1 | |
19 | ||
20 | #include <stdbool.h> | |
21 | #include <stddef.h> | |
22 | #include <stdint.h> | |
23 | #include "flow.h" | |
0193b2af | 24 | #include "netflow.h" |
064af421 BP |
25 | #include "tag.h" |
26 | ||
03292c46 JG |
27 | #ifdef __cplusplus |
28 | extern "C" { | |
29 | #endif | |
30 | ||
064af421 BP |
31 | struct odp_actions; |
32 | struct ofhooks; | |
33 | struct ofproto; | |
34 | struct svec; | |
35 | ||
72b06300 BP |
36 | enum { |
37 | DP_GROUP_FLOOD = 0, | |
38 | DP_GROUP_ALL = 1 | |
39 | }; | |
40 | ||
064af421 BP |
41 | struct ofexpired { |
42 | flow_t flow; | |
0193b2af JG |
43 | uint64_t packet_count; /* Packets from subrules. */ |
44 | uint64_t byte_count; /* Bytes from subrules. */ | |
064af421 | 45 | long long int used; /* Last-used time (0 if never used). */ |
064af421 BP |
46 | }; |
47 | ||
72b06300 BP |
48 | struct ofproto_sflow_options { |
49 | struct svec targets; | |
50 | uint32_t sampling_rate; | |
51 | uint32_t polling_interval; | |
52 | uint32_t header_len; | |
53 | uint32_t sub_id; | |
54 | char *agent_device; | |
55 | char *control_ip; | |
56 | }; | |
57 | ||
79c9f2ee BP |
58 | /* How the switch should act if the controller cannot be contacted. */ |
59 | enum ofproto_fail_mode { | |
60 | OFPROTO_FAIL_SECURE, /* Preserve flow table. */ | |
61 | OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */ | |
62 | }; | |
63 | ||
64 | enum ofproto_band { | |
65 | OFPROTO_IN_BAND, /* In-band connection to controller. */ | |
66 | OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */ | |
67 | }; | |
68 | ||
69 | struct ofproto_controller { | |
70 | char *target; /* e.g. "tcp:127.0.0.1" */ | |
71 | int max_backoff; /* Maximum reconnection backoff, in seconds. */ | |
72 | int probe_interval; /* Max idle time before probing, in seconds. */ | |
73 | enum ofproto_fail_mode fail; /* Controller failure handling mode. */ | |
74 | enum ofproto_band band; /* In-band or out-of-band? */ | |
75 | ||
76 | /* Discovery options. */ | |
77 | char *accept_re; /* Regexp for acceptable controllers. */ | |
78 | bool update_resolv_conf; /* Update /etc/resolv.conf? */ | |
79 | ||
80 | /* OpenFlow packet-in rate-limiting. */ | |
81 | int rate_limit; /* Max packet-in rate in packets per second. */ | |
82 | int burst_limit; /* Limit on accumulating packet credits. */ | |
83 | }; | |
84 | ||
23ff2821 JP |
85 | #define DEFAULT_MFR_DESC "Nicira Networks, Inc." |
86 | #define DEFAULT_HW_DESC "Open vSwitch" | |
87 | #define DEFAULT_SW_DESC VERSION BUILDNR | |
88 | #define DEFAULT_SERIAL_DESC "None" | |
89 | #define DEFAULT_DP_DESC "None" | |
90 | ||
1a6f1e2a JG |
91 | int ofproto_create(const char *datapath, const char *datapath_type, |
92 | const struct ofhooks *, void *aux, | |
064af421 BP |
93 | struct ofproto **ofprotop); |
94 | void ofproto_destroy(struct ofproto *); | |
95 | int ofproto_run(struct ofproto *); | |
96 | int ofproto_run1(struct ofproto *); | |
97 | int ofproto_run2(struct ofproto *, bool revalidate_all); | |
98 | void ofproto_wait(struct ofproto *); | |
99 | bool ofproto_is_alive(const struct ofproto *); | |
100 | ||
101 | /* Configuration. */ | |
102 | void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id); | |
76ce9432 BP |
103 | void ofproto_set_controllers(struct ofproto *, |
104 | const struct ofproto_controller *, size_t n); | |
064af421 | 105 | void ofproto_set_desc(struct ofproto *, |
5a719c38 JP |
106 | const char *mfr_desc, const char *hw_desc, |
107 | const char *sw_desc, const char *serial_desc, | |
8abc4ed7 | 108 | const char *dp_desc); |
064af421 BP |
109 | int ofproto_set_listeners(struct ofproto *, const struct svec *listeners); |
110 | int ofproto_set_snoops(struct ofproto *, const struct svec *snoops); | |
0193b2af JG |
111 | int ofproto_set_netflow(struct ofproto *, |
112 | const struct netflow_options *nf_options); | |
72b06300 | 113 | void ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *); |
064af421 | 114 | int ofproto_set_stp(struct ofproto *, bool enable_stp); |
064af421 BP |
115 | |
116 | /* Configuration querying. */ | |
117 | uint64_t ofproto_get_datapath_id(const struct ofproto *); | |
76ce9432 | 118 | bool ofproto_has_controller(const struct ofproto *); |
064af421 BP |
119 | void ofproto_get_listeners(const struct ofproto *, struct svec *); |
120 | void ofproto_get_snoops(const struct ofproto *, struct svec *); | |
4f2cad2c | 121 | void ofproto_get_all_flows(struct ofproto *p, struct ds *); |
064af421 BP |
122 | |
123 | /* Functions for use by ofproto implementation modules, not by clients. */ | |
124 | int ofproto_send_packet(struct ofproto *, const flow_t *, | |
125 | const union ofp_action *, size_t n_actions, | |
126 | const struct ofpbuf *); | |
127 | void ofproto_add_flow(struct ofproto *, const flow_t *, uint32_t wildcards, | |
128 | unsigned int priority, | |
129 | const union ofp_action *, size_t n_actions, | |
130 | int idle_timeout); | |
131 | void ofproto_delete_flow(struct ofproto *, const flow_t *, uint32_t wildcards, | |
132 | unsigned int priority); | |
133 | void ofproto_flush_flows(struct ofproto *); | |
134 | ||
135 | /* Hooks for ovs-vswitchd. */ | |
136 | struct ofhooks { | |
137 | void (*port_changed_cb)(enum ofp_port_reason, const struct ofp_phy_port *, | |
138 | void *aux); | |
139 | bool (*normal_cb)(const flow_t *, const struct ofpbuf *packet, | |
6a07af36 JG |
140 | struct odp_actions *, tag_type *, |
141 | uint16_t *nf_output_iface, void *aux); | |
064af421 BP |
142 | void (*account_flow_cb)(const flow_t *, const union odp_action *, |
143 | size_t n_actions, unsigned long long int n_bytes, | |
144 | void *aux); | |
145 | void (*account_checkpoint_cb)(void *aux); | |
146 | }; | |
147 | void ofproto_revalidate(struct ofproto *, tag_type); | |
148 | struct tag_set *ofproto_get_revalidate_set(struct ofproto *); | |
149 | ||
03292c46 JG |
150 | #ifdef __cplusplus |
151 | } | |
152 | #endif | |
153 | ||
064af421 | 154 | #endif /* ofproto.h */ |