9ns: Fix issues with can_have_children
[akaros.git] / kern / src / ns / allocb.c
1 /* Copyright © 1994-1999 Lucent Technologies Inc.  All rights reserved.
2  * Portions Copyright © 1997-1999 Vita Nuova Limited
3  * Portions Copyright © 2000-2007 Vita Nuova Holdings Limited
4  *                                (www.vitanuova.com)
5  * Revisions Copyright © 2000-2007 Lucent Technologies Inc. and others
6  *
7  * Modified for the Akaros operating system:
8  * Copyright (c) 2013-2014 The Regents of the University of California
9  * Copyright (c) 2013-2015 Google Inc.
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a copy
12  * of this software and associated documentation files (the "Software"), to deal
13  * in the Software without restriction, including without limitation the rights
14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15  * copies of the Software, and to permit persons to whom the Software is
16  * furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included in
19  * all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE. */
28
29 #include <slab.h>
30 #include <kmalloc.h>
31 #include <kref.h>
32 #include <string.h>
33 #include <stdio.h>
34 #include <assert.h>
35 #include <error.h>
36 #include <cpio.h>
37 #include <pmap.h>
38 #include <smp.h>
39 #include <net/ip.h>
40 #include <process.h>
41
42 /* Note that Hdrspc is only available via padblock (to the 'left' of the rp). */
43 enum {
44         Hdrspc = 128,           /* leave room for high-level headers */
45         Bdead = 0x51494F42,     /* "QIOB" */
46         BLOCKALIGN = 32,        /* was the old BY2V in inferno, which was 8 */
47 };
48
49 /*
50  *  allocate blocks (round data base address to 64 bit boundary).
51  *  if mallocz gives us more than we asked for, leave room at the front
52  *  for header.
53  */
54 struct block *block_alloc(size_t size, int mem_flags)
55 {
56         struct block *b;
57         uintptr_t addr;
58         int n;
59
60         /* If Hdrspc is not block aligned it will cause issues. */
61         static_assert(Hdrspc % BLOCKALIGN == 0);
62
63         b = kmalloc(sizeof(struct block) + size + Hdrspc + (BLOCKALIGN - 1),
64                                 mem_flags);
65         if (b == NULL)
66                 return NULL;
67
68         b->next = NULL;
69         b->list = NULL;
70         b->free = NULL;
71         b->flag = 0;
72         b->extra_len = 0;
73         b->nr_extra_bufs = 0;
74         b->extra_data = 0;
75         b->mss = 0;
76         b->network_offset = 0;
77         b->transport_offset = 0;
78
79         addr = (uintptr_t) b;
80         addr = ROUNDUP(addr + sizeof(struct block), BLOCKALIGN);
81         b->base = (uint8_t *) addr;
82         /* TODO: support this */
83         /* interesting. We can ask the allocator, after allocating,
84          * the *real* size of the block we got. Very nice.
85          * Not on akaros yet.
86          b->lim = ((uint8_t*)b) + msize(b);
87          * See use of n in commented code below
88          */
89         b->lim =
90                 ((uint8_t *) b) + sizeof(struct block) + size + Hdrspc + (BLOCKALIGN -
91                                                                                                                                   1);
92         b->rp = b->base;
93         /* TODO: support this */
94         /* n is supposed to be Hdrspc + rear padding + extra reserved memory, but
95          * since we don't currently support checking how much memory was actually
96          * reserved, this is always Hdrspc + rear padding. After rounding that down
97          * to BLOCKALIGN, it's always Hdrpsc since the padding is < BLOCKALIGN.
98          n = b->lim - b->base - size;
99          b->rp += n & ~(BLOCKALIGN - 1);
100          */
101         b->rp += Hdrspc;
102         b->wp = b->rp;
103         /* b->base is aligned, rounded up from b
104          * b->lim is the upper bound on our malloc
105          * b->rp is advanced by some aligned amount, based on how much extra we
106          * received from kmalloc and the Hdrspc. */
107         return b;
108 }
109
110 /* Makes sure b has nr_bufs extra_data.  Will grow, but not shrink, an existing
111  * extra_data array.  When growing, it'll copy over the old entries.  All new
112  * entries will be zeroed.  mem_flags determines if we'll block on kmallocs.
113  *
114  * Return 0 on success or -1 on error.
115  * Caller is responsible for concurrent access to the block's metadata. */
116 int block_add_extd(struct block *b, unsigned int nr_bufs, int mem_flags)
117 {
118         unsigned int old_nr_bufs = b->nr_extra_bufs;
119         size_t old_amt = sizeof(struct extra_bdata) * old_nr_bufs;
120         size_t new_amt = sizeof(struct extra_bdata) * nr_bufs;
121         void *new_bdata;
122
123         if (old_nr_bufs >= nr_bufs)
124                 return 0;
125         if (b->extra_data) {
126                 new_bdata = krealloc(b->extra_data, new_amt, mem_flags);
127                 if (!new_bdata)
128                         return -1;
129                 memset(new_bdata + old_amt, 0, new_amt - old_amt);
130         } else {
131                 new_bdata = kzmalloc(new_amt, mem_flags);
132                 if (!new_bdata)
133                         return - 1;
134         }
135         b->extra_data = new_bdata;
136         b->nr_extra_bufs = nr_bufs;
137         return 0;
138 }
139
140 /* Go backwards from the end of the list, remember the last unused slot, and
141  * stop when a used slot is encountered. */
142 static struct extra_bdata *next_unused_slot(struct block *b)
143 {
144         struct extra_bdata *ebd = NULL;
145
146         for (int i = b->nr_extra_bufs - 1; i >= 0; i--) {
147                 if (b->extra_data[i].base)
148                         break;
149                 ebd = &b->extra_data[i];
150         }
151         return ebd;
152 }
153
154 /* Append an extra data buffer @base with offset @off of length @len to block
155  * @b.  Reuse an unused extra data slot if there's any.
156  * Return 0 on success or -1 on error. */
157 int block_append_extra(struct block *b, uintptr_t base, uint32_t off,
158                        uint32_t len, int mem_flags)
159 {
160         unsigned int nr_bufs = b->nr_extra_bufs + 1;
161         struct extra_bdata *ebd;
162
163         ebd = next_unused_slot(b);
164         if (!ebd) {
165                 if (block_add_extd(b, nr_bufs, mem_flags) != 0)
166                         return -1;
167                 ebd = next_unused_slot(b);
168                 assert(ebd);
169         }
170         ebd->base = base;
171         ebd->off = off;
172         ebd->len = len;
173         b->extra_len += ebd->len;
174         return 0;
175 }
176
177 /* There's metadata in each block related to the data payload.  For instance,
178  * the TSO mss, the offsets to various headers, whether csums are needed, etc.
179  * When you create a new block, like in copyblock, this will copy those bits
180  * over. */
181 void block_copy_metadata(struct block *new_b, struct block *old_b)
182 {
183         new_b->flag |= (old_b->flag & BLOCK_META_FLAGS);
184         new_b->tx_csum_offset = old_b->tx_csum_offset;
185         new_b->mss = old_b->mss;
186         new_b->network_offset = old_b->network_offset;
187         new_b->transport_offset = old_b->transport_offset;
188 }
189
190 void block_reset_metadata(struct block *b)
191 {
192         b->flag &= ~BLOCK_META_FLAGS;
193         b->tx_csum_offset = 0;
194         b->mss = 0;
195         b->network_offset = 0;
196         b->transport_offset = 0;
197 }
198
199 void free_block_extra(struct block *b)
200 {
201         struct extra_bdata *ebd;
202
203         /* assuming our release method is kfree, which will change when we support
204          * user buffers */
205         for (int i = 0; i < b->nr_extra_bufs; i++) {
206                 ebd = &b->extra_data[i];
207                 if (ebd->base)
208                         kfree((void*)ebd->base);
209         }
210         b->extra_len = 0;
211         b->nr_extra_bufs = 0;
212         kfree(b->extra_data);   /* harmless if it is 0 */
213         b->extra_data = 0;              /* in case the block is reused by a free override */
214 }
215
216 /* Frees a block, returning its size (len, not alloc) */
217 size_t freeb(struct block *b)
218 {
219         void *dead = (void *)Bdead;
220         size_t ret;
221
222         if (b == NULL)
223                 return 0;
224         ret = BLEN(b);
225         free_block_extra(b);
226         /*
227          * drivers which perform non cache coherent DMA manage their own buffer
228          * pool of uncached buffers and provide their own free routine.
229          */
230         if (b->free) {
231                 b->free(b);
232                 return ret;
233         }
234         /* poison the block in case someone is still holding onto it */
235         b->next = dead;
236         b->rp = dead;
237         b->wp = dead;
238         b->lim = dead;
239         b->base = dead;
240         kfree(b);
241         return ret;
242 }
243
244 /* Free a list of blocks, returning their total size. */
245 size_t freeblist(struct block *b)
246 {
247         struct block *next;
248         size_t ret = 0;
249
250         for (; b != 0; b = next) {
251                 next = b->next;
252                 b->next = 0;
253                 ret += freeb(b);
254         }
255         return ret;
256 }
257
258 void checkb(struct block *b, char *msg)
259 {
260         void *dead = (void *)Bdead;
261         struct extra_bdata *ebd;
262         size_t extra_len = 0;
263
264         if (b == dead)
265                 panic("checkb b %s 0x%lx", msg, b);
266         if (b->base == dead || b->lim == dead || b->next == dead
267                 || b->rp == dead || b->wp == dead) {
268                 printd("checkb: base 0x%8.8lx lim 0x%8.8lx next 0x%8.8lx\n",
269                            b->base, b->lim, b->next);
270                 printd("checkb: rp 0x%8.8lx wp 0x%8.8lx\n", b->rp, b->wp);
271                 panic("checkb dead: %s\n", msg);
272         }
273
274         if (b->base > b->lim)
275                 panic("checkb 0 %s 0x%lx 0x%lx", msg, b->base, b->lim);
276         if (b->rp < b->base)
277                 panic("checkb 1 %s 0x%lx 0x%lx", msg, b->base, b->rp);
278         if (b->wp < b->base)
279                 panic("checkb 2 %s 0x%lx 0x%lx", msg, b->base, b->wp);
280         if (b->rp > b->lim)
281                 panic("checkb 3 %s 0x%lx 0x%lx", msg, b->rp, b->lim);
282         if (b->wp > b->lim)
283                 panic("checkb 4 %s 0x%lx 0x%lx", msg, b->wp, b->lim);
284         if (b->nr_extra_bufs && !b->extra_data)
285                 panic("checkb 5 %s missing extra_data", msg);
286
287         for (int i = 0; i < b->nr_extra_bufs; i++) {
288                 ebd = &b->extra_data[i];
289                 if (!ebd->base && (ebd->off || ebd->len))
290                         panic("checkb %s: ebd %d has no base, but has off %d and len %d",
291                               msg, i, ebd->off, ebd->len);
292                 if (ebd->base) {
293                         if (!kmalloc_refcnt((void*)ebd->base))
294                                 panic("checkb %s: buf %d, base %p has no refcnt!\n", msg, i,
295                                       ebd->base);
296                         extra_len += ebd->len;
297                 }
298         }
299         if (extra_len != b->extra_len)
300                 panic("checkb %s: block extra_len %d differs from sum of ebd len %d",
301                       msg, b->extra_len, extra_len);
302 }
303
304 void printblock(struct block *b)
305 {
306         unsigned char *c;
307         unsigned int off, elen;
308         struct extra_bdata *e;
309
310         if (b == NULL) {
311                 printk("block is null\n");
312                 return;
313         }
314
315         print_lock();
316         printk("block of BLEN = %d, with %d header and %d data in %d extras\n",
317                BLEN(b), BHLEN(b), b->extra_len, b->nr_extra_bufs);
318
319         printk("header:\n");
320         printk("%2x:\t", 0);
321         off = 0;
322         for (c = b->rp; c < b->wp; c++) {
323                 printk("  %02x", *c & 0xff);
324                 off++;
325                 if (off % 8 == 0) {
326                         printk("\n");
327                         printk("%2x:\t", off);
328                 }
329         }
330         printk("\n");
331         elen = b->extra_len;
332         for (int i = 0; (i < b->nr_extra_bufs) && elen; i++) {
333                 e = &b->extra_data[i];
334                 if (e->len == 0)
335                         continue;
336                 elen -= e->len;
337                 printk("data %d:\n", i);
338                 printk("%2x:\t", 0);
339                 for (off = 0; off < e->len; off++) {
340                         c = (unsigned char *)e->base + e->off + off;
341                         printk("  %02x", *c & 0xff);
342                         if ((off + 1) % 8 == 0 && off +1 < e->len) {
343                                 printk("\n");
344                                 printk("%2x:\t", off + 1);
345                         }
346                 }
347         }
348         printk("\n");
349         print_unlock();
350 }