blob: b132e4a3cf0f137b7e8d6a18f67b01b5c44a95c2 [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 Renkere333b3e2007-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 Renkerd90ebcb2008-11-12 00:47:26 -080060DCCP_SOCKOPT_AVAILABLE_CCIDS is also read-only and returns the list of CCIDs
61supported by the endpoint (see include/linux/dccp.h for symbolic constants).
62The caller needs to provide a sufficiently large (> 2) array of type uint8_t.
63
Gerrit Renkerb20a9c22008-11-23 16:02:31 -080064DCCP_SOCKOPT_CCID is write-only and sets both the TX and RX CCIDs at the same
65time, combining the operation of the next two socket options. This option is
66preferrable over the latter two, since often applications will use the same
67type of CCID for both directions; and mixed use of CCIDs is not currently well
68understood. This socket option takes as argument at least one uint8_t value, or
69an array of uint8_t values, which must match available CCIDS (see above). CCIDs
70must be registered on the socket before calling connect() or listen().
71
72DCCP_SOCKOPT_TX_CCID is read/write. It returns the current CCID (if set) or sets
73the preference list for the TX CCID, using the same format as DCCP_SOCKOPT_CCID.
74Please note that the getsockopt argument type here is `int', not uint8_t.
75
76DCCP_SOCKOPT_RX_CCID is analogous to DCCP_SOCKOPT_TX_CCID, but for the RX CCID.
77
Gerrit Renkerb8599d22007-12-13 12:25:01 -020078DCCP_SOCKOPT_SERVER_TIMEWAIT enables the server (listening socket) to hold
79timewait state when closing the connection (RFC 4340, 8.3). The usual case is
80that the closing server sends a CloseReq, whereupon the client holds timewait
81state. When this boolean socket option is on, the server sends a Close instead
82and will enter TIMEWAIT. This option must be set after accept() returns.
83
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020084DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
85partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
86always cover the entire packet and that only fully covered application data is
87accepted by the receiver. Hence, when using this feature on the sender, it must
88be enabled at the receiver, too with suitable choice of CsCov.
89
90DCCP_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.
Gerrit Renker2bfd7542007-10-04 14:50:57 -070093DCCP_SOCKOPT_RECV_CSCOV is for the receiver and has a different meaning: it
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020094 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
Gerrit Renker2bfd7542007-10-04 14:50:57 -070098 restrictive this setting (see [RFC 4340, sec. 9.2.1]). Partial coverage
99 settings are inherited to the child socket after accept().
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -0200100
Gerrit Renkerf2645102007-03-20 15:01:14 -0300101The following two options apply to CCID 3 exclusively and are getsockopt()-only.
102In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
103DCCP_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).
106DCCP_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
Gerrit Renker8e8c71f2007-11-21 09:56:48 -0200110On unidirectional connections it is useful to close the unused half-connection
111via shutdown (SHUT_WR or SHUT_RD): this will reduce per-packet processing costs.
Gerrit Renkerf2645102007-03-20 15:01:14 -0300112
Gerrit Renker2e2e9e92006-11-13 13:23:52 -0200113Sysctl variables
114================
115Several DCCP default parameters can be managed by the following sysctls
116(sysctl net.dccp.default or /proc/sys/net/dccp/default):
117
118request_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
127retries1
128 How often a DCCP Response is retransmitted until the listening DCCP
129 side considers its connecting peer dead. Analogue of tcp_retries1.
130
131retries2
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
Gerrit Renker2e2e9e92006-11-13 13:23:52 -0200136tx_ccid = 2
Gerrit Renker0049bab2008-12-08 01:18:05 -0800137 Default CCID for the sender-receiver half-connection. Depending on the
138 choice of CCID, the Send Ack Vector feature is enabled automatically.
Gerrit Renker2e2e9e92006-11-13 13:23:52 -0200139
140rx_ccid = 2
Gerrit Renker0049bab2008-12-08 01:18:05 -0800141 Default CCID for the receiver-sender half-connection; see tx_ccid.
Gerrit Renker2e2e9e92006-11-13 13:23:52 -0200142
143seq_window = 100
Gerrit Renker792b4872009-01-16 23:36:31 +0000144 The initial sequence window (sec. 7.5.2) of the sender. This influences
145 the local ackno validity and the remote seqno validity windows (7.5.1).
Gerrit Renker2e2e9e92006-11-13 13:23:52 -0200146
Ian McDonald82e3ab92006-11-20 19:19:32 -0200147tx_qlen = 5
148 The size of the transmit buffer in packets. A value of 0 corresponds
149 to an unbounded transmit buffer.
150
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300151sync_ratelimit = 125 ms
152 The timeout between subsequent DCCP-Sync packets sent in response to
153 sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
154 of this parameter is milliseconds; a value of 0 disables rate-limiting.
155
Gerrit Renkerc2814902007-11-21 10:14:31 -0200156IOCTLS
157======
158FIONREAD
159 Works as in udp(7): returns in the `int' argument pointer the size of
160 the next pending datagram in bytes, or 0 when no datagram is pending.
161
Ian McDonald98069ff2005-11-10 13:04:33 -0800162Notes
163=====
164
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200165DCCP does not travel through NAT successfully at present on many boxes. This is
Gerrit Renker126acd52007-10-04 14:40:22 -0700166because the checksum covers the pseudo-header as per TCP and UDP. Linux NAT
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200167support for DCCP has been added.