git.barrelfish.org Git - barrelfish/blob - 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->buffer_shift = 0;
  91     while(!((reg->buffer_size >> reg->buffer_shift) & 0x1)) {
  92         reg->buffer_shift++;
  93     }
  94
  95     reg->framecap = frame;
  96     reg->pool = bp;
  97
  98     err = invoke_frame_identify(reg->framecap, &reg->frame);
  99     if (err_is_fail(err)) {
 100         goto out_err1;
 101     }
 102
 103     NETDEBUG("bp=%p, framesize=%zu kB, elementsize=%zu\n", bp,
 104              reg->frame.bytes >> 10, buffersize);
 105
 106
 107     size_t numbuf = reg->frame.bytes / reg->buffer_size;
 108     assert(numbuf * reg->buffer_size <= reg->frame.bytes);
 109
 110     reg->netbufs = calloc(numbuf, sizeof(struct net_buf_p));
 111     if (reg->netbufs == NULL) {
 112         err = LIB_ERR_MALLOC_FAIL;
 113         goto out_err1;
 114     }
 115
 116     err = vspace_map_one_frame_attr(&reg->vbase, reg->frame.bytes, reg->framecap,
 117                                     NETWORKING_DEFAULT_BUFFER_FLAGS, NULL, NULL);
 118     if (err_is_fail(err)) {
 119         goto out_err2;
 120     }
 121
 122     NETDEBUG("netbufs mapped at %p\n", reg->vbase);
 123
 124     if (bp->dev_q) {
 125         debug_printf("netbuf: registering region with devq...\n");
 126         err = devq_register(bp->dev_q, reg->framecap, &reg->regionid);
 127         if (err_is_fail(err)) {
 128             goto out_err1;
 129         }
 130         NETDEBUG("registered region with devq. pbase=%" PRIxGENPADDR ", regionid=%" PRIx32 "\n",
 131                   reg->frame.base, reg->regionid);
 132     }
 133
 134     size_t offset = 0;
 135     for (size_t i = 0; i < numbuf; i++) {
 136         struct net_buf_p *nb = &reg->netbufs[i];
 137
 138         nb->offset = offset;
 139         nb->vbase = reg->vbase + offset;
 140         nb->region = reg;
 141         nb->pbuf.custom_free_function = net_buf_free;
 142 #if NETBUF_DEBGUG
 143         nb->allocated = 0;
 144         nb->enqueued = 0;
 145         nb->flags = 0;
 146         nb->magic = 0xdeadbeefcafebabe;
 147 #endif
 148         /* enqueue to freelist */
 149         nb->pbuf.pbuf.next =  bp->pbufs;
 150         bp->pbufs = &nb->pbuf.pbuf;
 151         bp->buffer_count++;
 152         bp->buffer_free++;
 153         offset += reg->buffer_size;
 154     }
 155
 156     reg->next = bp->regions;
 157     bp->regions = reg;
 158
 159     assert(bp->pbufs);
 160
 161     NETDEBUG("new region added to pool. free count: %zu / %zu\n",
 162              bp->buffer_free, bp->buffer_count);
 163
 164     return SYS_ERR_OK;
 165
 166     out_err2:
 167     free(reg->netbufs);
 168     out_err1:
 169     free(reg);
 170
 171     return err;
 172 }
 173
 174 /**
 175  * @brief grows the number of available buffers
 176  *
 177  * @param bp        buffer pool to grow
 178  * @param numbuf    number of buffers to create
 179  * @param size      size of a buffer
 180  *
 181  * @return SYS_ERR_OK on success, errval on failure
 182  */
 183 errval_t net_buf_grow(struct net_buf_pool *bp, size_t numbuf,
 184                                 size_t size)
 185 {
 186     errval_t err;
 187
 188     NETDEBUG("bp=%p, numbuf=%zu, size=%zu\n", bp, numbuf, size);
 189
 190     size = ROUND_UP(size, NETWORKING_BUFFER_ALIGN);
 191
 192     size_t alloc_size = ROUND_UP(numbuf * size, BASE_PAGE_SIZE);
 193
 194     NETDEBUG("allocate frame of %zu kB\n", alloc_size >> 10);
 195
 196     struct capref frame;
 197     err = frame_alloc(&frame, alloc_size, &alloc_size);
 198     if (err_is_fail(err)) {
 199         return err;
 200     }
 201
 202     err =  net_buf_add(bp, frame, size);
 203     if (err_is_fail(err)) {
 204         cap_destroy(frame);
 205     }
 206
 207     return err;
 208 }
 209
 210
 211 struct pbuf *net_buf_alloc(struct net_buf_pool *bp)
 212 {
 213     if (bp->pbufs) {
 214         struct net_buf_p *nb = (struct net_buf_p *)bp->pbufs;
 215 #if BENCH_LWIP_STACK
 216         nb->timestamp = 0;
 217 #endif
 218
 219 #if NETBUF_DEBGUG
 220         assert(nb->magic == 0xdeadbeefcafebabe);
 221         assert(nb->allocated == 0);
 222         assert(nb->enqueued == 0);
 223         assert(nb->flags == 0);
 224
 225 #endif
 226         bp->pbufs = bp->pbufs->next;
 227         bp->buffer_free--;
 228         struct pbuf* p;
 229         p = pbuf_alloced_custom(PBUF_RAW, 0, PBUF_REF, &nb->pbuf,
 230                                 nb->vbase, nb->region->buffer_size);
 231 #if NETBUF_DEBGUG
 232         nb->allocated = 1;
 233         assert(p->next == NULL);
 234 #endif
 235         NETDEBUG("bp=%p, allocated pbuf=%p, free count %zu / %zu\n", bp, p,
 236                  bp->buffer_free, bp->buffer_count);
 237      //   printf("alloc: %p\n", p);
 238
 239         return p;
 240     }
 241
 242     NETDEBUG("bp=%p has no free buffers. Free %zu / %zu\n", bp, bp->buffer_free,
 243                  bp->buffer_count);
 244
 245     return NULL;
 246 }
 247
 248 void net_buf_free(struct pbuf *p)
 249 {
 250     NETDEBUG("pbuf=%p\n", p);
 251
 252     if (p->next) {
 253         debug_printf("!!!!!! p->NEXT was not NULL\n");
 254     }
 255
 256    // printf("free: %p\n", p);
 257
 258     // TODO sanity checks ?
 259     struct net_buf_p *nb = (struct net_buf_p *)p;
 260
 261 #if NETBUF_DEBGUG
 262     assert(nb->magic == 0xdeadbeefcafebabe);
 263     assert(p->ref == 0);
 264     assert(nb->allocated == 1);
 265     assert(nb->enqueued == 0);
 266     assert(nb->flags == 0);
 267     nb->allocated = 0;
 268
 269 #endif
 270
 271     struct net_buf_pool *bp = nb->region->pool;
 272     p->next =  bp->pbufs;
 273     bp->pbufs = p;
 274     bp->buffer_free++;
 275 }
 276
 277 struct pbuf *net_buf_get_by_region(struct net_buf_pool *bp,
 278                                              uint32_t regionid, size_t offset)
 279 {
 280     NETDEBUG("bp=%p, rid=%u, offset=%zu\n", bp, regionid, offset);
 281
 282     struct net_buf_region *reg = bp->regions;
 283     while(reg) {
 284         if (reg->regionid == regionid) {
 285             /* found */
 286             if (reg->frame.bytes < offset) {
 287                 return NULL;
 288             }
 289
 290             assert((offset & (reg->buffer_size - 1)) == 0);
 291             assert(offset / reg->buffer_size < reg->pool->buffer_count);
 292             struct net_buf_p *nb = reg->netbufs + (offset / reg->buffer_size);
 293
 294             assert((offset / reg->buffer_size) == (offset >> reg->buffer_shift));
 295
 296             assert(nb->offset == offset);
 297
 298             return (struct pbuf *)nb;
 299         }
 300         reg = reg->next;
 301     }
 302     return NULL;
 303 }