lockinit(9)

lockinit, lockdestroy, lockcount, lockmgr, lockstatus, lockmgr_printinfo − lockmgr ファミリの関数

#include <sys/types.h>
#include <sys/lockmgr.h>

void

lockinit(struct lock *lkp, int prio, const char *wmesg, int timo, int flags);

void

lockdestroy(struct lock *lkp);

int

lockcount(struct lock *lkp);

int

lockmgr(struct lock *lkp, u_int flags, struct mtx *interlkp, struct thread *td);

int

lockstatus(struct lock *lkp, struct thread *td);

void

lockmgr_printinfo(struct lock *lkp);

解説

lockinit() 関数はロックを初期化するために使用されます。これはロックに関す る実行されることが可能なあらゆる操作の前に、呼び出されなければなりませ ん。引数は以下の通りです。

初期化されるべきロックへのポインタです。

prio
msleep(9) に渡される優先度です。

wmesg
ロックのメッセージです。これはデバッグ出力と msleep(9) の両方のた めに使用されます。

timo
msleep(9) に渡されるタイムアウト値です。

flags
ロックを初期化するために使用されるべきフラグです。

LK_NOWAIT
ロックを獲得するとき、スリープしません。

LK_SLEEPFAIL
スリープした後に失敗します。

LK_CANRECURSE
再帰的な排他ロックを許可します。

LK_REENABLE
ロックをドレインした後、そのロックを再度有効化しま す。

LK_NOPAUSE
ロックを獲得するとき、スピンロックを使用しません。

LK_TIMELOCK
スリープしている間 timo を使用します。そうでなけれ ば 0 が使用されます。

lockdestroy() 関数はロックを破壊するために使用され、カーネル内のいくつか の場所で呼び出されますが、現在は何もしません。

lockcount() 関数はロック lkp に対する排他ロックと共有ロックのカウント数を 返します。

lockmgr() 関数は共有ロックと排他ロックおよび再帰のサポートを含む、カーネ ル内部の一般的なロック機能を取り扱います。 lockmgr() はロックのアップグ レードとダウングレードも可能です。

引数は以下の通りです。

lkp
操作するべきロックへのポインタです。

flags
行なわれるべき操作を示しているフラグです。

LK_SHARED
共有ロックを獲得します。現在排他ロックが保持さ れている場合には、ダウングレードされます。

LK_EXCLUSIVE
排他ロックを獲得します。既に排他ロックが保持さ れていて、 LK_CANRECURSE が設定されていない場合 には、システムは panic(9) します。

LK_DOWNGRADE
排他ロックから共有ロックにダウングレードしま す。共有ロックのダウングレードは許可されていま せん。排他ロックが既に再帰している場合には、全 ての参照がダウングレードされます。

LK_EXCLUPGRADE
共有ロックから排他ロックにアップグレードしま す。他の誰かが先にアップグレードを待っている最 中の場合には、 EBUSY で失敗します。この呼び出し が失敗した場合には、その共有ロックは失われま す。排他ロックのアップグレードの試みは panic(9) を引き起こします。

LK_UPGRADE
共有ロックから排他ロックにアップグレードしま す。この呼び出しが失敗した場合には、その共有 ロックは失われます。排他ロックのアップグレード の試みは panic(9) を引き起こします。

LK_RELEASE
ロックを解放します。保持していないロックの解放 は、 panic(9) を引き起こすことがあります。

LK_DRAIN
ロック上の全ての行動の終了を待ち、それから役割 を終えた印を付けます。今にも解放されようとして いるメモリの一部分のロックを解放する前に使用さ れます。 (<sys/lockmgr.h> に解説されています。)

LK_SLEEPFAIL
操作がスリープした場合には、失敗します。

LK_NOWAIT
この呼び出しがスリープすることを認めません。こ れはロックをテストするために使用することが可能 です。

LK_CANRECURSE
排他ロック上の再帰を認めます。それぞれのロック に対し、解放が存在しなければなりません。

LK_INTERLOCK
(既にロックされているべき) 相互ロックをロック解 除します。

interlkp
ロックへのグループアクセスを制御するための相互ロック mutex で す。 LK_INTERLOCK が指定された場合には、 lockmgr() は interlkp は現在所有されていて再帰していないと仮定し、ロック解除されて返 します。 mtx_assert(9) を参照してください。

td
この呼び出しに責任があるレッドです。 NULL は LK_KERNPROC になり ます。

lockstatus() 関数は渡された thread に関するロックの状態を返します。 td が NULL で排他ロックが保持されている場合には、 LK_EXCLUSIVE が返されます。

lockmgr_printinfo() 関数はロックについてのデバッグ情報を出力します。これ は主に VOP_PRINT(9) 関数によって使用されます。

戻り値

lockcount() 関数は 0 以上の整数を返します。

lockmgr() 関数は成功時には 0 を、失敗時には 0 ではない値を返します。

lockstatus() 関数は以下の値を返します。

スレッド td によって排他ロックが保持されています。

LK_EXCLOTHER
スレッド td ではない他の誰かによって排他ロックが保持されて います。

LK_SHARED
共有ロックが保持されています。

0
だれもロックを保持していません。

エラー

lockmgr() は次の場合に失敗します。

LK_FORCEUPGRADE が要求されて、ほかのスレッドが既にロッ クのアップグレードを要求しています。

[EBUSY]
LK_NOWAIT が設定されて、スリープが要求されていました。

[ENOLCK]
LK_SLEEPFAIL が設定されて、 lockmgr() は既にスリープし ました。

[EINTR]
ロックの優先度に PCATCH が設定されて、スリープしている 間にシグナルが配送されました。下記の ERESTART エラーに 注意してください。

[ERESTART]
ロックの優先度に PCATCH が設定されて、スリープしている 間にシグナルが配送され、システムコールが再スタートされ ました。

[EWOULDBLOCK]
0 でないタイムアウトが与えられ、そのタイムアウトが満了 しました。

ロック

lockmgr() への flags 引数に LK_INTERLOCK が渡された場合には、 interlkp は lockmgr() を呼び出すために以前に保持されていなければならず、ロック解除さ れて返されます。

失敗するアップグレードの試みは、現在保持しているロックを失わせる結果にな ります。また、排他ロックのアップグレードは無効で、試行の結果として panic(9) を引き起こします。

msleep(9), mtx_assert(9), panic(9), VOP_PRINT(9)

このマニュアルページは Chad David ⟨davidc@acns.ab.ca⟩ が書きました。

FreeBSD 10.0 July 9, 2001 FreeBSD 10.0