Pass the buf to block_append_extra()
[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 <vfs.h>
30 #include <kfs.h>
31 #include <slab.h>
32 #include <kmalloc.h>
33 #include <kref.h>
34 #include <string.h>
35 #include <stdio.h>
36 #include <assert.h>
37 #include <error.h>
38 #include <cpio.h>
39 #include <pmap.h>
40 #include <smp.h>
41 #include <ip.h>
42 #include <process.h>
43
44 /* Note that Hdrspc is only available via padblock (to the 'left' of the rp). */
45 enum {
46         Hdrspc = 128,           /* leave room for high-level headers */
47         Bdead = 0x51494F42,     /* "QIOB" */
48         BLOCKALIGN = 32,        /* was the old BY2V in inferno, which was 8 */
49 };
50
51 /*
52  *  allocate blocks (round data base address to 64 bit boundary).
53  *  if mallocz gives us more than we asked for, leave room at the front
54  *  for header.
55  */
56 struct block *block_alloc(size_t size, int mem_flags)
57 {
58         struct block *b;
59         uintptr_t addr;
60         int n;
61
62         b = kmalloc(sizeof(struct block) + size + Hdrspc + (BLOCKALIGN - 1),
63                                 mem_flags);
64         if (b == NULL)
65                 return NULL;
66
67         b->next = NULL;
68         b->list = NULL;
69         b->free = NULL;
70         b->flag = 0;
71         b->extra_len = 0;
72         b->nr_extra_bufs = 0;
73         b->extra_data = 0;
74
75         addr = (uintptr_t) b;
76         addr = ROUNDUP(addr + sizeof(struct block), BLOCKALIGN);
77         b->base = (uint8_t *) addr;
78         /* TODO: support this */
79         /* interesting. We can ask the allocator, after allocating,
80          * the *real* size of the block we got. Very nice.
81          * Not on akaros yet.
82          b->lim = ((uint8_t*)b) + msize(b);
83          */
84         b->lim =
85                 ((uint8_t *) b) + sizeof(struct block) + size + Hdrspc + (BLOCKALIGN -
86                                                                                                                                   1);
87         b->rp = b->base;
88         n = b->lim - b->base - size;
89         b->rp += n & ~(BLOCKALIGN - 1);
90         b->wp = b->rp;
91         /* b->base is aligned, rounded up from b
92          * b->lim is the upper bound on our malloc
93          * b->rp is advanced by some aligned amount, based on how much extra we
94          * received from kmalloc and the Hdrspc. */
95         return b;
96 }
97
98 /* Makes sure b has nr_bufs extra_data.  Will grow, but not shrink, an existing
99  * extra_data array.  When growing, it'll copy over the old entries.  All new
100  * entries will be zeroed.  mem_flags determines if we'll block on kmallocs.
101  *
102  * Return 0 on success or -1 on error.
103  * Caller is responsible for concurrent access to the block's metadata. */
104 int block_add_extd(struct block *b, unsigned int nr_bufs, int mem_flags)
105 {
106         unsigned int old_nr_bufs = b->nr_extra_bufs;
107         size_t old_amt = sizeof(struct extra_bdata) * old_nr_bufs;
108         size_t new_amt = sizeof(struct extra_bdata) * nr_bufs;
109         void *new_bdata;
110
111         if (old_nr_bufs >= nr_bufs)
112                 return 0;
113         if (b->extra_data) {
114                 new_bdata = krealloc(b->extra_data, new_amt, mem_flags);
115                 if (!new_bdata)
116                         return -1;
117                 memset(new_bdata + old_amt, 0, new_amt - old_amt);
118         } else {
119                 new_bdata = kzmalloc(new_amt, mem_flags);
120                 if (!new_bdata)
121                         return - 1;
122         }
123         b->extra_data = new_bdata;
124         b->nr_extra_bufs = nr_bufs;
125         return 0;
126 }
127
128 /* Go backwards from the end of the list, remember the last unused slot, and
129  * stop when a used slot is encountered. */
130 static struct extra_bdata *next_unused_slot(struct block *b)
131 {
132         struct extra_bdata *ebd = NULL;
133
134         for (int i = b->nr_extra_bufs - 1; i >= 0; i--) {
135                 if (b->extra_data[i].base)
136                         break;
137                 ebd = &b->extra_data[i];
138         }
139         return ebd;
140 }
141
142 /* Append an extra data buffer @base with offset @off of length @len to block
143  * @b.  Reuse an unused extra data slot if there's any.
144  * Return 0 on success or -1 on error. */
145 int block_append_extra(struct block *b, uintptr_t base, uint32_t off,
146                        uint32_t len, int mem_flags)
147 {
148         unsigned int nr_bufs = b->nr_extra_bufs + 1;
149         struct extra_bdata *ebd;
150
151         ebd = next_unused_slot(b);
152         if (!ebd) {
153                 if (block_add_extd(b, nr_bufs, mem_flags) != 0)
154                         return -1;
155                 ebd = next_unused_slot(b);
156                 assert(ebd);
157         }
158         ebd->base = base;
159         ebd->off = off;
160         ebd->len = len;
161         b->extra_len += ebd->len;
162         return 0;
163 }
164
165 void free_block_extra(struct block *b)
166 {
167         struct extra_bdata *ebd;
168
169         /* assuming our release method is kfree, which will change when we support
170          * user buffers */
171         for (int i = 0; i < b->nr_extra_bufs; i++) {
172                 ebd = &b->extra_data[i];
173                 if (ebd->base)
174                         kfree((void*)ebd->base);
175         }
176         b->extra_len = 0;
177         b->nr_extra_bufs = 0;
178         kfree(b->extra_data);   /* harmless if it is 0 */
179         b->extra_data = 0;              /* in case the block is reused by a free override */
180 }
181
182 void freeb(struct block *b)
183 {
184         void *dead = (void *)Bdead;
185
186         if (b == NULL)
187                 return;
188
189         free_block_extra(b);
190         /*
191          * drivers which perform non cache coherent DMA manage their own buffer
192          * pool of uncached buffers and provide their own free routine.
193          */
194         if (b->free) {
195                 b->free(b);
196                 return;
197         }
198
199         /* poison the block in case someone is still holding onto it */
200         b->next = dead;
201         b->rp = dead;
202         b->wp = dead;
203         b->lim = dead;
204         b->base = dead;
205
206         kfree(b);
207 }
208
209 void checkb(struct block *b, char *msg)
210 {
211         void *dead = (void *)Bdead;
212         struct extra_bdata *ebd;
213
214         if (b == dead)
215                 panic("checkb b %s 0x%lx", msg, b);
216         if (b->base == dead || b->lim == dead || b->next == dead
217                 || b->rp == dead || b->wp == dead) {
218                 printd("checkb: base 0x%8.8lx lim 0x%8.8lx next 0x%8.8lx\n",
219                            b->base, b->lim, b->next);
220                 printd("checkb: rp 0x%8.8lx wp 0x%8.8lx\n", b->rp, b->wp);
221                 panic("checkb dead: %s\n", msg);
222         }
223
224         if (b->base > b->lim)
225                 panic("checkb 0 %s 0x%lx 0x%lx", msg, b->base, b->lim);
226         if (b->rp < b->base)
227                 panic("checkb 1 %s 0x%lx 0x%lx", msg, b->base, b->rp);
228         if (b->wp < b->base)
229                 panic("checkb 2 %s 0x%lx 0x%lx", msg, b->base, b->wp);
230         if (b->rp > b->lim)
231                 panic("checkb 3 %s 0x%lx 0x%lx", msg, b->rp, b->lim);
232         if (b->wp > b->lim)
233                 panic("checkb 4 %s 0x%lx 0x%lx", msg, b->wp, b->lim);
234         if (b->nr_extra_bufs && !b->extra_data)
235                 panic("checkb 5 %s missing extra_data", msg);
236
237         for (int i = 0; i < b->nr_extra_bufs; i++) {
238                 ebd = &b->extra_data[i];
239                 if (ebd->base) {
240                         if (!kmalloc_refcnt((void*)ebd->base))
241                                 panic("checkb buf %d, base %p has no refcnt!\n", i, ebd->base);
242                 }
243         }
244
245 }
246
247 void printblock(struct block *b)
248 {
249         unsigned char *c;
250         unsigned int off, elen;
251         struct extra_bdata *e;
252
253         if (b == NULL) {
254                 printk("block is null\n");
255                 return;
256         }
257
258         printk("block of BLEN = %d, with %d header and %d data in %d extras\n",
259                BLEN(b), BHLEN(b), b->extra_len, b->nr_extra_bufs);
260
261         printk("header:\n");
262         printk("%2x:\t", 0);
263         off = 0;
264         for (c = b->rp; c < b->wp; c++) {
265                 printk("  %02x", *c & 0xff);
266                 off++;
267                 if (off % 8 == 0) {
268                         printk("\n");
269                         printk("%2x:\t", off);
270                 }
271         }
272         printk("\n");
273         elen = b->extra_len;
274         for (int i = 0; (i < b->nr_extra_bufs) && elen; i++) {
275                 e = &b->extra_data[i];
276                 if (e->len == 0)
277                         continue;
278                 elen -= e->len;
279                 printk("data %d:\n", i);
280                 printk("%2x:\t", 0);
281                 for (off = 0; off < e->len; off++) {
282                         c = (unsigned char *)e->base + e->off + off;
283                         printk("  %02x", *c & 0xff);
284                         if ((off + 1) % 8 == 0 && off +1 < e->len) {
285                                 printk("\n");
286                                 printk("%2x:\t", off + 1);
287                         }
288                 }
289         }
290         printk("\n");
291 }