dccp: Remove obsolete parts of the old CCID interface
[linux-2.6.git] / Documentation / networking / dccp.txt
1 DCCP protocol
2 ============
3
4
5 Contents
6 ========
7
8 - Introduction
9 - Missing features
10 - Socket options
11 - Notes
12
13 Introduction
14 ============
15
16 Datagram Congestion Control Protocol (DCCP) is an unreliable, connection
17 oriented protocol designed to solve issues present in UDP and TCP, particularly
18 for real-time and multimedia (streaming) traffic.
19 It divides into a base protocol (RFC 4340) and plugable congestion control
20 modules called CCIDs. Like plugable TCP congestion control, at least one CCID
21 needs to be enabled in order for the protocol to function properly. In the Linux
22 implementation, this is the TCP-like CCID2 (RFC 4341). Additional CCIDs, such as
23 the TCP-friendly CCID3 (RFC 4342), are optional.
24 For a brief introduction to CCIDs and suggestions for choosing a CCID to match
25 given applications, see section 10 of RFC 4340.
26
27 It has a base protocol and pluggable congestion control IDs (CCIDs).
28
29 DCCP is a Proposed Standard (RFC 2026), and the homepage for DCCP as a protocol
30 is at http://www.ietf.org/html.charters/dccp-charter.html
31
32 Missing features
33 ================
34
35 The Linux DCCP implementation does not currently support all the features that are
36 specified in RFCs 4340...42.
37
38 The known bugs are at:
39         http://linux-net.osdl.org/index.php/TODO#DCCP
40
41 For more up-to-date versions of the DCCP implementation, please consider using
42 the experimental DCCP test tree; instructions for checking this out are on:
43 http://linux-net.osdl.org/index.php/DCCP_Testing#Experimental_DCCP_source_tree
44
45
46 Socket options
47 ==============
48
49 DCCP_SOCKOPT_SERVICE sets the service. The specification mandates use of
50 service codes (RFC 4340, sec. 8.1.2); if this socket option is not set,
51 the socket will fall back to 0 (which means that no meaningful service code
52 is present). On active sockets this is set before connect(); specifying more
53 than one code has no effect (all subsequent service codes are ignored). The
54 case is different for passive sockets, where multiple service codes (up to 32)
55 can be set before calling bind().
56
57 DCCP_SOCKOPT_GET_CUR_MPS is read-only and retrieves the current maximum packet
58 size (application payload size) in bytes, see RFC 4340, section 14.
59
60 DCCP_SOCKOPT_AVAILABLE_CCIDS is also read-only and returns the list of CCIDs
61 supported by the endpoint (see include/linux/dccp.h for symbolic constants).
62 The caller needs to provide a sufficiently large (> 2) array of type uint8_t.
63
64 DCCP_SOCKOPT_CCID is write-only and sets both the TX and RX CCIDs at the same
65 time, combining the operation of the next two socket options. This option is
66 preferrable over the latter two, since often applications will use the same
67 type of CCID for both directions; and mixed use of CCIDs is not currently well
68 understood. This socket option takes as argument at least one uint8_t value, or
69 an array of uint8_t values, which must match available CCIDS (see above). CCIDs
70 must be registered on the socket before calling connect() or listen().
71
72 DCCP_SOCKOPT_TX_CCID is read/write. It returns the current CCID (if set) or sets
73 the preference list for the TX CCID, using the same format as DCCP_SOCKOPT_CCID.
74 Please note that the getsockopt argument type here is `int', not uint8_t.
75
76 DCCP_SOCKOPT_RX_CCID is analogous to DCCP_SOCKOPT_TX_CCID, but for the RX CCID.
77
78 DCCP_SOCKOPT_SERVER_TIMEWAIT enables the server (listening socket) to hold
79 timewait state when closing the connection (RFC 4340, 8.3). The usual case is
80 that the closing server sends a CloseReq, whereupon the client holds timewait
81 state. When this boolean socket option is on, the server sends a Close instead
82 and will enter TIMEWAIT. This option must be set after accept() returns.
83
84 DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
85 partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
86 always cover the entire packet and that only fully covered application data is
87 accepted by the receiver. Hence, when using this feature on the sender, it must
88 be enabled at the receiver, too with suitable choice of CsCov.
89
90 DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
91         range 0..15 are acceptable. The default setting is 0 (full coverage),
92         values between 1..15 indicate partial coverage.
93 DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
94         sets a threshold, where again values 0..15 are acceptable. The default
95         of 0 means that all packets with a partial coverage will be discarded.
96         Values in the range 1..15 indicate that packets with minimally such a
97         coverage value are also acceptable. The higher the number, the more
98         restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
99         settings are inherited to the child socket after accept().
100
101 The following two options apply to CCID 3 exclusively and are getsockopt()-only.
102 In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
103 DCCP_SOCKOPT_CCID_RX_INFO
104         Returns a `struct tfrc_rx_info' in optval; the buffer for optval and
105         optlen must be set to at least sizeof(struct tfrc_rx_info).
106 DCCP_SOCKOPT_CCID_TX_INFO
107         Returns a `struct tfrc_tx_info' in optval; the buffer for optval and
108         optlen must be set to at least sizeof(struct tfrc_tx_info).
109
110 On unidirectional connections it is useful to close the unused half-connection
111 via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
112
113 Sysctl variables
114 ================
115 Several DCCP default parameters can be managed by the following sysctls
116 (sysctl net.dccp.default or /proc/sys/net/dccp/default):
117
118 request_retries
119         The number of active connection initiation retries (the number of
120         Requests minus one) before timing out. In addition, it also governs
121         the behaviour of the other, passive side: this variable also sets
122         the number of times DCCP repeats sending a Response when the initial
123         handshake does not progress from RESPOND to OPEN (i.e. when no Ack
124         is received after the initial Request).  This value should be greater
125         than 0, suggested is less than 10. Analogue of tcp_syn_retries.
126
127 retries1
128         How often a DCCP Response is retransmitted until the listening DCCP
129         side considers its connecting peer dead. Analogue of tcp_retries1.
130
131 retries2
132         The number of times a general DCCP packet is retransmitted. This has
133         importance for retransmitted acknowledgments and feature negotiation,
134         data packets are never retransmitted. Analogue of tcp_retries2.
135
136 send_ndp = 1
137         Whether or not to send NDP count options (sec. 7.7.2).
138
139 send_ackvec = 1
140         Whether or not to send Ack Vector options (sec. 11.5).
141
142 tx_ccid = 2
143         Default CCID for the sender-receiver half-connection. Depending on the
144         choice of CCID, the Send Ack Vector feature is enabled automatically.
145
146 rx_ccid = 2
147         Default CCID for the receiver-sender half-connection; see tx_ccid.
148
149 seq_window = 100
150         The initial sequence window (sec. 7.5.2).
151
152 tx_qlen = 5
153         The size of the transmit buffer in packets. A value of 0 corresponds
154         to an unbounded transmit buffer.
155
156 sync_ratelimit = 125 ms
157         The timeout between subsequent DCCP-Sync packets sent in response to
158         sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
159         of this parameter is milliseconds; a value of 0 disables rate-limiting.
160
161 IOCTLS
162 ======
163 FIONREAD
164         Works as in udp(7): returns in the `int' argument pointer the size of
165         the next pending datagram in bytes, or 0 when no datagram is pending.
166
167 Notes
168 =====
169
170 DCCP does not travel through NAT successfully at present on many boxes. This is
171 because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
172 support for DCCP has been added.