sys_rename: allow arbitrary rename
[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 WARN_EXTRA(b)                                                          \
17 {                                                                              \
18         if ((b)->extra_len)                                                        \
19                 warn_once("%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                 WARN_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                 WARN_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         WARN_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         WARN_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         WARN_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         WARN_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         WARN_EXTRA(bp);
844         for (l = &bp; *l; l = &(*l)->next) {
845                 nbp = *l;
846                 n = BLEN(nbp);
847                 if ((n << 2) < BALLOC(nbp)) {
848                         *l = allocb(n);
849                         memmove((*l)->wp, nbp->rp, n);
850                         (*l)->wp += n;
851                         (*l)->next = nbp->next;
852                         freeb(nbp);
853                 }
854         }
855
856         return bp;
857 }
858
859 int qproduce(struct queue *q, void *vp, int len)
860 {
861         struct block *b;
862         int dowakeup;
863         uint8_t *p = vp;
864
865         /* sync with qread */
866         dowakeup = 0;
867         spin_lock_irqsave(&q->lock);
868
869         /* no waiting receivers, room in buffer? */
870         if (q->len >= q->limit) {
871                 q->state |= Qflow;
872                 spin_unlock_irqsave(&q->lock);
873                 return -1;
874         }
875
876         /* save in buffer */
877         /* use Qcoalesce here to save storage */
878         // TODO: Consider removing the Qcoalesce flag and force a coalescing
879         // strategy by default.
880         b = q->blast;
881         if ((q->state & Qcoalesce) == 0 || q->bfirst == NULL
882                 || b->lim - b->wp < len) {
883                 /* need a new block */
884                 b = iallocb(len);
885                 if (b == 0) {
886                         spin_unlock_irqsave(&q->lock);
887                         return 0;
888                 }
889                 if (q->bfirst)
890                         q->blast->next = b;
891                 else
892                         q->bfirst = b;
893                 q->blast = b;
894                 /* b->next = 0; done by iallocb() */
895                 q->len += BALLOC(b);
896         }
897         WARN_EXTRA(b);
898         memmove(b->wp, p, len);
899         producecnt += len;
900         b->wp += len;
901         q->dlen += len;
902         QDEBUG checkb(b, "qproduce");
903
904         if (q->state & Qstarve) {
905                 q->state &= ~Qstarve;
906                 dowakeup = 1;
907         }
908
909         if (q->len >= q->limit)
910                 q->state |= Qflow;
911         spin_unlock_irqsave(&q->lock);
912
913         if (dowakeup)
914                 rendez_wakeup(&q->rr);
915
916         return len;
917 }
918
919 /* Add an extra_data entry to newb at newb_idx pointing to b's body, starting at
920  * body_rp, for up to len.  Returns the len consumed. 
921  *
922  * The base is 'b', so that we can kfree it later.  This currently ties us to
923  * using kfree for the release method for all extra_data.
924  *
925  * It is possible to have a body size that is 0, if there is no offset, and
926  * b->wp == b->rp.  This will have an extra data entry of 0 length. */
927 static size_t point_to_body(struct block *b, uint8_t *body_rp,
928                             struct block *newb, unsigned int newb_idx,
929                             size_t len)
930 {
931         struct extra_bdata *ebd = &newb->extra_data[newb_idx];
932
933         assert(newb_idx < newb->nr_extra_bufs);
934
935         kmalloc_incref(b);
936         ebd->base = (uintptr_t)b;
937         ebd->off = (uint32_t)(body_rp - (uint8_t*)b);
938         ebd->len = MIN(b->wp - body_rp, len);   /* think of body_rp as b->rp */
939         assert((int)ebd->len >= 0);
940         newb->extra_len += ebd->len;
941         return ebd->len;
942 }
943
944 /* Add an extra_data entry to newb at newb_idx pointing to b's b_idx'th
945  * extra_data buf, at b_off within that buffer, for up to len.  Returns the len
946  * consumed.
947  *
948  * We can have blocks with 0 length, but they are still refcnt'd.  See above. */
949 static size_t point_to_buf(struct block *b, unsigned int b_idx, uint32_t b_off,
950                            struct block *newb, unsigned int newb_idx,
951                            size_t len)
952 {
953         struct extra_bdata *n_ebd = &newb->extra_data[newb_idx];
954         struct extra_bdata *b_ebd = &b->extra_data[b_idx];
955
956         assert(b_idx < b->nr_extra_bufs);
957         assert(newb_idx < newb->nr_extra_bufs);
958
959         kmalloc_incref((void*)b_ebd->base);
960         n_ebd->base = b_ebd->base;
961         n_ebd->off = b_ebd->off + b_off;
962         n_ebd->len = MIN(b_ebd->len - b_off, len);
963         newb->extra_len += n_ebd->len;
964         return n_ebd->len;
965 }
966
967 /* given a string of blocks, fills the new block's extra_data  with the contents
968  * of the blist [offset, len + offset)
969  *
970  * returns 0 on success.  the only failure is if the extra_data array was too
971  * small, so this returns a positive integer saying how big the extra_data needs
972  * to be.
973  *
974  * callers are responsible for protecting the list structure. */
975 static int __blist_clone_to(struct block *blist, struct block *newb, int len,
976                             uint32_t offset)
977 {
978         struct block *b, *first;
979         unsigned int nr_bufs = 0;
980         unsigned int b_idx, newb_idx = 0;
981         uint8_t *first_main_body = 0;
982
983         /* find the first block; keep offset relative to the latest b in the list */
984         for (b = blist; b; b = b->next) {
985                 if (BLEN(b) > offset)
986                         break;
987                 offset -= BLEN(b);
988         }
989         /* qcopy semantics: if you asked for an offset outside the block list, you
990          * get an empty block back */
991         if (!b)
992                 return 0;
993         first = b;
994         /* upper bound for how many buffers we'll need in newb */
995         for (/* b is set*/; b; b = b->next) {
996                 nr_bufs += 1 + b->nr_extra_bufs;        /* 1 for the main body */
997         }
998         /* we might be holding a spinlock here, so we won't wait for kmalloc */
999         block_add_extd(newb, nr_bufs, 0);
1000         if (newb->nr_extra_bufs < nr_bufs) {
1001                 /* caller will need to alloc these, then re-call us */
1002                 return nr_bufs;
1003         }
1004         for (b = first; b && len; b = b->next) {
1005                 b_idx = 0;
1006                 if (offset) {
1007                         if (offset < BHLEN(b)) {
1008                                 /* off is in the main body */
1009                                 len -= point_to_body(b, b->rp + offset, newb, newb_idx, len);
1010                                 newb_idx++;
1011                         } else {
1012                                 /* off is in one of the buffers (or just past the last one).
1013                                  * we're not going to point to b's main body at all. */
1014                                 offset -= BHLEN(b);
1015                                 assert(b->extra_data);
1016                                 /* assuming these extrabufs are packed, or at least that len
1017                                  * isn't gibberish */
1018                                 while (b->extra_data[b_idx].len <= offset) {
1019                                         offset -= b->extra_data[b_idx].len;
1020                                         b_idx++;
1021                                 }
1022                                 /* now offset is set to our offset in the b_idx'th buf */
1023                                 len -= point_to_buf(b, b_idx, offset, newb, newb_idx, len);
1024                                 newb_idx++;
1025                                 b_idx++;
1026                         }
1027                         offset = 0;
1028                 } else {
1029                         len -= point_to_body(b, b->rp, newb, newb_idx, len);
1030                         newb_idx++;
1031                 }
1032                 /* knock out all remaining bufs.  we only did one point_to_ op by now,
1033                  * and any point_to_ could be our last if it consumed all of len. */
1034                 for (int i = b_idx; (i < b->nr_extra_bufs) && len; i++) {
1035                         len -= point_to_buf(b, i, 0, newb, newb_idx, len);
1036                         newb_idx++;
1037                 }
1038         }
1039         return 0;
1040 }
1041
1042 struct block *blist_clone(struct block *blist, int header_len, int len,
1043                           uint32_t offset)
1044 {
1045         int ret;
1046         struct block *newb = allocb(header_len);
1047         do {
1048                 ret = __blist_clone_to(blist, newb, len, offset);
1049                 if (ret)
1050                         block_add_extd(newb, ret, KMALLOC_WAIT);
1051         } while (ret);
1052         return newb;
1053 }
1054
1055 /* given a queue, makes a single block with header_len reserved space in the
1056  * block main body, and the contents of [offset, len + offset) pointed to in the
1057  * new blocks ext_data. */
1058 struct block *qclone(struct queue *q, int header_len, int len, uint32_t offset)
1059 {
1060         int ret;
1061         struct block *newb = allocb(header_len);
1062         /* the while loop should rarely be used: it would require someone
1063          * concurrently adding to the queue. */
1064         do {
1065                 /* TODO: RCU: protecting the q list (b->next) (need read lock) */
1066                 spin_lock_irqsave(&q->lock);
1067                 ret = __blist_clone_to(q->bfirst, newb, len, offset);
1068                 spin_unlock_irqsave(&q->lock);
1069                 if (ret)
1070                         block_add_extd(newb, ret, KMALLOC_WAIT);
1071         } while (ret);
1072         return newb;
1073 }
1074
1075 /*
1076  *  copy from offset in the queue
1077  */
1078 struct block *qcopy_old(struct queue *q, int len, uint32_t offset)
1079 {
1080         int sofar;
1081         int n;
1082         struct block *b, *nb;
1083         uint8_t *p;
1084
1085         nb = allocb(len);
1086
1087         spin_lock_irqsave(&q->lock);
1088
1089         /* go to offset */
1090         b = q->bfirst;
1091         for (sofar = 0;; sofar += n) {
1092                 if (b == NULL) {
1093                         spin_unlock_irqsave(&q->lock);
1094                         return nb;
1095                 }
1096                 n = BLEN(b);
1097                 if (sofar + n > offset) {
1098                         p = b->rp + offset - sofar;
1099                         n -= offset - sofar;
1100                         break;
1101                 }
1102                 QDEBUG checkb(b, "qcopy");
1103                 b = b->next;
1104         }
1105
1106         /* copy bytes from there */
1107         for (sofar = 0; sofar < len;) {
1108                 if (n > len - sofar)
1109                         n = len - sofar;
1110                 WARN_EXTRA(b);
1111                 memmove(nb->wp, p, n);
1112                 qcopycnt += n;
1113                 sofar += n;
1114                 nb->wp += n;
1115                 b = b->next;
1116                 if (b == NULL)
1117                         break;
1118                 n = BLEN(b);
1119                 p = b->rp;
1120         }
1121         spin_unlock_irqsave(&q->lock);
1122
1123         return nb;
1124 }
1125
1126 struct block *qcopy(struct queue *q, int len, uint32_t offset)
1127 {
1128 #ifdef CONFIG_BLOCK_EXTRAS
1129         return qclone(q, 0, len, offset);
1130 #else
1131         return qcopy_old(q, len, offset);
1132 #endif
1133 }
1134
1135 static void qinit_common(struct queue *q)
1136 {
1137         spinlock_init_irqsave(&q->lock);
1138         qlock_init(&q->rlock);
1139         qlock_init(&q->wlock);
1140         rendez_init(&q->rr);
1141         rendez_init(&q->wr);
1142 }
1143
1144 /*
1145  *  called by non-interrupt code
1146  */
1147 struct queue *qopen(int limit, int msg, void (*kick) (void *), void *arg)
1148 {
1149         struct queue *q;
1150
1151         q = kzmalloc(sizeof(struct queue), 0);
1152         if (q == 0)
1153                 return 0;
1154         qinit_common(q);
1155
1156         q->limit = q->inilim = limit;
1157         q->kick = kick;
1158         q->arg = arg;
1159         q->state = msg;
1160         q->state |= Qstarve;
1161         q->eof = 0;
1162         q->noblock = 0;
1163
1164         return q;
1165 }
1166
1167 /* open a queue to be bypassed */
1168 struct queue *qbypass(void (*bypass) (void *, struct block *), void *arg)
1169 {
1170         struct queue *q;
1171
1172         q = kzmalloc(sizeof(struct queue), 0);
1173         if (q == 0)
1174                 return 0;
1175         qinit_common(q);
1176
1177         q->limit = 0;
1178         q->arg = arg;
1179         q->bypass = bypass;
1180         q->state = 0;
1181
1182         return q;
1183 }
1184
1185 static int notempty(void *a)
1186 {
1187         struct queue *q = a;
1188
1189         return (q->state & Qclosed) || q->bfirst != 0;
1190 }
1191
1192 /* wait for the queue to be non-empty or closed.
1193  *
1194  * called with q ilocked.  rendez may error out, back through the caller, with
1195  * the irqsave lock unlocked.  */
1196 static int qwait(struct queue *q)
1197 {
1198         /* wait for data */
1199         for (;;) {
1200                 if (q->bfirst != NULL)
1201                         break;
1202
1203                 if (q->state & Qclosed) {
1204                         if (++q->eof > 3)
1205                                 return -1;
1206                         if (*q->err && strcmp(q->err, Ehungup) != 0)
1207                                 return -1;
1208                         return 0;
1209                 }
1210
1211                 q->state |= Qstarve;    /* flag requesting producer to wake me */
1212                 spin_unlock_irqsave(&q->lock);
1213                 /* may throw an error() */
1214                 rendez_sleep(&q->rr, notempty, q);
1215                 spin_lock_irqsave(&q->lock);
1216         }
1217         return 1;
1218 }
1219
1220 /*
1221  * add a block list to a queue
1222  */
1223 void qaddlist(struct queue *q, struct block *b)
1224 {
1225         /* TODO: q lock? */
1226         /* queue the block */
1227         if (q->bfirst)
1228                 q->blast->next = b;
1229         else
1230                 q->bfirst = b;
1231         q->len += blockalloclen(b);
1232         q->dlen += blocklen(b);
1233         while (b->next)
1234                 b = b->next;
1235         q->blast = b;
1236 }
1237
1238 /*
1239  *  called with q ilocked
1240  */
1241 struct block *qremove(struct queue *q)
1242 {
1243         struct block *b;
1244
1245         b = q->bfirst;
1246         if (b == NULL)
1247                 return NULL;
1248         q->bfirst = b->next;
1249         b->next = NULL;
1250         q->dlen -= BLEN(b);
1251         q->len -= BALLOC(b);
1252         QDEBUG checkb(b, "qremove");
1253         return b;
1254 }
1255
1256 static size_t read_from_block(struct block *b, uint8_t *to, size_t amt)
1257 {
1258         size_t copy_amt, retval = 0;
1259         struct extra_bdata *ebd;
1260         
1261         copy_amt = MIN(BHLEN(b), amt);
1262         memcpy(to, b->rp, copy_amt);
1263         /* advance the rp, since this block not be completely consumed and future
1264          * reads need to know where to pick up from */
1265         b->rp += copy_amt;
1266         to += copy_amt;
1267         amt -= copy_amt;
1268         retval += copy_amt;
1269         for (int i = 0; (i < b->nr_extra_bufs) && amt; i++) {
1270                 ebd = &b->extra_data[i];
1271                 /* skip empty entires.  if we track this in the struct block, we can
1272                  * just start the for loop early */
1273                 if (!ebd->base || !ebd->len)
1274                         continue;
1275                 copy_amt = MIN(ebd->len, amt);
1276                 memcpy(to, (void*)(ebd->base + ebd->off), copy_amt);
1277                 /* we're actually consuming the entries, just like how we advance rp up
1278                  * above, and might only consume part of one. */
1279                 ebd->len -= copy_amt;
1280                 ebd->off += copy_amt;
1281                 b->extra_len -= copy_amt;
1282                 if (!ebd->len) {
1283                         /* we don't actually have to decref here.  it's also done in
1284                          * freeb().  this is the earliest we can free. */
1285                         kfree((void*)ebd->base);
1286                         ebd->base = ebd->off = 0;
1287                 }
1288                 to += copy_amt;
1289                 amt -= copy_amt;
1290                 retval += copy_amt;
1291         }
1292         return retval;
1293 }
1294
1295 /*
1296  *  copy the contents of a string of blocks into
1297  *  memory.  emptied blocks are freed.  return
1298  *  pointer to first unconsumed block.
1299  */
1300 struct block *bl2mem(uint8_t * p, struct block *b, int n)
1301 {
1302         int i;
1303         struct block *next;
1304
1305         /* could be slicker here, since read_from_block is smart */
1306         for (; b != NULL; b = next) {
1307                 i = BLEN(b);
1308                 if (i > n) {
1309                         /* partial block, consume some */
1310                         read_from_block(b, p, n);
1311                         return b;
1312                 }
1313                 /* full block, consume all and move on */
1314                 i = read_from_block(b, p, i);
1315                 n -= i;
1316                 p += i;
1317                 next = b->next;
1318                 freeb(b);
1319         }
1320         return NULL;
1321 }
1322
1323 /*
1324  *  copy the contents of memory into a string of blocks.
1325  *  return NULL on error.
1326  */
1327 struct block *mem2bl(uint8_t * p, int len)
1328 {
1329         ERRSTACK(1);
1330         int n;
1331         struct block *b, *first, **l;
1332
1333         first = NULL;
1334         l = &first;
1335         if (waserror()) {
1336                 freeblist(first);
1337                 nexterror();
1338         }
1339         do {
1340                 n = len;
1341                 if (n > Maxatomic)
1342                         n = Maxatomic;
1343
1344                 *l = b = allocb(n);
1345                 /* TODO consider extra_data */
1346                 memmove(b->wp, p, n);
1347                 b->wp += n;
1348                 p += n;
1349                 len -= n;
1350                 l = &b->next;
1351         } while (len > 0);
1352         poperror();
1353
1354         return first;
1355 }
1356
1357 /*
1358  *  put a block back to the front of the queue
1359  *  called with q ilocked
1360  */
1361 void qputback(struct queue *q, struct block *b)
1362 {
1363         b->next = q->bfirst;
1364         if (q->bfirst == NULL)
1365                 q->blast = b;
1366         q->bfirst = b;
1367         q->len += BALLOC(b);
1368         q->dlen += BLEN(b);
1369 }
1370
1371 /*
1372  *  flow control, get producer going again
1373  *  called with q ilocked
1374  */
1375 static void qwakeup_iunlock(struct queue *q)
1376 {
1377         int dowakeup = 0;
1378
1379         /* if writer flow controlled, restart */
1380         if ((q->state & Qflow) && q->len < q->limit / 2) {
1381                 q->state &= ~Qflow;
1382                 dowakeup = 1;
1383         }
1384
1385         spin_unlock_irqsave(&q->lock);
1386
1387         /* wakeup flow controlled writers */
1388         if (dowakeup) {
1389                 if (q->kick)
1390                         q->kick(q->arg);
1391                 rendez_wakeup(&q->wr);
1392         }
1393 }
1394
1395 /*
1396  *  get next block from a queue (up to a limit)
1397  */
1398 struct block *qbread(struct queue *q, int len)
1399 {
1400         ERRSTACK(1);
1401         struct block *b, *nb;
1402         int n;
1403
1404         qlock(&q->rlock);
1405         if (waserror()) {
1406                 qunlock(&q->rlock);
1407                 nexterror();
1408         }
1409
1410         spin_lock_irqsave(&q->lock);
1411         switch (qwait(q)) {
1412                 case 0:
1413                         /* queue closed */
1414                         spin_unlock_irqsave(&q->lock);
1415                         qunlock(&q->rlock);
1416                         poperror();
1417                         return NULL;
1418                 case -1:
1419                         /* multiple reads on a closed queue */
1420                         spin_unlock_irqsave(&q->lock);
1421                         error(q->err);
1422         }
1423
1424         /* if we get here, there's at least one block in the queue */
1425         b = qremove(q);
1426         n = BLEN(b);
1427
1428         /* split block if it's too big and this is not a message queue */
1429         nb = b;
1430         if (n > len) {
1431                 WARN_EXTRA(b);
1432                 if ((q->state & Qmsg) == 0) {
1433                         n -= len;
1434                         b = allocb(n);
1435                         memmove(b->wp, nb->rp + len, n);
1436                         b->wp += n;
1437                         qputback(q, b);
1438                 }
1439                 nb->wp = nb->rp + len;
1440         }
1441
1442         /* restart producer */
1443         qwakeup_iunlock(q);
1444
1445         poperror();
1446         qunlock(&q->rlock);
1447         return nb;
1448 }
1449
1450 /*
1451  *  read a queue.  if no data is queued, post a struct block
1452  *  and wait on its Rendez.
1453  */
1454 long qread(struct queue *q, void *vp, int len)
1455 {
1456         ERRSTACK(1);
1457         struct block *b, *first, **l;
1458         int m, n;
1459
1460         qlock(&q->rlock);
1461         if (waserror()) {
1462                 qunlock(&q->rlock);
1463                 nexterror();
1464         }
1465
1466         spin_lock_irqsave(&q->lock);
1467 again:
1468         switch (qwait(q)) {
1469                 case 0:
1470                         /* queue closed */
1471                         spin_unlock_irqsave(&q->lock);
1472                         qunlock(&q->rlock);
1473                         poperror();
1474                         return 0;
1475                 case -1:
1476                         /* multiple reads on a closed queue */
1477                         spin_unlock_irqsave(&q->lock);
1478                         error(q->err);
1479         }
1480
1481         /* if we get here, there's at least one block in the queue */
1482         // TODO: Consider removing the Qcoalesce flag and force a coalescing
1483         // strategy by default.
1484         if (q->state & Qcoalesce) {
1485                 /* when coalescing, 0 length blocks just go away */
1486                 b = q->bfirst;
1487                 if (BLEN(b) <= 0) {
1488                         freeb(qremove(q));
1489                         goto again;
1490                 }
1491
1492                 /*  grab the first block plus as many
1493                  *  following blocks as will completely
1494                  *  fit in the read.
1495                  */
1496                 n = 0;
1497                 l = &first;
1498                 m = BLEN(b);
1499                 for (;;) {
1500                         *l = qremove(q);
1501                         l = &b->next;
1502                         n += m;
1503
1504                         b = q->bfirst;
1505                         if (b == NULL)
1506                                 break;
1507                         m = BLEN(b);
1508                         if (n + m > len)
1509                                 break;
1510                 }
1511         } else {
1512                 first = qremove(q);
1513                 n = BLEN(first);
1514         }
1515
1516         /* copy to user space outside of the ilock */
1517         spin_unlock_irqsave(&q->lock);
1518         b = bl2mem(vp, first, len);
1519         spin_lock_irqsave(&q->lock);
1520
1521         /* take care of any left over partial block */
1522         if (b != NULL) {
1523                 n -= BLEN(b);
1524                 if (q->state & Qmsg)
1525                         freeb(b);
1526                 else
1527                         qputback(q, b);
1528         }
1529
1530         /* restart producer */
1531         qwakeup_iunlock(q);
1532
1533         poperror();
1534         qunlock(&q->rlock);
1535         return n;
1536 }
1537
1538 static int qnotfull(void *a)
1539 {
1540         struct queue *q = a;
1541
1542         return q->len < q->limit || (q->state & Qclosed);
1543 }
1544
1545 uint32_t noblockcnt;
1546
1547 /*
1548  *  add a block to a queue obeying flow control
1549  */
1550 long qbwrite(struct queue *q, struct block *b)
1551 {
1552         ERRSTACK(1);
1553         int n, dowakeup;
1554         volatile bool should_free_b = TRUE;
1555
1556         n = BLEN(b);
1557
1558         if (q->bypass) {
1559                 (*q->bypass) (q->arg, b);
1560                 return n;
1561         }
1562
1563         dowakeup = 0;
1564         qlock(&q->wlock);
1565         if (waserror()) {
1566                 if (b != NULL && should_free_b)
1567                         freeb(b);
1568                 qunlock(&q->wlock);
1569                 nexterror();
1570         }
1571
1572         spin_lock_irqsave(&q->lock);
1573
1574         /* give up if the queue is closed */
1575         if (q->state & Qclosed) {
1576                 spin_unlock_irqsave(&q->lock);
1577                 error(q->err);
1578         }
1579
1580         /* if nonblocking, don't queue over the limit */
1581         if (q->len >= q->limit) {
1582                 if (q->noblock) {
1583                         spin_unlock_irqsave(&q->lock);
1584                         freeb(b);
1585                         noblockcnt += n;
1586                         qunlock(&q->wlock);
1587                         poperror();
1588                         return n;
1589                 }
1590         }
1591
1592         /* queue the block */
1593         should_free_b = FALSE;
1594         if (q->bfirst)
1595                 q->blast->next = b;
1596         else
1597                 q->bfirst = b;
1598         q->blast = b;
1599         b->next = 0;
1600         q->len += BALLOC(b);
1601         q->dlen += n;
1602         QDEBUG checkb(b, "qbwrite");
1603         b = NULL;
1604
1605         /* make sure other end gets awakened */
1606         if (q->state & Qstarve) {
1607                 q->state &= ~Qstarve;
1608                 dowakeup = 1;
1609         }
1610         spin_unlock_irqsave(&q->lock);
1611
1612         /*  get output going again */
1613         if (q->kick && (dowakeup || (q->state & Qkick)))
1614                 q->kick(q->arg);
1615
1616         /* wakeup anyone consuming at the other end */
1617         if (dowakeup)
1618                 rendez_wakeup(&q->rr);
1619
1620         /*
1621          *  flow control, wait for queue to get below the limit
1622          *  before allowing the process to continue and queue
1623          *  more.  We do this here so that postnote can only
1624          *  interrupt us after the data has been queued.  This
1625          *  means that things like 9p flushes and ssl messages
1626          *  will not be disrupted by software interrupts.
1627          *
1628          *  Note - this is moderately dangerous since a process
1629          *  that keeps getting interrupted and rewriting will
1630          *  queue infinite crud.
1631          */
1632         for (;;) {
1633                 if (q->noblock || qnotfull(q))
1634                         break;
1635
1636                 spin_lock_irqsave(&q->lock);
1637                 q->state |= Qflow;
1638                 spin_unlock_irqsave(&q->lock);
1639                 rendez_sleep(&q->wr, qnotfull, q);
1640         }
1641
1642         qunlock(&q->wlock);
1643         poperror();
1644         return n;
1645 }
1646
1647 long qibwrite(struct queue *q, struct block *b)
1648 {
1649         int n, dowakeup;
1650
1651         dowakeup = 0;
1652
1653         n = BLEN(b);
1654
1655         spin_lock_irqsave(&q->lock);
1656
1657         QDEBUG checkb(b, "qibwrite");
1658         if (q->bfirst)
1659                 q->blast->next = b;
1660         else
1661                 q->bfirst = b;
1662         q->blast = b;
1663         q->len += BALLOC(b);
1664         q->dlen += n;
1665
1666         if (q->state & Qstarve) {
1667                 q->state &= ~Qstarve;
1668                 dowakeup = 1;
1669         }
1670
1671         spin_unlock_irqsave(&q->lock);
1672
1673         if (dowakeup) {
1674                 if (q->kick)
1675                         q->kick(q->arg);
1676                 rendez_wakeup(&q->rr);
1677         }
1678
1679         return n;
1680 }
1681
1682 /*
1683  *  write to a queue.  only Maxatomic bytes at a time is atomic.
1684  */
1685 int qwrite(struct queue *q, void *vp, int len)
1686 {
1687         int n, sofar;
1688         struct block *b;
1689         uint8_t *p = vp;
1690         void *ext_buf;
1691
1692         QDEBUG if (!islo())
1693                  printd("qwrite hi %p\n", getcallerpc(&q));
1694
1695         sofar = 0;
1696         do {
1697                 n = len - sofar;
1698                 /* This is 64K, the max amount per single block.  Still a good value? */
1699                 if (n > Maxatomic)
1700                         n = Maxatomic;
1701
1702                 /* If n is small, we don't need to bother with the extra_data.  But
1703                  * until the whole stack can handle extd blocks, we'll use them
1704                  * unconditionally. */
1705 #ifdef CONFIG_BLOCK_EXTRAS
1706                 /* allocb builds in 128 bytes of header space to all blocks, but this is
1707                  * only available via padblock (to the left).  we also need some space
1708                  * for pullupblock for some basic headers (like icmp) that get written
1709                  * in directly */
1710                 b = allocb(64);
1711                 ext_buf = kmalloc(n, 0);
1712                 memcpy(ext_buf, p + sofar, n);
1713                 block_add_extd(b, 1, KMALLOC_WAIT); /* returns 0 on success */
1714                 b->extra_data[0].base = (uintptr_t)ext_buf;
1715                 b->extra_data[0].off = 0;
1716                 b->extra_data[0].len = n;
1717                 b->extra_len += n;
1718 #else
1719                 b = allocb(n);
1720                 memmove(b->wp, p + sofar, n);
1721                 b->wp += n;
1722 #endif
1723                         
1724                 qbwrite(q, b);
1725
1726                 sofar += n;
1727         } while (sofar < len && (q->state & Qmsg) == 0);
1728
1729         return len;
1730 }
1731
1732 /*
1733  *  used by print() to write to a queue.  Since we may be splhi or not in
1734  *  a process, don't qlock.
1735  */
1736 int qiwrite(struct queue *q, void *vp, int len)
1737 {
1738         int n, sofar, dowakeup;
1739         struct block *b;
1740         uint8_t *p = vp;
1741
1742         dowakeup = 0;
1743
1744         sofar = 0;
1745         do {
1746                 n = len - sofar;
1747                 if (n > Maxatomic)
1748                         n = Maxatomic;
1749
1750                 b = iallocb(n);
1751                 if (b == NULL)
1752                         break;
1753                 /* TODO consider extra_data */
1754                 memmove(b->wp, p + sofar, n);
1755                 /* this adjusts BLEN to be n, or at least it should */
1756                 b->wp += n;
1757                 assert(n == BLEN(b));
1758                 qibwrite(q, b);
1759
1760                 sofar += n;
1761         } while (sofar < len && (q->state & Qmsg) == 0);
1762
1763         return sofar;
1764 }
1765
1766 /*
1767  *  be extremely careful when calling this,
1768  *  as there is no reference accounting
1769  */
1770 void qfree(struct queue *q)
1771 {
1772         qclose(q);
1773         kfree(q);
1774 }
1775
1776 /*
1777  *  Mark a queue as closed.  No further IO is permitted.
1778  *  All blocks are released.
1779  */
1780 void qclose(struct queue *q)
1781 {
1782         struct block *bfirst;
1783
1784         if (q == NULL)
1785                 return;
1786
1787         /* mark it */
1788         spin_lock_irqsave(&q->lock);
1789         q->state |= Qclosed;
1790         q->state &= ~(Qflow | Qstarve);
1791         strncpy(q->err, Ehungup, sizeof(q->err));
1792         bfirst = q->bfirst;
1793         q->bfirst = 0;
1794         q->len = 0;
1795         q->dlen = 0;
1796         q->noblock = 0;
1797         spin_unlock_irqsave(&q->lock);
1798
1799         /* free queued blocks */
1800         freeblist(bfirst);
1801
1802         /* wake up readers/writers */
1803         rendez_wakeup(&q->rr);
1804         rendez_wakeup(&q->wr);
1805 }
1806
1807 /*
1808  *  Mark a queue as closed.  Wakeup any readers.  Don't remove queued
1809  *  blocks.
1810  */
1811 void qhangup(struct queue *q, char *msg)
1812 {
1813         /* mark it */
1814         spin_lock_irqsave(&q->lock);
1815         q->state |= Qclosed;
1816         if (msg == 0 || *msg == 0)
1817                 strncpy(q->err, Ehungup, sizeof(q->err));
1818         else
1819                 strncpy(q->err, msg, ERRMAX - 1);
1820         spin_unlock_irqsave(&q->lock);
1821
1822         /* wake up readers/writers */
1823         rendez_wakeup(&q->rr);
1824         rendez_wakeup(&q->wr);
1825 }
1826
1827 /*
1828  *  return non-zero if the q is hungup
1829  */
1830 int qisclosed(struct queue *q)
1831 {
1832         return q->state & Qclosed;
1833 }
1834
1835 /*
1836  *  mark a queue as no longer hung up
1837  */
1838 void qreopen(struct queue *q)
1839 {
1840         spin_lock_irqsave(&q->lock);
1841         q->state &= ~Qclosed;
1842         q->state |= Qstarve;
1843         q->eof = 0;
1844         q->limit = q->inilim;
1845         spin_unlock_irqsave(&q->lock);
1846 }
1847
1848 /*
1849  *  return bytes queued
1850  */
1851 int qlen(struct queue *q)
1852 {
1853         return q->dlen;
1854 }
1855
1856 /*
1857  * return space remaining before flow control
1858  */
1859 int qwindow(struct queue *q)
1860 {
1861         int l;
1862
1863         l = q->limit - q->len;
1864         if (l < 0)
1865                 l = 0;
1866         return l;
1867 }
1868
1869 /*
1870  *  return true if we can read without blocking
1871  */
1872 int qcanread(struct queue *q)
1873 {
1874         return q->bfirst != 0;
1875 }
1876
1877 /*
1878  *  change queue limit
1879  */
1880 void qsetlimit(struct queue *q, int limit)
1881 {
1882         q->limit = limit;
1883 }
1884
1885 /*
1886  *  set blocking/nonblocking
1887  */
1888 void qnoblock(struct queue *q, int onoff)
1889 {
1890         q->noblock = onoff;
1891 }
1892
1893 /*
1894  *  flush the output queue
1895  */
1896 void qflush(struct queue *q)
1897 {
1898         struct block *bfirst;
1899
1900         /* mark it */
1901         spin_lock_irqsave(&q->lock);
1902         bfirst = q->bfirst;
1903         q->bfirst = 0;
1904         q->len = 0;
1905         q->dlen = 0;
1906         spin_unlock_irqsave(&q->lock);
1907
1908         /* free queued blocks */
1909         freeblist(bfirst);
1910
1911         /* wake up readers/writers */
1912         rendez_wakeup(&q->wr);
1913 }
1914
1915 int qfull(struct queue *q)
1916 {
1917         return q->state & Qflow;
1918 }
1919
1920 int qstate(struct queue *q)
1921 {
1922         return q->state;
1923 }
1924
1925 void qdump(struct queue *q)
1926 {
1927         if (q)
1928                 printk("q=%p bfirst=%p blast=%p len=%d dlen=%d limit=%d state=#%x\n",
1929                            q, q->bfirst, q->blast, q->len, q->dlen, q->limit, q->state);
1930 }