blob: f771034e8f275704bf308601bc136d3d9452407b [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
Ian McDonald5fce9a22006-12-09 23:58:10 -020022It is at proposed standard RFC status and the homepage for DCCP as a protocol
23is at:
Ian McDonaldddfe10b2006-11-20 18:42:45 -020024 http://www.read.cs.ucla.edu/dccp/
Ian McDonald98069ff2005-11-10 13:04:33 -080025
26Missing features
27================
28
29The DCCP implementation does not currently have all the features that are in
Ian McDonaldddfe10b2006-11-20 18:42:45 -020030the RFC.
Ian McDonald98069ff2005-11-10 13:04:33 -080031
Ian McDonaldddfe10b2006-11-20 18:42:45 -020032The known bugs are at:
33 http://linux-net.osdl.org/index.php/TODO#DCCP
Ian McDonald98069ff2005-11-10 13:04:33 -080034
35Socket options
36==============
37
Gerrit Renker00e4d112006-09-22 09:33:58 +010038DCCP_SOCKOPT_SERVICE sets the service. The specification mandates use of
39service codes (RFC 4340, sec. 8.1.2); if this socket option is not set,
40the socket will fall back to 0 (which means that no meaningful service code
Gerrit Renker126acd52007-10-04 14:40:22 -070041is present). On active sockets this is set before connect(); specifying more
42than one code has no effect (all subsequent service codes are ignored). The
43case is different for passive sockets, where multiple service codes (up to 32)
44can be set before calling bind().
Ian McDonald98069ff2005-11-10 13:04:33 -080045
Gerrit Renker7c559a92007-10-04 14:39:22 -070046DCCP_SOCKOPT_GET_CUR_MPS is read-only and retrieves the current maximum packet
47size (application payload size) in bytes, see RFC 4340, section 14.
48
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020049DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
50partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
51always cover the entire packet and that only fully covered application data is
52accepted by the receiver. Hence, when using this feature on the sender, it must
53be enabled at the receiver, too with suitable choice of CsCov.
54
55DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
56 range 0..15 are acceptable. The default setting is 0 (full coverage),
57 values between 1..15 indicate partial coverage.
Gerrit Renker2bfd7542007-10-04 14:50:57 -070058DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020059 sets a threshold, where again values 0..15 are acceptable. The default
60 of 0 means that all packets with a partial coverage will be discarded.
61 Values in the range 1..15 indicate that packets with minimally such a
62 coverage value are also acceptable. The higher the number, the more
Gerrit Renker2bfd7542007-10-04 14:50:57 -070063 restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
64 settings are inherited to the child socket after accept().
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020065
Gerrit Renkerf2645102007-03-20 15:01:14 -030066The following two options apply to CCID 3 exclusively and are getsockopt()-only.
67In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
68DCCP_SOCKOPT_CCID_RX_INFO
69 Returns a `struct tfrc_rx_info' in optval; the buffer for optval and
70 optlen must be set to at least sizeof(struct tfrc_rx_info).
71DCCP_SOCKOPT_CCID_TX_INFO
72 Returns a `struct tfrc_tx_info' in optval; the buffer for optval and
73 optlen must be set to at least sizeof(struct tfrc_tx_info).
74
Gerrit Renker8e8c71f2007-11-21 09:56:48 -020075On unidirectional connections it is useful to close the unused half-connection
76via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
Gerrit Renkerf2645102007-03-20 15:01:14 -030077
Gerrit Renker2e2e9e92006-11-13 13:23:52 -020078Sysctl variables
79================
80Several DCCP default parameters can be managed by the following sysctls
81(sysctl net.dccp.default or /proc/sys/net/dccp/default):
82
83request_retries
84 The number of active connection initiation retries (the number of
85 Requests minus one) before timing out. In addition, it also governs
86 the behaviour of the other, passive side: this variable also sets
87 the number of times DCCP repeats sending a Response when the initial
88 handshake does not progress from RESPOND to OPEN (i.e. when no Ack
89 is received after the initial Request). This value should be greater
90 than 0, suggested is less than 10. Analogue of tcp_syn_retries.
91
92retries1
93 How often a DCCP Response is retransmitted until the listening DCCP
94 side considers its connecting peer dead. Analogue of tcp_retries1.
95
96retries2
97 The number of times a general DCCP packet is retransmitted. This has
98 importance for retransmitted acknowledgments and feature negotiation,
99 data packets are never retransmitted. Analogue of tcp_retries2.
100
101send_ndp = 1
102 Whether or not to send NDP count options (sec. 7.7.2).
103
104send_ackvec = 1
105 Whether or not to send Ack Vector options (sec. 11.5).
106
107ack_ratio = 2
108 The default Ack Ratio (sec. 11.3) to use.
109
110tx_ccid = 2
111 Default CCID for the sender-receiver half-connection.
112
113rx_ccid = 2
114 Default CCID for the receiver-sender half-connection.
115
116seq_window = 100
117 The initial sequence window (sec. 7.5.2).
118
Ian McDonald82e3ab92006-11-20 19:19:32 -0200119tx_qlen = 5
120 The size of the transmit buffer in packets. A value of 0 corresponds
121 to an unbounded transmit buffer.
122
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300123sync_ratelimit = 125 ms
124 The timeout between subsequent DCCP-Sync packets sent in response to
125 sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
126 of this parameter is milliseconds; a value of 0 disables rate-limiting.
127
Ian McDonald98069ff2005-11-10 13:04:33 -0800128Notes
129=====
130
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200131DCCP does not travel through NAT successfully at present on many boxes. This is
Gerrit Renker126acd52007-10-04 14:40:22 -0700132because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200133support for DCCP has been added.