blob: ffb9ca937d6530dcfb86e51b3bb230493a33cac2 [file] [log] [blame]
Ian McDonald98069ff2005-11-10 13:04:33 -08001DCCP protocol
2============
3
Ian McDonald98069ff2005-11-10 13:04:33 -08004
5Contents
6========
7
8- Introduction
9- Missing features
10- Socket options
11- Notes
12
13Introduction
14============
15
16Datagram Congestion Control Protocol (DCCP) is an unreliable, connection
Gerrit Renkere333b3ed2007-11-21 10:09:56 -020017oriented protocol designed to solve issues present in UDP and TCP, particularly
18for real-time and multimedia (streaming) traffic.
19It divides into a base protocol (RFC 4340) and plugable congestion control
20modules called CCIDs. Like plugable TCP congestion control, at least one CCID
21needs to be enabled in order for the protocol to function properly. In the Linux
22implementation, this is the TCP-like CCID2 (RFC 4341). Additional CCIDs, such as
23the TCP-friendly CCID3 (RFC 4342), are optional.
24For a brief introduction to CCIDs and suggestions for choosing a CCID to match
25given applications, see section 10 of RFC 4340.
Ian McDonald98069ff2005-11-10 13:04:33 -080026
27It has a base protocol and pluggable congestion control IDs (CCIDs).
28
Gerrit Renkerebe6f7e2007-11-21 10:00:17 -020029DCCP is a Proposed Standard (RFC 2026), and the homepage for DCCP as a protocol
30is at http://www.ietf.org/html.charters/dccp-charter.html
Ian McDonald98069ff2005-11-10 13:04:33 -080031
32Missing features
33================
34
Gerrit Renkerebe6f7e2007-11-21 10:00:17 -020035The Linux DCCP implementation does not currently support all the features that are
36specified in RFCs 4340...42.
Ian McDonald98069ff2005-11-10 13:04:33 -080037
Ian McDonaldddfe10b2006-11-20 18:42:45 -020038The known bugs are at:
39 http://linux-net.osdl.org/index.php/TODO#DCCP
Ian McDonald98069ff2005-11-10 13:04:33 -080040
Gerrit Renkerebe6f7e2007-11-21 10:00:17 -020041For more up-to-date versions of the DCCP implementation, please consider using
42the experimental DCCP test tree; instructions for checking this out are on:
43http://linux-net.osdl.org/index.php/DCCP_Testing#Experimental_DCCP_source_tree
44
45
Ian McDonald98069ff2005-11-10 13:04:33 -080046Socket options
47==============
48
Gerrit Renker00e4d112006-09-22 09:33:58 +010049DCCP_SOCKOPT_SERVICE sets the service. The specification mandates use of
50service codes (RFC 4340, sec. 8.1.2); if this socket option is not set,
51the socket will fall back to 0 (which means that no meaningful service code
Gerrit Renker126acd52007-10-04 14:40:22 -070052is present). On active sockets this is set before connect(); specifying more
53than one code has no effect (all subsequent service codes are ignored). The
54case is different for passive sockets, where multiple service codes (up to 32)
55can be set before calling bind().
Ian McDonald98069ff2005-11-10 13:04:33 -080056
Gerrit Renker7c559a92007-10-04 14:39:22 -070057DCCP_SOCKOPT_GET_CUR_MPS is read-only and retrieves the current maximum packet
58size (application payload size) in bytes, see RFC 4340, section 14.
59
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020060DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
61partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
62always cover the entire packet and that only fully covered application data is
63accepted by the receiver. Hence, when using this feature on the sender, it must
64be enabled at the receiver, too with suitable choice of CsCov.
65
66DCCP_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.
Gerrit Renker2bfd7542007-10-04 14:50:57 -070069DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020070 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
Gerrit Renker2bfd7542007-10-04 14:50:57 -070074 restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
75 settings are inherited to the child socket after accept().
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020076
Gerrit Renkerf2645102007-03-20 15:01:14 -030077The following two options apply to CCID 3 exclusively and are getsockopt()-only.
78In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
79DCCP_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).
82DCCP_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
Gerrit Renker8e8c71f2007-11-21 09:56:48 -020086On unidirectional connections it is useful to close the unused half-connection
87via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
Gerrit Renkerf2645102007-03-20 15:01:14 -030088
Gerrit Renker2e2e9e92006-11-13 13:23:52 -020089Sysctl variables
90================
91Several DCCP default parameters can be managed by the following sysctls
92(sysctl net.dccp.default or /proc/sys/net/dccp/default):
93
94request_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
103retries1
104 How often a DCCP Response is retransmitted until the listening DCCP
105 side considers its connecting peer dead. Analogue of tcp_retries1.
106
107retries2
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
112send_ndp = 1
113 Whether or not to send NDP count options (sec. 7.7.2).
114
115send_ackvec = 1
116 Whether or not to send Ack Vector options (sec. 11.5).
117
118ack_ratio = 2
119 The default Ack Ratio (sec. 11.3) to use.
120
121tx_ccid = 2
122 Default CCID for the sender-receiver half-connection.
123
124rx_ccid = 2
125 Default CCID for the receiver-sender half-connection.
126
127seq_window = 100
128 The initial sequence window (sec. 7.5.2).
129
Ian McDonald82e3ab92006-11-20 19:19:32 -0200130tx_qlen = 5
131 The size of the transmit buffer in packets. A value of 0 corresponds
132 to an unbounded transmit buffer.
133
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300134sync_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
Ian McDonald98069ff2005-11-10 13:04:33 -0800139Notes
140=====
141
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200142DCCP does not travel through NAT successfully at present on many boxes. This is
Gerrit Renker126acd52007-10-04 14:40:22 -0700143because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200144support for DCCP has been added.