Blame view

Documentation/networking/dccp.txt 9.38 KB
98069ff4e   Ian McDonald   [DCCP]: Create Do...
1
  DCCP protocol
4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
2
  =============
98069ff4e   Ian McDonald   [DCCP]: Create Do...
3

98069ff4e   Ian McDonald   [DCCP]: Create Do...
4
5
6
  
  Contents
  ========
98069ff4e   Ian McDonald   [DCCP]: Create Do...
7
8
9
  - Introduction
  - Missing features
  - Socket options
4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
10
11
12
  - Sysctl variables
  - IOCTLs
  - Other tunables
98069ff4e   Ian McDonald   [DCCP]: Create Do...
13
  - Notes
4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
14

98069ff4e   Ian McDonald   [DCCP]: Create Do...
15
16
  Introduction
  ============
98069ff4e   Ian McDonald   [DCCP]: Create Do...
17
  Datagram Congestion Control Protocol (DCCP) is an unreliable, connection
e333b3edc   Gerrit Renker   [DCCP]: Promote C...
18
19
  oriented protocol designed to solve issues present in UDP and TCP, particularly
  for real-time and multimedia (streaming) traffic.
c17cb8b55   Masanari Iida   doc:net: Fix typo...
20
21
  It divides into a base protocol (RFC 4340) and pluggable congestion control
  modules called CCIDs. Like pluggable TCP congestion control, at least one CCID
e333b3edc   Gerrit Renker   [DCCP]: Promote C...
22
23
24
25
26
  needs to be enabled in order for the protocol to function properly. In the Linux
  implementation, this is the TCP-like CCID2 (RFC 4341). Additional CCIDs, such as
  the TCP-friendly CCID3 (RFC 4342), are optional.
  For a brief introduction to CCIDs and suggestions for choosing a CCID to match
  given applications, see section 10 of RFC 4340.
98069ff4e   Ian McDonald   [DCCP]: Create Do...
27
28
  
  It has a base protocol and pluggable congestion control IDs (CCIDs).
ebe6f7e73   Gerrit Renker   [DCCP]: Update do...
29
30
  DCCP is a Proposed Standard (RFC 2026), and the homepage for DCCP as a protocol
  is at http://www.ietf.org/html.charters/dccp-charter.html
98069ff4e   Ian McDonald   [DCCP]: Create Do...
31

4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
32

98069ff4e   Ian McDonald   [DCCP]: Create Do...
33
34
  Missing features
  ================
ebe6f7e73   Gerrit Renker   [DCCP]: Update do...
35
36
  The Linux DCCP implementation does not currently support all the features that are
  specified in RFCs 4340...42.
98069ff4e   Ian McDonald   [DCCP]: Create Do...
37

ddfe10b82   Ian McDonald   [DCCP]: Update Do...
38
  The known bugs are at:
c996d8b9a   Michael Witten   Docs/Kconfig: Upd...
39
  	http://www.linuxfoundation.org/collaborate/workgroups/networking/todo#DCCP
98069ff4e   Ian McDonald   [DCCP]: Create Do...
40

ebe6f7e73   Gerrit Renker   [DCCP]: Update do...
41
42
  For more up-to-date versions of the DCCP implementation, please consider using
  the experimental DCCP test tree; instructions for checking this out are on:
c996d8b9a   Michael Witten   Docs/Kconfig: Upd...
43
  http://www.linuxfoundation.org/collaborate/workgroups/networking/dccp_testing#Experimental_DCCP_source_tree
ebe6f7e73   Gerrit Renker   [DCCP]: Update do...
44

98069ff4e   Ian McDonald   [DCCP]: Create Do...
45
46
  Socket options
  ==============
871a2c16c   Tomasz Grobelny   dccp: Policy-base...
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
  DCCP_SOCKOPT_QPOLICY_ID sets the dequeuing policy for outgoing packets. It takes
  a policy ID as argument and can only be set before the connection (i.e. changes
  during an established connection are not supported). Currently, two policies are
  defined: the "simple" policy (DCCPQ_POLICY_SIMPLE), which does nothing special,
  and a priority-based variant (DCCPQ_POLICY_PRIO). The latter allows to pass an
  u32 priority value as ancillary data to sendmsg(), where higher numbers indicate
  a higher packet priority (similar to SO_PRIORITY). This ancillary data needs to
  be formatted using a cmsg(3) message header filled in as follows:
  	cmsg->cmsg_level = SOL_DCCP;
  	cmsg->cmsg_type	 = DCCP_SCM_PRIORITY;
  	cmsg->cmsg_len	 = CMSG_LEN(sizeof(uint32_t));	/* or CMSG_LEN(4) */
  
  DCCP_SOCKOPT_QPOLICY_TXQLEN sets the maximum length of the output queue. A zero
  value is always interpreted as unbounded queue length. If different from zero,
  the interpretation of this parameter depends on the current dequeuing policy
  (see above): the "simple" policy will enforce a fixed queue size by returning
  EAGAIN, whereas the "prio" policy enforces a fixed queue length by dropping the
  lowest-priority packet first. The default value for this parameter is
  initialised from /proc/sys/net/dccp/default/tx_qlen.
