日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
SCTP(4) FreeBSD カーネルインタフェースマニュアル SCTP(4)
名称
sctp -- インターネットストリーム制御転送プロトコル
書式
options SCTP
options SCTP_SUPPORT
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/sctp.h>
int
socket(AF_INET, SOCK_STREAM, IPPROTO_SCTP);
int
socket(AF_INET, SOCK_SEQPACKET, IPPROTO_SCTP);
解説
SCTP プロトコルは、データの信頼性、フロー制御、双方向の転送を提供します。
それは、メッセージ指向のプロトコルであり、SOCK_STREAM と SOCK_SEQPACKET
抽象化をサポートすることができます。SCTP は、標準のインターネットアドレス
形式を使用して、さらに、``ポートアドレス'' のホスト毎のコレクション (収
集) を提供します。したがって、各アドレスは、ホスト識別ピア (相手側) 実態
上の特定の SCTP ポートで、ホストとネットワークを指定するインターネットア
ドレスで構成されます。
SCTP のプログラミングに関して 2 つのモデルがあります。最初は、SOCK_STREAM
抽象化を使用します。この抽象化で、SCTP プロトコルを利用するソケットは、
``アクティブ'' (active) または ``パッシブ'' (passive) です。アクティブな
ソケットは、パッシブなソケットに接続を開始します。デフォルトで、SCTP ソ
ケットは、アクティブで作成されます。パッシブなソケットを作成するために
は、bind(2) または sctp_bindx(3) システムコールでソケットをバインドした後
に、listen(2) システムコールを使用しなければなりません。パッシブなソケッ
トだけが、着信接続を受け付けるために accept(2) 呼び出しを使用します。アク
ティブなソケットだけが、接続を開始するために connect(2) 呼び出しを使用し
ます。
別の抽象化 SOCK_SEQPACKET は、ユーザが (ソケットアドレスを運ぶ有効な送信
呼び出しのいずれかを使用して)、アドレスに送信するする点において、
``connectionless'' (コネクションレス) 操作モードを提供し、アソシエーショ
ンは、基本的な SCTP 転送スタックによって暗黙的にセットアップされます。こ
の抽象化は、4 つの方法のハンドシェイクの 3 番目の行程でデータを送信するこ
とができるただ一つのものです。ユーザは、ソケットが接続を受け付けることが
できるように、まだ listen(2) を呼び出さなければなりません。しかしながら、
listen(2) の呼び出しは、まだ他のピアへの暗黙の接続を開始することからユー
ザを禁止しません。
SCTP プロトコルは、直接マルチホーミング (multi-homing) をサポートします。
それで、``ワイルドカード'' のアドレス INADDR_ANY でソケットをバインドする
とき、SCTP スタックは、ピアの範囲で考えられるすべてのローカルのアドレスに
関してピアに情報を与えます。そして、ピアには、たぶんローカルホストに到達
する複数のパスがあります。
また、SCTP 転送プロトコルもマルチストリーム (multi-stream) されます。マル
チストリームは、メッセージのサブ順序付けフローを送信する能力を参照しま
す。ユーザは、sctp_send(3) 関数呼び出しのような、拡張された送信呼び出しの
1 つで特定のストリームを指定することによって、これを実行します。異なった
ストリームでのメッセージの送信は、データの平行な配信を許可します、すなわ
ち、ストリーム 1 におけるメッセージの損失は、ストリーム 2 で送信される
メッセージの配信をブロックしません。
また、SCTP 転送プロトコルは、同様に順序付けされていないサービスを提供しま
す。順序付けされていないサービスによって、他のメッセージの順序に関係しな
いで、メッセージを送信して配信することができます。
SCTP カーネルの実装は、カーネルにコンパイルされるか、またはモジュールとし
て動的にロードされます。スタックの動的なロードをサポートするために、カー
ネルは、options SCTP_SUPPORT でコンパイルされなければなりません。
拡張
また、SCTP の FreeBSD の実装は、次の拡張をサポートします:
sctp 部分的な信頼性 この拡張によって、いくつかのユーザの指定された
パラメータに基づいてスキップされ配信されない
メッセージを持つことができます。
sctp 動的なアドレス付け この拡張によって、既存のアソシエーションから動
的にアドレスを追加して、削除することができま
す。
sctp 認証 この拡張によって、ユーザは、メッセージを送信す
るピアが、実際にアソシエーションをセットアップ
するピアであることを確認するために (データを含
んでいる) 特定のピアのチャンク (塊) を認証する
ことができます。また、共有されたキーオプション
は、2 つのスタックがキーを前もって共有すること
ができるように、供給されます。
パケットの取りこぼし いくつかのルータは、不正による損失を報告する特
別なサテライト (従属) プロトコルをサポートして
います。これによって、帯域幅の利用においてそれ
に続く損失なしで再転送することができます。
ストリームのリセット この拡張によって、どちらかの側のユーザは、いく
らか、またはすべてのストリームで使用されるスト
リームシーケンス番号をリセットできます。
ソケットオプション
SCTP は、setsockopt(2) で設定され、getsockopt(2) または sctp_opt_info(3)
でテストすることができる、多くのソケットオプションをサポートします:
SCTP_NODELAY
ほとんどの状況において、SCTP は、それが存在しているとき、データを
送信します。発行済のデータがまだ承認されていないとき、いったん承
認が受信されると、単一のパケットで送信される少量の出力を収集しま
す。応答を受信しないマウスイベントのストリームを送信するウィンド
ウシステムのような、いくつかのクライアントに関して、このパケット
化は、重要な遅延を引き起こすかもしれません。ブール値のオプション
SCTP_NODELAY は、このアルゴリズムを無効化します。
SCTP_RTOINFO
このオプションは、アソシエーション ``再転送のタイムアウト'' に関
する特有の情報を返します。また、デフォルト値を変更するためにそれ
を使用することができます。
SCTP_ASSOCINFO
このオプションは、要求されたアソシエーションに関する特有の情報を
返します。
SCTP_INITMSG
このオプションによって、利用者は、アソシエーションが暗黙のうちに
セットアップされるときに、デフォルトの送信パラメータを取得する
か、または設定することができます。それによって、利用者は、内向き
で許可されたストリームの最大の数とピアの要求されたストリームの数
としてそのようなものを変更することができ、
SCTP_AUTOCLOSE
1 対多ののモデル (SOCK_SEQPACKET) において、アソシエーションは、
暗黙のうちにセットアップされます。このオプションによって、ユーザ
は、アソシエーションを保持することができる、デフォルト番号のアイ
ドル秒を指定することができます。(ユーザメッセージが送信されない
か、または、ピアから受信されていないところで) アイドル秒の後に、
アソシエーションは、潔くクローズされます。この値のためのデフォル
トは、0 または無制限 (すなわち、自動的にクローズされない) です。
SCTP_SET_PEER_PRIMARY_ADDR
動的なアドレス拡張によって、ピアは、特定のアドレスがプライマリア
ドレスに作られることも要求できます。このオプションによって、呼び
出し側は、そのような要求をピアに行うことができます。また、ピアが
動的なアドレス拡張をサポートしていないなら、この呼び出しが、失敗
することに注意してください。呼び出し側は、ピアが、アソシエーショ
ンのセットアップの間または動的に伝える、有効なローカルアドレスを
提供しなければならないことに注意してください。
SCTP_PRIMARY_ADDR
このオプションによって、呼び出し側が送信したいプライマリアドレス
の設定を可能にします。呼び出し側は、プライマリとなるピアのアドレ
スを提供します。
SCTP_ADAPTATION_LAYER
また、動的アドレス拡張によって、ユーザは、アソシエーションのセッ
トアップで 32 ビットの不透明な (サイズおよび形がわからない) 値を
渡すことができます。このオプションによって、ユーザは、この値を設
定するか、または取得できます。
SCTP_DISABLE_FRAGMENTS
デフォルトで、SCTP は、ネットワークに適合し、次に後で、受信におい
て、断片を単一のユーザメッセージに再構築する、ユーザメッセージを
複数の断片に断片化します。代わりにこのオプションが有効にされるな
ら、パスの最大の転送単位 (P-MTU) を超える任意の送信は、失敗し、
メッセージは、送信されません。
SCTP_PEER_ADDR_PARAMS
このオプションによって、ユーザは、特定のピアアドレスのパラメータ
を設定するか、または取得できます。
SCTP_DEFAULT_SEND_PARAM
ユーザが拡張された送信呼び出し (例えば、sctp_sendmsg(3)) の 1 つ
を使用しないとき、デフォルト値の組は、それぞれの送信に適用しま
す。これらの値は、プロトコル毎の ID と同様に送信するストリーム番
号のようなものを含んでいます。このオプションによって、呼び出し側
は、これらの値を取得して、設定できます。ユーザがこれらのデフォル
ト値を変更するなら、これらの新しい値は、情報が送信側によって提供
されない (すなわち、非拡張 API が使用される) ときはいつも、デフォ
ルトとして使用されます。
SCTP_EVENTS
SCTP には、アプリケーションと通信することができるデータでないイベ
ントがあります。デフォルトで、これらは、受信されたメッセージで設
定された特別なフラグ MSG_NOTIFICATION でデータパスに到着するの
で、すべて無効にされます。このオプションによって、呼び出し側は、
それらが、受信に関心がある、異なったイベントで設定されるのと同様
に現在受信された、イベントを取得できます。
SCTP_I_WANT_MAPPED_V4_ADDR
SCTP は、IPV4 と IPV6 の両方をサポートします。SCTP は、マルチホー
ムであるので、アソシエーションは、IPV4 と IPV6 アドレスの両方にわ
たります。デフォルトで、IPV6 ソケットをオープンするとき、データが
ソケットでピアの V4 アドレスから到着するとき、V4 アドレスは、
AF_INET のアドレスファミリで示されます。これが望ましくないなら、
このオプションを、有効にすることができ、すべての V4 アドレスを
マップしている V6 表現に変換します。
SCTP_MAXSEG
デフォルトで、SCTP は、ピアの最も小さい P-MTU に基づくメッセージ
断片化ポイントを選択します。このオプションによって、呼び出し側
は、それをより小さい値に設定できます。ユーザは、この値を変更する
ことができますが、P-MTU がユーザによって設定された値より小さいな
ら、P-MTU 値は、任意のユーザ設定を上書きすることに注意してくださ
い。
SCTP_DELAYED_ACK_TIME
このオプションによって、ユーザは、SCTP が使用する遅延 ack 時間
(ミリ秒単位の) を設定して取得できます。デフォルトは、200 ミリ秒で
す。
SCTP_PARTIAL_DELIVERY_POINT
時には、SCTP は、全体のメッセージが到着する前に非常に大きいメッ
セージの配信を始める必要があります。デフォルトで、SCTP は、着信
メッセージが受信バッファの 1/4 より大きくなるまで、ウェートしま
す。このオプションによって、スタックに値は、より小さい値で上書き
することができます。
SCTP_FRAGMENT_INTERLEAVE
時には、SCTP は、(上記のように) の部分的な配信を開始します。通常
の場合では、連続した読み込みは、必要であるなら、ブロックして、そ
のメッセージのすべてが読み込まれるまで、メッセージの残りを返し続
けます。しかしながら、これは、他のメッセージが到着して、配信の準
備ができて、部分的に配信されたメッセージの後ろでブロックされるこ
とを意味します。このオプションが有効にされているなら、部分的に配
信されたメッセージに、それ以上の受信されるデータがないとき、続く
読み込みは、配信の準備ができてきる異なったメッセージを返します。
ユーザがメッセージ (ストリームとストリームシーケンス番号を通して)
の違いを伝えることができるように拡張 API を使用しなければならない
ので、このオプションは、デフォルトで、オフです。
SCTP_AUTH_CHUNK
デフォルトで、動的なアドレシングチャンク (塊) だけが認証されま
す。このオプションによって、ユーザは、追加のチャンク (塊) が同様
に認証されるよう要求できます。このオプションへの連続した呼び出し
は、動作し、認証を必要とするより多くのチャンク (塊) を追加し続け
ることに注意してください。このオプションは、今後のアソシエーショ
ンのみに効果があり、既存のものではないことに注意してください。
SCTP_AUTH_KEY
このオプションによって、ユーザは、後でピアを認証するために使用で
きる共有されたキーを指定できます。
SCTP_HMAC_IDENT
このオプションによって、利用者は、ピアを認証するために使用される
HMAC アルゴリズムのリストを取得するか、または設定できます。HMAC
値は、最初の HMAC 識別子が最も好ましく、最後は、最も好ましくない
ところの優先順であることに注意してください。
SCTP_AUTH_ACTIVE_KEY
このオプションによって、利用者は、認証情報の生成のためにキーをア
クティブにすることができます。ピアは、同じキーを持たなければなり
ません、さもなければ、データが破棄されることに注意してください。
SCTP_AUTH_DELETE_KEY
このオプションによって、利用者は、古いキーを削除できます。
SCTP_USE_EXT_RECVINFO
ソケット API の文書によって、拡張された送信/受信情報構造を使用で
きます。拡張された構造は、(現在の受信が完了して後に)、そのような
情報が知られているなら、次の受信されるメッセージに関連する追加
フィールドを含みます。デフォルトで、システムは、この情報を渡しま
せん。このオプションによって、ユーザは、この情報を要求できます。
SCTP_AUTO_ASCONF
デフォルトで、すべてのアドレスとシステム管理者へのバインドが自動
的で動的なアドレスを有効にするとき、SCTP スタックは、このオプショ
ンを真に設定することによって、任意のピアへの追加と削除要求に変更
するアドレスを自動的に生成します。このオプションによって、終点
(endpoint) は、その振舞いを無効にすることができます。
SCTP_MAXBURST
デフォルトで、SCTP は、混雑したウィンドウの開始で、パケットの大き
なバーストを生成することができないように、マイクロバースト制御を
実装します。デフォルトのバースト制限は、4 です。このオプションに
よって、ユーザは、この値を変更することができます。
SCTP_CONTEXT
多くの sctp 拡張呼び出しには、コンテキストフィールドがあります。
コンテキストフィールドは、送信の失敗で返される 32 ビットの不透明
な値です。このオプションによって、デフォルトのコンテキスト値を設
定する呼び出し側は、ユーザによってなにも提供されないとき、使用す
ることができます。
SCTP_EXPLICIT_EOR
デフォルトで、単一の送信は、完全なメッセージです。SCTP は、暗黙的
にレコードの境界を生成します。このオプションが有効にされるなら、
sctp_sndrcvinfo フラグフィールドで渡される、特別なフラグ SCTP_EOR
でユーザが、レコードの終わりを示すまで、すべて送信は、同じメッ
セージの部分です。これは、ユーザが異なって指定するまで、同じメッ
セージのすべての送信部分を効果的に作成します。これは、呼び出し側
が、SCTP_EOR を SCTP に渡す後まで、ストリーム番号を変更してはなら
ないことを意味し、そうでなければ、エラーが返されます。
SCTP_STATUS
このオプションは、指定されたアソシエーションに関する様々な状態情
報を返す読み込み専用のオプションです。
SCTP_GET_PEER_ADDR_INFO
この読み込み専用のオプションは、ピアアドレスの情報を返します。
SCTP_PEER_AUTH_CHUNKS
この読み込み専用のオプションは、ピアが認証されるのを必要とする
チャンク (塊) のリストを返します。
SCTP_LOCAL_AUTH_CHUNKS
この読み込み専用のオプションは、認証しなければならない局所的に必
要なチャンク (塊) のリストを返します。
SCTP_RESET_STREAMS
このソケットオプションは、ストリームのシーケンス番号、またはすべ
てのストリームのシーケンス番号をリセットするために使用されます。
また、ピアの SCTP 終点は、同様に、ストリームのリセット拡張をサ
ポートしなければならないことに注意してください。
MIB 変数
SCTP プロトコルは、sysctl(3) MIB の net.inet.sctp ブランチの多くの変数を
実装します。
Congestion Control
default_cc_module
デフォルトの輻輳制御モジュール。デフォルト値は、0 です。最小は、0
で、最大は、3 です。0 の値は、デフォルトの輻輳制御アルゴリズムを
有効にします。1 の値は、高速輻輳制御アルゴリズムを有効にします。2
の値は、HTCP 輻輳制御アルゴリズムを有効にします。3 の値は、データ
センタ輻輳制御 (DCCC) アルゴリズムを有効にします。
initial_cwnd
MTU の初期の輻輳ウィンドウサイズを定義します。
cwnd_maxburst
送信するとき、最大のバースト (burst) を制限するために、`ブライン
ド' ロジックの代わりに輻輳制御を使用します。デフォルト値は、1 で
す。0 または 1 に設定されます。
ecn_enable
明示的な輻輳通知 (Explicit Congestion Notification; ECN) を有効に
します。デフォルト値は、1 です。0 または 1 に設定されます。
rttvar_steady_step
輻輳ウィンドウを減らすことを試みるために取る同一の帯域幅測定 DCCC
の数。デフォルト値は、20 です。最小は、0 で、最大は、65535 です。
rttvar_eqret
ラウンドトリップ (round-trip) 時間と帯域幅が変更されないままであ
るとき、DCCC が輻輳ウィンドウサイズを減らすかどうか。デフォルト値
は、0 です。0 または 1 に設定されます。
rttvar_bw
シフト量 DCCC は、ラウンドトリップ時間の計算で帯域幅スムージング
(smoothing) のために使用します。デフォルト値は、4 です。最小は、0
で、最大は、32 です。
rttvar_rtt
シフト量 DCCC は、ラウンドトリップ計算のスムージングのために使用
します。デフォルト値は、5 です。最小は、0 で、最大は、32 です。
use_dcccecn
DCCC を使用するとき、ECN を有効にします。デフォルト値は、1 です。
0 または 1 に設定されます。
Misc
getcred
SCTP 接続の ucred を取得します。
assoclist
アクティブな SCTP アソシエーション (接続) のリスト。
stats SCTP 統計 (struct sctp_stat)。
diag_info_code
診断の情報エラーの原因コード。
blackhole
SCTP のブラックホール (blackhole) を有効にします。詳細について
は、blackhole(4) 参照してください。
sendall_limit
SCTP_SENDALL フラグの設定で転送することができる最大の (バイト単位
の) メッセージサイズ。
buffer_splitting
送信/受領バッファの分割を有効にします。
vtag_time_wait
秒単位の Vtag ウェート時間、0 で無効になります。
nat_friendly_init
INIT の NAT フレンドリな SCTP オプションの送信を有効にします。
enable_sack_immediately
SACK-IMMEDIATELY ビットの送信を有効にします。
udp_tunneling_port
SCTP/UDP のトンネルのポートを設定します。
mobility_fasthandoff
SCTP のファーストハンドオフを有効にします。
mobility_base
SCTP ベースの可動性を有効にします。
default_frag_interleave
デフォルトのフラグメントのインタリーブレベル。
default_ss_module
デフォルトのストリームのスケジューリングモジュール。
log_level
Ltrace/KTR トレースのログ記録レベル。
max_retran_chunk
アソシエーション (接続) がアボートされる前の DATA チャンクの再送
の数。
min_residual
分割の部分の秒単位の最小の残りデータのチャンク。
strict_data_order
厳密なデータの順序を強制します、制御の内部データであるなら、ア
ボート。
abort_at_limit
1 対 1 が qlimit に当るときアボートします。
hb_max_burst
確認するハートビート (heartbeat) の最大のバースト。
do_sctp_drain
システムが mbuf で低いなら、累積された TSN より高い、TSN で受信
キューのチャンクをフラッシュします。
max_chained_mbufs
チェーンの小さな mbuf の最大数をデフォルトにします。
abc_l_var
SACK (L) ごとに増加する SCTP ABC 最大。
nat_friendly
SCTP NAT フレンドリ操作。
cmt_use_dac
CMT DAC on/off フラグ。
cmt_on_off
CMT 設定。
outgoing_streams
発信するストリームの数をデフォルトとします。
incoming_streams
着信してくるストリームの数をデフォルトとします。
add_more_on_output
space-wise であるとき、ソケット送信バッファにより追加することを試
みることに価値があります。
path_pf_threshold
潜在的に失敗する閾値をデフォルトとします。
path_rtx_max
パスごとの最大の再送をデフォルトとします。
assoc_rtx_max
アソシエーション (接続) ごとの再送の最大数をデフォルトとします。
init_rtx_max
INIT チャンクのための再送の最大数をデフォルトとします。
valid_cookie_life
秒単位のクッキー存続期間をデフォルトとします。
init_rto_max
ミリ秒 (ms) 単位のアソシエーション (接続) の設定の間に最大の再送
タイムアウトをデフォルトとします。
rto_initial
ミリ秒 (ms) 単位の初期の再送のタイムアウトをデフォルトとします。
rto_min
ミリ秒 (ms) 単位の最小の再送のタイムアウトをデフォルトとします。
rto_max
ミリ秒 (ms) 単位の最大の再送のタイムアウトをデフォルトとします。
secret_lifetime
秒単位の秘密の存続期間デフォルトとします。
shutdown_guard_time
秒単位のシャットダウンガード (guard) タイマ (0 は、5 回の RTO.Max
を意味します)。
pmtu_raise_time
秒単位の PMTU 上昇 (raise) タイマをデフォルトとします。
heartbeat_interval
ミリ秒 (ms) 単位のハートビート (heartbeat) 間隔をデフォルトとしま
す。
asoc_resource
アソシエーション (接続) のキャッシュされたリソースの最大数。
sys_resource
システムのキャッシュされたリソースの最大数。
sack_freq
SACK 頻度をデフォルトとします。
delayed_sack_time
ミリ秒 (ms) 単位の遅延 SACK タイマをデフォルトとします。
chunkscale
チャンクとメッセージの数のスケーリング (scaling) のための調整変
数。
min_split_point
チャンクを分割するときの最小のサイズ。
pcbhashsize
PCB ハッシュテーブルサイズのための調整変数。
tcbhashsize
TCB ハッシュテーブルサイズのための調整変数。
maxchunks
アソシエーション (接続) ごとのキューの最大のチャンクをデフォルト
とします。
fr_maxburst
早い再伝達のとき、SCTP の終点のための最大のバースト (burst) をデ
フォルトとします。
maxburst
SCTP 終点のための最大のバースト (burst) をデフォルトとします。
peer_chkoh
送信されたチャンクごとの借方 (debit) の通信相手の rwnd への量。
strict_sacks
SCTP の厳密な SACK チェックを有効にします。
pktdrop_enable
SCTP PKTDROP を有効にします。
nrsack_enable
SCTP NR-SACK を有効にします。
reconfig_enable
SCTP RE-CONFIG を有効にします。
asconf_enable
SCTP ASCONF を有効にします。
auth_enable
SCTP AUTH を有効にします。
pr_enable
PR-SCTP を有効にします。
auto_asconf
SCTP Auto-ASCONF を有効にします。
recvspace
最大の着信してくる SCTP のバッファサイズ。
sendspace
最大の発信する SCTP のバッファサイズ。
関連項目
accept(2), bind(2), connect(2), listen(2), sctp_bindx(3),
sctp_connectx(3), sctp_opt_info(3), sctp_recvmsg(3), sctp_sendmsg(3),
blackhole(4)
バグ
sctp カーネルモジュールを、アンロードすることはできません。
FreeBSD 12.2 July 9, 2020 FreeBSD 12.2