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