00e4d116a   Gerrit Renker   [DCCP]: Allow def...
66
67
68
  DCCP_SOCKOPT_SERVICE sets the service. The specification mandates use of
  service codes (RFC 4340, sec. 8.1.2); if this socket option is not set,
  the socket will fall back to 0 (which means that no meaningful service code
126acd5bf   Gerrit Renker   [DCCP]: Update AP...
69
70
71
72
  is present). On active sockets this is set before connect(); specifying more
  than one code has no effect (all subsequent service codes are ignored). The
  case is different for passive sockets, where multiple service codes (up to 32)
  can be set before calling bind().
98069ff4e   Ian McDonald   [DCCP]: Create Do...
73

7c559a9e4   Gerrit Renker   [DCCP]: Add socke...
74
75
  DCCP_SOCKOPT_GET_CUR_MPS is read-only and retrieves the current maximum packet
  size (application payload size) in bytes, see RFC 4340, section 14.
d90ebcbfa   Gerrit Renker   dccp: Query suppo...
76
  DCCP_SOCKOPT_AVAILABLE_CCIDS is also read-only and returns the list of CCIDs
69a6a0b38   Gerrit Renker   dccp: allow probi...
77
78
79
80
  supported by the endpoint. The option value is an array of type uint8_t whose
  size is passed as option length. The minimum array size is 4 elements, the
  value returned in the optlen argument always reflects the true number of
  built-in CCIDs.
d90ebcbfa   Gerrit Renker   dccp: Query suppo...
81

b20a9c24d   Gerrit Renker   dccp: Set per-con...
82
83
  DCCP_SOCKOPT_CCID is write-only and sets both the TX and RX CCIDs at the same
  time, combining the operation of the next two socket options. This option is
c98be0c96   Carlos Garcia   doc: spelling err...
84
  preferable over the latter two, since often applications will use the same
