blob: f9157180f7d8a1cef907719cc96612eadf9607bb [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
41is present). Connecting sockets set at most one service option; for
42listening sockets, multiple service codes can be specified.
Ian McDonald98069ff2005-11-10 13:04:33 -080043
Gerrit Renker7c559a92007-10-04 14:39:22 -070044DCCP_SOCKOPT_GET_CUR_MPS is read-only and retrieves the current maximum packet
45size (application payload size) in bytes, see RFC 4340, section 14.
46
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -020047DCCP_SOCKOPT_SEND_CSCOV and DCCP_SOCKOPT_RECV_CSCOV are used for setting the
48partial checksum coverage (RFC 4340, sec. 9.2). The default is that checksums
49always cover the entire packet and that only fully covered application data is
50accepted by the receiver. Hence, when using this feature on the sender, it must
51be enabled at the receiver, too with suitable choice of CsCov.
52
53DCCP_SOCKOPT_SEND_CSCOV sets the sender checksum coverage. Values in the
54 range 0..15 are acceptable. The default setting is 0 (full coverage),
55 values between 1..15 indicate partial coverage.
56DCCP_SOCKOPT_SEND_CSCOV is for the receiver and has a different meaning: it
57 sets a threshold, where again values 0..15 are acceptable. The default
58 of 0 means that all packets with a partial coverage will be discarded.
59 Values in the range 1..15 indicate that packets with minimally such a
60 coverage value are also acceptable. The higher the number, the more
61 restrictive this setting (see [RFC 4340, sec. 9.2.1]).
62
Gerrit Renkerf2645102007-03-20 15:01:14 -030063The following two options apply to CCID 3 exclusively and are getsockopt()-only.
64In either case, a TFRC info struct (defined in <linux/tfrc.h>) is returned.
65DCCP_SOCKOPT_CCID_RX_INFO
66 Returns a `struct tfrc_rx_info' in optval; the buffer for optval and
67 optlen must be set to at least sizeof(struct tfrc_rx_info).
68DCCP_SOCKOPT_CCID_TX_INFO
69 Returns a `struct tfrc_tx_info' in optval; the buffer for optval and
70 optlen must be set to at least sizeof(struct tfrc_tx_info).
71
72
Gerrit Renker2e2e9e92006-11-13 13:23:52 -020073Sysctl variables
74================
75Several DCCP default parameters can be managed by the following sysctls
76(sysctl net.dccp.default or /proc/sys/net/dccp/default):
77
78request_retries
79 The number of active connection initiation retries (the number of
80 Requests minus one) before timing out. In addition, it also governs
81 the behaviour of the other, passive side: this variable also sets
82 the number of times DCCP repeats sending a Response when the initial
83 handshake does not progress from RESPOND to OPEN (i.e. when no Ack
84 is received after the initial Request). This value should be greater
85 than 0, suggested is less than 10. Analogue of tcp_syn_retries.
86
87retries1
88 How often a DCCP Response is retransmitted until the listening DCCP
89 side considers its connecting peer dead. Analogue of tcp_retries1.
90
91retries2
92 The number of times a general DCCP packet is retransmitted. This has
93 importance for retransmitted acknowledgments and feature negotiation,
94 data packets are never retransmitted. Analogue of tcp_retries2.
95
96send_ndp = 1
97 Whether or not to send NDP count options (sec. 7.7.2).
98
99send_ackvec = 1
100 Whether or not to send Ack Vector options (sec. 11.5).
101
102ack_ratio = 2
103 The default Ack Ratio (sec. 11.3) to use.
104
105tx_ccid = 2
106 Default CCID for the sender-receiver half-connection.
107
108rx_ccid = 2
109 Default CCID for the receiver-sender half-connection.
110
111seq_window = 100
112 The initial sequence window (sec. 7.5.2).
113
Ian McDonald82e3ab92006-11-20 19:19:32 -0200114tx_qlen = 5
115 The size of the transmit buffer in packets. A value of 0 corresponds
116 to an unbounded transmit buffer.
117
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300118sync_ratelimit = 125 ms
119 The timeout between subsequent DCCP-Sync packets sent in response to
120 sequence-invalid packets on the same socket (RFC 4340, 7.5.4). The unit
121 of this parameter is milliseconds; a value of 0 disables rate-limiting.
122
Ian McDonald98069ff2005-11-10 13:04:33 -0800123Notes
124=====
125
Ian McDonaldddfe10b2006-11-20 18:42:45 -0200126DCCP does not travel through NAT successfully at present on many boxes. This is
127because the checksum covers the psuedo-header as per TCP and UDP. Linux NAT
128support for DCCP has been added.