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