]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/dccp.h
[DCCP]: Don't use necessarily the same CCID for tx and rx
[mirror_ubuntu-bionic-kernel.git] / include / linux / dccp.h
CommitLineData
7c657876
ACM
1#ifndef _LINUX_DCCP_H
2#define _LINUX_DCCP_H
3
7c657876 4#include <linux/types.h>
5a47a470 5#include <asm/byteorder.h>
7c657876 6
7c657876
ACM
7/**
8 * struct dccp_hdr - generic part of DCCP packet header
9 *
10 * @dccph_sport - Relevant port on the endpoint that sent this packet
11 * @dccph_dport - Relevant port on the other endpoint
12 * @dccph_doff - Data Offset from the start of the DCCP header, in 32-bit words
13 * @dccph_ccval - Used by the HC-Sender CCID
14 * @dccph_cscov - Parts of the packet that are covered by the Checksum field
15 * @dccph_checksum - Internet checksum, depends on dccph_cscov
16 * @dccph_x - 0 = 24 bit sequence number, 1 = 48
17 * @dccph_type - packet type, see DCCP_PKT_ prefixed macros
18 * @dccph_seq - sequence number high or low order 24 bits, depends on dccph_x
19 */
20struct dccp_hdr {
21 __u16 dccph_sport,
22 dccph_dport;
23 __u8 dccph_doff;
24#if defined(__LITTLE_ENDIAN_BITFIELD)
25 __u8 dccph_cscov:4,
26 dccph_ccval:4;
27#elif defined(__BIG_ENDIAN_BITFIELD)
28 __u8 dccph_ccval:4,
29 dccph_cscov:4;
30#else
31#error "Adjust your <asm/byteorder.h> defines"
32#endif
33 __u16 dccph_checksum;
34#if defined(__LITTLE_ENDIAN_BITFIELD)
35 __u32 dccph_x:1,
36 dccph_type:4,
37 dccph_reserved:3,
38 dccph_seq:24;
39#elif defined(__BIG_ENDIAN_BITFIELD)
40 __u32 dccph_reserved:3,
41 dccph_type:4,
42 dccph_x:1,
43 dccph_seq:24;
44#else
45#error "Adjust your <asm/byteorder.h> defines"
46#endif
47};
48
7c657876
ACM
49/**
50 * struct dccp_hdr_ext - the low bits of a 48 bit seq packet
51 *
52 * @dccph_seq_low - low 24 bits of a 48 bit seq packet
53 */
54struct dccp_hdr_ext {
55 __u32 dccph_seq_low;
56};
57
7c657876
ACM
58/**
59 * struct dccp_hdr_request - Conection initiation request header
60 *
61 * @dccph_req_service - Service to which the client app wants to connect
62 * @dccph_req_options - list of options (must be a multiple of 32 bits
63 */
64struct dccp_hdr_request {
65 __u32 dccph_req_service;
66};
7c657876
ACM
67/**
68 * struct dccp_hdr_ack_bits - acknowledgment bits common to most packets
69 *
70 * @dccph_resp_ack_nr_high - 48 bit ack number high order bits, contains GSR
71 * @dccph_resp_ack_nr_low - 48 bit ack number low order bits, contains GSR
72 */
73struct dccp_hdr_ack_bits {
74 __u32 dccph_reserved1:8,
75 dccph_ack_nr_high:24;
76 __u32 dccph_ack_nr_low;
77};
7c657876
ACM
78/**
79 * struct dccp_hdr_response - Conection initiation response header
80 *
81 * @dccph_resp_ack_nr_high - 48 bit ack number high order bits, contains GSR
82 * @dccph_resp_ack_nr_low - 48 bit ack number low order bits, contains GSR
83 * @dccph_resp_service - Echoes the Service Code on a received DCCP-Request
84 * @dccph_resp_options - list of options (must be a multiple of 32 bits
85 */
86struct dccp_hdr_response {
87 struct dccp_hdr_ack_bits dccph_resp_ack;
88 __u32 dccph_resp_service;
89};
90
7c657876
ACM
91/**
92 * struct dccp_hdr_reset - Unconditionally shut down a connection
93 *
94 * @dccph_reset_service - Echoes the Service Code on a received DCCP-Request
95 * @dccph_reset_options - list of options (must be a multiple of 32 bits
96 */
97struct dccp_hdr_reset {
98 struct dccp_hdr_ack_bits dccph_reset_ack;
99 __u8 dccph_reset_code,
100 dccph_reset_data[3];
101};
102
7c657876
ACM
103enum dccp_pkt_type {
104 DCCP_PKT_REQUEST = 0,
105 DCCP_PKT_RESPONSE,
106 DCCP_PKT_DATA,
107 DCCP_PKT_ACK,
108 DCCP_PKT_DATAACK,
109 DCCP_PKT_CLOSEREQ,
110 DCCP_PKT_CLOSE,
111 DCCP_PKT_RESET,
112 DCCP_PKT_SYNC,
113 DCCP_PKT_SYNCACK,
114 DCCP_PKT_INVALID,
115};
116
117#define DCCP_NR_PKT_TYPES DCCP_PKT_INVALID
118
119static inline unsigned int dccp_packet_hdr_len(const __u8 type)
120{
121 if (type == DCCP_PKT_DATA)
122 return 0;
123 if (type == DCCP_PKT_DATAACK ||
124 type == DCCP_PKT_ACK ||
125 type == DCCP_PKT_SYNC ||
126 type == DCCP_PKT_SYNCACK ||
127 type == DCCP_PKT_CLOSE ||
128 type == DCCP_PKT_CLOSEREQ)
129 return sizeof(struct dccp_hdr_ack_bits);
130 if (type == DCCP_PKT_REQUEST)
131 return sizeof(struct dccp_hdr_request);
132 if (type == DCCP_PKT_RESPONSE)
133 return sizeof(struct dccp_hdr_response);
134 return sizeof(struct dccp_hdr_reset);
135}
7c657876
ACM
136enum dccp_reset_codes {
137 DCCP_RESET_CODE_UNSPECIFIED = 0,
138 DCCP_RESET_CODE_CLOSED,
139 DCCP_RESET_CODE_ABORTED,
140 DCCP_RESET_CODE_NO_CONNECTION,
141 DCCP_RESET_CODE_PACKET_ERROR,
142 DCCP_RESET_CODE_OPTION_ERROR,
143 DCCP_RESET_CODE_MANDATORY_ERROR,
144 DCCP_RESET_CODE_CONNECTION_REFUSED,
145 DCCP_RESET_CODE_BAD_SERVICE_CODE,
146 DCCP_RESET_CODE_TOO_BUSY,
147 DCCP_RESET_CODE_BAD_INIT_COOKIE,
148 DCCP_RESET_CODE_AGGRESSION_PENALTY,
149};
150
151/* DCCP options */
152enum {
153 DCCPO_PADDING = 0,
154 DCCPO_MANDATORY = 1,
155 DCCPO_MIN_RESERVED = 3,
156 DCCPO_MAX_RESERVED = 31,
157 DCCPO_NDP_COUNT = 37,
158 DCCPO_ACK_VECTOR_0 = 38,
159 DCCPO_ACK_VECTOR_1 = 39,
160 DCCPO_TIMESTAMP = 41,
161 DCCPO_TIMESTAMP_ECHO = 42,
162 DCCPO_ELAPSED_TIME = 43,
163 DCCPO_MAX = 45,
164 DCCPO_MIN_CCID_SPECIFIC = 128,
165 DCCPO_MAX_CCID_SPECIFIC = 255,
166};
167
168/* DCCP features */
169enum {
170 DCCPF_RESERVED = 0,
171 DCCPF_SEQUENCE_WINDOW = 3,
172 DCCPF_SEND_ACK_VECTOR = 6,
173 DCCPF_SEND_NDP_COUNT = 7,
174 /* 10-127 reserved */
175 DCCPF_MIN_CCID_SPECIFIC = 128,
176 DCCPF_MAX_CCID_SPECIFIC = 255,
177};
178
a84ffe43
ACM
179/* DCCP socket options */
180#define DCCP_SOCKOPT_PACKET_SIZE 1
67e6b629
ACM
181#define DCCP_SOCKOPT_SERVICE 2
182
183#define DCCP_SERVICE_LIST_MAX_LEN 32
a84ffe43 184
5a47a470
HW
185#ifdef __KERNEL__
186
187#include <linux/in.h>
188#include <linux/list.h>
189#include <linux/uio.h>
190#include <linux/workqueue.h>
191
192#include <net/inet_connection_sock.h>
64cf1e5d 193#include <net/inet_timewait_sock.h>
5a47a470
HW
194#include <net/sock.h>
195#include <net/tcp_states.h>
196#include <net/tcp.h>
197
198enum dccp_state {
199 DCCP_OPEN = TCP_ESTABLISHED,
200 DCCP_REQUESTING = TCP_SYN_SENT,
201 DCCP_PARTOPEN = TCP_FIN_WAIT1, /* FIXME:
202 This mapping is horrible, but TCP has
203 no matching state for DCCP_PARTOPEN,
204 as TCP_SYN_RECV is already used by
205 DCCP_RESPOND, why don't stop using TCP
206 mapping of states? OK, now we don't use
207 sk_stream_sendmsg anymore, so doesn't
208 seem to exist any reason for us to
209 do the TCP mapping here */
210 DCCP_LISTEN = TCP_LISTEN,
211 DCCP_RESPOND = TCP_SYN_RECV,
212 DCCP_CLOSING = TCP_CLOSING,
213 DCCP_TIME_WAIT = TCP_TIME_WAIT,
214 DCCP_CLOSED = TCP_CLOSE,
215 DCCP_MAX_STATES = TCP_MAX_STATES,
216};
217
218#define DCCP_STATE_MASK 0xf
219#define DCCP_ACTION_FIN (1<<7)
220
221enum {
222 DCCPF_OPEN = TCPF_ESTABLISHED,
223 DCCPF_REQUESTING = TCPF_SYN_SENT,
224 DCCPF_PARTOPEN = TCPF_FIN_WAIT1,
225 DCCPF_LISTEN = TCPF_LISTEN,
226 DCCPF_RESPOND = TCPF_SYN_RECV,
227 DCCPF_CLOSING = TCPF_CLOSING,
228 DCCPF_TIME_WAIT = TCPF_TIME_WAIT,
229 DCCPF_CLOSED = TCPF_CLOSE,
230};
231
232static inline struct dccp_hdr *dccp_hdr(const struct sk_buff *skb)
233{
234 return (struct dccp_hdr *)skb->h.raw;
235}
236
237static inline struct dccp_hdr_ext *dccp_hdrx(const struct sk_buff *skb)
238{
239 return (struct dccp_hdr_ext *)(skb->h.raw + sizeof(struct dccp_hdr));
240}
241
1d3de414
HW
242static inline unsigned int __dccp_basic_hdr_len(const struct dccp_hdr *dh)
243{
244 return sizeof(*dh) + (dh->dccph_x ? sizeof(struct dccp_hdr_ext) : 0);
245}
246
5a47a470
HW
247static inline unsigned int dccp_basic_hdr_len(const struct sk_buff *skb)
248{
249 const struct dccp_hdr *dh = dccp_hdr(skb);
1d3de414 250 return __dccp_basic_hdr_len(dh);
5a47a470
HW
251}
252
253static inline __u64 dccp_hdr_seq(const struct sk_buff *skb)
254{
255 const struct dccp_hdr *dh = dccp_hdr(skb);
256#if defined(__LITTLE_ENDIAN_BITFIELD)
257 __u64 seq_nr = ntohl(dh->dccph_seq << 8);
258#elif defined(__BIG_ENDIAN_BITFIELD)
259 __u64 seq_nr = ntohl(dh->dccph_seq);
260#else
261#error "Adjust your <asm/byteorder.h> defines"
262#endif
263
264 if (dh->dccph_x != 0)
265 seq_nr = (seq_nr << 32) + ntohl(dccp_hdrx(skb)->dccph_seq_low);
266
267 return seq_nr;
268}
269
270static inline struct dccp_hdr_request *dccp_hdr_request(struct sk_buff *skb)
271{
272 return (struct dccp_hdr_request *)(skb->h.raw + dccp_basic_hdr_len(skb));
273}
274
275static inline struct dccp_hdr_ack_bits *dccp_hdr_ack_bits(const struct sk_buff *skb)
276{
277 return (struct dccp_hdr_ack_bits *)(skb->h.raw + dccp_basic_hdr_len(skb));
278}
279
280static inline u64 dccp_hdr_ack_seq(const struct sk_buff *skb)
281{
282 const struct dccp_hdr_ack_bits *dhack = dccp_hdr_ack_bits(skb);
283#if defined(__LITTLE_ENDIAN_BITFIELD)
284 return (((u64)ntohl(dhack->dccph_ack_nr_high << 8)) << 32) + ntohl(dhack->dccph_ack_nr_low);
285#elif defined(__BIG_ENDIAN_BITFIELD)
286 return (((u64)ntohl(dhack->dccph_ack_nr_high)) << 32) + ntohl(dhack->dccph_ack_nr_low);
287#else
288#error "Adjust your <asm/byteorder.h> defines"
289#endif
290}
291
292static inline struct dccp_hdr_response *dccp_hdr_response(struct sk_buff *skb)
293{
294 return (struct dccp_hdr_response *)(skb->h.raw + dccp_basic_hdr_len(skb));
295}
296
297static inline struct dccp_hdr_reset *dccp_hdr_reset(struct sk_buff *skb)
298{
299 return (struct dccp_hdr_reset *)(skb->h.raw + dccp_basic_hdr_len(skb));
300}
301
1d3de414
HW
302static inline unsigned int __dccp_hdr_len(const struct dccp_hdr *dh)
303{
304 return __dccp_basic_hdr_len(dh) +
305 dccp_packet_hdr_len(dh->dccph_type);
306}
307
5a47a470
HW
308static inline unsigned int dccp_hdr_len(const struct sk_buff *skb)
309{
1d3de414 310 return __dccp_hdr_len(dccp_hdr(skb));
5a47a470
HW
311}
312
313
7c657876
ACM
314/* initial values for each feature */
315#define DCCPF_INITIAL_SEQUENCE_WINDOW 100
316/* FIXME: for now we're using CCID 3 (TFRC) */
317#define DCCPF_INITIAL_CCID 3
318#define DCCPF_INITIAL_SEND_ACK_VECTOR 0
319/* FIXME: for now we're default to 1 but it should really be 0 */
320#define DCCPF_INITIAL_SEND_NDP_COUNT 1
321
322#define DCCP_NDP_LIMIT 0xFFFFFF
323
324/**
325 * struct dccp_options - option values for a DCCP connection
326 * @dccpo_sequence_window - Sequence Window Feature (section 7.5.2)
327 * @dccpo_ccid - Congestion Control Id (CCID) (section 10)
328 * @dccpo_send_ack_vector - Send Ack Vector Feature (section 11.5)
329 * @dccpo_send_ndp_count - Send NDP Count Feature (7.7.2)
330 */
331struct dccp_options {
332 __u64 dccpo_sequence_window;
561713cf
ACM
333 __u8 dccpo_rx_ccid;
334 __u8 dccpo_tx_ccid;
7c657876
ACM
335 __u8 dccpo_send_ack_vector;
336 __u8 dccpo_send_ndp_count;
337};
338
339extern void __dccp_options_init(struct dccp_options *dccpo);
340extern void dccp_options_init(struct dccp_options *dccpo);
341extern int dccp_parse_options(struct sock *sk, struct sk_buff *skb);
342
343struct dccp_request_sock {
344 struct inet_request_sock dreq_inet_rsk;
345 __u64 dreq_iss;
346 __u64 dreq_isr;
347 __u32 dreq_service;
348};
349
350static inline struct dccp_request_sock *dccp_rsk(const struct request_sock *req)
351{
352 return (struct dccp_request_sock *)req;
353}
354
64cf1e5d
ACM
355extern struct inet_timewait_death_row dccp_death_row;
356
7c657876 357struct dccp_options_received {
ae31c339 358 u32 dccpor_ndp; /* only 24 bits */
7c657876
ACM
359 u32 dccpor_timestamp;
360 u32 dccpor_timestamp_echo;
361 u32 dccpor_elapsed_time;
362};
363
364struct ccid;
365
366enum dccp_role {
367 DCCP_ROLE_UNDEFINED,
368 DCCP_ROLE_LISTEN,
369 DCCP_ROLE_CLIENT,
370 DCCP_ROLE_SERVER,
371};
372
67e6b629
ACM
373struct dccp_service_list {
374 __u32 dccpsl_nr;
375 __u32 dccpsl_list[0];
376};
377
378#define DCCP_SERVICE_INVALID_VALUE htonl((__u32)-1)
379
380static inline int dccp_list_has_service(const struct dccp_service_list *sl,
381 const u32 service)
382{
383 if (likely(sl != NULL)) {
384 u32 i = sl->dccpsl_nr;
385 while (i--)
386 if (sl->dccpsl_list[i] == service)
387 return 1;
388 }
389 return 0;
390}
391
ae31c339
ACM
392struct dccp_ackvec;
393
7c657876
ACM
394/**
395 * struct dccp_sock - DCCP socket state
396 *
397 * @dccps_swl - sequence number window low
398 * @dccps_swh - sequence number window high
399 * @dccps_awl - acknowledgement number window low
400 * @dccps_awh - acknowledgement number window high
401 * @dccps_iss - initial sequence number sent
402 * @dccps_isr - initial sequence number received
403 * @dccps_osr - first OPEN sequence number received
404 * @dccps_gss - greatest sequence number sent
405 * @dccps_gsr - greatest valid sequence number received
406 * @dccps_gar - greatest valid ack number received on a non-Sync; initialized to %dccps_iss
407 * @dccps_timestamp_time - time of latest TIMESTAMP option
408 * @dccps_timestamp_echo - latest timestamp received on a TIMESTAMP option
409 * @dccps_ext_header_len - network protocol overhead (IP/IPv6 options)
410 * @dccps_pmtu_cookie - Last pmtu seen by socket
a84ffe43 411 * @dccps_packet_size - Set thru setsockopt
7c657876
ACM
412 * @dccps_role - Role of this sock, one of %dccp_role
413 * @dccps_ndp_count - number of Non Data Packets since last data packet
ae31c339 414 * @dccps_hc_rx_ackvec - rx half connection ack vector
7c657876
ACM
415 */
416struct dccp_sock {
417 /* inet_connection_sock has to be the first member of dccp_sock */
418 struct inet_connection_sock dccps_inet_connection;
419 __u64 dccps_swl;
420 __u64 dccps_swh;
421 __u64 dccps_awl;
422 __u64 dccps_awh;
423 __u64 dccps_iss;
424 __u64 dccps_isr;
425 __u64 dccps_osr;
426 __u64 dccps_gss;
427 __u64 dccps_gsr;
428 __u64 dccps_gar;
67e6b629
ACM
429 __u32 dccps_service;
430 struct dccp_service_list *dccps_service_list;
1bc09869 431 struct timeval dccps_timestamp_time;
7c657876 432 __u32 dccps_timestamp_echo;
a84ffe43 433 __u32 dccps_packet_size;
7c657876
ACM
434 unsigned long dccps_ndp_count;
435 __u16 dccps_ext_header_len;
436 __u32 dccps_pmtu_cookie;
437 __u32 dccps_mss_cache;
438 struct dccp_options dccps_options;
ae31c339 439 struct dccp_ackvec *dccps_hc_rx_ackvec;
7c657876
ACM
440 void *dccps_hc_rx_ccid_private;
441 void *dccps_hc_tx_ccid_private;
442 struct ccid *dccps_hc_rx_ccid;
443 struct ccid *dccps_hc_tx_ccid;
444 struct dccp_options_received dccps_options_received;
b0e56780 445 struct timeval dccps_epoch;
7c657876 446 enum dccp_role dccps_role:2;
507d37cf
ACM
447 __u8 dccps_hc_rx_insert_options:1;
448 __u8 dccps_hc_tx_insert_options:1;
7c657876
ACM
449};
450
451static inline struct dccp_sock *dccp_sk(const struct sock *sk)
452{
453 return (struct dccp_sock *)sk;
454}
455
67e6b629
ACM
456static inline int dccp_service_not_initialized(const struct sock *sk)
457{
458 return dccp_sk(sk)->dccps_service == DCCP_SERVICE_INVALID_VALUE;
459}
460
7c657876
ACM
461static inline const char *dccp_role(const struct sock *sk)
462{
463 switch (dccp_sk(sk)->dccps_role) {
464 case DCCP_ROLE_UNDEFINED: return "undefined";
465 case DCCP_ROLE_LISTEN: return "listen";
466 case DCCP_ROLE_SERVER: return "server";
467 case DCCP_ROLE_CLIENT: return "client";
468 }
469 return NULL;
470}
471
5a47a470
HW
472#endif /* __KERNEL__ */
473
7c657876 474#endif /* _LINUX_DCCP_H */