mbuf 割り付けマクロ

MGETHDR( struct mbuf *mbuf, int how, short type);

MCLGET( struct mbuf *mbuf, int how);

MEXTADD( struct mbuf *mbuf, caddr_t buf, u_int size, void (*free)(void *opt_arg1, void *opt_arg2), void *opt_arg1, void *opt_arg2, short flags, int type);

MEXTFREE( struct mbuf *mbuf);

MFREE( struct mbuf *mbuf, struct mbuf *successor);

mbuf ユーティリティマクロ

M_ALIGN( struct mbuf *mbuf, u_int len);

MH_ALIGN( struct mbuf *mbuf, u_int len);

int
M_LEADINGSPACE( struct mbuf *mbuf);

int
M_TRAILINGSPACE( struct mbuf *mbuf);

M_MOVE_PKTHDR( struct mbuf *to, struct mbuf *from);

M_PREPEND( struct mbuf *mbuf, int len, int how);

MCHTYPE( struct mbuf *mbuf, u_int type);

int
M_WRITABLE( struct mbuf *mbuf);

mbuf 割り付け関数

struct mbuf *
m_getm( struct mbuf *orig, int len, int how, int type);

struct mbuf *
m_getcl( int how, short type, int flags);

struct mbuf *
m_getclr( int how, int type);

struct mbuf *
m_gethdr( int how, int type);

struct mbuf *
m_free( struct mbuf *mbuf);

void
m_freem( struct mbuf *mbuf);

mbuf ユーティリティ関数

void
m_align( struct mbuf *mbuf, int len);

int
m_append( struct mbuf *mbuf, int len, c_caddr_t cp);

struct mbuf *
m_prepend( struct mbuf *mbuf, int len, int how);

struct mbuf *
m_copyup( struct mbuf *mbuf, int len, int dstoff);

struct mbuf *
m_pullup( struct mbuf *mbuf, int len);

struct mbuf *
m_pulldown( struct mbuf *mbuf, int offset, int len, int *offsetp);

struct mbuf *
m_copym( struct mbuf *mbuf, int offset, int len, int how);

struct mbuf *
m_copypacket( struct mbuf *mbuf, int how);

struct mbuf *
m_dup( struct mbuf *mbuf, int how);

void
m_copydata( const struct mbuf *mbuf, int offset, int len, caddr_t buf);

void
m_copyback( struct mbuf *mbuf, int offset, int len, caddr_t buf);

struct mbuf *
m_devget( char *buf, int len, int offset, struct ifnet *ifp, void (*copy)(char *from, caddr_t to, u_int len));

void
m_cat( struct mbuf *m, struct mbuf *n);

u_int
m_fixhdr( struct mbuf *mbuf);

void
m_dup_pkthdr( struct mbuf *to, struct mbuf *from);

void
m_move_pkthdr( struct mbuf *to, struct mbuf *from);

u_int
m_length( struct mbuf *mbuf, struct mbuf **last);

struct mbuf *
m_split( struct mbuf *mbuf, int len, int how);

int
m_apply( struct mbuf *mbuf, int off, int len, int (*f)(void *arg, void *data, u_int len), void *arg);

struct mbuf *
m_getptr( struct mbuf *mbuf, int loc, int *off);

struct mbuf *
m_defrag( struct mbuf *m0, int how);

struct mbuf *
m_unshare( struct mbuf *m0, int how);

マクロと関数

mtod( mbuf, type)

mbuf ポインタをデータポインタに変換します。マクロは、指定された type のポインタへのデータポインタのキャスト (cast) に展開します。 注: mbuf に連続したデータが十分あることを保証することは、賢明です。詳細については、 m_pullup() 参照。

MGET( mbuf, how, type)

mbuf を割り付けて、内部のデータを含むように、それを初期化します。 mbuf は、成功すれば、割り付けられた mbuf を指すか、または失敗すれば NULL に設定されます。 how 引数は、 M_WAITOK または M_NOWAIT に設定されます。それは、必要なら、呼び出し側がブロックすることを望んでいるかどうか指定します。 mbuf に関連する多くの他の関数とマクロは、それらが、ある時点で新しい mbuf を割り付ける必要があるので、同じ引数を持っています。

歴史的に mbuf アロケータ ( 歴史 セクションを参照) は、割り付けフラグ M_WAIT と M_DONTWAIT を使用していました。これらの定数は、互換性のために保持されていますが、新しいコードでそれらを使用することは、お勧めできません。

