SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/dccp.h

   1 #ifndef _LINUX_DCCP_H
   2 #define _LINUX_DCCP_H
   3
   4 #include <linux/types.h>
   5 #include <asm/byteorder.h>
   6
   7 /* Structure describing an Internet (DCCP) socket address. */
   8 struct sockaddr_dccp {
   9         __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;
  15 };
  16
  17 /**
  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  */
  30 struct 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
  59 /**
  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  */
  64 struct dccp_hdr_ext {
  65         __u32   dccph_seq_low;
  66 };
  67
  68 /**
  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  */
  74 struct dccp_hdr_request {
  75         __u32   dccph_req_service;
  76 };
  77 /**
  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  */
  83 struct dccp_hdr_ack_bits {
  84         __u32   dccph_reserved1:8,
  85                 dccph_ack_nr_high:24;
  86         __u32   dccph_ack_nr_low;
  87 };
  88 /**
  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  */
  96 struct dccp_hdr_response {
  97         struct dccp_hdr_ack_bits        dccph_resp_ack;
  98         __u32                           dccph_resp_service;
  99 };
 100
 101 /**
 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  */
 107 struct dccp_hdr_reset {
 108         struct dccp_hdr_ack_bits        dccph_reset_ack;
 109         __u8                            dccph_reset_code,
 110                                         dccph_reset_data[3];
 111 };
 112
 113 enum 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
 129 static 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 }
 146 enum 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 */
 162 enum {
 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 */
 179 enum {
 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
 189 #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>
 197 #include <net/sock.h>
 198 #include <net/tcp_states.h>
 199 #include <net/tcp.h>
 200
 201 enum dccp_state {
 202         DCCP_OPEN       = TCP_ESTABLISHED,
 203         DCCP_REQUESTING = TCP_SYN_SENT,
 204         DCCP_PARTOPEN   = TCP_FIN_WAIT1, /* FIXME:
 205                                             This mapping is horrible, but TCP has
 206                                             no matching state for DCCP_PARTOPEN,
 207                                             as TCP_SYN_RECV is already used by
 208                                             DCCP_RESPOND, why don't stop using TCP
 209                                             mapping of states? OK, now we don't use
 210                                             sk_stream_sendmsg anymore, so doesn't
 211                                             seem to exist any reason for us to
 212                                             do the TCP mapping here */
 213         DCCP_LISTEN     = TCP_LISTEN,
 214         DCCP_RESPOND    = TCP_SYN_RECV,
 215         DCCP_CLOSING    = TCP_CLOSING,
 216         DCCP_TIME_WAIT  = TCP_TIME_WAIT,
 217         DCCP_CLOSED     = TCP_CLOSE,
 218         DCCP_MAX_STATES = TCP_MAX_STATES,
 219 };
 220
 221 #define DCCP_STATE_MASK 0xf
 222 #define DCCP_ACTION_FIN (1<<7)
 223
 224 enum {
 225         DCCPF_OPEN       = TCPF_ESTABLISHED,
 226         DCCPF_REQUESTING = TCPF_SYN_SENT,
 227         DCCPF_PARTOPEN   = TCPF_FIN_WAIT1,
 228         DCCPF_LISTEN     = TCPF_LISTEN,
 229         DCCPF_RESPOND    = TCPF_SYN_RECV,
 230         DCCPF_CLOSING    = TCPF_CLOSING,
 231         DCCPF_TIME_WAIT  = TCPF_TIME_WAIT,
 232         DCCPF_CLOSED     = TCPF_CLOSE,
 233 };
 234
 235 static inline struct dccp_hdr *dccp_hdr(const struct sk_buff *skb)
 236 {
 237         return (struct dccp_hdr *)skb->h.raw;
 238 }
 239
 240 static inline struct dccp_hdr_ext *dccp_hdrx(const struct sk_buff *skb)
 241 {
 242         return (struct dccp_hdr_ext *)(skb->h.raw + sizeof(struct dccp_hdr));
 243 }
 244
 245 static inline unsigned int __dccp_basic_hdr_len(const struct dccp_hdr *dh)
 246 {
 247         return sizeof(*dh) + (dh->dccph_x ? sizeof(struct dccp_hdr_ext) : 0);
 248 }
 249
 250 static inline unsigned int dccp_basic_hdr_len(const struct sk_buff *skb)
 251 {
 252         const struct dccp_hdr *dh = dccp_hdr(skb);
 253         return __dccp_basic_hdr_len(dh);
 254 }
 255
 256 static inline __u64 dccp_hdr_seq(const struct sk_buff *skb)
 257 {
 258         const struct dccp_hdr *dh = dccp_hdr(skb);
 259 #if defined(__LITTLE_ENDIAN_BITFIELD)
 260         __u64 seq_nr = ntohl(dh->dccph_seq << 8);
 261 #elif defined(__BIG_ENDIAN_BITFIELD)
 262         __u64 seq_nr = ntohl(dh->dccph_seq);
 263 #else
 264 #error  "Adjust your <asm/byteorder.h> defines"
 265 #endif
 266
 267         if (dh->dccph_x != 0)
 268                 seq_nr = (seq_nr << 32) + ntohl(dccp_hdrx(skb)->dccph_seq_low);
 269
 270         return seq_nr;
 271 }
 272
 273 static inline struct dccp_hdr_request *dccp_hdr_request(struct sk_buff *skb)
 274 {
 275         return (struct dccp_hdr_request *)(skb->h.raw + dccp_basic_hdr_len(skb));
 276 }
 277
 278 static inline struct dccp_hdr_ack_bits *dccp_hdr_ack_bits(const struct sk_buff *skb)
 279 {
 280         return (struct dccp_hdr_ack_bits *)(skb->h.raw + dccp_basic_hdr_len(skb));
 281 }
 282
 283 static inline u64 dccp_hdr_ack_seq(const struct sk_buff *skb)
 284 {
 285         const struct dccp_hdr_ack_bits *dhack = dccp_hdr_ack_bits(skb);
 286 #if defined(__LITTLE_ENDIAN_BITFIELD)
 287         return (((u64)ntohl(dhack->dccph_ack_nr_high << 8)) << 32) + ntohl(dhack->dccph_ack_nr_low);
 288 #elif defined(__BIG_ENDIAN_BITFIELD)
 289         return (((u64)ntohl(dhack->dccph_ack_nr_high)) << 32) + ntohl(dhack->dccph_ack_nr_low);
 290 #else
 291 #error  "Adjust your <asm/byteorder.h> defines"
 292 #endif
 293 }
 294
 295 static inline struct dccp_hdr_response *dccp_hdr_response(struct sk_buff *skb)
 296 {
 297         return (struct dccp_hdr_response *)(skb->h.raw + dccp_basic_hdr_len(skb));
 298 }
 299
 300 static inline struct dccp_hdr_reset *dccp_hdr_reset(struct sk_buff *skb)
 301 {
 302         return (struct dccp_hdr_reset *)(skb->h.raw + dccp_basic_hdr_len(skb));
 303 }
 304
 305 static inline unsigned int __dccp_hdr_len(const struct dccp_hdr *dh)
 306 {
 307         return __dccp_basic_hdr_len(dh) +
 308                dccp_packet_hdr_len(dh->dccph_type);
 309 }
 310
 311 static inline unsigned int dccp_hdr_len(const struct sk_buff *skb)
 312 {
 313         return __dccp_hdr_len(dccp_hdr(skb));
 314 }
 315
 316
 317 /* initial values for each feature */
 318 #define DCCPF_INITIAL_SEQUENCE_WINDOW           100
 319 /* FIXME: for now we're using CCID 3 (TFRC) */
 320 #define DCCPF_INITIAL_CCID                      3
 321 #define DCCPF_INITIAL_SEND_ACK_VECTOR           0
 322 /* FIXME: for now we're default to 1 but it should really be 0 */
 323 #define DCCPF_INITIAL_SEND_NDP_COUNT            1
 324
 325 #define DCCP_NDP_LIMIT 0xFFFFFF
 326
 327 /**
 328   * struct dccp_options - option values for a DCCP connection
 329   *     @dccpo_sequence_window - Sequence Window Feature (section 7.5.2)
 330   *     @dccpo_ccid - Congestion Control Id (CCID) (section 10)
 331   *     @dccpo_send_ack_vector - Send Ack Vector Feature (section 11.5)
 332   *     @dccpo_send_ndp_count - Send NDP Count Feature (7.7.2)
 333   */
 334 struct dccp_options {
 335         __u64   dccpo_sequence_window;
 336         __u8    dccpo_ccid;
 337         __u8    dccpo_send_ack_vector;
 338         __u8    dccpo_send_ndp_count;
 339 };
 340
 341 extern void __dccp_options_init(struct dccp_options *dccpo);
 342 extern void dccp_options_init(struct dccp_options *dccpo);
 343 extern int dccp_parse_options(struct sock *sk, struct sk_buff *skb);
 344
 345 struct dccp_request_sock {
 346         struct inet_request_sock dreq_inet_rsk;
 347         __u64                    dreq_iss;
 348         __u64                    dreq_isr;
 349         __u32                    dreq_service;
 350 };
 351
 352 static inline struct dccp_request_sock *dccp_rsk(const struct request_sock *req)
 353 {
 354         return (struct dccp_request_sock *)req;
 355 }
 356
 357 /* Read about the ECN nonce to see why it is 253 */
 358 #define DCCP_MAX_ACK_VECTOR_LEN 253
 359
 360 struct dccp_options_received {
 361         u32     dccpor_ndp:24,
 362                 dccpor_ack_vector_len:8;
 363         u32     dccpor_ack_vector_idx:10;
 364         /* 22 bits hole, try to pack */
 365         u32     dccpor_timestamp;
 366         u32     dccpor_timestamp_echo;
 367         u32     dccpor_elapsed_time;
 368 };
 369
 370 struct ccid;
 371
 372 enum dccp_role {
 373         DCCP_ROLE_UNDEFINED,
 374         DCCP_ROLE_LISTEN,
 375         DCCP_ROLE_CLIENT,
 376         DCCP_ROLE_SERVER,
 377 };
 378
 379 /**
 380  * struct dccp_sock - DCCP socket state
 381  *
 382  * @dccps_swl - sequence number window low
 383  * @dccps_swh - sequence number window high
 384  * @dccps_awl - acknowledgement number window low
 385  * @dccps_awh - acknowledgement number window high
 386  * @dccps_iss - initial sequence number sent
 387  * @dccps_isr - initial sequence number received
 388  * @dccps_osr - first OPEN sequence number received
 389  * @dccps_gss - greatest sequence number sent
 390  * @dccps_gsr - greatest valid sequence number received
 391  * @dccps_gar - greatest valid ack number received on a non-Sync; initialized to %dccps_iss
 392  * @dccps_timestamp_time - time of latest TIMESTAMP option
 393  * @dccps_timestamp_echo - latest timestamp received on a TIMESTAMP option
 394  * @dccps_ext_header_len - network protocol overhead (IP/IPv6 options)
 395  * @dccps_pmtu_cookie - Last pmtu seen by socket
 396  * @dccps_avg_packet_size - FIXME: has to be set by the app thru some setsockopt or ioctl, CCID3 uses it
 397  * @dccps_role - Role of this sock, one of %dccp_role
 398  * @dccps_ndp_count - number of Non Data Packets since last data packet
 399  * @dccps_hc_rx_ackpkts - receiver half connection acked packets
 400  */
 401 struct dccp_sock {
 402         /* inet_connection_sock has to be the first member of dccp_sock */
 403         struct inet_connection_sock     dccps_inet_connection;
 404         __u64                           dccps_swl;
 405         __u64                           dccps_swh;
 406         __u64                           dccps_awl;
 407         __u64                           dccps_awh;
 408         __u64                           dccps_iss;
 409         __u64                           dccps_isr;
 410         __u64                           dccps_osr;
 411         __u64                           dccps_gss;
 412         __u64                           dccps_gsr;
 413         __u64                           dccps_gar;
 414         unsigned long                   dccps_service;
 415         unsigned long                   dccps_timestamp_time;
 416         __u32                           dccps_timestamp_echo;
 417         __u32                           dccps_avg_packet_size;
 418         unsigned long                   dccps_ndp_count;
 419         __u16                           dccps_ext_header_len;
 420         __u32                           dccps_pmtu_cookie;
 421         __u32                           dccps_mss_cache;
 422         struct dccp_options             dccps_options;
 423         struct dccp_ackpkts             *dccps_hc_rx_ackpkts;
 424         void                            *dccps_hc_rx_ccid_private;
 425         void                            *dccps_hc_tx_ccid_private;
 426         struct ccid                     *dccps_hc_rx_ccid;
 427         struct ccid                     *dccps_hc_tx_ccid;
 428         struct dccp_options_received    dccps_options_received;
 429         enum dccp_role                  dccps_role:2;
 430 };
 431
 432 static inline struct dccp_sock *dccp_sk(const struct sock *sk)
 433 {
 434         return (struct dccp_sock *)sk;
 435 }
 436
 437 static inline const char *dccp_role(const struct sock *sk)
 438 {
 439         switch (dccp_sk(sk)->dccps_role) {
 440         case DCCP_ROLE_UNDEFINED: return "undefined";
 441         case DCCP_ROLE_LISTEN:    return "listen";
 442         case DCCP_ROLE_SERVER:    return "server";
 443         case DCCP_ROLE_CLIENT:    return "client";
 444         }
 445         return NULL;
 446 }
 447
 448 #endif /* __KERNEL__ */
 449
 450 #endif /* _LINUX_DCCP_H */