libnet: adding buffer debug facilities
[barrelfish] / lib / net / netbufs.c
1 /*
2  * Copyright (c) 2017, ETH Zurich.
3  * All rights reserved.
4  *
5  * This file is distributed under the terms in the attached LICENSE file.
6  * If you do not find this file, copies can be found by writing to:
7  * ETH Zurich D-INFK, Universitaetsstrasse 6, CH-8092 Zurich. Attn: Systems Group.
8  */
9
10
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <string.h>
14
15 #include <barrelfish/barrelfish.h>
16
17 #include <devif/queue_interface.h>
18
19 #include <lwip/pbuf.h>
20
21 #include "networking_internal.h"
22 #define NETDEBUG_SUBSYSTEM "net_buf"
23
24
25 ///< the default flags to map the buffers
26 #define NETWORKING_DEFAULT_BUFFER_FLAGS VREGION_FLAGS_READ_WRITE
27
28 ///< buffer alignment
29 #define NETWORKING_BUFFER_ALIGN 2048
30
31
32
33 /**
34  * @brief initializes the networking buffer pools
35  *
36  * @param dev_q     the device queue to create the buffer pool for
37  * @param numbuf    number of initial buffers
38  * @param size      size of the networking buffer
39  * @param retbp     buffer pool to initialize
40  *
41  * @return SYS_ERR_OK on success, errval on failure
42  */
43 errval_t net_buf_init(struct devq *dev_q, size_t numbuf, size_t size,
44                                 struct net_buf_pool **retbp)
45 {
46     errval_t err;
47
48     assert(retbp);
49
50     NETDEBUG("initializing buffer pool with %zu x %zu buffers...\n", numbuf, size);
51
52     struct net_buf_pool *netbp = calloc(1, sizeof(*netbp));
53     if (netbp == NULL) {
54         return LIB_ERR_MALLOC_FAIL;
55     }
56
57     netbp->dev_q = dev_q;
58
59     err = net_buf_grow(netbp, numbuf, size);
60     if (err_is_fail(err)) {
61         free(netbp);
62         return err;
63     }
64
65     *retbp = netbp;
66
67     return SYS_ERR_OK;
68 }
69
70 /**
71  * @brief adds a previously allocated frame to the buffer pool
72  *
73  * @param bp            buffer pool to add the frame to
74  * @param frame         frame capability
75  * @param buffersize    size of a buffer
76  *
77  * @return SYS_ERR_OK on success, errval on failure
78  */
79 errval_t net_buf_add(struct net_buf_pool *bp, struct capref frame, size_t buffersize)
80 {
81     errval_t err;
82
83
84     struct net_buf_region *reg = calloc(1, sizeof(struct net_buf_region));
85     if (reg == NULL) {
86         return LIB_ERR_MALLOC_FAIL;
87     }
88
89     reg->buffer_size = ROUND_UP(buffersize, NETWORKING_BUFFER_ALIGN);
90     reg->framecap = frame;
91     reg->pool = bp;
92
93     err = invoke_frame_identify(reg->framecap, &reg->frame);
94     if (err_is_fail(err)) {
95         goto out_err1;
96     }
97
98     NETDEBUG("bp=%p, framesize=%zu kB, elementsize=%zu\n", bp,
99              reg->frame.bytes >> 10, buffersize);
100
101
102     size_t numbuf = reg->frame.bytes / reg->buffer_size;
103     assert(numbuf * reg->buffer_size <= reg->frame.bytes);
104
105     reg->netbufs = calloc(numbuf, sizeof(struct net_buf_p));
106     if (reg->netbufs == NULL) {
107         err = LIB_ERR_MALLOC_FAIL;
108         goto out_err1;
109     }
110
111     err = vspace_map_one_frame_attr(&reg->vbase, reg->frame.bytes, reg->framecap,
112                                     NETWORKING_DEFAULT_BUFFER_FLAGS, NULL, NULL);
113     if (err_is_fail(err)) {
114         goto out_err2;
115     }
116
117     NETDEBUG("netbufs mapped at %p\n", reg->vbase);
118
119     if (bp->dev_q) {
120         debug_printf("netbuf: registering region with devq...\n");
121         err = devq_register(bp->dev_q, reg->framecap, &reg->regionid);
122         if (err_is_fail(err)) {
123             goto out_err1;
124         }
125         NETDEBUG("registered region with devq. pbase=%" PRIxGENPADDR ", regionid=%" PRIx32 "\n",
126                   reg->frame.base, reg->regionid);
127     }
128
129     size_t offset = 0;
130     for (size_t i = 0; i < numbuf; i++) {
131         struct net_buf_p *nb = &reg->netbufs[i];
132
133         nb->offset = offset;
134         nb->vbase = reg->vbase + offset;
135         nb->region = reg;
136         nb->pbuf.custom_free_function = net_buf_free;
137 #if NETBUF_DEBGUG
138         nb->allocated = 0;
139         nb->enqueued = 0;
140         nb->flags = 0;
141         nb->magic = 0xdeadbeefcafebabe;
142 #endif
143         /* enqueue to freelist */
144         nb->pbuf.pbuf.next =  bp->pbufs;
145         bp->pbufs = &nb->pbuf.pbuf;
146         bp->buffer_count++;
147         bp->buffer_free++;
148         offset += reg->buffer_size;
149     }
150
151     reg->next = bp->regions;
152     bp->regions = reg;
153
154     assert(bp->pbufs);
155
156     NETDEBUG("new region added to pool. free count: %zu / %zu\n",
157              bp->buffer_free, bp->buffer_count);
158
159     return SYS_ERR_OK;
160
161     out_err2:
162     free(reg->netbufs);
163     out_err1:
164     free(reg);
165
166     return err;
167 }
168
169 /**
170  * @brief grows the number of available buffers
171  *
172  * @param bp        buffer pool to grow
173  * @param numbuf    number of buffers to create
174  * @param size      size of a buffer
175  *
176  * @return SYS_ERR_OK on success, errval on failure
177  */
178 errval_t net_buf_grow(struct net_buf_pool *bp, size_t numbuf,
179                                 size_t size)
180 {
181     errval_t err;
182
183     NETDEBUG("bp=%p, numbuf=%zu, size=%zu\n", bp, numbuf, size);
184
185     size = ROUND_UP(size, NETWORKING_BUFFER_ALIGN);
186
187     size_t alloc_size = ROUND_UP(numbuf * size, BASE_PAGE_SIZE);
188
189     NETDEBUG("allocate frame of %zu kB\n", alloc_size >> 10);
190
191     struct capref frame;
192     err = frame_alloc(&frame, alloc_size, &alloc_size);
193     if (err_is_fail(err)) {
194         return err;
195     }
196
197     err =  net_buf_add(bp, frame, size);
198     if (err_is_fail(err)) {
199         cap_destroy(frame);
200     }
201
202     return err;
203 }
204
205
206 struct pbuf *net_buf_alloc(struct net_buf_pool *bp)
207 {
208     if (bp->pbufs) {
209         struct net_buf_p *nb = (struct net_buf_p *)bp->pbufs;
210 #if BENCH_LWIP_STACK
211         nb->timestamp = 0;
212 #endif
213
214 #if NETBUF_DEBGUG
215         assert(nb->magic == 0xdeadbeefcafebabe);
216         assert(nb->allocated == 0);
217         assert(nb->enqueued == 0);
218         assert(nb->flags == 0);
219
220 #endif
221         bp->pbufs = bp->pbufs->next;
222         bp->buffer_free--;
223         struct pbuf* p;
224         p = pbuf_alloced_custom(PBUF_RAW, 0, PBUF_REF, &nb->pbuf,
225                                 nb->vbase, nb->region->buffer_size);
226 #if NETBUF_DEBGUG
227         nb->allocated = 1;
228         assert(p->next == NULL);
229 #endif
230         NETDEBUG("bp=%p, allocated pbuf=%p, free count %zu / %zu\n", bp, p,
231                  bp->buffer_free, bp->buffer_count);
232      //   printf("alloc: %p\n", p);
233
234         return p;
235     }
236
237     NETDEBUG("bp=%p has no free buffers. Free %zu / %zu\n", bp, bp->buffer_free,
238                  bp->buffer_count);
239
240     return NULL;
241 }
242
243 void net_buf_free(struct pbuf *p)
244 {
245     NETDEBUG("pbuf=%p\n", p);
246
247     if (p->next) {
248         debug_printf("!!!!!! p->NEXT was not NULL\n");
249     }
250
251    // printf("free: %p\n", p);
252
253     // TODO sanity checks ?
254     struct net_buf_p *nb = (struct net_buf_p *)p;
255
256 #if NETBUF_DEBGUG
257     assert(nb->magic == 0xdeadbeefcafebabe);
258     assert(p->ref == 0);
259     assert(nb->allocated == 1);
260     assert(nb->enqueued == 0);
261     assert(nb->flags == 0);
262     nb->allocated = 0;
263
264 #endif
265
266     struct net_buf_pool *bp = nb->region->pool;
267     p->next =  bp->pbufs;
268     bp->pbufs = p;
269     bp->buffer_free++;
270 }
271
272 struct pbuf *net_buf_get_by_region(struct net_buf_pool *bp,
273                                              uint32_t regionid, size_t offset)
274 {
275     NETDEBUG("bp=%p, rid=%u, offset=%zu\n", bp, regionid, offset);
276
277     struct net_buf_region *reg = bp->regions;
278     while(reg) {
279         if (reg->regionid == regionid) {
280             /* found */
281             if (reg->frame.bytes < offset) {
282                 return NULL;
283             }
284
285             assert((offset & (reg->buffer_size - 1)) == 0);
286             assert(offset / reg->buffer_size < reg->pool->buffer_count);
287             struct net_buf_p *nb = reg->netbufs + (offset / reg->buffer_size);
288             assert(nb->offset == offset);
289
290             return (struct pbuf *)nb;
291         }
292         reg = reg->next;
293     }
294     return NULL;
295 }