テキストの59〜60ページ

本文

この章の最初のほうで扱ったシンプルなキューは、まるでおもちゃである。
しかし、xv6は読み込みと書き込みを同期化するためにsleepとwakeupを使うような本物のキューを2つ含む。
ひとつはIDEドライバで使われる。
プロセスはディスクへのリクエストをキューへ追加し、そしてsleepを呼ぶ。
割り込みハンドラはwakeupを使って、そのプロセスにそのリクエストが完了したことを通知する。

より複雑な実例としては、パイプの実装である。
我々は第0章でパイプのインターフェイスを見た。
パイプの一端に書きこまれたデータは、カーネルのバッファにコピーされ、そして他の一端から読み込めるようになる。
先の章では、パイプを取り巻くファイルシステムのサポートについて説明する。
しかし今は、pipewriteとpipereadの実装について見ていこう。

パイプはすべて、pipe構造体として表現される。
その構造体は、lockとバッファのためのdataというフィールドを含む。
nreadとnwriteというフィールドは、それぞれそのバッファから何バイト読み込んだか、何バイト書き込んだかを表す。
バッファは循環するようになっていて、buf[PIPESIZE-1]の後に書きこまれる次のバイトはbuf[0]である。
しかしnread、nwriteは循環しない。
この決まりごとは、バッファがいっぱいな状態（nwrite == nread+PIPESIZE）と、バッファが空である状態（nwrite == nread）の識別を可能にする。
しかしそれは、バッファのデータを参照するときに、単純にbuf[nread]とするのではなく、buf[nread % PIPESIZE]としなければならないということを意味する。（nwriteの場合も同じである）
2つの別のCPU上でpipereadとpipewriteが同時に呼び出されると仮定しよう。

pipe.c

#include "types.h"
#include "defs.h"
#include "param.h"
#include "mmu.h"
#include "proc.h"
#include "fs.h"
#include "file.h"
#include "spinlock.h"

#define PIPESIZE 512

struct pipe {
  struct spinlock lock;
  char data[PIPESIZE];
  uint nread;     // number of bytes read
  uint nwrite;    // number of bytes written
  int readopen;   // read fd is still open
  int writeopen;  // write fd is still open
};

int
pipealloc(struct file **f0, struct file **f1)
{
  struct pipe *p;

  p = 0;
  *f0 = *f1 = 0;
  if((*f0 = filealloc()) == 0 || (*f1 = filealloc()) == 0)
    goto bad;
  if((p = (struct pipe*)kalloc()) == 0)
    goto bad;
  p->readopen = 1;
  p->writeopen = 1;
  p->nwrite = 0;
  p->nread = 0;
  initlock(&p->lock, "pipe");
  (*f0)->type = FD_PIPE;
  (*f0)->readable = 1;
  (*f0)->writable = 0;
  (*f0)->pipe = p;
  (*f1)->type = FD_PIPE;
  (*f1)->readable = 0;
  (*f1)->writable = 1;
  (*f1)->pipe = p;
  return 0;

//PAGEBREAK: 20
 bad:
  if(p)
    kfree((char*)p);
  if(*f0)
    fileclose(*f0);
  if(*f1)
    fileclose(*f1);
  return -1;
}

void
pipeclose(struct pipe *p, int writable)
{
  acquire(&p->lock);
  if(writable){
    p->writeopen = 0;
    wakeup(&p->nread);
  } else {
    p->readopen = 0;
    wakeup(&p->nwrite);
  }
  if(p->readopen == 0 && p->writeopen == 0){
    release(&p->lock);
    kfree((char*)p);
  } else
    release(&p->lock);
}

//PAGEBREAK: 40
int
pipewrite(struct pipe *p, char *addr, int n)
{
  int i;

  acquire(&p->lock);
  for(i = 0; i < n; i++){
    while(p->nwrite == p->nread + PIPESIZE){  //DOC: pipewrite-full
      if(p->readopen == 0 || proc->killed){
        release(&p->lock);
        return -1;
      }
      wakeup(&p->nread);
      sleep(&p->nwrite, &p->lock);  //DOC: pipewrite-sleep
    }
    p->data[p->nwrite++ % PIPESIZE] = addr[i];
  }
  wakeup(&p->nread);  //DOC: pipewrite-wakeup1
  release(&p->lock);
  return n;
}