MGETHDR( mbuf, how, type)

mbuf を割り付けて、パケットヘッダと内部のデータを含むように、それを初期化します。詳細については、 MGET() 参照。

MEXTADD( mbuf, buf, size, free, opt_arg1, opt_arg2, flags, type)

外部的に管理されたデータを mbuf に関連付けます。 mbuf 中に含まれるあらゆる内部のデータは、捨てられ、 M_EXT フラグが設定されます。 buf と size 引数は、それぞれデータのアドレスと長さです。 free 引数は、mbuf が解放されるとき、データを解放するために呼び出される関数を指します。それは、 type が EXT_EXTREF である場合にだけ使用されます。 opt_arg1 と opt_arg2 引数は、 free (解放) するために変更されずに渡されます。 flags 引数は、追加の mbuf フラグを指定します。 M_EXT を指定する必要はありません。最終に、 type 引数は、 mbuf が解放されるとき、それがどのように処理されるかを制御する、外部データのタイプを指定します。ほとんどの場合、正しい値は、 EXT_EXTREF です。

MCLGET( mbuf, how)

mbuf cluster を mbuf に割り付けて、アタッチします。マクロが失敗するなら、 M_EXT フラグは、 mbuf に設定されないでしょう。

M_ALIGN( mbuf, len)

ポインタ mbuf->m_data をロングワードに整列された mbuf の内部のデータ領域の終わりに、サイズ len のオブジェクトを置くように設定します。 mbuf が MGET() または m_get() で新しく割り付けられる場合のみ、適切です。

MH_ALIGN( mbuf, len)

M_ALIGN() が行うのと同じ目的で役立ちますが、 MGETHDR() または m_gethdr() で新しく割り付けられた mbuf のためだけか、または m_dup_pkthdr() または m_move_pkthdr() によって初期化します。

m_align( mbuf, len)

M_ALIGN() と同じ用途を提供しますが、mbuf のどんなタイプも取り扱います。

M_LEADINGSPACE( mbuf)

mbuf のデータの始まりの前の利用可能なバイト数を返します。

M_TRAILINGSPACE( mbuf)

mbuf のデータの終わり以降の利用可能なバイト数を返します。

M_PREPEND( mbuf, len, how)

このマクロは、 mbuf chain で動作します。それは、(例えば、リンクレイヤヘッダの整備の後に残る) データの前の可能な空き空間を利用することができるように m_prepend() のための最適化されたラッパです。新しい mbuf chain のポインタまたは NULL は、呼び出しの後に mbuf にあります。

M_MOVE_PKTHDR( to, from)

このマクロを使用することは、 m_move_pkthdr( to, from) を呼び出すことと同等です。

M_WRITABLE( mbuf)

このマクロは、 mbuf が M_RDONLY であるとマークされないなら、そして mbuf が外部記憶を含んでいないなら、または、そうするなら、記憶域の参照カウントが 1 より大きくないなら、真と評価します。 M_RDONLY フラグは、 mbuf->m_flags に設定することができます。これは、外部記憶のセットアップの間に、 flags 引数として M_RDONLY ビットを MEXTADD() マクロに渡すことによって達成することができるか、または個々の mbuf に直接設定することができます。

MCHTYPE( mbuf, type)

mbuf のタイプを type に変更します。これは、比較的高価な操作であり、避けられるべきです。

関数は、次の通りです:

m_get( how, type)

ノン-クリティカルパスのための MGET() の関数バージョン。

m_getm( orig, len, how, type)

必要なら、 mbuf と mbuf cluster に値する len バイトを割り付けて、そして、 mbuf chain を mbuf chain orig (それが NULL でないなら) に割り付けられた結果を追加します。割り付けがいずれかの点で失敗するなら、割り付けられたものなら何でも解放して、 NULL を返します。 orig が NULL でないなら、それは、解放されません。 len バイトを既存の mbuf または mbuf chain (例えば、前もって割り付けられたリングに位置しているかもしれないもの) に追加するか、または単に mbuf と mbuf cluster 割り付けをいちかばちか実行するために、 m_getm() を使用することは可能です。

m_gethdr( how, type)

ノン-クリティカルパスのための MGETHDR() の関数バージョン。

m_getcl( how, type, flags)

