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