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