それにアタッチする mbuf cluster で mbuf を取って来ます。割り付けの 1 つが失敗するなら、全体の割り付けは失敗します。このルーチンは、割り付けの間のアンロック/再ロックすることを避けるように、 mbuf と mbuf cluster を一緒に両方取って来る好ましい方法です。失敗すれば NULL を返します。

m_getclr( how, type)

mbuf を割り付けて、データ領域を 0 クリアします。

m_free( mbuf)

mbuf を解放します。解放された mbuf の m_next を返します。

下記の関数は、 mbuf chains で動作します。

m_freem( mbuf)

任意の外部記憶も含めて全体の mbuf chain を解放します。

m_adj( mbuf, len)

len が正の値なら、 mbuf chain の先頭から len バイトを取り除き、そうでなければ、末尾から取り除きます。

m_append( mbuf, len, cp)

データ cp の len バイトを mbuf chain に追加します。新しいデータが既存の空間に適合しないなら、mbuf chain を拡張します。

m_prepend( mbuf, len, how)

新しい mbuf を割り付けて、適切に M_PKTHDR を取り扱う mbuf chain の先頭にそれを追加します。 注: M_PKTHDR フラグの設定によって、 len が MLEN または MHLEN 未満でなければならないので、任意の mbuf cluster を割り付けできません。

m_copyup( mbuf, len, dstoff)

m_pullup() と同様ですが、データの len バイトを新しい mbuf の dstoff バイトの位置にコピーします。 dstoff 引数は、データを整列し、リンクレイヤヘッダに空きを残します。成功すれば新しい mbuf chain を返し、失敗すれば mbuf chain を解放して NULL を返します。 注意: 関数が mbuf cluster を割り付けないので、 len + dstoff は、 MHLEN 未満でなければなりません。

m_pullup( mbuf, len)

mbuf chain の最初の len バイトは、連続しており、 mbuf のデータ領域に置かれ、したがって、それらは、 mtod( mbuf, type) でアクセス可能であるように調整します。いくらかの mbuf を再割り付けし、データの移動を必要とするかもしれないことを覚えていることは、重要であるので、古い mbuf チェーンの中でデータを参照するすべてのポインタが再計算しなければならないか、または無効にしなければなりません。成功すれば、新しい mbuf chain を返し、失敗すれば、 NULL を返します (この場合、 mbuf chain は、解放されます)。 注: len は、 MHLEN 以下でなければならないので、任意の mbuf cluster を割り付けることができません。

m_pulldown( mbuf, offset, len, offsetp)

mbuf chain の offset と offset + len の間の len バイトの調整は、 mbuf のデータ領域に連続して置かれているので、それらは、 mtod( mbuf, type) でアクセスしやすくなります。 len は、 mbuf cluster のサイズ以下でなければなりません。要求された領域を含むチェーンの中間の mbuf へのポインタを返します。返された mbuf に含まれるデータへの mbuf chain のデータ領域のオフセットは、 *offsetp に格納されます。 offp が NULL であるなら、領域は、 mtod( mbuf, type) を使用してアクセスされます。 offp が NULL でなければ、領域は、 mtod( mbuf, uint8_t, +, *offsetp) を使用してアクセスされます。始めと off の間の mbuf チェーンの領域は、変更されていません、したがって、 m_pulldown() を呼び出す前にこの領域中でデータへのポインタを保持することは安全です。

m_copym( mbuf, offset, len, how)

始めの offset バイトから始まり、 len バイトが続く mbuf chain コピーを行います。 len が M_COPYALL であるなら、 mbuf chain の端までコピーします。 注: mbuf cluster がコピーされないので、コピーは、読み込み専用です、それらの参照カウントだけが増加されます。

m_copypacket( mbuf, how)

存在しなければならないヘッダを含む全体のパケットをコピーします。これは、よくある例 m_copym( mbuf, 0, M_COPYALL, how) の最適化されたバージョンです。 注: mbuf cluster がコピーされないので、コピーは、読み込み専用です、それらの参照カウントだけが増加されます。

m_dup( mbuf, how)

任意の mbuf cluster のコピーを含むまったく新しい mbuf chain にパケットヘッダ mbuf chain をコピーします。 mbuf chain の書き込み可能なコピーを必要とするとき、 m_copypacket() の代わりにこれを使用します。

m_copydata( mbuf, offset, len, buf)

