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