40309c0518d8680f9875c9cd5a4fbac1661072e4
[akaros.git] / kern / src / ns / qio.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
43 #define PANIC_EXTRA(b)                                                  \
44 {                                                                       \
45         if ((b)->extra_len) {                                           \
46                 printblock(b);                                          \
47                 backtrace();                                            \
48                 panic("%s doesn't handle extra_data", __FUNCTION__);    \
49         }                                                               \
50 }
51
52 static uint32_t padblockcnt;
53 static uint32_t concatblockcnt;
54 static uint32_t pullupblockcnt;
55 static uint32_t copyblockcnt;
56 static uint32_t consumecnt;
57 static uint32_t producecnt;
58 static uint32_t qcopycnt;
59
60 static int debugging;
61
62 #define QDEBUG  if(0)
63
64 /*
65  *  IO queues
66  */
67
68 struct queue {
69         spinlock_t lock;;
70
71         struct block *bfirst;           /* buffer */
72         struct block *blast;
73
74         int len;                                        /* bytes allocated to queue */
75         int dlen;                                       /* data bytes in queue */
76         int limit;                                      /* max bytes in queue */
77         int inilim;                             /* initial limit */
78         int state;
79         int eof;                                        /* number of eofs read by user */
80
81         void (*kick) (void *);          /* restart output */
82         void (*bypass) (void *, struct block *);        /* bypass queue altogether */
83         void *arg;                                      /* argument to kick */
84
85         struct rendez rr;                       /* process waiting to read */
86         struct rendez wr;                       /* process waiting to write */
87         qio_wake_cb_t wake_cb;          /* callbacks for qio wakeups */
88         void *wake_data;
89
90         char err[ERRMAX];
91 };
92
93 enum {
94         Maxatomic = 64 * 1024,
95         QIO_CAN_ERR_SLEEP = (1 << 0),   /* can throw errors or block/sleep */
96         QIO_LIMIT = (1 << 1),                   /* respect q->limit */
97         QIO_DROP_OVERFLOW = (1 << 2),   /* alternative to setting qdropoverflow */
98         QIO_JUST_ONE_BLOCK = (1 << 3),  /* when qbreading, just get one block */
99         QIO_NON_BLOCK = (1 << 4),               /* throw EAGAIN instead of blocking */
100         QIO_DONT_KICK = (1 << 5),               /* don't kick when waking */
101 };
102
103 unsigned int qiomaxatomic = Maxatomic;
104
105 static size_t copy_to_block_body(struct block *to, void *from, size_t copy_amt);
106 static ssize_t __qbwrite(struct queue *q, struct block *b, int flags);
107 static struct block *__qbread(struct queue *q, size_t len, int qio_flags,
108                               int mem_flags);
109 static bool qwait_and_ilock(struct queue *q, int qio_flags);
110
111 /* Helper: fires a wake callback, sending 'filter' */
112 static void qwake_cb(struct queue *q, int filter)
113 {
114         if (q->wake_cb)
115                 q->wake_cb(q, q->wake_data, filter);
116 }
117
118 void ixsummary(void)
119 {
120         debugging ^= 1;
121         printd("pad %lu, concat %lu, pullup %lu, copy %lu\n",
122                    padblockcnt, concatblockcnt, pullupblockcnt, copyblockcnt);
123         printd("consume %lu, produce %lu, qcopy %lu\n",
124                    consumecnt, producecnt, qcopycnt);
125 }
126
127 /*
128  *  pad a block to the front (or the back if size is negative)
129  */
130 struct block *padblock(struct block *bp, int size)
131 {
132         int n;
133         struct block *nbp;
134         uint8_t bcksum = bp->flag & BCKSUM_FLAGS;
135         uint16_t checksum_start = bp->checksum_start;
136         uint16_t checksum_offset = bp->checksum_offset;
137         uint16_t mss = bp->mss;
138
139         QDEBUG checkb(bp, "padblock 1");
140         if (size >= 0) {
141                 if (bp->rp - bp->base >= size) {
142                         bp->checksum_start += size;
143                         bp->rp -= size;
144                         return bp;
145                 }
146
147                 PANIC_EXTRA(bp);
148                 if (bp->next)
149                         panic("padblock %p", getcallerpc(&bp));
150                 n = BLEN(bp);
151                 padblockcnt++;
152                 nbp = block_alloc(size + n, MEM_WAIT);
153                 nbp->rp += size;
154                 nbp->wp = nbp->rp;
155                 memmove(nbp->wp, bp->rp, n);
156                 nbp->wp += n;
157                 freeb(bp);
158                 nbp->rp -= size;
159         } else {
160                 size = -size;
161
162                 PANIC_EXTRA(bp);
163
164                 if (bp->next)
165                         panic("padblock %p", getcallerpc(&bp));
166
167                 if (bp->lim - bp->wp >= size)
168                         return bp;
169
170                 n = BLEN(bp);
171                 padblockcnt++;
172                 nbp = block_alloc(size + n, MEM_WAIT);
173                 memmove(nbp->wp, bp->rp, n);
174                 nbp->wp += n;
175                 freeb(bp);
176         }
177         if (bcksum) {
178                 nbp->flag |= bcksum;
179                 nbp->checksum_start = checksum_start;
180                 nbp->checksum_offset = checksum_offset;
181                 nbp->mss = mss;
182         }
183         QDEBUG checkb(nbp, "padblock 1");
184         return nbp;
185 }
186
187 /*
188  *  return count of bytes in a string of blocks
189  */
190 int blocklen(struct block *bp)
191 {
192         int len;
193
194         len = 0;
195         while (bp) {
196                 len += BLEN(bp);
197                 bp = bp->next;
198         }
199         return len;
200 }
201
202 /*
203  * return count of space in blocks
204  */
205 int blockalloclen(struct block *bp)
206 {
207         int len;
208
209         len = 0;
210         while (bp) {
211                 len += BALLOC(bp);
212                 bp = bp->next;
213         }
214         return len;
215 }
216
217 /*
218  *  copy the  string of blocks into
219  *  a single block and free the string
220  */
221 struct block *concatblock(struct block *bp)
222 {
223         int len;
224         struct block *nb, *f;
225
226         if (bp->next == 0)
227                 return bp;
228
229         /* probably use parts of qclone */
230         PANIC_EXTRA(bp);
231         nb = block_alloc(blocklen(bp), MEM_WAIT);
232         for (f = bp; f; f = f->next) {
233                 len = BLEN(f);
234                 memmove(nb->wp, f->rp, len);
235                 nb->wp += len;
236         }
237         concatblockcnt += BLEN(nb);
238         freeblist(bp);
239         QDEBUG checkb(nb, "concatblock 1");
240         return nb;
241 }
242
243 /* Makes an identical copy of the block, collapsing all the data into the block
244  * body.  It does not point to the contents of the original, it is a copy
245  * (unlike qclone).  Since we're copying, we might as well put the memory into
246  * one contiguous chunk. */
247 struct block *copyblock(struct block *bp, int mem_flags)
248 {
249         struct block *newb;
250         struct extra_bdata *ebd;
251         size_t amt;
252
253         QDEBUG checkb(bp, "copyblock 0");
254         newb = block_alloc(BLEN(bp), mem_flags);
255         if (!newb)
256                 return 0;
257         amt = copy_to_block_body(newb, bp->rp, BHLEN(bp));
258         assert(amt == BHLEN(bp));
259         for (int i = 0; i < bp->nr_extra_bufs; i++) {
260                 ebd = &bp->extra_data[i];
261                 if (!ebd->base || !ebd->len)
262                         continue;
263                 amt = copy_to_block_body(newb, (void*)ebd->base + ebd->off, ebd->len);
264                 assert(amt == ebd->len);
265         }
266         /* TODO: any other flags that need copied over? */
267         if (bp->flag & BCKSUM_FLAGS) {
268                 newb->flag |= (bp->flag & BCKSUM_FLAGS);
269                 newb->checksum_start = bp->checksum_start;
270                 newb->checksum_offset = bp->checksum_offset;
271                 newb->mss = bp->mss;
272         }
273         copyblockcnt++;
274         QDEBUG checkb(newb, "copyblock 1");
275         return newb;
276 }
277
278 /* Returns a block with the remaining contents of b all in the main body of the
279  * returned block.  Replace old references to b with the returned value (which
280  * may still be 'b', if no change was needed. */
281 struct block *linearizeblock(struct block *b)
282 {
283         struct block *newb;
284
285         if (!b->extra_len)
286                 return b;
287         newb = copyblock(b, MEM_WAIT);
288         freeb(b);
289         return newb;
290 }
291
292 /* Make sure the first block has at least n bytes in its main body.  Pulls up
293  * data from the *list* of blocks.  Returns 0 if there is not enough data in the
294  * block list. */
295 struct block *pullupblock(struct block *bp, int n)
296 {
297         int i, len, seglen;
298         struct block *nbp;
299         struct extra_bdata *ebd;
300
301         /*
302          *  this should almost always be true, it's
303          *  just to avoid every caller checking.
304          */
305         if (BHLEN(bp) >= n)
306                 return bp;
307
308         /* If there's no chance, just bail out now.  This might be slightly wasteful
309          * if there's a long blist that does have enough data. */
310         if (n > blocklen(bp))
311                 return 0;
312         /* a start at explicit main-body / header management */
313         if (bp->extra_len) {
314                 if (n > bp->lim - bp->rp) {
315                         /* would need to realloc a new block and copy everything over. */
316                         panic("can't pullup %d bytes, no place to put it: bp->lim %p, bp->rp %p, bp->lim-bp->rp %d\n",
317                                         n, bp->lim, bp->rp, bp->lim-bp->rp);
318                 }
319                 len = n - BHLEN(bp);
320                 /* Would need to recursively call this, or otherwise pull from later
321                  * blocks and put chunks of their data into the block we're building. */
322                 if (len > bp->extra_len)
323                         panic("pullup more than extra (%d, %d, %d)\n",
324                               n, BHLEN(bp), bp->extra_len);
325                 QDEBUG checkb(bp, "before pullup");
326                 for (int i = 0; (i < bp->nr_extra_bufs) && len; i++) {
327                         ebd = &bp->extra_data[i];
328                         if (!ebd->base || !ebd->len)
329                                 continue;
330                         seglen = MIN(ebd->len, len);
331                         memcpy(bp->wp, (void*)(ebd->base + ebd->off), seglen);
332                         bp->wp += seglen;
333                         len -= seglen;
334                         ebd->len -= seglen;
335                         ebd->off += seglen;
336                         bp->extra_len -= seglen;
337                         if (ebd->len == 0) {
338                                 kfree((void *)ebd->base);
339                                 ebd->off = 0;
340                                 ebd->base = 0;
341                         }
342                 }
343                 /* maybe just call pullupblock recursively here */
344                 if (len)
345                         panic("pullup %d bytes overdrawn\n", len);
346                 QDEBUG checkb(bp, "after pullup");
347                 return bp;
348         }
349
350         /*
351          *  if not enough room in the first block,
352          *  add another to the front of the list.
353          */
354         if (bp->lim - bp->rp < n) {
355                 nbp = block_alloc(n, MEM_WAIT);
356                 nbp->next = bp;
357                 bp = nbp;
358         }
359
360         /*
361          *  copy bytes from the trailing blocks into the first
362          */
363         n -= BLEN(bp);
364         while ((nbp = bp->next)) {
365                 i = BLEN(nbp);
366                 if (i > n) {
367                         memmove(bp->wp, nbp->rp, n);
368                         pullupblockcnt++;
369                         bp->wp += n;
370                         nbp->rp += n;
371                         QDEBUG checkb(bp, "pullupblock 1");
372                         return bp;
373                 } else {
374                         memmove(bp->wp, nbp->rp, i);
375                         pullupblockcnt++;
376                         bp->wp += i;
377                         bp->next = nbp->next;
378                         nbp->next = 0;
379                         freeb(nbp);
380                         n -= i;
381                         if (n == 0) {
382                                 QDEBUG checkb(bp, "pullupblock 2");
383                                 return bp;
384                         }
385                 }
386         }
387         freeb(bp);
388         return 0;
389 }
390
391 /*
392  *  make sure the first block has at least n bytes in its main body
393  */
394 struct block *pullupqueue(struct queue *q, int n)
395 {
396         struct block *b;
397
398         /* TODO: lock to protect the queue links? */
399         if ((BHLEN(q->bfirst) >= n))
400                 return q->bfirst;
401         q->bfirst = pullupblock(q->bfirst, n);
402         for (b = q->bfirst; b != NULL && b->next != NULL; b = b->next) ;
403         q->blast = b;
404         return q->bfirst;
405 }
406
407 /* throw away count bytes from the front of
408  * block's extradata.  Returns count of bytes
409  * thrown away
410  */
411
412 static int pullext(struct block *bp, int count)
413 {
414         struct extra_bdata *ed;
415         int i, rem, bytes = 0;
416
417         for (i = 0; bp->extra_len && count && i < bp->nr_extra_bufs; i++) {
418                 ed = &bp->extra_data[i];
419                 rem = MIN(count, ed->len);
420                 bp->extra_len -= rem;
421                 count -= rem;
422                 bytes += rem;
423                 ed->off += rem;
424                 ed->len -= rem;
425                 if (ed->len == 0) {
426                         kfree((void *)ed->base);
427                         ed->base = 0;
428                         ed->off = 0;
429                 }
430         }
431         return bytes;
432 }
433
434 /* throw away count bytes from the end of a
435  * block's extradata.  Returns count of bytes
436  * thrown away
437  */
438
439 static int dropext(struct block *bp, int count)
440 {
441         struct extra_bdata *ed;
442         int i, rem, bytes = 0;
443
444         for (i = bp->nr_extra_bufs - 1; bp->extra_len && count && i >= 0; i--) {
445                 ed = &bp->extra_data[i];
446                 rem = MIN(count, ed->len);
447                 bp->extra_len -= rem;
448                 count -= rem;
449                 bytes += rem;
450                 ed->len -= rem;
451                 if (ed->len == 0) {
452                         kfree((void *)ed->base);
453                         ed->base = 0;
454                         ed->off = 0;
455                 }
456         }
457         return bytes;
458 }
459
460 /*
461  *  throw away up to count bytes from a
462  *  list of blocks.  Return count of bytes
463  *  thrown away.
464  */
465 static int _pullblock(struct block **bph, int count, int free)
466 {
467         struct block *bp;
468         int n, bytes;
469
470         bytes = 0;
471         if (bph == NULL)
472                 return 0;
473
474         while (*bph != NULL && count != 0) {
475                 bp = *bph;
476
477                 n = MIN(BHLEN(bp), count);
478                 bytes += n;
479                 count -= n;
480                 bp->rp += n;
481                 n = pullext(bp, count);
482                 bytes += n;
483                 count -= n;
484                 QDEBUG checkb(bp, "pullblock ");
485                 if (BLEN(bp) == 0 && (free || count)) {
486                         *bph = bp->next;
487                         bp->next = NULL;
488                         freeb(bp);
489                 }
490         }
491         return bytes;
492 }
493
494 int pullblock(struct block **bph, int count)
495 {
496         return _pullblock(bph, count, 1);
497 }
498
499 /*
500  *  trim to len bytes starting at offset
501  */
502 struct block *trimblock(struct block *bp, int offset, int len)
503 {
504         uint32_t l, trim;
505         int olen = len;
506
507         QDEBUG checkb(bp, "trimblock 1");
508         if (blocklen(bp) < offset + len) {
509                 freeblist(bp);
510                 return NULL;
511         }
512
513         l =_pullblock(&bp, offset, 0);
514         if (bp == NULL)
515                 return NULL;
516         if (l != offset) {
517                 freeblist(bp);
518                 return NULL;
519         }
520
521         while ((l = BLEN(bp)) < len) {
522                 len -= l;
523                 bp = bp->next;
524         }
525
526         trim = BLEN(bp) - len;
527         trim -= dropext(bp, trim);
528         bp->wp -= trim;
529
530         if (bp->next) {
531                 freeblist(bp->next);
532                 bp->next = NULL;
533         }
534         return bp;
535 }
536
537 /* Adjust block @bp so that its size is exactly @len.
538  * If the size is increased, fill in the new contents with zeros.
539  * If the size is decreased, discard some of the old contents at the tail. */
540 struct block *adjustblock(struct block *bp, int len)
541 {
542         struct extra_bdata *ebd;
543         void *buf;
544         int i;
545
546         if (len < 0) {
547                 freeb(bp);
548                 return NULL;
549         }
550
551         if (len == BLEN(bp))
552                 return bp;
553
554         /* Shrink within block main body. */
555         if (len <= BHLEN(bp)) {
556                 free_block_extra(bp);
557                 bp->wp = bp->rp + len;
558                 QDEBUG checkb(bp, "adjustblock 1");
559                 return bp;
560         }
561
562         /* Need to grow. */
563         if (len > BLEN(bp)) {
564                 /* Grow within block main body. */
565                 if (bp->extra_len == 0 && bp->rp + len <= bp->lim) {
566                         memset(bp->wp, 0, len - BLEN(bp));
567                         bp->wp = bp->rp + len;
568                         QDEBUG checkb(bp, "adjustblock 2");
569                         return bp;
570                 }
571                 /* Grow with extra data buffers. */
572                 buf = kzmalloc(len - BLEN(bp), MEM_WAIT);
573                 block_append_extra(bp, (uintptr_t)buf, 0, len - BLEN(bp), MEM_WAIT);
574                 QDEBUG checkb(bp, "adjustblock 3");
575                 return bp;
576         }
577
578         /* Shrink extra data buffers.
579          * len is how much of ebd we need to keep.
580          * extra_len is re-accumulated. */
581         assert(bp->extra_len > 0);
582         len -= BHLEN(bp);
583         bp->extra_len = 0;
584         for (i = 0; i < bp->nr_extra_bufs; i++) {
585                 ebd = &bp->extra_data[i];
586                 if (len <= ebd->len)
587                         break;
588                 len -= ebd->len;
589                 bp->extra_len += ebd->len;
590         }
591         /* If len becomes zero, extra_data[i] should be freed. */
592         if (len > 0) {
593                 ebd = &bp->extra_data[i];
594                 ebd->len = len;
595                 bp->extra_len += ebd->len;
596                 i++;
597         }
598         for (; i < bp->nr_extra_bufs; i++) {
599                 ebd = &bp->extra_data[i];
600                 if (ebd->base)
601                         kfree((void*)ebd->base);
602                 ebd->base = ebd->off = ebd->len = 0;
603         }
604         QDEBUG checkb(bp, "adjustblock 4");
605         return bp;
606 }
607
608 /* Helper: removes and returns the first block from q */
609 static struct block *pop_first_block(struct queue *q)
610 {
611         struct block *b = q->bfirst;
612
613         q->len -= BALLOC(b);  // XXX all usages of q->len with extra_data are fucked
614         q->dlen -= BLEN(b);
615         q->bfirst = b->next;
616         b->next = 0;
617         return b;
618 }
619
620 /* Helper: copies up to copy_amt from a buf to a block's main body (b->wp) */
621 static size_t copy_to_block_body(struct block *to, void *from, size_t copy_amt)
622 {
623         copy_amt = MIN(to->lim - to->wp, copy_amt);
624         memcpy(to->wp, from, copy_amt);
625         to->wp += copy_amt;
626         return copy_amt;
627 }
628
629 /* Accounting helper.  Block b in q lost amt extra_data */
630 static void block_and_q_lost_extra(struct block *b, struct queue *q, size_t amt)
631 {
632         b->extra_len -= amt;
633         q->len -= amt;
634         q->dlen -= amt;
635 }
636
637 /* Helper: moves ebd from a block (in from_q) to another block.  The *ebd is
638  * fixed in 'from', so we move its contents and zero it out in 'from'.
639  *
640  * Returns the length moved (0 on failure). */
641 static size_t move_ebd(struct extra_bdata *ebd, struct block *to,
642                        struct block *from, struct queue *from_q)
643 {
644         size_t ret = ebd->len;
645
646         if (block_append_extra(to, ebd->base, ebd->off, ebd->len, MEM_ATOMIC))
647                 return 0;
648         block_and_q_lost_extra(from, from_q, ebd->len);
649         ebd->base = ebd->len = ebd->off = 0;
650         return ret;
651 }
652
653 /* Copy up to len bytes from q->bfirst to @to, leaving the block in place.  May
654  * return with less than len, but greater than 0, even if there is more
655  * available in q.
656  *
657  * At any moment that we have copied anything and things are tricky, we can just
658  * return.  The trickiness comes from a bunch of variables: is the main body
659  * empty?  How do we split the ebd?  If our alloc fails, then we can fall back
660  * to @to's main body, but only if we haven't used it yet. */
661 static size_t copy_from_first_block(struct queue *q, struct block *to,
662                                     size_t len)
663 {
664         struct block *from = q->bfirst;
665         size_t copy_amt, amt;
666         struct extra_bdata *ebd;
667
668         assert(len < BLEN(from));       /* sanity */
669         /* Try to extract from the main body */
670         copy_amt = MIN(BHLEN(from), len);
671         if (copy_amt) {
672                 copy_amt = copy_to_block_body(to, from->rp, copy_amt);
673                 from->rp += copy_amt;
674                 /* We only change dlen, (data len), not q->len, since the q still has
675                  * the same block memory allocation (no kfrees happened) */
676                 q->dlen -= copy_amt;
677         }
678         /* Try to extract the remainder from the extra data */
679         len -= copy_amt;
680         for (int i = 0; (i < from->nr_extra_bufs) && len; i++) {
681                 ebd = &from->extra_data[i];
682                 if (!ebd->base || !ebd->len)
683                         continue;
684                 if (len >= ebd->len) {
685                         amt = move_ebd(ebd, to, from, q);
686                         if (!amt) {
687                                 /* our internal alloc could have failed.   this ebd is now the
688                                  * last one we'll consider.  let's handle it separately and put
689                                  * it in the main body. */
690                                 if (copy_amt)
691                                         return copy_amt;
692                                 copy_amt = copy_to_block_body(to, (void*)ebd->base + ebd->off,
693                                                               ebd->len);
694                                 block_and_q_lost_extra(from, q, copy_amt);
695                                 break;
696                         }
697                         len -= amt;
698                         copy_amt += amt;
699                         continue;
700                 } else {
701                         /* If we're here, we reached our final ebd, which we'll need to
702                          * split to get anything from it. */
703                         if (copy_amt)
704                                 return copy_amt;
705                         copy_amt = copy_to_block_body(to, (void*)ebd->base + ebd->off,
706                                                       len);
707                         ebd->off += copy_amt;
708                         ebd->len -= copy_amt;
709                         block_and_q_lost_extra(from, q, copy_amt);
710                         break;
711                 }
712         }
713         if (len)
714                 assert(copy_amt);       /* sanity */
715         return copy_amt;
716 }
717
718 /* Return codes for __qbread and __try_qbread. */
719 enum {
720         QBR_OK,
721         QBR_FAIL,
722         QBR_SPARE,      /* we need a spare block */
723         QBR_AGAIN,      /* do it again, we are coalescing blocks */
724 };
725
726 /* Helper and back-end for __qbread: extracts and returns a list of blocks
727  * containing up to len bytes.  It may contain less than len even if q has more
728  * data.
729  *
730  * Returns a code interpreted by __qbread, and the returned blist in ret. */
731 static int __try_qbread(struct queue *q, size_t len, int qio_flags,
732                         struct block **real_ret, struct block *spare)
733 {
734         struct block *ret, *ret_last, *first;
735         size_t blen;
736         bool was_unwritable = FALSE;
737         int dowakeup = 0;
738
739         if (qio_flags & QIO_CAN_ERR_SLEEP) {
740                 if (!qwait_and_ilock(q, qio_flags)) {
741                         spin_unlock_irqsave(&q->lock);
742                         return QBR_FAIL;
743                 }
744                 /* we qwaited and still hold the lock, so the q is not empty */
745                 first = q->bfirst;
746         } else {
747                 spin_lock_irqsave(&q->lock);
748                 first = q->bfirst;
749                 if (!first) {
750                         spin_unlock_irqsave(&q->lock);
751                         return QBR_FAIL;
752                 }
753         }
754         was_unwritable = !qwritable(q);
755         blen = BLEN(first);
756         if ((q->state & Qcoalesce) && (blen == 0)) {
757                 freeb(pop_first_block(q));
758                 spin_unlock_irqsave(&q->lock);
759                 /* Need to retry to make sure we have a first block */
760                 return QBR_AGAIN;
761         }
762         /* Qmsg is a bit weird.  The old 9ns code seemed to yank the entire block,
763          * regardless of len.  We'll do the same, and just return the minimum: the
764          * first block.  I'd be happy to remove this. */
765         if (q->state & Qmsg) {
766                 ret = pop_first_block(q);
767                 goto out_ok;
768         }
769         /* Let's get at least something first - makes the code easier.  This way,
770          * we'll only ever split the block once. */
771         if (blen <= len) {
772                 ret = pop_first_block(q);
773                 len -= blen;
774         } else {
775                 /* need to split the block.  we won't actually take the first block out
776                  * of the queue - we're just extracting a little bit. */
777                 if (!spare) {
778                         /* We have nothing and need a spare block.  Retry! */
779                         spin_unlock_irqsave(&q->lock);
780                         return QBR_SPARE;
781                 }
782                 copy_from_first_block(q, spare, len);
783                 ret = spare;
784                 goto out_ok;
785         }
786         /* At this point, we just grabbed the first block.  We can try to grab some
787          * more, up to len (if they want). */
788         if (qio_flags & QIO_JUST_ONE_BLOCK)
789                 goto out_ok;
790         ret_last = ret;
791         while (q->bfirst && (len > 0)) {
792                 blen = BLEN(q->bfirst);
793                 if ((q->state & Qcoalesce) && (blen == 0)) {
794                         /* remove the intermediate 0 blocks */
795                         freeb(pop_first_block(q));
796                         continue;
797                 }
798                 if (blen > len) {
799                         /* We could try to split the block, but that's a huge pain.  For
800                          * instance, we might need to move the main body of b into an
801                          * extra_data of ret_last.  lots of ways for that to fail, and lots
802                          * of cases to consider.  Easier to just bail out.  This is why I
803                          * did the first block above: we don't need to worry about this. */
804                          break;
805                 }
806                 ret_last->next = pop_first_block(q);
807                 ret_last = ret_last->next;
808                 len -= blen;
809         }
810 out_ok:
811         /*
812          *  if writer flow controlled, restart
813          *
814          *  This used to be
815          *  q->len < q->limit/2
816          *  but it slows down tcp too much for certain write sizes.
817          *  I really don't understand it completely.  It may be
818          *  due to the queue draining so fast that the transmission
819          *  stalls waiting for the app to produce more data.  - presotto
820          */
821         if ((q->state & Qflow) && q->len < q->limit) {
822                 q->state &= ~Qflow;
823                 dowakeup = 1;
824         }
825         spin_unlock_irqsave(&q->lock);
826         /* wakeup flow controlled writers */
827         if (dowakeup) {
828                 if (q->kick && !(qio_flags & QIO_DONT_KICK))
829                         q->kick(q->arg);
830                 rendez_wakeup(&q->wr);
831         }
832         if (was_unwritable)
833                 qwake_cb(q, FDTAP_FILT_WRITABLE);
834         *real_ret = ret;
835         return QBR_OK;
836 }
837
838 /* Helper and front-end for __try_qbread: extracts and returns a list of blocks
839  * containing up to len bytes.  It may contain less than len even if q has more
840  * data.
841  *
842  * Returns 0 if the q is closed or would require blocking and !CAN_BLOCK.
843  *
844  * Technically, there's a weird corner case with !Qcoalesce and Qmsg where you
845  * could get a zero length block back. */
846 static struct block *__qbread(struct queue *q, size_t len, int qio_flags,
847                               int mem_flags)
848 {
849         struct block *ret = 0;
850         struct block *spare = 0;
851
852         while (1) {
853                 switch (__try_qbread(q, len, qio_flags, &ret, spare)) {
854                 case QBR_OK:
855                 case QBR_FAIL:
856                         if (spare && (ret != spare))
857                                 freeb(spare);
858                         return ret;
859                 case QBR_SPARE:
860                         assert(!spare);
861                         /* Due to some nastiness, we need a fresh block so we can read out
862                          * anything from the queue.  'len' seems like a reasonable amount.
863                          * Maybe we can get away with less. */
864                         spare = block_alloc(len, mem_flags);
865                         if (!spare)
866                                 return 0;
867                         break;
868                 case QBR_AGAIN:
869                         /* if the first block is 0 and we are Qcoalesce, then we'll need to
870                          * try again.  We bounce out of __try so we can perform the "is
871                          * there a block" logic again from the top. */
872                         break;
873                 }
874         }
875 }
876
877 /*
878  *  get next block from a queue, return null if nothing there
879  */
880 struct block *qget(struct queue *q)
881 {
882         /* since len == SIZE_MAX, we should never need to do a mem alloc */
883         return __qbread(q, SIZE_MAX, QIO_JUST_ONE_BLOCK, MEM_ATOMIC);
884 }
885
886 /* Throw away the next 'len' bytes in the queue returning the number actually
887  * discarded.
888  *
889  * If the bytes are in the queue, then they must be discarded.  The only time to
890  * return less than len is if the q itself has less than len bytes.
891  *
892  * This won't trigger a kick when waking up any sleepers.  This seems to be Plan
893  * 9's intent, since the TCP stack will deadlock if qdiscard kicks. */
894 size_t qdiscard(struct queue *q, size_t len)
895 {
896         struct block *blist;
897         size_t removed_amt;
898         size_t sofar = 0;
899
900         /* This is racy.  There could be multiple qdiscarders or other consumers,
901          * where the consumption could be interleaved. */
902         while (qlen(q) && len) {
903                 blist = __qbread(q, len, QIO_DONT_KICK, MEM_WAIT);
904                 removed_amt = freeblist(blist);
905                 sofar += removed_amt;
906                 len -= removed_amt;
907         }
908         return sofar;
909 }
910
911 ssize_t qpass(struct queue *q, struct block *b)
912 {
913         return __qbwrite(q, b, QIO_LIMIT | QIO_DROP_OVERFLOW);
914 }
915
916 ssize_t qpassnolim(struct queue *q, struct block *b)
917 {
918         return __qbwrite(q, b, 0);
919 }
920
921 /*
922  *  if the allocated space is way out of line with the used
923  *  space, reallocate to a smaller block
924  */
925 struct block *packblock(struct block *bp)
926 {
927         struct block **l, *nbp;
928         int n;
929
930         if (bp->extra_len)
931                 return bp;
932         for (l = &bp; *l; l = &(*l)->next) {
933                 nbp = *l;
934                 n = BLEN(nbp);
935                 if ((n << 2) < BALLOC(nbp)) {
936                         *l = block_alloc(n, MEM_WAIT);
937                         memmove((*l)->wp, nbp->rp, n);
938                         (*l)->wp += n;
939                         (*l)->next = nbp->next;
940                         freeb(nbp);
941                 }
942         }
943
944         return bp;
945 }
946
947 /* Add an extra_data entry to newb at newb_idx pointing to b's body, starting at
948  * body_rp, for up to len.  Returns the len consumed.
949  *
950  * The base is 'b', so that we can kfree it later.  This currently ties us to
951  * using kfree for the release method for all extra_data.
952  *
953  * It is possible to have a body size that is 0, if there is no offset, and
954  * b->wp == b->rp.  This will have an extra data entry of 0 length. */
955 static size_t point_to_body(struct block *b, uint8_t *body_rp,
956                             struct block *newb, unsigned int newb_idx,
957                             size_t len)
958 {
959         struct extra_bdata *ebd = &newb->extra_data[newb_idx];
960
961         assert(newb_idx < newb->nr_extra_bufs);
962
963         kmalloc_incref(b);
964         ebd->base = (uintptr_t)b;
965         ebd->off = (uint32_t)(body_rp - (uint8_t*)b);
966         ebd->len = MIN(b->wp - body_rp, len);   /* think of body_rp as b->rp */
967         assert((int)ebd->len >= 0);
968         newb->extra_len += ebd->len;
969         return ebd->len;
970 }
971
972 /* Add an extra_data entry to newb at newb_idx pointing to b's b_idx'th
973  * extra_data buf, at b_off within that buffer, for up to len.  Returns the len
974  * consumed.
975  *
976  * We can have blocks with 0 length, but they are still refcnt'd.  See above. */
977 static size_t point_to_buf(struct block *b, unsigned int b_idx, uint32_t b_off,
978                            struct block *newb, unsigned int newb_idx,
979                            size_t len)
980 {
981         struct extra_bdata *n_ebd = &newb->extra_data[newb_idx];
982         struct extra_bdata *b_ebd = &b->extra_data[b_idx];
983
984         assert(b_idx < b->nr_extra_bufs);
985         assert(newb_idx < newb->nr_extra_bufs);
986
987         kmalloc_incref((void*)b_ebd->base);
988         n_ebd->base = b_ebd->base;
989         n_ebd->off = b_ebd->off + b_off;
990         n_ebd->len = MIN(b_ebd->len - b_off, len);
991         newb->extra_len += n_ebd->len;
992         return n_ebd->len;
993 }
994
995 /* given a string of blocks, sets up the new block's extra_data such that it
996  * *points* to the contents of the blist [offset, len + offset).  This does not
997  * make a separate copy of the contents of the blist.
998  *
999  * returns 0 on success.  the only failure is if the extra_data array was too
1000  * small, so this returns a positive integer saying how big the extra_data needs
1001  * to be.
1002  *
1003  * callers are responsible for protecting the list structure. */
1004 static int __blist_clone_to(struct block *blist, struct block *newb, int len,
1005                             uint32_t offset)
1006 {
1007         struct block *b, *first;
1008         unsigned int nr_bufs = 0;
1009         unsigned int b_idx, newb_idx = 0;
1010         uint8_t *first_main_body = 0;
1011
1012         /* find the first block; keep offset relative to the latest b in the list */
1013         for (b = blist; b; b = b->next) {
1014                 if (BLEN(b) > offset)
1015                         break;
1016                 offset -= BLEN(b);
1017         }
1018         /* qcopy semantics: if you asked for an offset outside the block list, you
1019          * get an empty block back */
1020         if (!b)
1021                 return 0;
1022         first = b;
1023         /* upper bound for how many buffers we'll need in newb */
1024         for (/* b is set*/; b; b = b->next) {
1025                 nr_bufs += 1 + b->nr_extra_bufs;        /* 1 for the main body */
1026         }
1027         /* we might be holding a spinlock here, so we won't wait for kmalloc */
1028         if (block_add_extd(newb, nr_bufs, 0) != 0) {
1029                 /* caller will need to alloc these, then re-call us */
1030                 return nr_bufs;
1031         }
1032         for (b = first; b && len; b = b->next) {
1033                 b_idx = 0;
1034                 if (offset) {
1035                         if (offset < BHLEN(b)) {
1036                                 /* off is in the main body */
1037                                 len -= point_to_body(b, b->rp + offset, newb, newb_idx, len);
1038                                 newb_idx++;
1039                         } else {
1040                                 /* off is in one of the buffers (or just past the last one).
1041                                  * we're not going to point to b's main body at all. */
1042                                 offset -= BHLEN(b);
1043                                 assert(b->extra_data);
1044                                 /* assuming these extrabufs are packed, or at least that len
1045                                  * isn't gibberish */
1046                                 while (b->extra_data[b_idx].len <= offset) {
1047                                         offset -= b->extra_data[b_idx].len;
1048                                         b_idx++;
1049                                 }
1050                                 /* now offset is set to our offset in the b_idx'th buf */
1051                                 len -= point_to_buf(b, b_idx, offset, newb, newb_idx, len);
1052                                 newb_idx++;
1053                                 b_idx++;
1054                         }
1055                         offset = 0;
1056                 } else {
1057                         len -= point_to_body(b, b->rp, newb, newb_idx, len);
1058                         newb_idx++;
1059                 }
1060                 /* knock out all remaining bufs.  we only did one point_to_ op by now,
1061                  * and any point_to_ could be our last if it consumed all of len. */
1062                 for (int i = b_idx; (i < b->nr_extra_bufs) && len; i++) {
1063                         len -= point_to_buf(b, i, 0, newb, newb_idx, len);
1064                         newb_idx++;
1065                 }
1066         }
1067         return 0;
1068 }
1069
1070 struct block *blist_clone(struct block *blist, int header_len, int len,
1071                           uint32_t offset)
1072 {
1073         int ret;
1074         struct block *newb = block_alloc(header_len, MEM_WAIT);
1075         do {
1076                 ret = __blist_clone_to(blist, newb, len, offset);
1077                 if (ret)
1078                         block_add_extd(newb, ret, MEM_WAIT);
1079         } while (ret);
1080         return newb;
1081 }
1082
1083 /* given a queue, makes a single block with header_len reserved space in the
1084  * block main body, and the contents of [offset, len + offset) pointed to in the
1085  * new blocks ext_data.  This does not make a copy of the q's contents, though
1086  * you do have a ref count on the memory. */
1087 struct block *qclone(struct queue *q, int header_len, int len, uint32_t offset)
1088 {
1089         int ret;
1090         struct block *newb = block_alloc(header_len, MEM_WAIT);
1091         /* the while loop should rarely be used: it would require someone
1092          * concurrently adding to the queue. */
1093         do {
1094                 /* TODO: RCU: protecting the q list (b->next) (need read lock) */
1095                 spin_lock_irqsave(&q->lock);
1096                 ret = __blist_clone_to(q->bfirst, newb, len, offset);
1097                 spin_unlock_irqsave(&q->lock);
1098                 if (ret)
1099                         block_add_extd(newb, ret, MEM_WAIT);
1100         } while (ret);
1101         return newb;
1102 }
1103
1104 /*
1105  *  copy from offset in the queue
1106  */
1107 struct block *qcopy_old(struct queue *q, int len, uint32_t offset)
1108 {
1109         int sofar;
1110         int n;
1111         struct block *b, *nb;
1112         uint8_t *p;
1113
1114         nb = block_alloc(len, MEM_WAIT);
1115
1116         spin_lock_irqsave(&q->lock);
1117
1118         /* go to offset */
1119         b = q->bfirst;
1120         for (sofar = 0;; sofar += n) {
1121                 if (b == NULL) {
1122                         spin_unlock_irqsave(&q->lock);
1123                         return nb;
1124                 }
1125                 n = BLEN(b);
1126                 if (sofar + n > offset) {
1127                         p = b->rp + offset - sofar;
1128                         n -= offset - sofar;
1129                         break;
1130                 }
1131                 QDEBUG checkb(b, "qcopy");
1132                 b = b->next;
1133         }
1134
1135         /* copy bytes from there */
1136         for (sofar = 0; sofar < len;) {
1137                 if (n > len - sofar)
1138                         n = len - sofar;
1139                 PANIC_EXTRA(b);
1140                 memmove(nb->wp, p, n);
1141                 qcopycnt += n;
1142                 sofar += n;
1143                 nb->wp += n;
1144                 b = b->next;
1145                 if (b == NULL)
1146                         break;
1147                 n = BLEN(b);
1148                 p = b->rp;
1149         }
1150         spin_unlock_irqsave(&q->lock);
1151
1152         return nb;
1153 }
1154
1155 struct block *qcopy(struct queue *q, int len, uint32_t offset)
1156 {
1157 #ifdef CONFIG_BLOCK_EXTRAS
1158         return qclone(q, 0, len, offset);
1159 #else
1160         return qcopy_old(q, len, offset);
1161 #endif
1162 }
1163
1164 static void qinit_common(struct queue *q)
1165 {
1166         spinlock_init_irqsave(&q->lock);
1167         rendez_init(&q->rr);
1168         rendez_init(&q->wr);
1169 }
1170
1171 /*
1172  *  called by non-interrupt code
1173  */
1174 struct queue *qopen(int limit, int msg, void (*kick) (void *), void *arg)
1175 {
1176         struct queue *q;
1177
1178         q = kzmalloc(sizeof(struct queue), 0);
1179         if (q == 0)
1180                 return 0;
1181         qinit_common(q);
1182
1183         q->limit = q->inilim = limit;
1184         q->kick = kick;
1185         q->arg = arg;
1186         q->state = msg;
1187         q->state |= Qstarve;
1188         q->eof = 0;
1189
1190         return q;
1191 }
1192
1193 /* open a queue to be bypassed */
1194 struct queue *qbypass(void (*bypass) (void *, struct block *), void *arg)
1195 {
1196         struct queue *q;
1197
1198         q = kzmalloc(sizeof(struct queue), 0);
1199         if (q == 0)
1200                 return 0;
1201         qinit_common(q);
1202
1203         q->limit = 0;
1204         q->arg = arg;
1205         q->bypass = bypass;
1206         q->state = 0;
1207
1208         return q;
1209 }
1210
1211 static int notempty(void *a)
1212 {
1213         struct queue *q = a;
1214
1215         return (q->state & Qclosed) || q->bfirst != 0;
1216 }
1217
1218 /* Block, waiting for the queue to be non-empty or closed.  Returns with
1219  * the spinlock held.  Returns TRUE when there queue is not empty, FALSE if it
1220  * was naturally closed.  Throws an error o/w. */
1221 static bool qwait_and_ilock(struct queue *q, int qio_flags)
1222 {
1223         while (1) {
1224                 spin_lock_irqsave(&q->lock);
1225                 if (q->bfirst != NULL)
1226                         return TRUE;
1227                 if (q->state & Qclosed) {
1228                         if (++q->eof > 3) {
1229                                 spin_unlock_irqsave(&q->lock);
1230                                 error(EPIPE, "multiple reads on a closed queue");
1231                         }
1232                         if (q->err[0]) {
1233                                 spin_unlock_irqsave(&q->lock);
1234                                 error(EPIPE, q->err);
1235                         }
1236                         return FALSE;
1237                 }
1238                 /* We set Qstarve regardless of whether we are non-blocking or not.
1239                  * Qstarve tracks the edge detection of the queue being empty. */
1240                 q->state |= Qstarve;
1241                 if (qio_flags & QIO_NON_BLOCK) {
1242                         spin_unlock_irqsave(&q->lock);
1243                         error(EAGAIN, "queue empty");
1244                 }
1245                 spin_unlock_irqsave(&q->lock);
1246                 /* may throw an error() */
1247                 rendez_sleep(&q->rr, notempty, q);
1248         }
1249 }
1250
1251 /*
1252  * add a block list to a queue
1253  * XXX basically the same as enqueue blist, and has no locking!
1254  */
1255 void qaddlist(struct queue *q, struct block *b)
1256 {
1257         /* TODO: q lock? */
1258         /* queue the block */
1259         if (q->bfirst)
1260                 q->blast->next = b;
1261         else
1262                 q->bfirst = b;
1263         q->len += blockalloclen(b);
1264         q->dlen += blocklen(b);
1265         while (b->next)
1266                 b = b->next;
1267         q->blast = b;
1268 }
1269
1270 static size_t read_from_block(struct block *b, uint8_t *to, size_t amt)
1271 {
1272         size_t copy_amt, retval = 0;
1273         struct extra_bdata *ebd;
1274
1275         copy_amt = MIN(BHLEN(b), amt);
1276         memcpy(to, b->rp, copy_amt);
1277         /* advance the rp, since this block not be completely consumed and future
1278          * reads need to know where to pick up from */
1279         b->rp += copy_amt;
1280         to += copy_amt;
1281         amt -= copy_amt;
1282         retval += copy_amt;
1283         for (int i = 0; (i < b->nr_extra_bufs) && amt; i++) {
1284                 ebd = &b->extra_data[i];
1285                 /* skip empty entires.  if we track this in the struct block, we can
1286                  * just start the for loop early */
1287                 if (!ebd->base || !ebd->len)
1288                         continue;
1289                 copy_amt = MIN(ebd->len, amt);
1290                 memcpy(to, (void*)(ebd->base + ebd->off), copy_amt);
1291                 /* we're actually consuming the entries, just like how we advance rp up
1292                  * above, and might only consume part of one. */
1293                 ebd->len -= copy_amt;
1294                 ebd->off += copy_amt;
1295                 b->extra_len -= copy_amt;
1296                 if (!ebd->len) {
1297                         /* we don't actually have to decref here.  it's also done in
1298                          * freeb().  this is the earliest we can free. */
1299                         kfree((void*)ebd->base);
1300                         ebd->base = ebd->off = 0;
1301                 }
1302                 to += copy_amt;
1303                 amt -= copy_amt;
1304                 retval += copy_amt;
1305         }
1306         return retval;
1307 }
1308
1309 /*
1310  *  copy the contents of a string of blocks into
1311  *  memory.  emptied blocks are freed.  return
1312  *  pointer to first unconsumed block.
1313  */
1314 struct block *bl2mem(uint8_t * p, struct block *b, int n)
1315 {
1316         int i;
1317         struct block *next;
1318
1319         /* could be slicker here, since read_from_block is smart */
1320         for (; b != NULL; b = next) {
1321                 i = BLEN(b);
1322                 if (i > n) {
1323                         /* partial block, consume some */
1324                         read_from_block(b, p, n);
1325                         return b;
1326                 }
1327                 /* full block, consume all and move on */
1328                 i = read_from_block(b, p, i);
1329                 n -= i;
1330                 p += i;
1331                 next = b->next;
1332                 freeb(b);
1333         }
1334         return NULL;
1335 }
1336
1337 /* Extract the contents of all blocks and copy to va, up to len.  Returns the
1338  * actual amount copied. */
1339 static size_t read_all_blocks(struct block *b, void *va, size_t len)
1340 {
1341         size_t sofar = 0;
1342         struct block *next;
1343
1344         do {
1345                 /* We should be draining every block completely. */
1346                 assert(BLEN(b) <= len - sofar);
1347                 assert(va);
1348                 assert(va + sofar);
1349                 assert(b->rp);
1350                 sofar += read_from_block(b, va + sofar, len - sofar);
1351                 next = b->next;
1352                 freeb(b);
1353                 b = next;
1354         } while (b);
1355         return sofar;
1356 }
1357
1358 /*
1359  *  copy the contents of memory into a string of blocks.
1360  *  return NULL on error.
1361  */
1362 struct block *mem2bl(uint8_t * p, int len)
1363 {
1364         ERRSTACK(1);
1365         int n;
1366         struct block *b, *first, **l;
1367
1368         first = NULL;
1369         l = &first;
1370         if (waserror()) {
1371                 freeblist(first);
1372                 nexterror();
1373         }
1374         do {
1375                 n = len;
1376                 if (n > Maxatomic)
1377                         n = Maxatomic;
1378
1379                 *l = b = block_alloc(n, MEM_WAIT);
1380                 /* TODO consider extra_data */
1381                 memmove(b->wp, p, n);
1382                 b->wp += n;
1383                 p += n;
1384                 len -= n;
1385                 l = &b->next;
1386         } while (len > 0);
1387         poperror();
1388
1389         return first;
1390 }
1391
1392 /*
1393  *  put a block back to the front of the queue
1394  *  called with q ilocked
1395  */
1396 void qputback(struct queue *q, struct block *b)
1397 {
1398         b->next = q->bfirst;
1399         if (q->bfirst == NULL)
1400                 q->blast = b;
1401         q->bfirst = b;
1402         q->len += BALLOC(b);
1403         q->dlen += BLEN(b);
1404 }
1405
1406 /*
1407  *  get next block from a queue (up to a limit)
1408  *
1409  */
1410 struct block *qbread(struct queue *q, size_t len)
1411 {
1412         return __qbread(q, len, QIO_JUST_ONE_BLOCK | QIO_CAN_ERR_SLEEP, MEM_WAIT);
1413 }
1414
1415 struct block *qbread_nonblock(struct queue *q, size_t len)
1416 {
1417         return __qbread(q, len, QIO_JUST_ONE_BLOCK | QIO_CAN_ERR_SLEEP |
1418                         QIO_NON_BLOCK, MEM_WAIT);
1419 }
1420
1421 /* read up to len from a queue into vp. */
1422 size_t qread(struct queue *q, void *va, size_t len)
1423 {
1424         struct block *blist = __qbread(q, len, QIO_CAN_ERR_SLEEP, MEM_WAIT);
1425
1426         if (!blist)
1427                 return 0;
1428         return read_all_blocks(blist, va, len);
1429 }
1430
1431 size_t qread_nonblock(struct queue *q, void *va, size_t len)
1432 {
1433         struct block *blist = __qbread(q, len, QIO_CAN_ERR_SLEEP | QIO_NON_BLOCK,
1434                                        MEM_WAIT);
1435
1436         if (!blist)
1437                 return 0;
1438         return read_all_blocks(blist, va, len);
1439 }
1440
1441 static int qnotfull(void *a)
1442 {
1443         struct queue *q = a;
1444
1445         return q->len < q->limit || (q->state & Qclosed);
1446 }
1447
1448 /* Helper: enqueues a list of blocks to a queue.  Returns the total length. */
1449 static size_t enqueue_blist(struct queue *q, struct block *b)
1450 {
1451         size_t len, dlen;
1452
1453         if (q->bfirst)
1454                 q->blast->next = b;
1455         else
1456                 q->bfirst = b;
1457         len = BALLOC(b);
1458         dlen = BLEN(b);
1459         while (b->next) {
1460                 b = b->next;
1461                 len += BALLOC(b);
1462                 dlen += BLEN(b);
1463         }
1464         q->blast = b;
1465         q->len += len;
1466         q->dlen += dlen;
1467         return dlen;
1468 }
1469
1470 /* Adds block (which can be a list of blocks) to the queue, subject to
1471  * qio_flags.  Returns the length written on success or -1 on non-throwable
1472  * error.  Adjust qio_flags to control the value-added features!. */
1473 static ssize_t __qbwrite(struct queue *q, struct block *b, int qio_flags)
1474 {
1475         ssize_t ret;
1476         bool dowakeup = FALSE;
1477         bool was_empty;
1478
1479         if (q->bypass) {
1480                 ret = blocklen(b);
1481                 (*q->bypass) (q->arg, b);
1482                 return ret;
1483         }
1484         spin_lock_irqsave(&q->lock);
1485         was_empty = q->len == 0;
1486         if (q->state & Qclosed) {
1487                 spin_unlock_irqsave(&q->lock);
1488                 freeblist(b);
1489                 if (!(qio_flags & QIO_CAN_ERR_SLEEP))
1490                         return -1;
1491                 if (q->err[0])
1492                         error(EPIPE, q->err);
1493                 else
1494                         error(EPIPE, "connection closed");
1495         }
1496         if ((qio_flags & QIO_LIMIT) && (q->len >= q->limit)) {
1497                 /* drop overflow takes priority over regular non-blocking */
1498                 if ((qio_flags & QIO_DROP_OVERFLOW) || (q->state & Qdropoverflow)) {
1499                         spin_unlock_irqsave(&q->lock);
1500                         freeb(b);
1501                         return -1;
1502                 }
1503                 /* People shouldn't set NON_BLOCK without CAN_ERR, but we can be nice
1504                  * and catch it. */
1505                 if ((qio_flags & QIO_CAN_ERR_SLEEP) && (qio_flags & QIO_NON_BLOCK)) {
1506                         spin_unlock_irqsave(&q->lock);
1507                         freeb(b);
1508                         error(EAGAIN, "queue full");
1509                 }
1510         }
1511         ret = enqueue_blist(q, b);
1512         QDEBUG checkb(b, "__qbwrite");
1513         /* make sure other end gets awakened */
1514         if (q->state & Qstarve) {
1515                 q->state &= ~Qstarve;
1516                 dowakeup = TRUE;
1517         }
1518         spin_unlock_irqsave(&q->lock);
1519         /* TODO: not sure if the usage of a kick is mutually exclusive with a
1520          * wakeup, meaning that actual users either want a kick or have qreaders. */
1521         if (q->kick && (dowakeup || (q->state & Qkick)))
1522                 q->kick(q->arg);
1523         if (dowakeup)
1524                 rendez_wakeup(&q->rr);
1525         if (was_empty)
1526                 qwake_cb(q, FDTAP_FILT_READABLE);
1527         /*
1528          *  flow control, wait for queue to get below the limit
1529          *  before allowing the process to continue and queue
1530          *  more.  We do this here so that postnote can only
1531          *  interrupt us after the data has been queued.  This
1532          *  means that things like 9p flushes and ssl messages
1533          *  will not be disrupted by software interrupts.
1534          *
1535          *  Note - this is moderately dangerous since a process
1536          *  that keeps getting interrupted and rewriting will
1537          *  queue infinite crud.
1538          */
1539         if ((qio_flags & QIO_CAN_ERR_SLEEP) &&
1540             !(q->state & Qdropoverflow) && !(qio_flags & QIO_NON_BLOCK)) {
1541                 /* This is a racy peek at the q status.  If we accidentally block, we
1542                  * set Qflow, so someone should wake us.  If we accidentally don't
1543                  * block, we just returned to the user and let them slip a block past
1544                  * flow control. */
1545                 while (!qnotfull(q)) {
1546                         spin_lock_irqsave(&q->lock);
1547                         q->state |= Qflow;
1548                         spin_unlock_irqsave(&q->lock);
1549                         rendez_sleep(&q->wr, qnotfull, q);
1550                 }
1551         }
1552         return ret;
1553 }
1554
1555 /*
1556  *  add a block to a queue obeying flow control
1557  */
1558 ssize_t qbwrite(struct queue *q, struct block *b)
1559 {
1560         return __qbwrite(q, b, QIO_CAN_ERR_SLEEP | QIO_LIMIT);
1561 }
1562
1563 ssize_t qbwrite_nonblock(struct queue *q, struct block *b)
1564 {
1565         return __qbwrite(q, b, QIO_CAN_ERR_SLEEP | QIO_LIMIT | QIO_NON_BLOCK);
1566 }
1567
1568 ssize_t qibwrite(struct queue *q, struct block *b)
1569 {
1570         return __qbwrite(q, b, 0);
1571 }
1572
1573 /* Helper, allocs a block and copies [from, from + len) into it.  Returns the
1574  * block on success, 0 on failure. */
1575 static struct block *build_block(void *from, size_t len, int mem_flags)
1576 {
1577         struct block *b;
1578         void *ext_buf;
1579
1580         /* If len is small, we don't need to bother with the extra_data.  But until
1581          * the whole stack can handle extd blocks, we'll use them unconditionally.
1582          * */
1583 #ifdef CONFIG_BLOCK_EXTRAS
1584         /* allocb builds in 128 bytes of header space to all blocks, but this is
1585          * only available via padblock (to the left).  we also need some space
1586          * for pullupblock for some basic headers (like icmp) that get written
1587          * in directly */
1588         b = block_alloc(64, mem_flags);
1589         if (!b)
1590                 return 0;
1591         ext_buf = kmalloc(len, mem_flags);
1592         if (!ext_buf) {
1593                 kfree(b);
1594                 return 0;
1595         }
1596         memcpy(ext_buf, from, len);
1597         if (block_add_extd(b, 1, mem_flags)) {
1598                 kfree(ext_buf);
1599                 kfree(b);
1600                 return 0;
1601         }
1602         b->extra_data[0].base = (uintptr_t)ext_buf;
1603         b->extra_data[0].off = 0;
1604         b->extra_data[0].len = len;
1605         b->extra_len += len;
1606 #else
1607         b = block_alloc(len, mem_flags);
1608         if (!b)
1609                 return 0;
1610         memmove(b->wp, from, len);
1611         b->wp += len;
1612 #endif
1613         return b;
1614 }
1615
1616 static ssize_t __qwrite(struct queue *q, void *vp, size_t len, int mem_flags,
1617                         int qio_flags)
1618 {
1619         size_t n, sofar;
1620         struct block *b;
1621         uint8_t *p = vp;
1622         void *ext_buf;
1623
1624         sofar = 0;
1625         do {
1626                 n = len - sofar;
1627                 /* This is 64K, the max amount per single block.  Still a good value? */
1628                 if (n > Maxatomic)
1629                         n = Maxatomic;
1630                 b = build_block(p + sofar, n, mem_flags);
1631                 if (!b)
1632                         break;
1633                 if (__qbwrite(q, b, qio_flags) < 0)
1634                         break;
1635                 sofar += n;
1636         } while ((sofar < len) && (q->state & Qmsg) == 0);
1637         return sofar;
1638 }
1639
1640 ssize_t qwrite(struct queue *q, void *vp, int len)
1641 {
1642         return __qwrite(q, vp, len, MEM_WAIT, QIO_CAN_ERR_SLEEP | QIO_LIMIT);
1643 }
1644
1645 ssize_t qwrite_nonblock(struct queue *q, void *vp, int len)
1646 {
1647         return __qwrite(q, vp, len, MEM_WAIT, QIO_CAN_ERR_SLEEP | QIO_LIMIT |
1648                                               QIO_NON_BLOCK);
1649 }
1650
1651 ssize_t qiwrite(struct queue *q, void *vp, int len)
1652 {
1653         return __qwrite(q, vp, len, MEM_ATOMIC, 0);
1654 }
1655
1656 /*
1657  *  be extremely careful when calling this,
1658  *  as there is no reference accounting
1659  */
1660 void qfree(struct queue *q)
1661 {
1662         qclose(q);
1663         kfree(q);
1664 }
1665
1666 /*
1667  *  Mark a queue as closed.  No further IO is permitted.
1668  *  All blocks are released.
1669  */
1670 void qclose(struct queue *q)
1671 {
1672         struct block *bfirst;
1673
1674         if (q == NULL)
1675                 return;
1676
1677         /* mark it */
1678         spin_lock_irqsave(&q->lock);
1679         q->state |= Qclosed;
1680         q->state &= ~(Qflow | Qstarve | Qdropoverflow);
1681         q->err[0] = 0;
1682         bfirst = q->bfirst;
1683         q->bfirst = 0;
1684         q->len = 0;
1685         q->dlen = 0;
1686         spin_unlock_irqsave(&q->lock);
1687
1688         /* free queued blocks */
1689         freeblist(bfirst);
1690
1691         /* wake up readers/writers */
1692         rendez_wakeup(&q->rr);
1693         rendez_wakeup(&q->wr);
1694         qwake_cb(q, FDTAP_FILT_HANGUP);
1695 }
1696
1697 /* Mark a queue as closed.  Wakeup any readers.  Don't remove queued blocks.
1698  *
1699  * msg will be the errstr received by any waiters (qread, qbread, etc).  If
1700  * there is no message, which is what also happens during a natural qclose(),
1701  * those waiters will simply return 0.  qwriters will always error() on a
1702  * closed/hungup queue. */
1703 void qhangup(struct queue *q, char *msg)
1704 {
1705         /* mark it */
1706         spin_lock_irqsave(&q->lock);
1707         q->state |= Qclosed;
1708         if (msg == 0 || *msg == 0)
1709                 q->err[0] = 0;
1710         else
1711                 strlcpy(q->err, msg, ERRMAX);
1712         spin_unlock_irqsave(&q->lock);
1713
1714         /* wake up readers/writers */
1715         rendez_wakeup(&q->rr);
1716         rendez_wakeup(&q->wr);
1717         qwake_cb(q, FDTAP_FILT_HANGUP);
1718 }
1719
1720 /*
1721  *  return non-zero if the q is hungup
1722  */
1723 int qisclosed(struct queue *q)
1724 {
1725         return q->state & Qclosed;
1726 }
1727
1728 /*
1729  *  mark a queue as no longer hung up.  resets the wake_cb.
1730  */
1731 void qreopen(struct queue *q)
1732 {
1733         spin_lock_irqsave(&q->lock);
1734         q->state &= ~Qclosed;
1735         q->state |= Qstarve;
1736         q->eof = 0;
1737         q->limit = q->inilim;
1738         q->wake_cb = 0;
1739         q->wake_data = 0;
1740         spin_unlock_irqsave(&q->lock);
1741 }
1742
1743 /*
1744  *  return bytes queued
1745  */
1746 int qlen(struct queue *q)
1747 {
1748         return q->dlen;
1749 }
1750
1751 /*
1752  * return space remaining before flow control
1753  */
1754 int qwindow(struct queue *q)
1755 {
1756         int l;
1757
1758         l = q->limit - q->len;
1759         if (l < 0)
1760                 l = 0;
1761         return l;
1762 }
1763
1764 /*
1765  *  return true if we can read without blocking
1766  */
1767 int qcanread(struct queue *q)
1768 {
1769         return q->bfirst != 0;
1770 }
1771
1772 /*
1773  *  change queue limit
1774  */
1775 void qsetlimit(struct queue *q, int limit)
1776 {
1777         q->limit = limit;
1778 }
1779
1780 /*
1781  *  set whether writes drop overflowing blocks, or if we sleep
1782  */
1783 void qdropoverflow(struct queue *q, bool onoff)
1784 {
1785         spin_lock_irqsave(&q->lock);
1786         if (onoff)
1787                 q->state |= Qdropoverflow;
1788         else
1789                 q->state &= ~Qdropoverflow;
1790         spin_unlock_irqsave(&q->lock);
1791 }
1792
1793 /* Be careful: this can affect concurrent reads/writes and code that might have
1794  * built-in expectations of the q's type. */
1795 void q_toggle_qmsg(struct queue *q, bool onoff)
1796 {
1797         spin_lock_irqsave(&q->lock);
1798         if (onoff)
1799                 q->state |= Qmsg;
1800         else
1801                 q->state &= ~Qmsg;
1802         spin_unlock_irqsave(&q->lock);
1803 }
1804
1805 /* Be careful: this can affect concurrent reads/writes and code that might have
1806  * built-in expectations of the q's type. */
1807 void q_toggle_qcoalesce(struct queue *q, bool onoff)
1808 {
1809         spin_lock_irqsave(&q->lock);
1810         if (onoff)
1811                 q->state |= Qcoalesce;
1812         else
1813                 q->state &= ~Qcoalesce;
1814         spin_unlock_irqsave(&q->lock);
1815 }
1816
1817 /*
1818  *  flush the output queue
1819  */
1820 void qflush(struct queue *q)
1821 {
1822         struct block *bfirst;
1823
1824         /* mark it */
1825         spin_lock_irqsave(&q->lock);
1826         bfirst = q->bfirst;
1827         q->bfirst = 0;
1828         q->len = 0;
1829         q->dlen = 0;
1830         spin_unlock_irqsave(&q->lock);
1831
1832         /* free queued blocks */
1833         freeblist(bfirst);
1834
1835         /* wake up writers */
1836         rendez_wakeup(&q->wr);
1837         qwake_cb(q, FDTAP_FILT_WRITABLE);
1838 }
1839
1840 int qfull(struct queue *q)
1841 {
1842         return q->len >= q->limit;
1843 }
1844
1845 int qstate(struct queue *q)
1846 {
1847         return q->state;
1848 }
1849
1850 void qdump(struct queue *q)
1851 {
1852         if (q)
1853                 printk("q=%p bfirst=%p blast=%p len=%d dlen=%d limit=%d state=#%x\n",
1854                            q, q->bfirst, q->blast, q->len, q->dlen, q->limit, q->state);
1855 }
1856
1857 /* On certain wakeup events, qio will call func(q, data, filter), where filter
1858  * marks the type of wakeup event (flags from FDTAP).
1859  *
1860  * There's no sync protection.  If you change the CB while the qio is running,
1861  * you might get a CB with the data or func from a previous set_wake_cb.  You
1862  * should set this once per queue and forget it.
1863  *
1864  * You can remove the CB by passing in 0 for the func.  Alternatively, you can
1865  * just make sure that the func(data) pair are valid until the queue is freed or
1866  * reopened. */
1867 void qio_set_wake_cb(struct queue *q, qio_wake_cb_t func, void *data)
1868 {
1869         q->wake_data = data;
1870         wmb();  /* if we see func, we'll also see the data for it */
1871         q->wake_cb = func;
1872 }
1873
1874 /* Helper for detecting whether we'll block on a read at this instant. */
1875 bool qreadable(struct queue *q)
1876 {
1877         return qlen(q) > 0;
1878 }
1879
1880 /* Helper for detecting whether we'll block on a write at this instant. */
1881 bool qwritable(struct queue *q)
1882 {
1883         return qwindow(q) > 0;
1884 }