始めから off バイトで始まる mbuf chain から、 len バイトを含んで、データを、指示されたバッファ buf にコピーします。

m_copyback( mbuf, offset, len, buf)

バッファ buf から mbuf chain の始めから offset で始まる、指示された mbuf chain に len バイトを、必要なら、 mbuf chain を拡張して、コピーし戻します。 注: 任意の mbuf cluster を割り付けません、ただ、 mbuf を mbuf chain に追加します。現在の mbuf chain の終りを越えて offset を設定することは安全です: 0 クリアされた mbuf が空間を満たすために割り付けられます。

m_length( mbuf, last)

mbuf chain の長さと、オプションで最終の mbuf へのポインタを返します。

m_dup_pkthdr( to, from, how)

関数の完了したときに、 mbuf to は、 from->m_pkthdr の同一の複製物と mbuf chain from で見つかる 1 パケット毎の属性を含みます。 mbuf from は、最初に設定されたフラグ M_PKTHDR がなければなりません、そして、 to は、入力時には空でなければなりません。

m_move_pkthdr( to, from)

m_pkthdr と mbuf chain from からのパケット毎の属性を mbuf to に移動します。 mbuf from は、最初に設定されたフラグ M_PKTHDR がなければなりません、そして、 to は、入力時には、空でなければなりません。関数の完了したときに、 from は、フラグ M_PKTHDR とクリアされたパケット毎の属性を持ちます。

m_fixhdr( mbuf)

パケットヘッダ長を mbuf chain の長さに設定します。

m_devget( buf, len, offset, ifp, copy)

buf によって指されたデバイスのローカルメモリからのデータを mbuf chain にコピーします。コピーは、指定されたコピールーチン copy か、または copy が NULL であるなら、 bcopy() を使用して行われます。

m_cat( m, n)

n を m に連結します。両方の mbuf chains は、同じタイプでなければなりません。関数が戻った後でも N は、有効です。 注: それは、 M_PKTHDR とフレンドを取り扱いません。

m_split( mbuf, len, how)

mbuf chain を 2 つの部分に分離して末尾を返します: 最初の len バイトのほかはすべて。失敗の場合には、それは、 NULL を返して、 mbuf chain を元の状態に復元することを試みます。

m_apply( mbuf, off, len, f, arg)

オフセット off で長さ len バイトの mbuf chain に関数を適用します。そうでなければ不要であるか、または望ましくない m_pullup() への呼び出しを避けるために通常使用されます。 arg は、コールバック関数 f に渡される便利な引数です。

f() が呼び出されるたびに、 arg、現在の mbuf の data へのポインタ、と関数が適用されるべきであるこの mbuf のデータの長さ len が渡されます。

関数は、成功を示すために 0 を返すべきです。そうでなければ、エラーが示されるなら、 m_apply() は、エラーを返し、 mbuf chain を通して繰り返すのを停止します。

m_getptr( mbuf, loc, off)

ポインタを mbuf chain の始まりから loc バイトに位置するデータを含む mbuf へのポインタを返します。 mbuf への対応するオフセットは、 *off に格納されます。

m_defrag( m0, how)

mbuf chain の断片化を解消して、mbuf とクラスタの最も短い可能なチェーンを返します。割り付けが失敗して、これを完了することができないなら、 NULL が返され、元のチェーンは、変更されません。成功すれば、元のチェーンは、解放され、新しいチェーンが返されます。呼び出し側の好みによって、 how は、 M_WAITOK または M_NOWAIT のいずれかであるべきです。

特定の長い mbuf chains が TX 記述子リストに追加される前に、短縮されなければならないところで、この関数は、ネットワークドライバで特に役に立ちます。

m_unshare( m0, how)

他のユーザに影響しないで内容を安全に変更することができる指定された mbuf チェーンのバージョンを作成します。割り付けが失敗して、この操作が完了することができないなら、 NULL が返されます。オリジナルの mbuf チェーンは、常に再要求され、任意の共有された mbuf クラスタの参照カウントは、減少されます。呼び出し側の選択によって、 how は、 M_WAITOK または M_NOWAIT のいずれかであるべきです。このプロセスの副作用として、返された mbuf チェーンは、圧縮されます。

この関数は、データを暗号化するか、またはそうでなければ転送する前に変更されなければならないとき、ネットワークコードの転送パスで特に役に立ちます。