blob: fdc93beec05767be426b75dc4baebbddb495ea3e [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
17based protocol designed to solve issues present in UDP and TCP particularly
18for real time and multimedia traffic.
19
20It has a base protocol and pluggable congestion control IDs (CCIDs).
21
Gerrit Renkerebe6f7e2007-11-21 10:00:17 -020022DCCP is a Proposed Standard (RFC 2026), and the homepage for DCCP as a protocol
23is at http://www.ietf.org/html.charters/dccp-charter.html
Ian McDonald98069ff2005-11-10 13:04:33 -080024
25Missing features
26================
27
Gerrit Renkerebe6f7e2007-11-21 10:00:17 -020028The Linux DCCP implementation does not currently support all the features that are
29specified in RFCs 4340...42.
Ian McDonald98069ff2005-11-10 13:04:33 -080030
Ian McDonaldddfe10b2006-11-20 18:42:45 -020031The known bugs are at:
32 http://linux-net.osdl.org/index.php/TODO#DCCP
Ian McDonald98069ff2005-11-10 13:04:33 -080033
Gerrit Renkerebe6f7e2007-11-21 10:00:17 -020034For more up-to-date versions of the DCCP implementation, please consider using
35the experimental DCCP test tree; instructions for checking this out are on:
36http://linux-net.osdl.org/index.php/DCCP_Testing#Experimental_DCCP_source_tree
37
38
Ian McDonald98069ff2005-11-10 13:04:33 -080039Socket options
40==============
41
Gerrit Renker00e4d112006-09-22 09:33:58 +010042DCCP_SOCKOPT_SERVICE sets the service. The specification mandates use of
43service codes (RFC 4340, sec. 8.1.2); if this socket option is not set,
44the socket will fall back to 0 (which means that no meaningful service code
Gerrit Renker126acd52007-10-04 14:40:22 -070045is present). On active sockets this is set before connect(); specifying more
46than one code has no effect (all subsequent service codes are ignored). The
47case is different for passive sockets, where multiple service codes (up to 32)
48can be set before calling bind().
Ian McDonald98069ff2005-11-10 13:04:33 -080049
Gerrit Renker7c559a92007-10-04 14:39:22 -070050DCCP_SOCKOPT_GET_CUR_MPS is read-only and retrieves the current maximum packet
51size (application payload size) in bytes, see RFC 4340, section 14.
52
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020053DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
54partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
55always cover the entire packet and that only fully covered application data is
56accepted by the receiver. Hence, when using this feature on the sender, it must
57be enabled at the receiver, too with suitable choice of CsCov.
58
59DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
60 range 0..15 are acceptable. The default setting is 0 (full coverage),
61 values between 1..15 indicate partial coverage.
Gerrit Renker2bfd7542007-10-04 14:50:57 -070062DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020063 sets a threshold, where again values 0..15 are acceptable. The default
64 of 0 means that all packets with a partial coverage will be discarded.
65 Values in the range 1..15 indicate that packets with minimally such a
66 coverage value are also acceptable. The higher the number, the more
Gerrit Renker2bfd7542007-10-04 14:50:57 -070067 restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
68 settings are inherited to the child socket after accept().
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020069
Gerrit Renkerf2645102007-03-20 15:01:14 -030070The following two options apply to CCID 3 exclusively and are getsockopt()-only.
71In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
72DCCP_SOCKOPT_CCID_RX_INFO
73 Returns a `struct tfrc_rx_info' in optval; the buffer for optval and
74 optlen must be set to at least sizeof(struct tfrc_rx_info).
75DCCP_SOCKOPT_CCID_TX_INFO
76 Returns a `struct tfrc_tx_info' in optval; the buffer for optval and
77 optlen must be set to at least sizeof(struct tfrc_tx_info).
78
Gerrit Renker8e8c71f2007-11-21 09:56:48 -020079On unidirectional connections it is useful to close the unused half-connection
80via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
Gerrit Renkerf2645102007-03-20 15:01:14 -030081
Gerrit Renker2e2e9e92006-11-13 13:23:52 -020082Sysctl variables
83================
84Several DCCP default parameters can be managed by the following sysctls
85(sysctl net.dccp.default or /proc/sys/net/dccp/default):
86
87request_retries
88 The number of active connection initiation retries (the number of
89 Requests minus one) before timing out. In addition, it also governs
90 the behaviour of the other, passive side: this variable also sets
91 the number of times DCCP repeats sending a Response when the initial
92 handshake does not progress from RESPOND to OPEN (i.e. when no Ack
93 is received after the initial Request). This value should be greater
94 than 0, suggested is less than 10. Analogue of tcp_syn_retries.
95
96retries1
97 How often a DCCP Response is retransmitted until the listening DCCP
98 side considers its connecting peer dead. Analogue of tcp_retries1.
99
100retries2
101 The number of times a general DCCP packet is retransmitted. This has
102 importance for retransmitted acknowledgments and feature negotiation,
103 data packets are never retransmitted. Analogue of tcp_retries2.
104
105send_ndp = 1
106 Whether or not to send NDP count options (sec. 7.7.2).
107
108send_ackvec = 1
109 Whether or not to send Ack Vector options (sec. 11.5).
110
111ack_ratio = 2
112 The default Ack Ratio (sec. 11.3) to use.
113
114tx_ccid = 2
115 Default CCID for the sender-receiver half-connection.
116
117rx_ccid = 2
118 Default CCID for the receiver-sender half-connection.
119
120seq_window = 100
121 The initial sequence window (sec. 7.5.2).
122
Ian McDonald82e3ab92006-11-20 19:19:32 -0200123tx_qlen = 5
124 The size of the transmit buffer in packets. A value of 0 corresponds
125 to an unbounded transmit buffer.
126
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300127sync_ratelimit = 125 ms
128 The timeout between subsequent DCCP-Sync packets sent in response to
129 sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
130 of this parameter is milliseconds; a value of 0 disables rate-limiting.
131
Ian McDonald98069ff2005-11-10 13:04:33 -0800132Notes
133=====
134
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200135DCCP does not travel through NAT successfully at present on many boxes. This is
Gerrit Renker126acd52007-10-04 14:40:22 -0700136because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200137support for DCCP has been added.