b20a9c24d   Gerrit Renker   dccp: Set per-con...
85
86
87
88
89
90
91
92
93
94
  type of CCID for both directions; and mixed use of CCIDs is not currently well
  understood. This socket option takes as argument at least one uint8_t value, or
  an array of uint8_t values, which must match available CCIDS (see above). CCIDs
  must be registered on the socket before calling connect() or listen().
  
  DCCP_SOCKOPT_TX_CCID is read/write. It returns the current CCID (if set) or sets
  the preference list for the TX CCID, using the same format as DCCP_SOCKOPT_CCID.
  Please note that the getsockopt argument type here is `int', not uint8_t.
  
  DCCP_SOCKOPT_RX_CCID is analogous to DCCP_SOCKOPT_TX_CCID, but for the RX CCID.
b8599d207   Gerrit Renker   [DCCP]: Support f...
95
96
97
98
99
  DCCP_SOCKOPT_SERVER_TIMEWAIT enables the server (listening socket) to hold
  timewait state when closing the connection (RFC 4340, 8.3). The usual case is
  that the closing server sends a CloseReq, whereupon the client holds timewait
  state. When this boolean socket option is on, the server sends a Close instead
  and will enter TIMEWAIT. This option must be set after accept() returns.
6f4e5fff1   Gerrit Renker   [DCCP]: Support f...
100
101
102
103
104
105
106
107
108
  DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
  partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
  always cover the entire packet and that only fully covered application data is
  accepted by the receiver. Hence, when using this feature on the sender, it must
  be enabled at the receiver, too with suitable choice of CsCov.
  
  DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
  	range 0..15 are acceptable. The default setting is 0 (full coverage),
  	values between 1..15 indicate partial coverage.
2bfd754d1   Gerrit Renker   [DCCP]: Correct d...
109
  DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
6f4e5fff1   Gerrit Renker   [DCCP]: Support f...
110
111
112
113
  	sets a threshold, where again values 0..15 are acceptable. The default
  	of 0 means that all packets with a partial coverage will be discarded.
  	Values in the range 1..15 indicate that packets with minimally such a
  	coverage value are also acceptable. The higher the number, the more
2bfd754d1   Gerrit Renker   [DCCP]: Correct d...
114
115
  	restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
  	settings are inherited to the child socket after accept().
6f4e5fff1   Gerrit Renker   [DCCP]: Support f...
116

f26451013   Gerrit Renker   [CCID3]: Add docu...
117
118
119
120
121
122
123
124
  The following two options apply to CCID 3 exclusively and are getsockopt()-only.
  In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
  DCCP_SOCKOPT_CCID_RX_INFO
  	Returns a `struct tfrc_rx_info' in optval; the buffer for optval and
  	optlen must be set to at least sizeof(struct tfrc_rx_info).
  DCCP_SOCKOPT_CCID_TX_INFO
  	Returns a `struct tfrc_tx_info' in optval; the buffer for optval and
  	optlen must be set to at least sizeof(struct tfrc_tx_info).
8e8c71f1a   Gerrit Renker   [DCCP]: Honour an...
125
126
  On unidirectional connections it is useful to close the unused half-connection
  via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
f26451013   Gerrit Renker   [CCID3]: Add docu...
127

4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
128

2e2e9e92b   Gerrit Renker   [DCCP]: Add sysct...
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  Sysctl variables
  ================
  Several DCCP default parameters can be managed by the following sysctls
  (sysctl net.dccp.default or /proc/sys/net/dccp/default):
  
  request_retries
  	The number of active connection initiation retries (the number of
  	Requests minus one) before timing out. In addition, it also governs
  	the behaviour of the other, passive side: this variable also sets
  	the number of times DCCP repeats sending a Response when the initial
  	handshake does not progress from RESPOND to OPEN (i.e. when no Ack
  	is received after the initial Request).  This value should be greater
  	than 0, suggested is less than 10. Analogue of tcp_syn_retries.
  
  retries1
  	How often a DCCP Response is retransmitted until the listening DCCP
  	side considers its connecting peer dead. Analogue of tcp_retries1.
  
  retries2
  	The number of times a general DCCP packet is retransmitted. This has
  	importance for retransmitted acknowledgments and feature negotiation,
  	data packets are never retransmitted. Analogue of tcp_retries2.
2e2e9e92b   Gerrit Renker   [DCCP]: Add sysct...
151
  tx_ccid = 2
0049bab5e   Gerrit Renker   dccp: Remove obso...
152
153
  	Default CCID for the sender-receiver half-connection. Depending on the
  	choice of CCID, the Send Ack Vector feature is enabled automatically.
2e2e9e92b   Gerrit Renker   [DCCP]: Add sysct...
154
155
  
  rx_ccid = 2
0049bab5e   Gerrit Renker   dccp: Remove obso...
156
  	Default CCID for the receiver-sender half-connection; see tx_ccid.
2e2e9e92b   Gerrit Renker   [DCCP]: Add sysct...
157
158
  
  seq_window = 100
792b48780   Gerrit Renker   dccp: Implement b...
159
160
  	The initial sequence window (sec. 7.5.2) of the sender. This influences
  	the local ackno validity and the remote seqno validity windows (7.5.1).
bfbb23466   Gerrit Renker   dccp: make upper ...
161
  	Values in the range Wmin = 32 (RFC 4340, 7.5.2) up to 2^32-1 can be set.
2e2e9e92b   Gerrit Renker   [DCCP]: Add sysct...
162

82e3ab9db   Ian McDonald   [DCCP]: Adds the ...
163
164
165
  tx_qlen = 5
  	The size of the transmit buffer in packets. A value of 0 corresponds
  	to an unbounded transmit buffer.
a94f0f970   Gerrit Renker   [DCCP]: Rate-limi...
166
167
168
169
  sync_ratelimit = 125 ms
  	The timeout between subsequent DCCP-Sync packets sent in response to
  	sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
  	of this parameter is milliseconds; a value of 0 disables rate-limiting.
4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
170

c28149016   Gerrit Renker   [DCCP]: Update do...
171
172
173
174
175
  IOCTLS
  ======
  FIONREAD
  	Works as in udp(7): returns in the `int' argument pointer the size of
  	the next pending datagram in bytes, or 0 when no datagram is pending.
4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
176
177
178
179
180
181
182
183
184
185
  
  Other tunables
  ==============
  Per-route rto_min support
  	CCID-2 supports the RTAX_RTO_MIN per-route setting for the minimum value
  	of the RTO timer. This setting can be modified via the 'rto_min' option
  	of iproute2; for example:
  		> ip route change 10.0.0.0/24   rto_min 250j dev wlan0
  		> ip route add    10.0.0.254/32 rto_min 800j dev wlan0
  		> ip route show dev wlan0
89858ad14   Gerrit Renker   dccp ccid-3: use ...
186
187
188
  	CCID-3 also supports the rto_min setting: it is used to define the lower
  	bound for the expiry of the nofeedback timer. This can be useful on LANs
  	with very low RTTs (e.g., loopback, Gbit ethernet).
4886fcad6   Gerrit Renker   dccp ccid-2: Shar...
189

98069ff4e   Ian McDonald   [DCCP]: Create Do...
190
191
  Notes
  =====
ddfe10b82   Ian McDonald   [DCCP]: Update Do...
192
  DCCP does not travel through NAT successfully at present on many boxes. This is
126acd5bf   Gerrit Renker   [DCCP]: Update AP...
193
  because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
ddfe10b82   Ian McDonald   [DCCP]: Update Do...
194
  support for DCCP has been added.