int
piperead(struct pipe *p, char *addr, int n)
{
  int i;

  acquire(&p->lock);
  while(p->nread == p->nwrite && p->writeopen){  //DOC: pipe-empty
    if(proc->killed){
      release(&p->lock);
      return -1;
    }
    sleep(&p->nread, &p->lock); //DOC: piperead-sleep
  }
  for(i = 0; i < n; i++){  //DOC: piperead-copy
    if(p->nread == p->nwrite)
      break;
    addr[i] = p->data[p->nread++ % PIPESIZE];
  }
  wakeup(&p->nwrite);  //DOC: piperead-wakeup
  release(&p->lock);
  return i;
}

pipewriteは、まずパイプのロックを獲得することから始める。
そのロックは、読み書きバイト数、データ、そしてそれらに関係するインバリアントを保護する。
pipereadも、まずロックの獲得を試みるが、不可能である。（今はpipewriteとpipereadを同時に実行してると仮定してるので）
こちらはロックが解放されるまでacquireのところで止まったままになる。
pipereadが待ってる間、pipewriteは渡されたデータをループで1バイト毎（addr[0], addr[1], …, addr[n-1]）に処理し、それぞれpipeに追加する。
このループ中でバッファがいっぱいになる可能性がある。
この場合pipewriteは、データが準備できたという事をスリープ中の読み込み側に伝えるためにwakeupを呼び、そして、読み込み側がバッファからいくらかデータを取り出すのを待つために、&p->nwriteというチャンネルでスリープする。
sleepによって、このpipewriteを実行しているプロセスをスリープさせる処理の一環としてp->lockが解放される。

そしたらp->lockが獲得可能となるので、pipereadはそのロックを獲得し処理を開始する。
pipereadは、p->nread != p->nwriteであることに気づき（pipewriteがスリープしたのはp->nwrite == p->nread+PIPESIZEになったからである）、最初のwhileループをスキップする。
それからpipereadは、パイプからデータをコピーし、nreadをコピーしたバイト数の分だけインクリメントする。
これでパイプにまた書き込めるようになったので、pipereadは呼び出し側に戻る前に、wakeupを呼び、スリープ中の書き込み側を起こす。
wakeupは、&p->nwriteというチャンネルでスリープ中のプロセスを探す。
そのプロセスは、pipewriteを実行中だったがバッファがいっぱいになったので止まってたプロセスである。
wakeupはそのプロセスをRUNNABLEとしてマークする。

パイプのコードは、読み込み側と書き込み側で別のスリープチャンネル（p->nreadとp->nwrite）を使う。
このことによって、（あまりありそうではないが）多くの読み込み手と書き込み手が同じパイプを待つような場合により効率的になる。
パイプのコードは、スリープする条件のチェックを行うループの内側でsleepを呼ぶ。
複数の読み手や書き手がある場合、最初のプロセスを除いてすべて起こされるが、まだ条件が偽であるので再度スリープする。

感想

パイプの実装についてです。
acquire/relese、sleep/wakeupを使ってるので、背景まで含めると結構複雑なコードだと思いますが、今まで学んだ分のおかげですんなり読めました。

そういう背景を除けば、このコードのキモはpipe構造体のdataフィールドのみ循環利用される事かなと思います。
書き込みと読み込みは必ず交互に実行されるわけではなく、また読み込みバイト数が書き込みバイト数を下回る可能性もあるということを考えると、循環以外の考え方はちょっと現実的じゃない気がします。

最後の方にも書かれてますが、sleepはその条件をチェックするループの内側で呼べという決まりごとがここでも守られてます。
なぜそうすべきか？ってのは、一言で言えば「起こされたときにまだ条件が整ってなければまたsleepすべきだから」ってところですかね。