blob: 61d042bbbf607253033d9948b291cab2322814ba [file] [log] [blame]
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -07001#ifndef _LINUX_DCCP_H
2#define _LINUX_DCCP_H
3
Harald Welte5a47a472005-08-09 20:26:03 -07004
5#include <linux/in.h>
Alexey Dobriyana6b7a402011-06-06 10:43:46 +00006#include <linux/interrupt.h>
Arnaldo Carvalho de Melo19ac2142007-08-19 17:18:33 -07007#include <linux/ktime.h>
Harald Welte5a47a472005-08-09 20:26:03 -07008#include <linux/list.h>
9#include <linux/uio.h>
10#include <linux/workqueue.h>
11
12#include <net/inet_connection_sock.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020013#include <net/inet_sock.h>
Arnaldo Carvalho de Melo64cf1e52005-08-09 20:45:21 -070014#include <net/inet_timewait_sock.h>
Harald Welte5a47a472005-08-09 20:26:03 -070015#include <net/tcp_states.h>
David Howells607ca462012-10-13 10:46:48 +010016#include <uapi/linux/dccp.h>
Harald Welte5a47a472005-08-09 20:26:03 -070017
18enum dccp_state {
Gerrit Renkerf11135a2007-11-28 11:34:53 -020019 DCCP_OPEN = TCP_ESTABLISHED,
20 DCCP_REQUESTING = TCP_SYN_SENT,
21 DCCP_LISTEN = TCP_LISTEN,
22 DCCP_RESPOND = TCP_SYN_RECV,
23 /*
24 * States involved in closing a DCCP connection:
25 * 1) ACTIVE_CLOSEREQ is entered by a server sending a CloseReq.
26 *
27 * 2) CLOSING can have three different meanings (RFC 4340, 8.3):
28 * a. Client has performed active-close, has sent a Close to the server
29 * from state OPEN or PARTOPEN, and is waiting for the final Reset
30 * (in this case, SOCK_DONE == 1).
31 * b. Client is asked to perform passive-close, by receiving a CloseReq
32 * in (PART)OPEN state. It sends a Close and waits for final Reset
33 * (in this case, SOCK_DONE == 0).
34 * c. Server performs an active-close as in (a), keeps TIMEWAIT state.
35 *
36 * 3) The following intermediate states are employed to give passively
37 * closing nodes a chance to process their unread data:
38 * - PASSIVE_CLOSE (from OPEN => CLOSED) and
39 * - PASSIVE_CLOSEREQ (from (PART)OPEN to CLOSING; case (b) above).
40 */
41 DCCP_ACTIVE_CLOSEREQ = TCP_FIN_WAIT1,
42 DCCP_PASSIVE_CLOSE = TCP_CLOSE_WAIT, /* any node receiving a Close */
43 DCCP_CLOSING = TCP_CLOSING,
44 DCCP_TIME_WAIT = TCP_TIME_WAIT,
45 DCCP_CLOSED = TCP_CLOSE,
Eric Dumazet85645ba2015-03-22 10:22:24 -070046 DCCP_NEW_SYN_RECV = TCP_NEW_SYN_RECV,
Gerrit Renkerf11135a2007-11-28 11:34:53 -020047 DCCP_PARTOPEN = TCP_MAX_STATES,
48 DCCP_PASSIVE_CLOSEREQ, /* clients receiving CloseReq */
Gerrit Renker9b91ad22007-11-20 21:56:37 -020049 DCCP_MAX_STATES
Harald Welte5a47a472005-08-09 20:26:03 -070050};
51
Harald Welte5a47a472005-08-09 20:26:03 -070052enum {
Gerrit Renkerf11135a2007-11-28 11:34:53 -020053 DCCPF_OPEN = TCPF_ESTABLISHED,
54 DCCPF_REQUESTING = TCPF_SYN_SENT,
55 DCCPF_LISTEN = TCPF_LISTEN,
56 DCCPF_RESPOND = TCPF_SYN_RECV,
57 DCCPF_ACTIVE_CLOSEREQ = TCPF_FIN_WAIT1,
58 DCCPF_CLOSING = TCPF_CLOSING,
59 DCCPF_TIME_WAIT = TCPF_TIME_WAIT,
60 DCCPF_CLOSED = TCPF_CLOSE,
Eric Dumazet85645ba2015-03-22 10:22:24 -070061 DCCPF_NEW_SYN_RECV = TCPF_NEW_SYN_RECV,
Gerrit Renkerf11135a2007-11-28 11:34:53 -020062 DCCPF_PARTOPEN = (1 << DCCP_PARTOPEN),
Harald Welte5a47a472005-08-09 20:26:03 -070063};
64
65static inline struct dccp_hdr *dccp_hdr(const struct sk_buff *skb)
66{
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -070067 return (struct dccp_hdr *)skb_transport_header(skb);
Harald Welte5a47a472005-08-09 20:26:03 -070068}
69
Gerrit Renker9b420782006-11-10 11:22:32 -020070static inline struct dccp_hdr *dccp_zeroed_hdr(struct sk_buff *skb, int headlen)
71{
Arnaldo Carvalho de Melobadff6d2007-03-13 13:06:52 -030072 skb_push(skb, headlen);
73 skb_reset_transport_header(skb);
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -070074 return memset(skb_transport_header(skb), 0, headlen);
Gerrit Renker9b420782006-11-10 11:22:32 -020075}
76
Gerrit Renkerfde20102007-10-24 10:12:09 -020077static inline struct dccp_hdr_ext *dccp_hdrx(const struct dccp_hdr *dh)
Harald Welte5a47a472005-08-09 20:26:03 -070078{
Gerrit Renkerfde20102007-10-24 10:12:09 -020079 return (struct dccp_hdr_ext *)((unsigned char *)dh + sizeof(*dh));
Harald Welte5a47a472005-08-09 20:26:03 -070080}
81
Harald Welte1d3de412005-08-09 20:26:55 -070082static inline unsigned int __dccp_basic_hdr_len(const struct dccp_hdr *dh)
83{
84 return sizeof(*dh) + (dh->dccph_x ? sizeof(struct dccp_hdr_ext) : 0);
85}
86
Harald Welte5a47a472005-08-09 20:26:03 -070087static inline unsigned int dccp_basic_hdr_len(const struct sk_buff *skb)
88{
89 const struct dccp_hdr *dh = dccp_hdr(skb);
Harald Welte1d3de412005-08-09 20:26:55 -070090 return __dccp_basic_hdr_len(dh);
Harald Welte5a47a472005-08-09 20:26:03 -070091}
92
Gerrit Renkerfde20102007-10-24 10:12:09 -020093static inline __u64 dccp_hdr_seq(const struct dccp_hdr *dh)
Harald Welte5a47a472005-08-09 20:26:03 -070094{
Andrea Bittau60fe62e2006-03-20 19:23:32 -080095 __u64 seq_nr = ntohs(dh->dccph_seq);
Harald Welte5a47a472005-08-09 20:26:03 -070096
97 if (dh->dccph_x != 0)
Gerrit Renkerfde20102007-10-24 10:12:09 -020098 seq_nr = (seq_nr << 32) + ntohl(dccp_hdrx(dh)->dccph_seq_low);
Andrea Bittau60fe62e2006-03-20 19:23:32 -080099 else
100 seq_nr += (u32)dh->dccph_seq2 << 16;
Harald Welte5a47a472005-08-09 20:26:03 -0700101
102 return seq_nr;
103}
104
105static inline struct dccp_hdr_request *dccp_hdr_request(struct sk_buff *skb)
106{
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700107 return (struct dccp_hdr_request *)(skb_transport_header(skb) +
108 dccp_basic_hdr_len(skb));
Harald Welte5a47a472005-08-09 20:26:03 -0700109}
110
111static inline struct dccp_hdr_ack_bits *dccp_hdr_ack_bits(const struct sk_buff *skb)
112{
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700113 return (struct dccp_hdr_ack_bits *)(skb_transport_header(skb) +
114 dccp_basic_hdr_len(skb));
Harald Welte5a47a472005-08-09 20:26:03 -0700115}
116
117static inline u64 dccp_hdr_ack_seq(const struct sk_buff *skb)
118{
119 const struct dccp_hdr_ack_bits *dhack = dccp_hdr_ack_bits(skb);
Andrea Bittau60fe62e2006-03-20 19:23:32 -0800120 return ((u64)ntohs(dhack->dccph_ack_nr_high) << 32) + ntohl(dhack->dccph_ack_nr_low);
Harald Welte5a47a472005-08-09 20:26:03 -0700121}
122
123static inline struct dccp_hdr_response *dccp_hdr_response(struct sk_buff *skb)
124{
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700125 return (struct dccp_hdr_response *)(skb_transport_header(skb) +
126 dccp_basic_hdr_len(skb));
Harald Welte5a47a472005-08-09 20:26:03 -0700127}
128
129static inline struct dccp_hdr_reset *dccp_hdr_reset(struct sk_buff *skb)
130{
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700131 return (struct dccp_hdr_reset *)(skb_transport_header(skb) +
132 dccp_basic_hdr_len(skb));
Harald Welte5a47a472005-08-09 20:26:03 -0700133}
134
Harald Welte1d3de412005-08-09 20:26:55 -0700135static inline unsigned int __dccp_hdr_len(const struct dccp_hdr *dh)
136{
137 return __dccp_basic_hdr_len(dh) +
138 dccp_packet_hdr_len(dh->dccph_type);
139}
140
Harald Welte5a47a472005-08-09 20:26:03 -0700141static inline unsigned int dccp_hdr_len(const struct sk_buff *skb)
142{
Harald Welte1d3de412005-08-09 20:26:55 -0700143 return __dccp_hdr_len(dccp_hdr(skb));
Harald Welte5a47a472005-08-09 20:26:03 -0700144}
145
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700146/**
Gerrit Renkerb4d4f7c2007-12-13 12:37:19 -0200147 * struct dccp_request_sock - represent DCCP-specific connection request
148 * @dreq_inet_rsk: structure inherited from
Samuel Jerof541fb72012-02-26 18:22:02 -0700149 * @dreq_iss: initial sequence number, sent on the first Response (RFC 4340, 7.1)
150 * @dreq_gss: greatest sequence number sent (for retransmitted Responses)
151 * @dreq_isr: initial sequence number received in the first Request
152 * @dreq_gsr: greatest sequence number received (for retransmitted Request(s))
Gerrit Renkerb4d4f7c2007-12-13 12:37:19 -0200153 * @dreq_service: service code present on the Request (there is just one)
Gerrit Renkerac757732008-11-04 23:55:49 -0800154 * @dreq_featneg: feature negotiation options for this connection
Gerrit Renkerb4d4f7c2007-12-13 12:37:19 -0200155 * The following two fields are analogous to the ones in dccp_sock:
156 * @dreq_timestamp_echo: last received timestamp to echo (13.1)
157 * @dreq_timestamp_echo: the time of receiving the last @dreq_timestamp_echo
158 */
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700159struct dccp_request_sock {
160 struct inet_request_sock dreq_inet_rsk;
161 __u64 dreq_iss;
Samuel Jerof541fb72012-02-26 18:22:02 -0700162 __u64 dreq_gss;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700163 __u64 dreq_isr;
Samuel Jerof541fb72012-02-26 18:22:02 -0700164 __u64 dreq_gsr;
Andrea Bittau60fe62e2006-03-20 19:23:32 -0800165 __be32 dreq_service;
Gerrit Renkerac757732008-11-04 23:55:49 -0800166 struct list_head dreq_featneg;
Gerrit Renkerb4d4f7c2007-12-13 12:37:19 -0200167 __u32 dreq_timestamp_echo;
168 __u32 dreq_timestamp_time;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700169};
170
171static inline struct dccp_request_sock *dccp_rsk(const struct request_sock *req)
172{
173 return (struct dccp_request_sock *)req;
174}
175
Arnaldo Carvalho de Melo64cf1e52005-08-09 20:45:21 -0700176extern struct inet_timewait_death_row dccp_death_row;
177
Gerrit Renker8b819412007-12-13 12:29:24 -0200178extern int dccp_parse_options(struct sock *sk, struct dccp_request_sock *dreq,
179 struct sk_buff *skb);
180
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700181struct dccp_options_received {
Gerrit Renker5b5d0e72008-07-13 11:51:40 +0100182 u64 dccpor_ndp:48;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700183 u32 dccpor_timestamp;
184 u32 dccpor_timestamp_echo;
185 u32 dccpor_elapsed_time;
186};
187
188struct ccid;
189
190enum dccp_role {
191 DCCP_ROLE_UNDEFINED,
192 DCCP_ROLE_LISTEN,
193 DCCP_ROLE_CLIENT,
194 DCCP_ROLE_SERVER,
195};
196
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700197struct dccp_service_list {
198 __u32 dccpsl_nr;
Andrea Bittau60fe62e2006-03-20 19:23:32 -0800199 __be32 dccpsl_list[0];
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700200};
201
202#define DCCP_SERVICE_INVALID_VALUE htonl((__u32)-1)
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200203#define DCCP_SERVICE_CODE_IS_ABSENT 0
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700204
Yaowei Bai0c6119d2015-10-08 21:28:58 +0800205static inline bool dccp_list_has_service(const struct dccp_service_list *sl,
Andrea Bittau60fe62e2006-03-20 19:23:32 -0800206 const __be32 service)
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700207{
208 if (likely(sl != NULL)) {
209 u32 i = sl->dccpsl_nr;
210 while (i--)
211 if (sl->dccpsl_list[i] == service)
Yaowei Bai0c6119d2015-10-08 21:28:58 +0800212 return true;
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700213 }
Yaowei Bai0c6119d2015-10-08 21:28:58 +0800214 return false;
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700215}
216
Arnaldo Carvalho de Meloae31c332005-09-18 00:17:51 -0700217struct dccp_ackvec;
218
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700219/**
220 * struct dccp_sock - DCCP socket state
221 *
222 * @dccps_swl - sequence number window low
223 * @dccps_swh - sequence number window high
224 * @dccps_awl - acknowledgement number window low
225 * @dccps_awh - acknowledgement number window high
226 * @dccps_iss - initial sequence number sent
227 * @dccps_isr - initial sequence number received
228 * @dccps_osr - first OPEN sequence number received
229 * @dccps_gss - greatest sequence number sent
230 * @dccps_gsr - greatest valid sequence number received
231 * @dccps_gar - greatest valid ack number received on a non-Sync; initialized to %dccps_iss
Gerrit Renker09dbc382006-11-14 12:57:34 -0200232 * @dccps_service - first (passive sock) or unique (active sock) service code
233 * @dccps_service_list - second .. last service code on passive socket
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700234 * @dccps_timestamp_echo - latest timestamp received on a TIMESTAMP option
Gerrit Renkerb4d4f7c2007-12-13 12:37:19 -0200235 * @dccps_timestamp_time - time of receiving latest @dccps_timestamp_echo
Gerrit Renker91d73c12007-04-20 13:57:21 -0700236 * @dccps_l_ack_ratio - feature-local Ack Ratio
237 * @dccps_r_ack_ratio - feature-remote Ack Ratio
Gerrit Renker792b4872009-01-16 23:36:31 +0000238 * @dccps_l_seq_win - local Sequence Window (influences ack number validity)
239 * @dccps_r_seq_win - remote Sequence Window (influences seq number validity)
Gerrit Renker6f4e5ff2006-11-10 17:43:06 -0200240 * @dccps_pcslen - sender partial checksum coverage (via sockopt)
241 * @dccps_pcrlen - receiver partial checksum coverage (via sockopt)
Gerrit Renker4098dce2008-12-08 01:18:37 -0800242 * @dccps_send_ndp_count - local Send NDP Count feature (7.7.2)
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700243 * @dccps_ndp_count - number of Non Data Packets since last data packet
Gerrit Renker91d73c12007-04-20 13:57:21 -0700244 * @dccps_mss_cache - current value of MSS (path MTU minus header sizes)
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300245 * @dccps_rate_last - timestamp for rate-limiting DCCP-Sync (RFC 4340, 7.5.4)
Gerrit Renkerac757732008-11-04 23:55:49 -0800246 * @dccps_featneg - tracks feature-negotiation state (mostly during handshake)
Arnaldo Carvalho de Meloae31c332005-09-18 00:17:51 -0700247 * @dccps_hc_rx_ackvec - rx half connection ack vector
Gerrit Renker91d73c12007-04-20 13:57:21 -0700248 * @dccps_hc_rx_ccid - CCID used for the receiver (or receiving half-connection)
249 * @dccps_hc_tx_ccid - CCID used for the sender (or sending half-connection)
250 * @dccps_options_received - parsed set of retrieved options
Tomasz Grobelny871a2c12010-12-04 13:38:01 +0100251 * @dccps_qpolicy - TX dequeueing policy, one of %dccp_packet_dequeueing_policy
252 * @dccps_tx_qlen - maximum length of the TX queue
Gerrit Renker91d73c12007-04-20 13:57:21 -0700253 * @dccps_role - role of this sock, one of %dccp_role
254 * @dccps_hc_rx_insert_options - receiver wants to add options when acking
255 * @dccps_hc_tx_insert_options - sender wants to add options when sending
Gerrit Renkerb8599d22007-12-13 12:25:01 -0200256 * @dccps_server_timewait - server holds timewait state on close (RFC 4340, 8.3)
Gerrit Renkerd83447f2010-11-14 17:25:46 +0100257 * @dccps_sync_scheduled - flag which signals "send out-of-band message soon"
Gerrit Renkerdc841e32010-10-27 19:16:26 +0000258 * @dccps_xmitlet - tasklet scheduled by the TX CCID to dequeue data packets
259 * @dccps_xmit_timer - used by the TX CCID to delay sending (rate-based pacing)
Gerrit Renker89560b52007-03-20 15:27:17 -0300260 * @dccps_syn_rtt - RTT sample from Request/Response exchange (in usecs)
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700261 */
262struct dccp_sock {
263 /* inet_connection_sock has to be the first member of dccp_sock */
264 struct inet_connection_sock dccps_inet_connection;
Gerrit Renker89560b52007-03-20 15:27:17 -0300265#define dccps_syn_rtt dccps_inet_connection.icsk_ack.lrcvtime
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700266 __u64 dccps_swl;
267 __u64 dccps_swh;
268 __u64 dccps_awl;
269 __u64 dccps_awh;
270 __u64 dccps_iss;
271 __u64 dccps_isr;
272 __u64 dccps_osr;
273 __u64 dccps_gss;
274 __u64 dccps_gsr;
275 __u64 dccps_gar;
Andrea Bittau60fe62e2006-03-20 19:23:32 -0800276 __be32 dccps_service;
Arnaldo Carvalho de Melocf6b5fbe2008-02-03 04:07:48 -0800277 __u32 dccps_mss_cache;
Arnaldo Carvalho de Melo67e6b622005-09-16 16:58:40 -0700278 struct dccp_service_list *dccps_service_list;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700279 __u32 dccps_timestamp_echo;
Gerrit Renkerb4d4f7c2007-12-13 12:37:19 -0200280 __u32 dccps_timestamp_time;
Andrea Bittau2a91aa32006-03-20 17:41:47 -0800281 __u16 dccps_l_ack_ratio;
282 __u16 dccps_r_ack_ratio;
Gerrit Renker792b4872009-01-16 23:36:31 +0000283 __u64 dccps_l_seq_win:48;
284 __u64 dccps_r_seq_win:48;
Gerrit Renker29450552008-11-16 22:53:48 -0800285 __u8 dccps_pcslen:4;
286 __u8 dccps_pcrlen:4;
Gerrit Renker4098dce2008-12-08 01:18:37 -0800287 __u8 dccps_send_ndp_count:1;
Gerrit Renker5b5d0e72008-07-13 11:51:40 +0100288 __u64 dccps_ndp_count:48;
Gerrit Renkera94f0f92007-09-26 11:31:49 -0300289 unsigned long dccps_rate_last;
Gerrit Renkerac757732008-11-04 23:55:49 -0800290 struct list_head dccps_featneg;
Arnaldo Carvalho de Meloae31c332005-09-18 00:17:51 -0700291 struct dccp_ackvec *dccps_hc_rx_ackvec;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700292 struct ccid *dccps_hc_rx_ccid;
293 struct ccid *dccps_hc_tx_ccid;
294 struct dccp_options_received dccps_options_received;
Tomasz Grobelny871a2c12010-12-04 13:38:01 +0100295 __u8 dccps_qpolicy;
296 __u32 dccps_tx_qlen;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700297 enum dccp_role dccps_role:2;
Arnaldo Carvalho de Melo507d37c2005-09-09 02:30:07 -0300298 __u8 dccps_hc_rx_insert_options:1;
299 __u8 dccps_hc_tx_insert_options:1;
Gerrit Renkerb8599d22007-12-13 12:25:01 -0200300 __u8 dccps_server_timewait:1;
Gerrit Renkerd83447f2010-11-14 17:25:46 +0100301 __u8 dccps_sync_scheduled:1;
Gerrit Renkerdc841e32010-10-27 19:16:26 +0000302 struct tasklet_struct dccps_xmitlet;
Ian McDonald97e58482006-08-26 19:16:45 -0700303 struct timer_list dccps_xmit_timer;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700304};
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200305
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700306static inline struct dccp_sock *dccp_sk(const struct sock *sk)
307{
308 return (struct dccp_sock *)sk;
309}
310
311static inline const char *dccp_role(const struct sock *sk)
312{
313 switch (dccp_sk(sk)->dccps_role) {
314 case DCCP_ROLE_UNDEFINED: return "undefined";
315 case DCCP_ROLE_LISTEN: return "listen";
316 case DCCP_ROLE_SERVER: return "server";
317 case DCCP_ROLE_CLIENT: return "client";
318 }
319 return NULL;
320}
321
Eric Dumazet42cb80a2015-03-22 10:22:19 -0700322extern void dccp_syn_ack_timeout(const struct request_sock *req);
Eric Dumazetc72e1182012-04-12 22:16:05 +0000323
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700324#endif /* _LINUX_DCCP_H */