]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/dccp.h
[DCCPv6]: Resolve conditional build problem
[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 {
60fe62e7 21 __be16 dccph_sport,
7c657876
ACM
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)
60fe62e7 35 __u8 dccph_x:1,
7c657876 36 dccph_type:4,
60fe62e7 37 dccph_reserved:3;
7c657876 38#elif defined(__BIG_ENDIAN_BITFIELD)
60fe62e7 39 __u8 dccph_reserved:3,
7c657876 40 dccph_type:4,
60fe62e7 41 dccph_x:1;
7c657876
ACM
42#else
43#error "Adjust your <asm/byteorder.h> defines"
44#endif
60fe62e7
AB
45 __u8 dccph_seq2;
46 __be16 dccph_seq;
7c657876
ACM
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 {
60fe62e7 55 __be32 dccph_seq_low;
7c657876
ACM
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 {
60fe62e7 65 __be32 dccph_req_service;
7c657876 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 {
60fe62e7
AB
74 __be16 dccph_reserved1;
75 __be16 dccph_ack_nr_high;
76 __be32 dccph_ack_nr_low;
7c657876 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;
60fe62e7 88 __be32 dccph_resp_service;
7c657876
ACM
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,
afe00251
AB
157 DCCPO_CHANGE_L = 32,
158 DCCPO_CONFIRM_L = 33,
159 DCCPO_CHANGE_R = 34,
160 DCCPO_CONFIRM_R = 35,
7c657876
ACM
161 DCCPO_NDP_COUNT = 37,
162 DCCPO_ACK_VECTOR_0 = 38,
163 DCCPO_ACK_VECTOR_1 = 39,
164 DCCPO_TIMESTAMP = 41,
165 DCCPO_TIMESTAMP_ECHO = 42,
166 DCCPO_ELAPSED_TIME = 43,
167 DCCPO_MAX = 45,
168 DCCPO_MIN_CCID_SPECIFIC = 128,
169 DCCPO_MAX_CCID_SPECIFIC = 255,
170};
171
b83eff64
IM
172/* DCCP CCIDS */
173enum {
174 DCCPC_CCID2 = 2,
175 DCCPC_CCID3 = 3,
176};
177
7c657876
ACM
178/* DCCP features */
179enum {
180 DCCPF_RESERVED = 0,
afe00251 181 DCCPF_CCID = 1,
7c657876 182 DCCPF_SEQUENCE_WINDOW = 3,
afe00251 183 DCCPF_ACK_RATIO = 5,
7c657876
ACM
184 DCCPF_SEND_ACK_VECTOR = 6,
185 DCCPF_SEND_NDP_COUNT = 7,
6f4e5fff 186 DCCPF_MIN_CSUM_COVER = 8,
7c657876
ACM
187 /* 10-127 reserved */
188 DCCPF_MIN_CCID_SPECIFIC = 128,
189 DCCPF_MAX_CCID_SPECIFIC = 255,
190};
191
afe00251
AB
192/* this structure is argument to DCCP_SOCKOPT_CHANGE_X */
193struct dccp_so_feat {
194 __u8 dccpsf_feat;
1acc04cd 195 __u8 __user *dccpsf_val;
afe00251
AB
196 __u8 dccpsf_len;
197};
198
a84ffe43
ACM
199/* DCCP socket options */
200#define DCCP_SOCKOPT_PACKET_SIZE 1
67e6b629 201#define DCCP_SOCKOPT_SERVICE 2
afe00251
AB
202#define DCCP_SOCKOPT_CHANGE_L 3
203#define DCCP_SOCKOPT_CHANGE_R 4
6f4e5fff
GR
204#define DCCP_SOCKOPT_SEND_CSCOV 10
205#define DCCP_SOCKOPT_RECV_CSCOV 11
88f964db
ACM
206#define DCCP_SOCKOPT_CCID_RX_INFO 128
207#define DCCP_SOCKOPT_CCID_TX_INFO 192
67e6b629
ACM
208
209#define DCCP_SERVICE_LIST_MAX_LEN 32
a84ffe43 210
5a47a470
HW
211#ifdef __KERNEL__
212
213#include <linux/in.h>
214#include <linux/list.h>
215#include <linux/uio.h>
216#include <linux/workqueue.h>
217
218#include <net/inet_connection_sock.h>
14c85021 219#include <net/inet_sock.h>
64cf1e5d 220#include <net/inet_timewait_sock.h>
5a47a470 221#include <net/tcp_states.h>
5a47a470
HW
222
223enum dccp_state {
224 DCCP_OPEN = TCP_ESTABLISHED,
225 DCCP_REQUESTING = TCP_SYN_SENT,
226 DCCP_PARTOPEN = TCP_FIN_WAIT1, /* FIXME:
227 This mapping is horrible, but TCP has
228 no matching state for DCCP_PARTOPEN,
229 as TCP_SYN_RECV is already used by
230 DCCP_RESPOND, why don't stop using TCP
231 mapping of states? OK, now we don't use
232 sk_stream_sendmsg anymore, so doesn't
233 seem to exist any reason for us to
234 do the TCP mapping here */
235 DCCP_LISTEN = TCP_LISTEN,
236 DCCP_RESPOND = TCP_SYN_RECV,
237 DCCP_CLOSING = TCP_CLOSING,
238 DCCP_TIME_WAIT = TCP_TIME_WAIT,
239 DCCP_CLOSED = TCP_CLOSE,
240 DCCP_MAX_STATES = TCP_MAX_STATES,
241};
242
243#define DCCP_STATE_MASK 0xf
244#define DCCP_ACTION_FIN (1<<7)
245
246enum {
247 DCCPF_OPEN = TCPF_ESTABLISHED,
248 DCCPF_REQUESTING = TCPF_SYN_SENT,
249 DCCPF_PARTOPEN = TCPF_FIN_WAIT1,
250 DCCPF_LISTEN = TCPF_LISTEN,
251 DCCPF_RESPOND = TCPF_SYN_RECV,
252 DCCPF_CLOSING = TCPF_CLOSING,
253 DCCPF_TIME_WAIT = TCPF_TIME_WAIT,
254 DCCPF_CLOSED = TCPF_CLOSE,
255};
256
257static inline struct dccp_hdr *dccp_hdr(const struct sk_buff *skb)
258{
259 return (struct dccp_hdr *)skb->h.raw;
260}
261
9b42078e
GR
262static inline struct dccp_hdr *dccp_zeroed_hdr(struct sk_buff *skb, int headlen)
263{
264 skb->h.raw = skb_push(skb, headlen);
265 memset(skb->h.raw, 0, headlen);
266 return dccp_hdr(skb);
267}
268
5a47a470
HW
269static inline struct dccp_hdr_ext *dccp_hdrx(const struct sk_buff *skb)
270{
271 return (struct dccp_hdr_ext *)(skb->h.raw + sizeof(struct dccp_hdr));
272}
273
1d3de414
HW
274static inline unsigned int __dccp_basic_hdr_len(const struct dccp_hdr *dh)
275{
276 return sizeof(*dh) + (dh->dccph_x ? sizeof(struct dccp_hdr_ext) : 0);
277}
278
5a47a470
HW
279static inline unsigned int dccp_basic_hdr_len(const struct sk_buff *skb)
280{
281 const struct dccp_hdr *dh = dccp_hdr(skb);
1d3de414 282 return __dccp_basic_hdr_len(dh);
5a47a470
HW
283}
284
285static inline __u64 dccp_hdr_seq(const struct sk_buff *skb)
286{
287 const struct dccp_hdr *dh = dccp_hdr(skb);
60fe62e7 288 __u64 seq_nr = ntohs(dh->dccph_seq);
5a47a470
HW
289
290 if (dh->dccph_x != 0)
291 seq_nr = (seq_nr << 32) + ntohl(dccp_hdrx(skb)->dccph_seq_low);
60fe62e7
AB
292 else
293 seq_nr += (u32)dh->dccph_seq2 << 16;
5a47a470
HW
294
295 return seq_nr;
296}
297
298static inline struct dccp_hdr_request *dccp_hdr_request(struct sk_buff *skb)
299{
300 return (struct dccp_hdr_request *)(skb->h.raw + dccp_basic_hdr_len(skb));
301}
302
303static inline struct dccp_hdr_ack_bits *dccp_hdr_ack_bits(const struct sk_buff *skb)
304{
305 return (struct dccp_hdr_ack_bits *)(skb->h.raw + dccp_basic_hdr_len(skb));
306}
307
308static inline u64 dccp_hdr_ack_seq(const struct sk_buff *skb)
309{
310 const struct dccp_hdr_ack_bits *dhack = dccp_hdr_ack_bits(skb);
60fe62e7 311 return ((u64)ntohs(dhack->dccph_ack_nr_high) << 32) + ntohl(dhack->dccph_ack_nr_low);
5a47a470
HW
312}
313
314static inline struct dccp_hdr_response *dccp_hdr_response(struct sk_buff *skb)
315{
316 return (struct dccp_hdr_response *)(skb->h.raw + dccp_basic_hdr_len(skb));
317}
318
319static inline struct dccp_hdr_reset *dccp_hdr_reset(struct sk_buff *skb)
320{
321 return (struct dccp_hdr_reset *)(skb->h.raw + dccp_basic_hdr_len(skb));
322}
323
1d3de414
HW
324static inline unsigned int __dccp_hdr_len(const struct dccp_hdr *dh)
325{
326 return __dccp_basic_hdr_len(dh) +
327 dccp_packet_hdr_len(dh->dccph_type);
328}
329
5a47a470
HW
330static inline unsigned int dccp_hdr_len(const struct sk_buff *skb)
331{
1d3de414 332 return __dccp_hdr_len(dccp_hdr(skb));
5a47a470
HW
333}
334
335
7c657876
ACM
336/* initial values for each feature */
337#define DCCPF_INITIAL_SEQUENCE_WINDOW 100
afe00251 338#define DCCPF_INITIAL_ACK_RATIO 2
b83eff64 339#define DCCPF_INITIAL_CCID DCCPC_CCID2
2a91aa39 340#define DCCPF_INITIAL_SEND_ACK_VECTOR 1
7c657876
ACM
341/* FIXME: for now we're default to 1 but it should really be 0 */
342#define DCCPF_INITIAL_SEND_NDP_COUNT 1
343
344#define DCCP_NDP_LIMIT 0xFFFFFF
345
346/**
a4bf3902
ACM
347 * struct dccp_minisock - Minimal DCCP connection representation
348 *
349 * Will be used to pass the state from dccp_request_sock to dccp_sock.
350 *
351 * @dccpms_sequence_window - Sequence Window Feature (section 7.5.2)
352 * @dccpms_ccid - Congestion Control Id (CCID) (section 10)
353 * @dccpms_send_ack_vector - Send Ack Vector Feature (section 11.5)
354 * @dccpms_send_ndp_count - Send NDP Count Feature (7.7.2)
7c657876 355 */
a4bf3902
ACM
356struct dccp_minisock {
357 __u64 dccpms_sequence_window;
358 __u8 dccpms_rx_ccid;
359 __u8 dccpms_tx_ccid;
360 __u8 dccpms_send_ack_vector;
361 __u8 dccpms_send_ndp_count;
362 __u8 dccpms_ack_ratio;
363 struct list_head dccpms_pending;
364 struct list_head dccpms_conf;
afe00251
AB
365};
366
367struct dccp_opt_conf {
368 __u8 *dccpoc_val;
369 __u8 dccpoc_len;
370};
371
372struct dccp_opt_pend {
373 struct list_head dccpop_node;
374 __u8 dccpop_type;
375 __u8 dccpop_feat;
376 __u8 *dccpop_val;
377 __u8 dccpop_len;
378 int dccpop_conf;
379 struct dccp_opt_conf *dccpop_sc;
7c657876
ACM
380};
381
a4bf3902
ACM
382extern void __dccp_minisock_init(struct dccp_minisock *dmsk);
383extern void dccp_minisock_init(struct dccp_minisock *dmsk);
384
7c657876
ACM
385extern int dccp_parse_options(struct sock *sk, struct sk_buff *skb);
386
387struct dccp_request_sock {
388 struct inet_request_sock dreq_inet_rsk;
389 __u64 dreq_iss;
390 __u64 dreq_isr;
60fe62e7 391 __be32 dreq_service;
7c657876
ACM
392};
393
394static inline struct dccp_request_sock *dccp_rsk(const struct request_sock *req)
395{
396 return (struct dccp_request_sock *)req;
397}
398
64cf1e5d
ACM
399extern struct inet_timewait_death_row dccp_death_row;
400
7c657876 401struct dccp_options_received {
ae31c339 402 u32 dccpor_ndp; /* only 24 bits */
7c657876
ACM
403 u32 dccpor_timestamp;
404 u32 dccpor_timestamp_echo;
405 u32 dccpor_elapsed_time;
406};
407
408struct ccid;
409
410enum dccp_role {
411 DCCP_ROLE_UNDEFINED,
412 DCCP_ROLE_LISTEN,
413 DCCP_ROLE_CLIENT,
414 DCCP_ROLE_SERVER,
415};
416
67e6b629
ACM
417struct dccp_service_list {
418 __u32 dccpsl_nr;
60fe62e7 419 __be32 dccpsl_list[0];
67e6b629
ACM
420};
421
422#define DCCP_SERVICE_INVALID_VALUE htonl((__u32)-1)
00e4d116 423#define DCCP_SERVICE_CODE_IS_ABSENT 0
67e6b629
ACM
424
425static inline int dccp_list_has_service(const struct dccp_service_list *sl,
60fe62e7 426 const __be32 service)
67e6b629
ACM
427{
428 if (likely(sl != NULL)) {
429 u32 i = sl->dccpsl_nr;
430 while (i--)
431 if (sl->dccpsl_list[i] == service)
432 return 1;
433 }
434 return 0;
435}
436
ae31c339
ACM
437struct dccp_ackvec;
438
7c657876
ACM
439/**
440 * struct dccp_sock - DCCP socket state
441 *
442 * @dccps_swl - sequence number window low
443 * @dccps_swh - sequence number window high
444 * @dccps_awl - acknowledgement number window low
445 * @dccps_awh - acknowledgement number window high
446 * @dccps_iss - initial sequence number sent
447 * @dccps_isr - initial sequence number received
448 * @dccps_osr - first OPEN sequence number received
449 * @dccps_gss - greatest sequence number sent
450 * @dccps_gsr - greatest valid sequence number received
451 * @dccps_gar - greatest valid ack number received on a non-Sync; initialized to %dccps_iss
452 * @dccps_timestamp_time - time of latest TIMESTAMP option
453 * @dccps_timestamp_echo - latest timestamp received on a TIMESTAMP option
a84ffe43 454 * @dccps_packet_size - Set thru setsockopt
7c657876 455 * @dccps_role - Role of this sock, one of %dccp_role
6f4e5fff
GR
456 * @dccps_pcslen - sender partial checksum coverage (via sockopt)
457 * @dccps_pcrlen - receiver partial checksum coverage (via sockopt)
7c657876 458 * @dccps_ndp_count - number of Non Data Packets since last data packet
ae31c339 459 * @dccps_hc_rx_ackvec - rx half connection ack vector
97e5848d 460 * @dccps_xmit_timer - timer for when CCID is not ready to send
7c657876
ACM
461 */
462struct dccp_sock {
463 /* inet_connection_sock has to be the first member of dccp_sock */
464 struct inet_connection_sock dccps_inet_connection;
465 __u64 dccps_swl;
466 __u64 dccps_swh;
467 __u64 dccps_awl;
468 __u64 dccps_awh;
469 __u64 dccps_iss;
470 __u64 dccps_isr;
471 __u64 dccps_osr;
472 __u64 dccps_gss;
473 __u64 dccps_gsr;
474 __u64 dccps_gar;
60fe62e7 475 __be32 dccps_service;
67e6b629 476 struct dccp_service_list *dccps_service_list;
1bc09869 477 struct timeval dccps_timestamp_time;
7c657876 478 __u32 dccps_timestamp_echo;
a84ffe43 479 __u32 dccps_packet_size;
2a91aa39
AB
480 __u16 dccps_l_ack_ratio;
481 __u16 dccps_r_ack_ratio;
6f4e5fff
GR
482 __u16 dccps_pcslen;
483 __u16 dccps_pcrlen;
7c657876 484 unsigned long dccps_ndp_count;
7c657876 485 __u32 dccps_mss_cache;
a4bf3902 486 struct dccp_minisock dccps_minisock;
ae31c339 487 struct dccp_ackvec *dccps_hc_rx_ackvec;
7c657876
ACM
488 struct ccid *dccps_hc_rx_ccid;
489 struct ccid *dccps_hc_tx_ccid;
490 struct dccp_options_received dccps_options_received;
b0e56780 491 struct timeval dccps_epoch;
7c657876 492 enum dccp_role dccps_role:2;
507d37cf
ACM
493 __u8 dccps_hc_rx_insert_options:1;
494 __u8 dccps_hc_tx_insert_options:1;
97e5848d 495 struct timer_list dccps_xmit_timer;
7c657876
ACM
496};
497
498static inline struct dccp_sock *dccp_sk(const struct sock *sk)
499{
500 return (struct dccp_sock *)sk;
501}
502
a4bf3902
ACM
503static inline struct dccp_minisock *dccp_msk(const struct sock *sk)
504{
505 return (struct dccp_minisock *)&dccp_sk(sk)->dccps_minisock;
506}
507
7c657876
ACM
508static inline const char *dccp_role(const struct sock *sk)
509{
510 switch (dccp_sk(sk)->dccps_role) {
511 case DCCP_ROLE_UNDEFINED: return "undefined";
512 case DCCP_ROLE_LISTEN: return "listen";
513 case DCCP_ROLE_SERVER: return "server";
514 case DCCP_ROLE_CLIENT: return "client";
515 }
516 return NULL;
517}
518
5a47a470
HW
519#endif /* __KERNEL__ */
520
7c657876 521#endif /* _LINUX_DCCP_H */