[DCCP]: Promote CCID2 as default CCID
[cascardo/linux.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_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
61 partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
62 always cover the entire packet and that only fully covered application data is
63 accepted by the receiver. Hence, when using this feature on the sender, it must
64 be enabled at the receiver, too with suitable choice of CsCov.
65
66 DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
67         range 0..15 are acceptable. The default setting is 0 (full coverage),
68         values between 1..15 indicate partial coverage.
69 DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
70         sets a threshold, where again values 0..15 are acceptable. The default
71         of 0 means that all packets with a partial coverage will be discarded.
72         Values in the range 1..15 indicate that packets with minimally such a
73         coverage value are also acceptable. The higher the number, the more
74         restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
75         settings are inherited to the child socket after accept().
76
77 The following two options apply to CCID 3 exclusively and are getsockopt()-only.
78 In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
79 DCCP_SOCKOPT_CCID_RX_INFO
80         Returns a `struct tfrc_rx_info' in optval; the buffer for optval and
81         optlen must be set to at least sizeof(struct tfrc_rx_info).
82 DCCP_SOCKOPT_CCID_TX_INFO
83         Returns a `struct tfrc_tx_info' in optval; the buffer for optval and
84         optlen must be set to at least sizeof(struct tfrc_tx_info).
85
86 On unidirectional connections it is useful to close the unused half-connection
87 via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
88
89 Sysctl variables
90 ================
91 Several DCCP default parameters can be managed by the following sysctls
92 (sysctl net.dccp.default or /proc/sys/net/dccp/default):
93
94 request_retries
95         The number of active connection initiation retries (the number of
96         Requests minus one) before timing out. In addition, it also governs
97         the behaviour of the other, passive side: this variable also sets
98         the number of times DCCP repeats sending a Response when the initial
99         handshake does not progress from RESPOND to OPEN (i.e. when no Ack
100         is received after the initial Request).  This value should be greater
101         than 0, suggested is less than 10. Analogue of tcp_syn_retries.
102
103 retries1
104         How often a DCCP Response is retransmitted until the listening DCCP
105         side considers its connecting peer dead. Analogue of tcp_retries1.
106
107 retries2
108         The number of times a general DCCP packet is retransmitted. This has
109         importance for retransmitted acknowledgments and feature negotiation,
110         data packets are never retransmitted. Analogue of tcp_retries2.
111
112 send_ndp = 1
113         Whether or not to send NDP count options (sec. 7.7.2).
114
115 send_ackvec = 1
116         Whether or not to send Ack Vector options (sec. 11.5).
117
118 ack_ratio = 2
119         The default Ack Ratio (sec. 11.3) to use.
120
121 tx_ccid = 2
122         Default CCID for the sender-receiver half-connection.
123
124 rx_ccid = 2
125         Default CCID for the receiver-sender half-connection.
126
127 seq_window = 100
128         The initial sequence window (sec. 7.5.2).
129
130 tx_qlen = 5
131         The size of the transmit buffer in packets. A value of 0 corresponds
132         to an unbounded transmit buffer.
133
134 sync_ratelimit = 125 ms
135         The timeout between subsequent DCCP-Sync packets sent in response to
136         sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
137         of this parameter is milliseconds; a value of 0 disables rate-limiting.
138
139 Notes
140 =====
141
142 DCCP does not travel through NAT successfully at present on many boxes. This is
143 because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
144 support for DCCP has been added.