]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
abe529af | 2 | * Copyright (c) 2008, 2009, 2010, 2011 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 | #include <config.h> | |
18 | #include "pktbuf.h" | |
19 | #include <inttypes.h> | |
20 | #include <stdlib.h> | |
21 | #include "coverage.h" | |
fa37b408 | 22 | #include "ofp-util.h" |
064af421 BP |
23 | #include "ofpbuf.h" |
24 | #include "timeval.h" | |
25 | #include "util.h" | |
26 | #include "vconn.h" | |
064af421 BP |
27 | #include "vlog.h" |
28 | ||
d98e6007 | 29 | VLOG_DEFINE_THIS_MODULE(pktbuf); |
5136ce49 | 30 | |
d76f09ea BP |
31 | COVERAGE_DEFINE(pktbuf_buffer_unknown); |
32 | COVERAGE_DEFINE(pktbuf_null_cookie); | |
33 | COVERAGE_DEFINE(pktbuf_retrieved); | |
34 | COVERAGE_DEFINE(pktbuf_reuse_error); | |
35 | ||
064af421 BP |
36 | /* Buffers are identified by a 32-bit opaque ID. We divide the ID |
37 | * into a buffer number (low bits) and a cookie (high bits). The buffer number | |
38 | * is an index into an array of buffers. The cookie distinguishes between | |
39 | * different packets that have occupied a single buffer. Thus, the more | |
40 | * buffers we have, the lower-quality the cookie... */ | |
41 | #define PKTBUF_BITS 8 | |
42 | #define PKTBUF_MASK (PKTBUF_CNT - 1) | |
43 | #define PKTBUF_CNT (1u << PKTBUF_BITS) | |
44 | ||
45 | #define COOKIE_BITS (32 - PKTBUF_BITS) | |
46 | #define COOKIE_MAX ((1u << COOKIE_BITS) - 1) | |
47 | ||
48 | #define OVERWRITE_MSECS 5000 | |
49 | ||
50 | struct packet { | |
51 | struct ofpbuf *buffer; | |
52 | uint32_t cookie; | |
53 | long long int timeout; | |
54 | uint16_t in_port; | |
55 | }; | |
56 | ||
57 | struct pktbuf { | |
58 | struct packet packets[PKTBUF_CNT]; | |
59 | unsigned int buffer_idx; | |
7778bd15 | 60 | unsigned int null_idx; |
064af421 BP |
61 | }; |
62 | ||
63 | int | |
64 | pktbuf_capacity(void) | |
65 | { | |
66 | return PKTBUF_CNT; | |
67 | } | |
68 | ||
69 | struct pktbuf * | |
70 | pktbuf_create(void) | |
71 | { | |
ec6fde61 | 72 | return xzalloc(sizeof *pktbuf_create()); |
064af421 BP |
73 | } |
74 | ||
75 | void | |
76 | pktbuf_destroy(struct pktbuf *pb) | |
77 | { | |
78 | if (pb) { | |
79 | size_t i; | |
80 | ||
81 | for (i = 0; i < PKTBUF_CNT; i++) { | |
82 | ofpbuf_delete(pb->packets[i].buffer); | |
83 | } | |
84 | free(pb); | |
85 | } | |
86 | } | |
87 | ||
7778bd15 BP |
88 | static unsigned int |
89 | make_id(unsigned int buffer_idx, unsigned int cookie) | |
90 | { | |
91 | return buffer_idx | (cookie << PKTBUF_BITS); | |
92 | } | |
93 | ||
94 | /* Attempts to allocate an OpenFlow packet buffer id within 'pb'. The packet | |
ec14ac26 EJ |
95 | * buffer will store a copy of 'buffer_size' bytes in 'buffer' and the port |
96 | * number 'in_port', which should be the OpenFlow port number on which 'buffer' | |
97 | * was received. | |
7778bd15 BP |
98 | * |
99 | * If successful, returns the packet buffer id (a number other than | |
100 | * UINT32_MAX). pktbuf_retrieve() can later be used to retrieve the buffer and | |
101 | * its input port number (buffers do expire after a time, so this is not | |
102 | * guaranteed to be true forever). On failure, returns UINT32_MAX. | |
103 | * | |
104 | * The caller retains ownership of 'buffer'. */ | |
064af421 | 105 | uint32_t |
ec14ac26 EJ |
106 | pktbuf_save(struct pktbuf *pb, const void *buffer, size_t buffer_size, |
107 | uint16_t in_port) | |
064af421 BP |
108 | { |
109 | struct packet *p = &pb->packets[pb->buffer_idx]; | |
110 | pb->buffer_idx = (pb->buffer_idx + 1) & PKTBUF_MASK; | |
111 | if (p->buffer) { | |
112 | if (time_msec() < p->timeout) { | |
113 | return UINT32_MAX; | |
114 | } | |
115 | ofpbuf_delete(p->buffer); | |
116 | } | |
117 | ||
118 | /* Don't use maximum cookie value since all-1-bits ID is special. */ | |
119 | if (++p->cookie >= COOKIE_MAX) { | |
120 | p->cookie = 0; | |
121 | } | |
ec14ac26 EJ |
122 | p->buffer = ofpbuf_clone_data_with_headroom(buffer, buffer_size, |
123 | sizeof(struct ofp_packet_in)); | |
124 | ||
125 | ||
064af421 BP |
126 | p->timeout = time_msec() + OVERWRITE_MSECS; |
127 | p->in_port = in_port; | |
7778bd15 BP |
128 | return make_id(p - pb->packets, p->cookie); |
129 | } | |
130 | ||
131 | /* | |
132 | * Allocates and returns a "null" packet buffer id. The returned packet buffer | |
133 | * id is considered valid by pktbuf_retrieve(), but it is not associated with | |
134 | * actual buffered data. | |
135 | * | |
136 | * This function is always successful. | |
137 | * | |
138 | * This is useful in one special case: with the current OpenFlow design, the | |
139 | * "fail-open" code cannot always know whether a connection to a controller is | |
140 | * actually valid until it receives a OFPT_PACKET_OUT or OFPT_FLOW_MOD request, | |
141 | * but at that point the packet in question has already been forwarded (since | |
142 | * we are still in "fail-open" mode). If the packet was buffered in the usual | |
143 | * way, then the OFPT_PACKET_OUT or OFPT_FLOW_MOD would cause a duplicate | |
144 | * packet in the network. Null packet buffer ids identify such a packet that | |
145 | * has already been forwarded, so that Open vSwitch can quietly ignore the | |
146 | * request to re-send it. (After that happens, the switch exits fail-open | |
147 | * mode.) | |
148 | * | |
149 | * See the top-level comment in fail-open.c for an overview. | |
150 | */ | |
151 | uint32_t | |
152 | pktbuf_get_null(void) | |
153 | { | |
154 | return make_id(0, COOKIE_MAX); | |
064af421 BP |
155 | } |
156 | ||
7778bd15 | 157 | /* Attempts to retrieve a saved packet with the given 'id' from 'pb'. Returns |
90bf1e07 | 158 | * 0 if successful, otherwise an OpenFlow error code. |
7778bd15 BP |
159 | * |
160 | * On success, ordinarily stores the buffered packet in '*bufferp' and the | |
161 | * datapath port number on which the packet was received in '*in_port'. The | |
162 | * caller becomes responsible for freeing the buffer. However, if 'id' | |
163 | * identifies a "null" packet buffer (created with pktbuf_get_null()), stores | |
608efb41 | 164 | * NULL in '*bufferp' and UINT16_max in '*in_port'. |
7778bd15 | 165 | * |
109b8459 BP |
166 | * 'in_port' may be NULL if the input port is not of interest. |
167 | * | |
750638bb BP |
168 | * A returned packet will have at least sizeof(struct ofp_packet_in) bytes of |
169 | * headroom. | |
170 | * | |
608efb41 | 171 | * On failure, stores NULL in in '*bufferp' and UINT16_MAX in '*in_port'. */ |
90bf1e07 | 172 | enum ofperr |
064af421 BP |
173 | pktbuf_retrieve(struct pktbuf *pb, uint32_t id, struct ofpbuf **bufferp, |
174 | uint16_t *in_port) | |
175 | { | |
176 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 20); | |
177 | struct packet *p; | |
90bf1e07 | 178 | enum ofperr error; |
064af421 | 179 | |
abe529af BP |
180 | if (id == UINT32_MAX) { |
181 | error = 0; | |
182 | goto error; | |
183 | } | |
184 | ||
064af421 BP |
185 | if (!pb) { |
186 | VLOG_WARN_RL(&rl, "attempt to send buffered packet via connection " | |
187 | "without buffers"); | |
90bf1e07 | 188 | return OFPERR_OFPBRC_BUFFER_UNKNOWN; |
064af421 BP |
189 | } |
190 | ||
191 | p = &pb->packets[id & PKTBUF_MASK]; | |
192 | if (p->cookie == id >> PKTBUF_BITS) { | |
193 | struct ofpbuf *buffer = p->buffer; | |
194 | if (buffer) { | |
195 | *bufferp = buffer; | |
109b8459 BP |
196 | if (in_port) { |
197 | *in_port = p->in_port; | |
198 | } | |
064af421 BP |
199 | p->buffer = NULL; |
200 | COVERAGE_INC(pktbuf_retrieved); | |
201 | return 0; | |
202 | } else { | |
203 | COVERAGE_INC(pktbuf_reuse_error); | |
204 | VLOG_WARN_RL(&rl, "attempt to reuse buffer %08"PRIx32, id); | |
90bf1e07 | 205 | error = OFPERR_OFPBRC_BUFFER_EMPTY; |
064af421 | 206 | } |
7778bd15 | 207 | } else if (id >> PKTBUF_BITS != COOKIE_MAX) { |
49bdc010 | 208 | COVERAGE_INC(pktbuf_buffer_unknown); |
064af421 BP |
209 | VLOG_WARN_RL(&rl, "cookie mismatch: %08"PRIx32" != %08"PRIx32, |
210 | id, (id & PKTBUF_MASK) | (p->cookie << PKTBUF_BITS)); | |
90bf1e07 | 211 | error = OFPERR_OFPBRC_BUFFER_UNKNOWN; |
7778bd15 BP |
212 | } else { |
213 | COVERAGE_INC(pktbuf_null_cookie); | |
214 | VLOG_INFO_RL(&rl, "Received null cookie %08"PRIx32" (this is normal " | |
215 | "if the switch was recently in fail-open mode)", id); | |
216 | error = 0; | |
064af421 | 217 | } |
abe529af | 218 | error: |
064af421 | 219 | *bufferp = NULL; |
109b8459 BP |
220 | if (in_port) { |
221 | *in_port = UINT16_MAX; | |
222 | } | |
064af421 BP |
223 | return error; |
224 | } | |
225 | ||
226 | void | |
227 | pktbuf_discard(struct pktbuf *pb, uint32_t id) | |
228 | { | |
229 | struct packet *p = &pb->packets[id & PKTBUF_MASK]; | |
230 | if (p->cookie == id >> PKTBUF_BITS) { | |
231 | ofpbuf_delete(p->buffer); | |
232 | p->buffer = NULL; | |
233 | } | |
234 | } |