qio: Track the amount of bytes read
[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 dlen;                                       /* data bytes in queue */
75         int limit;                                      /* max bytes in queue */
76         int inilim;                             /* initial limit */
77         int state;
78         int eof;                                        /* number of eofs read by user */
79         size_t bytes_read;
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->dlen -= BLEN(b);
614         q->bytes_read += 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->dlen -= amt;
634         q->bytes_read += 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                 q->bytes_read += copy_amt;
678         }
679         /* Try to extract the remainder from the extra data */
680         len -= copy_amt;
681         for (int i = 0; (i < from->nr_extra_bufs) && len; i++) {
682                 ebd = &from->extra_data[i];
683                 if (!ebd->base || !ebd->len)
684                         continue;
685                 if (len >= ebd->len) {
686                         amt = move_ebd(ebd, to, from, q);
687                         if (!amt) {
688                                 /* our internal alloc could have failed.   this ebd is now the
689                                  * last one we'll consider.  let's handle it separately and put
690                                  * it in the main body. */
691                                 if (copy_amt)
692                                         return copy_amt;
693                                 copy_amt = copy_to_block_body(to, (void*)ebd->base + ebd->off,
694                                                               ebd->len);
695                                 block_and_q_lost_extra(from, q, copy_amt);
696                                 break;
697                         }
698                         len -= amt;
699                         copy_amt += amt;
700                         continue;
701                 } else {
702                         /* If we're here, we reached our final ebd, which we'll need to
703                          * split to get anything from it. */
704                         if (copy_amt)
705                                 return copy_amt;
706                         copy_amt = copy_to_block_body(to, (void*)ebd->base + ebd->off,
707                                                       len);
708                         ebd->off += copy_amt;
709                         ebd->len -= copy_amt;
710                         block_and_q_lost_extra(from, q, copy_amt);
711                         break;
712                 }
713         }
714         if (len)
715                 assert(copy_amt);       /* sanity */
716         return copy_amt;
717 }
718
719 /* Return codes for __qbread and __try_qbread. */
720 enum {
721         QBR_OK,
722         QBR_FAIL,
723         QBR_SPARE,      /* we need a spare block */
724         QBR_AGAIN,      /* do it again, we are coalescing blocks */
725 };
726
727 /* Helper and back-end for __qbread: extracts and returns a list of blocks
728  * containing up to len bytes.  It may contain less than len even if q has more
729  * data.
730  *
731  * Returns a code interpreted by __qbread, and the returned blist in ret. */
732 static int __try_qbread(struct queue *q, size_t len, int qio_flags,
733                         struct block **real_ret, struct block *spare)
734 {
735         struct block *ret, *ret_last, *first;
736         size_t blen;
737         bool was_unwritable = FALSE;
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         /* We need to check before adjusting q->len.  We're checking the writer's
755          * sleep condition / tap condition.  When set, we *might* be making an edge
756          * transition (from unwritable to writable), which needs to wake and fire
757          * taps.  But, our read might not drain the queue below q->lim.  We'll check
758          * again later to see if we should really wake them.  */
759         was_unwritable = !qwritable(q);
760         blen = BLEN(first);
761         if ((q->state & Qcoalesce) && (blen == 0)) {
762                 freeb(pop_first_block(q));
763                 spin_unlock_irqsave(&q->lock);
764                 /* Need to retry to make sure we have a first block */
765                 return QBR_AGAIN;
766         }
767         /* Qmsg: just return the first block.  Be careful, since our caller might
768          * not read all of the block and thus drop bytes.  Similar to SOCK_DGRAM. */
769         if (q->state & Qmsg) {
770                 ret = pop_first_block(q);
771                 goto out_ok;
772         }
773         /* Let's get at least something first - makes the code easier.  This way,
774          * we'll only ever split the block once. */
775         if (blen <= len) {
776                 ret = pop_first_block(q);
777                 len -= blen;
778         } else {
779                 /* need to split the block.  we won't actually take the first block out
780                  * of the queue - we're just extracting a little bit. */
781                 if (!spare) {
782                         /* We have nothing and need a spare block.  Retry! */
783                         spin_unlock_irqsave(&q->lock);
784                         return QBR_SPARE;
785                 }
786                 copy_from_first_block(q, spare, len);
787                 ret = spare;
788                 goto out_ok;
789         }
790         /* At this point, we just grabbed the first block.  We can try to grab some
791          * more, up to len (if they want). */
792         if (qio_flags & QIO_JUST_ONE_BLOCK)
793                 goto out_ok;
794         ret_last = ret;
795         while (q->bfirst && (len > 0)) {
796                 blen = BLEN(q->bfirst);
797                 if ((q->state & Qcoalesce) && (blen == 0)) {
798                         /* remove the intermediate 0 blocks */
799                         freeb(pop_first_block(q));
800                         continue;
801                 }
802                 if (blen > len) {
803                         /* We could try to split the block, but that's a huge pain.  For
804                          * instance, we might need to move the main body of b into an
805                          * extra_data of ret_last.  lots of ways for that to fail, and lots
806                          * of cases to consider.  Easier to just bail out.  This is why I
807                          * did the first block above: we don't need to worry about this. */
808                          break;
809                 }
810                 ret_last->next = pop_first_block(q);
811                 ret_last = ret_last->next;
812                 len -= blen;
813         }
814 out_ok:
815         /* Don't wake them up or fire tap if we didn't drain enough. */
816         if (!qwritable(q))
817                 was_unwritable = FALSE;
818         spin_unlock_irqsave(&q->lock);
819         if (was_unwritable) {
820                 if (q->kick && !(qio_flags & QIO_DONT_KICK))
821                         q->kick(q->arg);
822                 rendez_wakeup(&q->wr);
823                 qwake_cb(q, FDTAP_FILT_WRITABLE);
824         }
825         *real_ret = ret;
826         return QBR_OK;
827 }
828
829 /* Helper and front-end for __try_qbread: extracts and returns a list of blocks
830  * containing up to len bytes.  It may contain less than len even if q has more
831  * data.
832  *
833  * Returns 0 if the q is closed, if it would require blocking and !CAN_BLOCK, or
834  * if it required a spare and the memory allocation failed.
835  *
836  * Technically, there's a weird corner case with !Qcoalesce and Qmsg where you
837  * could get a zero length block back. */
838 static struct block *__qbread(struct queue *q, size_t len, int qio_flags,
839                               int mem_flags)
840 {
841         ERRSTACK(1);
842         struct block *ret = 0;
843         struct block *volatile spare = 0;       /* volatile for the waserror */
844
845         /* __try_qbread can throw, based on qio flags. */
846         if ((qio_flags & QIO_CAN_ERR_SLEEP) && waserror()) {
847                 if (spare)
848                         freeb(spare);
849                 nexterror();
850         }
851         while (1) {
852                 switch (__try_qbread(q, len, qio_flags, &ret, spare)) {
853                 case QBR_OK:
854                 case QBR_FAIL:
855                         if (spare && (ret != spare))
856                                 freeb(spare);
857                         goto out_ret;
858                 case QBR_SPARE:
859                         assert(!spare);
860                         /* Due to some nastiness, we need a fresh block so we can read out
861                          * anything from the queue.  'len' seems like a reasonable amount.
862                          * Maybe we can get away with less. */
863                         spare = block_alloc(len, mem_flags);
864                         if (!spare) {
865                                 /* Careful here: a memory failure (possible with MEM_ATOMIC)
866                                  * could look like 'no data in the queue' (QBR_FAIL).  The only
867                                  * one who does is this qget(), who happens to know that we
868                                  * won't need a spare, due to the len argument.  Spares are only
869                                  * needed when we need to split a block. */
870                                 ret = 0;
871                                 goto out_ret;
872                         }
873                         break;
874                 case QBR_AGAIN:
875                         /* if the first block is 0 and we are Qcoalesce, then we'll need to
876                          * try again.  We bounce out of __try so we can perform the "is
877                          * there a block" logic again from the top. */
878                         break;
879                 }
880         }
881         assert(0);
882 out_ret:
883         if (qio_flags & QIO_CAN_ERR_SLEEP)
884                 poperror();
885         return ret;
886 }
887
888 /*
889  *  get next block from a queue, return null if nothing there
890  */
891 struct block *qget(struct queue *q)
892 {
893         /* since len == SIZE_MAX, we should never need to do a mem alloc */
894         return __qbread(q, SIZE_MAX, QIO_JUST_ONE_BLOCK, MEM_ATOMIC);
895 }
896
897 /* Throw away the next 'len' bytes in the queue returning the number actually
898  * discarded.
899  *
900  * If the bytes are in the queue, then they must be discarded.  The only time to
901  * return less than len is if the q itself has less than len bytes.
902  *
903  * This won't trigger a kick when waking up any sleepers.  This seems to be Plan
904  * 9's intent, since the TCP stack will deadlock if qdiscard kicks. */
905 size_t qdiscard(struct queue *q, size_t len)
906 {
907         struct block *blist;
908         size_t removed_amt;
909         size_t sofar = 0;
910
911         /* This is racy.  There could be multiple qdiscarders or other consumers,
912          * where the consumption could be interleaved. */
913         while (qlen(q) && len) {
914                 blist = __qbread(q, len, QIO_DONT_KICK, MEM_WAIT);
915                 removed_amt = freeblist(blist);
916                 sofar += removed_amt;
917                 len -= removed_amt;
918         }
919         return sofar;
920 }
921
922 ssize_t qpass(struct queue *q, struct block *b)
923 {
924         return __qbwrite(q, b, QIO_LIMIT | QIO_DROP_OVERFLOW);
925 }
926
927 ssize_t qpassnolim(struct queue *q, struct block *b)
928 {
929         return __qbwrite(q, b, 0);
930 }
931
932 /*
933  *  if the allocated space is way out of line with the used
934  *  space, reallocate to a smaller block
935  */
936 struct block *packblock(struct block *bp)
937 {
938         struct block **l, *nbp;
939         int n;
940
941         if (bp->extra_len)
942                 return bp;
943         for (l = &bp; *l; l = &(*l)->next) {
944                 nbp = *l;
945                 n = BLEN(nbp);
946                 if ((n << 2) < BALLOC(nbp)) {
947                         *l = block_alloc(n, MEM_WAIT);
948                         memmove((*l)->wp, nbp->rp, n);
949                         (*l)->wp += n;
950                         (*l)->next = nbp->next;
951                         freeb(nbp);
952                 }
953         }
954
955         return bp;
956 }
957
958 /* Add an extra_data entry to newb at newb_idx pointing to b's body, starting at
959  * body_rp, for up to len.  Returns the len consumed.
960  *
961  * The base is 'b', so that we can kfree it later.  This currently ties us to
962  * using kfree for the release method for all extra_data.
963  *
964  * It is possible to have a body size that is 0, if there is no offset, and
965  * b->wp == b->rp.  This will have an extra data entry of 0 length. */
966 static size_t point_to_body(struct block *b, uint8_t *body_rp,
967                             struct block *newb, unsigned int newb_idx,
968                             size_t len)
969 {
970         struct extra_bdata *ebd = &newb->extra_data[newb_idx];
971
972         assert(newb_idx < newb->nr_extra_bufs);
973
974         kmalloc_incref(b);
975         ebd->base = (uintptr_t)b;
976         ebd->off = (uint32_t)(body_rp - (uint8_t*)b);
977         ebd->len = MIN(b->wp - body_rp, len);   /* think of body_rp as b->rp */
978         assert((int)ebd->len >= 0);
979         newb->extra_len += ebd->len;
980         return ebd->len;
981 }
982
983 /* Add an extra_data entry to newb at newb_idx pointing to b's b_idx'th
984  * extra_data buf, at b_off within that buffer, for up to len.  Returns the len
985  * consumed.
986  *
987  * We can have blocks with 0 length, but they are still refcnt'd.  See above. */
988 static size_t point_to_buf(struct block *b, unsigned int b_idx, uint32_t b_off,
989                            struct block *newb, unsigned int newb_idx,
990                            size_t len)
991 {
992         struct extra_bdata *n_ebd = &newb->extra_data[newb_idx];
993         struct extra_bdata *b_ebd = &b->extra_data[b_idx];
994
995         assert(b_idx < b->nr_extra_bufs);
996         assert(newb_idx < newb->nr_extra_bufs);
997
998         kmalloc_incref((void*)b_ebd->base);
999         n_ebd->base = b_ebd->base;
1000         n_ebd->off = b_ebd->off + b_off;
1001         n_ebd->len = MIN(b_ebd->len - b_off, len);
1002         newb->extra_len += n_ebd->len;
1003         return n_ebd->len;
1004 }
1005
1006 /* given a string of blocks, sets up the new block's extra_data such that it
1007  * *points* to the contents of the blist [offset, len + offset).  This does not
1008  * make a separate copy of the contents of the blist.
1009  *
1010  * returns 0 on success.  the only failure is if the extra_data array was too
1011  * small, so this returns a positive integer saying how big the extra_data needs
1012  * to be.
1013  *
1014  * callers are responsible for protecting the list structure. */
1015 static int __blist_clone_to(struct block *blist, struct block *newb, int len,
1016                             uint32_t offset)
1017 {
1018         struct block *b, *first;
1019         unsigned int nr_bufs = 0;
1020         unsigned int b_idx, newb_idx = 0;
1021         uint8_t *first_main_body = 0;
1022
1023         /* find the first block; keep offset relative to the latest b in the list */
1024         for (b = blist; b; b = b->next) {
1025                 if (BLEN(b) > offset)
1026                         break;
1027                 offset -= BLEN(b);
1028         }
1029         /* qcopy semantics: if you asked for an offset outside the block list, you
1030          * get an empty block back */
1031         if (!b)
1032                 return 0;
1033         first = b;
1034         /* upper bound for how many buffers we'll need in newb */
1035         for (/* b is set*/; b; b = b->next) {
1036                 nr_bufs += 1 + b->nr_extra_bufs;        /* 1 for the main body */
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, newb_idx, len);
1049                                 newb_idx++;
1050                         } else {
1051                                 /* off is in one of the buffers (or just past the last one).
1052                                  * we're not going to point to b's main body at all. */
1053                                 offset -= BHLEN(b);
1054                                 assert(b->extra_data);
1055                                 /* assuming these extrabufs are packed, or at least that len
1056                                  * isn't gibberish */
1057                                 while (b->extra_data[b_idx].len <= offset) {
1058                                         offset -= b->extra_data[b_idx].len;
1059                                         b_idx++;
1060                                 }
1061                                 /* now offset is set to our offset in the b_idx'th buf */
1062                                 len -= point_to_buf(b, b_idx, offset, newb, newb_idx, len);
1063                                 newb_idx++;
1064                                 b_idx++;
1065                         }
1066                         offset = 0;
1067                 } else {
1068                         len -= point_to_body(b, b->rp, newb, newb_idx, len);
1069                         newb_idx++;
1070                 }
1071                 /* knock out all remaining bufs.  we only did one point_to_ op by now,
1072                  * and any point_to_ could be our last if it consumed all of len. */
1073                 for (int i = b_idx; (i < b->nr_extra_bufs) && len; i++) {
1074                         len -= point_to_buf(b, i, 0, newb, newb_idx, len);
1075                         newb_idx++;
1076                 }
1077         }
1078         return 0;
1079 }
1080
1081 struct block *blist_clone(struct block *blist, int header_len, int len,
1082                           uint32_t offset)
1083 {
1084         int ret;
1085         struct block *newb = block_alloc(header_len, MEM_WAIT);
1086         do {
1087                 ret = __blist_clone_to(blist, newb, len, offset);
1088                 if (ret)
1089                         block_add_extd(newb, ret, MEM_WAIT);
1090         } while (ret);
1091         return newb;
1092 }
1093
1094 /* given a queue, makes a single block with header_len reserved space in the
1095  * block main body, and the contents of [offset, len + offset) pointed to in the
1096  * new blocks ext_data.  This does not make a copy of the q's contents, though
1097  * you do have a ref count on the memory. */
1098 struct block *qclone(struct queue *q, int header_len, int len, uint32_t offset)
1099 {
1100         int ret;
1101         struct block *newb = block_alloc(header_len, MEM_WAIT);
1102         /* the while loop should rarely be used: it would require someone
1103          * concurrently adding to the queue. */
1104         do {
1105                 /* TODO: RCU: protecting the q list (b->next) (need read lock) */
1106                 spin_lock_irqsave(&q->lock);
1107                 ret = __blist_clone_to(q->bfirst, newb, len, offset);
1108                 spin_unlock_irqsave(&q->lock);
1109                 if (ret)
1110                         block_add_extd(newb, ret, MEM_WAIT);
1111         } while (ret);
1112         return newb;
1113 }
1114
1115 /*
1116  *  copy from offset in the queue
1117  */
1118 struct block *qcopy_old(struct queue *q, int len, uint32_t offset)
1119 {
1120         int sofar;
1121         int n;
1122         struct block *b, *nb;
1123         uint8_t *p;
1124
1125         nb = block_alloc(len, MEM_WAIT);
1126
1127         spin_lock_irqsave(&q->lock);
1128
1129         /* go to offset */
1130         b = q->bfirst;
1131         for (sofar = 0;; sofar += n) {
1132                 if (b == NULL) {
1133                         spin_unlock_irqsave(&q->lock);
1134                         return nb;
1135                 }
1136                 n = BLEN(b);
1137                 if (sofar + n > offset) {
1138                         p = b->rp + offset - sofar;
1139                         n -= offset - sofar;
1140                         break;
1141                 }
1142                 QDEBUG checkb(b, "qcopy");
1143                 b = b->next;
1144         }
1145
1146         /* copy bytes from there */
1147         for (sofar = 0; sofar < len;) {
1148                 if (n > len - sofar)
1149                         n = len - sofar;
1150                 PANIC_EXTRA(b);
1151                 memmove(nb->wp, p, n);
1152                 qcopycnt += n;
1153                 sofar += n;
1154                 nb->wp += n;
1155                 b = b->next;
1156                 if (b == NULL)
1157                         break;
1158                 n = BLEN(b);
1159                 p = b->rp;
1160         }
1161         spin_unlock_irqsave(&q->lock);
1162
1163         return nb;
1164 }
1165
1166 struct block *qcopy(struct queue *q, int len, uint32_t offset)
1167 {
1168 #ifdef CONFIG_BLOCK_EXTRAS
1169         return qclone(q, 0, len, offset);
1170 #else
1171         return qcopy_old(q, len, offset);
1172 #endif
1173 }
1174
1175 static void qinit_common(struct queue *q)
1176 {
1177         spinlock_init_irqsave(&q->lock);
1178         rendez_init(&q->rr);
1179         rendez_init(&q->wr);
1180 }
1181
1182 /*
1183  *  called by non-interrupt code
1184  */
1185 struct queue *qopen(int limit, int msg, void (*kick) (void *), void *arg)
1186 {
1187         struct queue *q;
1188
1189         q = kzmalloc(sizeof(struct queue), 0);
1190         if (q == 0)
1191                 return 0;
1192         qinit_common(q);
1193
1194         q->limit = q->inilim = limit;
1195         q->kick = kick;
1196         q->arg = arg;
1197         q->state = msg;
1198         q->eof = 0;
1199
1200         return q;
1201 }
1202
1203 /* open a queue to be bypassed */
1204 struct queue *qbypass(void (*bypass) (void *, struct block *), void *arg)
1205 {
1206         struct queue *q;
1207
1208         q = kzmalloc(sizeof(struct queue), 0);
1209         if (q == 0)
1210                 return 0;
1211         qinit_common(q);
1212
1213         q->limit = 0;
1214         q->arg = arg;
1215         q->bypass = bypass;
1216         q->state = 0;
1217
1218         return q;
1219 }
1220
1221 static int notempty(void *a)
1222 {
1223         struct queue *q = a;
1224
1225         return (q->state & Qclosed) || q->bfirst != 0;
1226 }
1227
1228 /* Block, waiting for the queue to be non-empty or closed.  Returns with
1229  * the spinlock held.  Returns TRUE when there queue is not empty, FALSE if it
1230  * was naturally closed.  Throws an error o/w. */
1231 static bool qwait_and_ilock(struct queue *q, int qio_flags)
1232 {
1233         while (1) {
1234                 spin_lock_irqsave(&q->lock);
1235                 if (q->bfirst != NULL)
1236                         return TRUE;
1237                 if (q->state & Qclosed) {
1238                         if (++q->eof > 3) {
1239                                 spin_unlock_irqsave(&q->lock);
1240                                 error(EPIPE, "multiple reads on a closed queue");
1241                         }
1242                         if (q->err[0]) {
1243                                 spin_unlock_irqsave(&q->lock);
1244                                 error(EPIPE, q->err);
1245                         }
1246                         return FALSE;
1247                 }
1248                 if (qio_flags & QIO_NON_BLOCK) {
1249                         spin_unlock_irqsave(&q->lock);
1250                         error(EAGAIN, "queue empty");
1251                 }
1252                 spin_unlock_irqsave(&q->lock);
1253                 /* As with the producer side, we check for a condition while holding the
1254                  * q->lock, decide to sleep, then unlock.  It's like the "check, signal,
1255                  * check again" pattern, but we do it conditionally.  Both sides agree
1256                  * synchronously to do it, and those decisions are made while holding
1257                  * q->lock.  I think this is OK.
1258                  *
1259                  * The invariant is that no reader sleeps when the queue has data.
1260                  * While holding the rendez lock, if we see there's no data, we'll
1261                  * sleep.  Since we saw there was no data, the next writer will see (or
1262                  * already saw) no data, and then the writer decides to rendez_wake,
1263                  * which will grab the rendez lock.  If the writer already did that,
1264                  * then we'll see notempty when we do our check-again. */
1265                 rendez_sleep(&q->rr, notempty, q);
1266         }
1267 }
1268
1269 /*
1270  * add a block list to a queue
1271  * XXX basically the same as enqueue blist, and has no locking!
1272  */
1273 void qaddlist(struct queue *q, struct block *b)
1274 {
1275         /* TODO: q lock? */
1276         /* queue the block */
1277         if (q->bfirst)
1278                 q->blast->next = b;
1279         else
1280                 q->bfirst = b;
1281         q->dlen += blocklen(b);
1282         while (b->next)
1283                 b = b->next;
1284         q->blast = b;
1285 }
1286
1287 static size_t read_from_block(struct block *b, uint8_t *to, size_t amt)
1288 {
1289         size_t copy_amt, retval = 0;
1290         struct extra_bdata *ebd;
1291
1292         copy_amt = MIN(BHLEN(b), amt);
1293         memcpy(to, b->rp, copy_amt);
1294         /* advance the rp, since this block not be completely consumed and future
1295          * reads need to know where to pick up from */
1296         b->rp += copy_amt;
1297         to += copy_amt;
1298         amt -= copy_amt;
1299         retval += copy_amt;
1300         for (int i = 0; (i < b->nr_extra_bufs) && amt; i++) {
1301                 ebd = &b->extra_data[i];
1302                 /* skip empty entires.  if we track this in the struct block, we can
1303                  * just start the for loop early */
1304                 if (!ebd->base || !ebd->len)
1305                         continue;
1306                 copy_amt = MIN(ebd->len, amt);
1307                 memcpy(to, (void*)(ebd->base + ebd->off), copy_amt);
1308                 /* we're actually consuming the entries, just like how we advance rp up
1309                  * above, and might only consume part of one. */
1310                 ebd->len -= copy_amt;
1311                 ebd->off += copy_amt;
1312                 b->extra_len -= copy_amt;
1313                 if (!ebd->len) {
1314                         /* we don't actually have to decref here.  it's also done in
1315                          * freeb().  this is the earliest we can free. */
1316                         kfree((void*)ebd->base);
1317                         ebd->base = ebd->off = 0;
1318                 }
1319                 to += copy_amt;
1320                 amt -= copy_amt;
1321                 retval += copy_amt;
1322         }
1323         return retval;
1324 }
1325
1326 /*
1327  *  copy the contents of a string of blocks into
1328  *  memory.  emptied blocks are freed.  return
1329  *  pointer to first unconsumed block.
1330  */
1331 struct block *bl2mem(uint8_t * p, struct block *b, int n)
1332 {
1333         int i;
1334         struct block *next;
1335
1336         /* could be slicker here, since read_from_block is smart */
1337         for (; b != NULL; b = next) {
1338                 i = BLEN(b);
1339                 if (i > n) {
1340                         /* partial block, consume some */
1341                         read_from_block(b, p, n);
1342                         return b;
1343                 }
1344                 /* full block, consume all and move on */
1345                 i = read_from_block(b, p, i);
1346                 n -= i;
1347                 p += i;
1348                 next = b->next;
1349                 freeb(b);
1350         }
1351         return NULL;
1352 }
1353
1354 /* Extract the contents of all blocks and copy to va, up to len.  Returns the
1355  * actual amount copied. */
1356 static size_t read_all_blocks(struct block *b, void *va, size_t len)
1357 {
1358         size_t sofar = 0;
1359         struct block *next;
1360
1361         do {
1362                 /* We should be draining every block completely. */
1363                 assert(BLEN(b) <= len - sofar);
1364                 assert(va);
1365                 assert(va + sofar);
1366                 assert(b->rp);
1367                 sofar += read_from_block(b, va + sofar, len - sofar);
1368                 next = b->next;
1369                 freeb(b);
1370                 b = next;
1371         } while (b);
1372         return sofar;
1373 }
1374
1375 /*
1376  *  copy the contents of memory into a string of blocks.
1377  *  return NULL on error.
1378  */
1379 struct block *mem2bl(uint8_t * p, int len)
1380 {
1381         ERRSTACK(1);
1382         int n;
1383         struct block *b, *first, **l;
1384
1385         first = NULL;
1386         l = &first;
1387         if (waserror()) {
1388                 freeblist(first);
1389                 nexterror();
1390         }
1391         do {
1392                 n = len;
1393                 if (n > Maxatomic)
1394                         n = Maxatomic;
1395
1396                 *l = b = block_alloc(n, MEM_WAIT);
1397                 /* TODO consider extra_data */
1398                 memmove(b->wp, p, n);
1399                 b->wp += n;
1400                 p += n;
1401                 len -= n;
1402                 l = &b->next;
1403         } while (len > 0);
1404         poperror();
1405
1406         return first;
1407 }
1408
1409 /*
1410  *  put a block back to the front of the queue
1411  *  called with q ilocked
1412  */
1413 void qputback(struct queue *q, struct block *b)
1414 {
1415         b->next = q->bfirst;
1416         if (q->bfirst == NULL)
1417                 q->blast = b;
1418         q->bfirst = b;
1419         q->dlen += BLEN(b);
1420         /* qputback seems to undo a read, so we can undo the accounting too. */
1421         q->bytes_read -= BLEN(b);
1422 }
1423
1424 /*
1425  *  get next block from a queue (up to a limit)
1426  *
1427  */
1428 struct block *qbread(struct queue *q, size_t len)
1429 {
1430         return __qbread(q, len, QIO_JUST_ONE_BLOCK | QIO_CAN_ERR_SLEEP, MEM_WAIT);
1431 }
1432
1433 struct block *qbread_nonblock(struct queue *q, size_t len)
1434 {
1435         return __qbread(q, len, QIO_JUST_ONE_BLOCK | QIO_CAN_ERR_SLEEP |
1436                         QIO_NON_BLOCK, MEM_WAIT);
1437 }
1438
1439 /* read up to len from a queue into vp. */
1440 size_t qread(struct queue *q, void *va, size_t len)
1441 {
1442         struct block *blist = __qbread(q, len, QIO_CAN_ERR_SLEEP, MEM_WAIT);
1443
1444         if (!blist)
1445                 return 0;
1446         return read_all_blocks(blist, va, len);
1447 }
1448
1449 size_t qread_nonblock(struct queue *q, void *va, size_t len)
1450 {
1451         struct block *blist = __qbread(q, len, QIO_CAN_ERR_SLEEP | QIO_NON_BLOCK,
1452                                        MEM_WAIT);
1453
1454         if (!blist)
1455                 return 0;
1456         return read_all_blocks(blist, va, len);
1457 }
1458
1459 /* This is the rendez wake condition for writers. */
1460 static int qwriter_should_wake(void *a)
1461 {
1462         struct queue *q = a;
1463
1464         return qwritable(q) || (q->state & Qclosed);
1465 }
1466
1467 /* Helper: enqueues a list of blocks to a queue.  Returns the total length. */
1468 static size_t enqueue_blist(struct queue *q, struct block *b)
1469 {
1470         size_t dlen;
1471
1472         if (q->bfirst)
1473                 q->blast->next = b;
1474         else
1475                 q->bfirst = b;
1476         dlen = BLEN(b);
1477         while (b->next) {
1478                 b = b->next;
1479                 dlen += BLEN(b);
1480         }
1481         q->blast = b;
1482         q->dlen += dlen;
1483         return dlen;
1484 }
1485
1486 /* Adds block (which can be a list of blocks) to the queue, subject to
1487  * qio_flags.  Returns the length written on success or -1 on non-throwable
1488  * error.  Adjust qio_flags to control the value-added features!. */
1489 static ssize_t __qbwrite(struct queue *q, struct block *b, int qio_flags)
1490 {
1491         ssize_t ret;
1492         bool was_unreadable;
1493
1494         if (q->bypass) {
1495                 ret = blocklen(b);
1496                 (*q->bypass) (q->arg, b);
1497                 return ret;
1498         }
1499         spin_lock_irqsave(&q->lock);
1500         was_unreadable = q->dlen == 0;
1501         if (q->state & Qclosed) {
1502                 spin_unlock_irqsave(&q->lock);
1503                 freeblist(b);
1504                 if (!(qio_flags & QIO_CAN_ERR_SLEEP))
1505                         return -1;
1506                 if (q->err[0])
1507                         error(EPIPE, q->err);
1508                 else
1509                         error(EPIPE, "connection closed");
1510         }
1511         if ((qio_flags & QIO_LIMIT) && (q->dlen >= q->limit)) {
1512                 /* drop overflow takes priority over regular non-blocking */
1513                 if ((qio_flags & QIO_DROP_OVERFLOW) || (q->state & Qdropoverflow)) {
1514                         spin_unlock_irqsave(&q->lock);
1515                         freeb(b);
1516                         return -1;
1517                 }
1518                 /* People shouldn't set NON_BLOCK without CAN_ERR, but we can be nice
1519                  * and catch it. */
1520                 if ((qio_flags & QIO_CAN_ERR_SLEEP) && (qio_flags & QIO_NON_BLOCK)) {
1521                         spin_unlock_irqsave(&q->lock);
1522                         freeb(b);
1523                         error(EAGAIN, "queue full");
1524                 }
1525         }
1526         ret = enqueue_blist(q, b);
1527         QDEBUG checkb(b, "__qbwrite");
1528         spin_unlock_irqsave(&q->lock);
1529         /* TODO: not sure if the usage of a kick is mutually exclusive with a
1530          * wakeup, meaning that actual users either want a kick or have qreaders. */
1531         if (q->kick && (was_unreadable || (q->state & Qkick)))
1532                 q->kick(q->arg);
1533         if (was_unreadable) {
1534                 /* Unlike the read side, there's no double-check to make sure the queue
1535                  * transitioned across an edge.  We know we added something, so that's
1536                  * enough.  We wake if the queue was empty.  Both sides are the same, in
1537                  * that the condition for which we do the rendez_wakeup() is the same as
1538                  * the condition done for the rendez_sleep(). */
1539                 rendez_wakeup(&q->rr);
1540                 qwake_cb(q, FDTAP_FILT_READABLE);
1541         }
1542         /*
1543          *  flow control, wait for queue to get below the limit
1544          *  before allowing the process to continue and queue
1545          *  more.  We do this here so that postnote can only
1546          *  interrupt us after the data has been queued.  This
1547          *  means that things like 9p flushes and ssl messages
1548          *  will not be disrupted by software interrupts.
1549          *
1550          *  Note - this is moderately dangerous since a process
1551          *  that keeps getting interrupted and rewriting will
1552          *  queue infinite crud.
1553          */
1554         if ((qio_flags & QIO_CAN_ERR_SLEEP) &&
1555             !(q->state & Qdropoverflow) && !(qio_flags & QIO_NON_BLOCK)) {
1556                 /* This is a racy peek at the q status.  If we accidentally block, our
1557                  * rendez will return.  The rendez's peak (qwriter_should_wake) is also
1558                  * racy w.r.t.  the q's spinlock (that lock protects writes, but not
1559                  * reads).
1560                  *
1561                  * Here's the deal: when holding the rendez lock, if we see the sleep
1562                  * condition, the consumer will wake us.  The condition will only ever
1563                  * be changed by the next qbread() (consumer, changes q->dlen).  That
1564                  * code will do a rendez wake, which will spin on the rendez lock,
1565                  * meaning it won't procede until we either see the new state (and
1566                  * return) or put ourselves on the rendez, and wake up.
1567                  *
1568                  * The pattern is one side writes mem, then signals.  Our side checks
1569                  * the signal, then reads the mem.  The goal is to not miss seeing the
1570                  * signal AND missing the memory write.  In this specific case, the
1571                  * signal is actually synchronous (the rendez lock) and not basic shared
1572                  * memory.
1573                  *
1574                  * Oh, and we spin in case we woke early and someone else filled the
1575                  * queue, mesa-style. */
1576                 while (!qwriter_should_wake(q))
1577                         rendez_sleep(&q->wr, qwriter_should_wake, q);
1578         }
1579         return ret;
1580 }
1581
1582 /*
1583  *  add a block to a queue obeying flow control
1584  */
1585 ssize_t qbwrite(struct queue *q, struct block *b)
1586 {
1587         return __qbwrite(q, b, QIO_CAN_ERR_SLEEP | QIO_LIMIT);
1588 }
1589
1590 ssize_t qbwrite_nonblock(struct queue *q, struct block *b)
1591 {
1592         return __qbwrite(q, b, QIO_CAN_ERR_SLEEP | QIO_LIMIT | QIO_NON_BLOCK);
1593 }
1594
1595 ssize_t qibwrite(struct queue *q, struct block *b)
1596 {
1597         return __qbwrite(q, b, 0);
1598 }
1599
1600 /* Helper, allocs a block and copies [from, from + len) into it.  Returns the
1601  * block on success, 0 on failure. */
1602 static struct block *build_block(void *from, size_t len, int mem_flags)
1603 {
1604         struct block *b;
1605         void *ext_buf;
1606
1607         /* If len is small, we don't need to bother with the extra_data.  But until
1608          * the whole stack can handle extd blocks, we'll use them unconditionally.
1609          * */
1610 #ifdef CONFIG_BLOCK_EXTRAS
1611         /* allocb builds in 128 bytes of header space to all blocks, but this is
1612          * only available via padblock (to the left).  we also need some space
1613          * for pullupblock for some basic headers (like icmp) that get written
1614          * in directly */
1615         b = block_alloc(64, mem_flags);
1616         if (!b)
1617                 return 0;
1618         ext_buf = kmalloc(len, mem_flags);
1619         if (!ext_buf) {
1620                 kfree(b);
1621                 return 0;
1622         }
1623         memcpy(ext_buf, from, len);
1624         if (block_add_extd(b, 1, mem_flags)) {
1625                 kfree(ext_buf);
1626                 kfree(b);
1627                 return 0;
1628         }
1629         b->extra_data[0].base = (uintptr_t)ext_buf;
1630         b->extra_data[0].off = 0;
1631         b->extra_data[0].len = len;
1632         b->extra_len += len;
1633 #else
1634         b = block_alloc(len, mem_flags);
1635         if (!b)
1636                 return 0;
1637         memmove(b->wp, from, len);
1638         b->wp += len;
1639 #endif
1640         return b;
1641 }
1642
1643 static ssize_t __qwrite(struct queue *q, void *vp, size_t len, int mem_flags,
1644                         int qio_flags)
1645 {
1646         ERRSTACK(1);
1647         size_t n;
1648         volatile size_t sofar = 0;      /* volatile for the waserror */
1649         struct block *b;
1650         uint8_t *p = vp;
1651         void *ext_buf;
1652
1653         /* Only some callers can throw.  Others might be in a context where waserror
1654          * isn't safe. */
1655         if ((qio_flags & QIO_CAN_ERR_SLEEP) && waserror()) {
1656                 /* Any error (EAGAIN for nonblock, syscall aborted, even EPIPE) after
1657                  * some data has been sent should be treated as a partial write. */
1658                 if (sofar)
1659                         goto out_ok;
1660                 nexterror();
1661         }
1662         do {
1663                 n = len - sofar;
1664                 /* This is 64K, the max amount per single block.  Still a good value? */
1665                 if (n > Maxatomic)
1666                         n = Maxatomic;
1667                 b = build_block(p + sofar, n, mem_flags);
1668                 if (!b)
1669                         break;
1670                 if (__qbwrite(q, b, qio_flags) < 0)
1671                         break;
1672                 sofar += n;
1673         } while ((sofar < len) && (q->state & Qmsg) == 0);
1674 out_ok:
1675         if (qio_flags & QIO_CAN_ERR_SLEEP)
1676                 poperror();
1677         return sofar;
1678 }
1679
1680 ssize_t qwrite(struct queue *q, void *vp, int len)
1681 {
1682         return __qwrite(q, vp, len, MEM_WAIT, QIO_CAN_ERR_SLEEP | QIO_LIMIT);
1683 }
1684
1685 ssize_t qwrite_nonblock(struct queue *q, void *vp, int len)
1686 {
1687         return __qwrite(q, vp, len, MEM_WAIT, QIO_CAN_ERR_SLEEP | QIO_LIMIT |
1688                                               QIO_NON_BLOCK);
1689 }
1690
1691 ssize_t qiwrite(struct queue *q, void *vp, int len)
1692 {
1693         return __qwrite(q, vp, len, MEM_ATOMIC, 0);
1694 }
1695
1696 /*
1697  *  be extremely careful when calling this,
1698  *  as there is no reference accounting
1699  */
1700 void qfree(struct queue *q)
1701 {
1702         qclose(q);
1703         kfree(q);
1704 }
1705
1706 /*
1707  *  Mark a queue as closed.  No further IO is permitted.
1708  *  All blocks are released.
1709  */
1710 void qclose(struct queue *q)
1711 {
1712         struct block *bfirst;
1713
1714         if (q == NULL)
1715                 return;
1716
1717         /* mark it */
1718         spin_lock_irqsave(&q->lock);
1719         q->state |= Qclosed;
1720         q->state &= ~Qdropoverflow;
1721         q->err[0] = 0;
1722         bfirst = q->bfirst;
1723         q->bfirst = 0;
1724         q->dlen = 0;
1725         spin_unlock_irqsave(&q->lock);
1726
1727         /* free queued blocks */
1728         freeblist(bfirst);
1729
1730         /* wake up readers/writers */
1731         rendez_wakeup(&q->rr);
1732         rendez_wakeup(&q->wr);
1733         qwake_cb(q, FDTAP_FILT_HANGUP);
1734 }
1735
1736 /* Mark a queue as closed.  Wakeup any readers.  Don't remove queued blocks.
1737  *
1738  * msg will be the errstr received by any waiters (qread, qbread, etc).  If
1739  * there is no message, which is what also happens during a natural qclose(),
1740  * those waiters will simply return 0.  qwriters will always error() on a
1741  * closed/hungup queue. */
1742 void qhangup(struct queue *q, char *msg)
1743 {
1744         /* mark it */
1745         spin_lock_irqsave(&q->lock);
1746         q->state |= Qclosed;
1747         if (msg == 0 || *msg == 0)
1748                 q->err[0] = 0;
1749         else
1750                 strlcpy(q->err, msg, ERRMAX);
1751         spin_unlock_irqsave(&q->lock);
1752
1753         /* wake up readers/writers */
1754         rendez_wakeup(&q->rr);
1755         rendez_wakeup(&q->wr);
1756         qwake_cb(q, FDTAP_FILT_HANGUP);
1757 }
1758
1759 /*
1760  *  return non-zero if the q is hungup
1761  */
1762 int qisclosed(struct queue *q)
1763 {
1764         return q->state & Qclosed;
1765 }
1766
1767 /*
1768  *  mark a queue as no longer hung up.  resets the wake_cb.
1769  */
1770 void qreopen(struct queue *q)
1771 {
1772         spin_lock_irqsave(&q->lock);
1773         q->state &= ~Qclosed;
1774         q->eof = 0;
1775         q->limit = q->inilim;
1776         q->wake_cb = 0;
1777         q->wake_data = 0;
1778         spin_unlock_irqsave(&q->lock);
1779 }
1780
1781 /*
1782  *  return bytes queued
1783  */
1784 int qlen(struct queue *q)
1785 {
1786         return q->dlen;
1787 }
1788
1789 size_t q_bytes_read(struct queue *q)
1790 {
1791         return q->bytes_read;
1792 }
1793
1794 /*
1795  * return space remaining before flow control
1796  *
1797  *  This used to be
1798  *  q->len < q->limit/2
1799  *  but it slows down tcp too much for certain write sizes.
1800  *  I really don't understand it completely.  It may be
1801  *  due to the queue draining so fast that the transmission
1802  *  stalls waiting for the app to produce more data.  - presotto
1803  *
1804  *  q->len was the amount of bytes, which is no longer used.  we now use
1805  *  q->dlen, the amount of usable data.  a.k.a. qlen()...  - brho
1806  */
1807 int qwindow(struct queue *q)
1808 {
1809         int l;
1810
1811         l = q->limit - q->dlen;
1812         if (l < 0)
1813                 l = 0;
1814         return l;
1815 }
1816
1817 /*
1818  *  return true if we can read without blocking
1819  */
1820 int qcanread(struct queue *q)
1821 {
1822         return q->bfirst != 0;
1823 }
1824
1825 /*
1826  *  change queue limit
1827  */
1828 void qsetlimit(struct queue *q, int limit)
1829 {
1830         q->limit = limit;
1831 }
1832
1833 /*
1834  *  set whether writes drop overflowing blocks, or if we sleep
1835  */
1836 void qdropoverflow(struct queue *q, bool onoff)
1837 {
1838         spin_lock_irqsave(&q->lock);
1839         if (onoff)
1840                 q->state |= Qdropoverflow;
1841         else
1842                 q->state &= ~Qdropoverflow;
1843         spin_unlock_irqsave(&q->lock);
1844 }
1845
1846 /* Be careful: this can affect concurrent reads/writes and code that might have
1847  * built-in expectations of the q's type. */
1848 void q_toggle_qmsg(struct queue *q, bool onoff)
1849 {
1850         spin_lock_irqsave(&q->lock);
1851         if (onoff)
1852                 q->state |= Qmsg;
1853         else
1854                 q->state &= ~Qmsg;
1855         spin_unlock_irqsave(&q->lock);
1856 }
1857
1858 /* Be careful: this can affect concurrent reads/writes and code that might have
1859  * built-in expectations of the q's type. */
1860 void q_toggle_qcoalesce(struct queue *q, bool onoff)
1861 {
1862         spin_lock_irqsave(&q->lock);
1863         if (onoff)
1864                 q->state |= Qcoalesce;
1865         else
1866                 q->state &= ~Qcoalesce;
1867         spin_unlock_irqsave(&q->lock);
1868 }
1869
1870 /*
1871  *  flush the output queue
1872  */
1873 void qflush(struct queue *q)
1874 {
1875         struct block *bfirst;
1876
1877         /* mark it */
1878         spin_lock_irqsave(&q->lock);
1879         bfirst = q->bfirst;
1880         q->bfirst = 0;
1881         q->dlen = 0;
1882         spin_unlock_irqsave(&q->lock);
1883
1884         /* free queued blocks */
1885         freeblist(bfirst);
1886
1887         /* wake up writers */
1888         rendez_wakeup(&q->wr);
1889         qwake_cb(q, FDTAP_FILT_WRITABLE);
1890 }
1891
1892 int qfull(struct queue *q)
1893 {
1894         return !qwritable(q);
1895 }
1896
1897 int qstate(struct queue *q)
1898 {
1899         return q->state;
1900 }
1901
1902 void qdump(struct queue *q)
1903 {
1904         if (q)
1905                 printk("q=%p bfirst=%p blast=%p dlen=%d limit=%d state=#%x\n",
1906                            q, q->bfirst, q->blast, q->dlen, q->limit, q->state);
1907 }
1908
1909 /* On certain wakeup events, qio will call func(q, data, filter), where filter
1910  * marks the type of wakeup event (flags from FDTAP).
1911  *
1912  * There's no sync protection.  If you change the CB while the qio is running,
1913  * you might get a CB with the data or func from a previous set_wake_cb.  You
1914  * should set this once per queue and forget it.
1915  *
1916  * You can remove the CB by passing in 0 for the func.  Alternatively, you can
1917  * just make sure that the func(data) pair are valid until the queue is freed or
1918  * reopened. */
1919 void qio_set_wake_cb(struct queue *q, qio_wake_cb_t func, void *data)
1920 {
1921         q->wake_data = data;
1922         wmb();  /* if we see func, we'll also see the data for it */
1923         q->wake_cb = func;
1924 }
1925
1926 /* Helper for detecting whether we'll block on a read at this instant. */
1927 bool qreadable(struct queue *q)
1928 {
1929         return qlen(q) > 0;
1930 }
1931
1932 /* Helper for detecting whether we'll block on a write at this instant. */
1933 bool qwritable(struct queue *q)
1934 {
1935         return !q->limit || qwindow(q) > 0;
1936 }