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

   1 #ifndef _DCCP_H
   2 #define _DCCP_H
   3 /*
   4  *  net/dccp/dccp.h
   5  *
   6  *  An implementation of the DCCP protocol
   7  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
   8  *  Copyright (c) 2005 Ian McDonald <iam4@cs.waikato.ac.nz>
   9  *
  10  *      This program is free software; you can redistribute it and/or modify it
  11  *      under the terms of the GNU General Public License version 2 as
  12  *      published by the Free Software Foundation.
  13  */
  14
  15 #include <linux/config.h>
  16 #include <linux/dccp.h>
  17 #include <net/snmp.h>
  18 #include <net/sock.h>
  19 #include <net/tcp.h>
  20
  21 #ifdef CONFIG_IP_DCCP_DEBUG
  22 extern int dccp_debug;
  23
  24 #define dccp_pr_debug(format, a...) \
  25         do { if (dccp_debug) \
  26                 printk(KERN_DEBUG "%s: " format, __FUNCTION__ , ##a); \
  27         } while (0)
  28 #define dccp_pr_debug_cat(format, a...) do { if (dccp_debug) \
  29                                              printk(format, ##a); } while (0)
  30 #else
  31 #define dccp_pr_debug(format, a...)
  32 #define dccp_pr_debug_cat(format, a...)
  33 #endif
  34
  35 extern struct inet_hashinfo dccp_hashinfo;
  36
  37 extern atomic_t dccp_orphan_count;
  38 extern int dccp_tw_count;
  39 extern void dccp_tw_deschedule(struct inet_timewait_sock *tw);
  40
  41 extern void dccp_time_wait(struct sock *sk, int state, int timeo);
  42
  43 /* FIXME: Right size this */
  44 #define DCCP_MAX_OPT_LEN 128
  45
  46 #define DCCP_MAX_PACKET_HDR 32
  47
  48 #define MAX_DCCP_HEADER  (DCCP_MAX_PACKET_HDR + DCCP_MAX_OPT_LEN + MAX_HEADER)
  49
  50 #define DCCP_TIMEWAIT_LEN (60 * HZ) /* how long to wait to destroy TIME-WAIT
  51                                      * state, about 60 seconds */
  52
  53 /* draft-ietf-dccp-spec-11.txt initial RTO value */
  54 #define DCCP_TIMEOUT_INIT ((unsigned)(3 * HZ))
  55
  56 /* Maximal interval between probes for local resources.  */
  57 #define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
  58
  59 #define DCCP_RTO_MAX ((unsigned)(120 * HZ)) /* FIXME: using TCP value */
  60
  61 extern struct proto dccp_v4_prot;
  62
  63 /* is seq1 < seq2 ? */
  64 static inline int before48(const u64 seq1, const u64 seq2)
  65 {
  66         return (s64)((seq1 << 16) - (seq2 << 16)) < 0;
  67 }
  68
  69 /* is seq1 > seq2 ? */
  70 static inline int after48(const u64 seq1, const u64 seq2)
  71 {
  72         return (s64)((seq2 << 16) - (seq1 << 16)) < 0;
  73 }
  74
  75 /* is seq2 <= seq1 <= seq3 ? */
  76 static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
  77 {
  78         return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
  79 }
  80
  81 static inline u64 max48(const u64 seq1, const u64 seq2)
  82 {
  83         return after48(seq1, seq2) ? seq1 : seq2;
  84 }
  85
  86 enum {
  87         DCCP_MIB_NUM = 0,
  88         DCCP_MIB_ACTIVEOPENS,                   /* ActiveOpens */
  89         DCCP_MIB_ESTABRESETS,                   /* EstabResets */
  90         DCCP_MIB_CURRESTAB,                     /* CurrEstab */
  91         DCCP_MIB_OUTSEGS,                       /* OutSegs */
  92         DCCP_MIB_OUTRSTS,
  93         DCCP_MIB_ABORTONTIMEOUT,
  94         DCCP_MIB_TIMEOUTS,
  95         DCCP_MIB_ABORTFAILED,
  96         DCCP_MIB_PASSIVEOPENS,
  97         DCCP_MIB_ATTEMPTFAILS,
  98         DCCP_MIB_OUTDATAGRAMS,
  99         DCCP_MIB_INERRS,
 100         DCCP_MIB_OPTMANDATORYERROR,
 101         DCCP_MIB_INVALIDOPT,
 102         __DCCP_MIB_MAX
 103 };
 104
 105 #define DCCP_MIB_MAX    __DCCP_MIB_MAX
 106 struct dccp_mib {
 107         unsigned long   mibs[DCCP_MIB_MAX];
 108 } __SNMP_MIB_ALIGN__;
 109
 110 DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
 111 #define DCCP_INC_STATS(field)       SNMP_INC_STATS(dccp_statistics, field)
 112 #define DCCP_INC_STATS_BH(field)    SNMP_INC_STATS_BH(dccp_statistics, field)
 113 #define DCCP_INC_STATS_USER(field)  SNMP_INC_STATS_USER(dccp_statistics, field)
 114 #define DCCP_DEC_STATS(field)       SNMP_DEC_STATS(dccp_statistics, field)
 115 #define DCCP_ADD_STATS_BH(field, val) \
 116                         SNMP_ADD_STATS_BH(dccp_statistics, field, val)
 117 #define DCCP_ADD_STATS_USER(field, val) \
 118                         SNMP_ADD_STATS_USER(dccp_statistics, field, val)
 119
 120 extern int  dccp_transmit_skb(struct sock *sk, struct sk_buff *skb);
 121 extern int  dccp_retransmit_skb(struct sock *sk, struct sk_buff *skb);
 122
 123 extern int dccp_send_response(struct sock *sk);
 124 extern void dccp_send_ack(struct sock *sk);
 125 extern void dccp_send_delayed_ack(struct sock *sk);
 126 extern void dccp_send_sync(struct sock *sk, const u64 seq,
 127                            const enum dccp_pkt_type pkt_type);
 128
 129 extern int dccp_write_xmit(struct sock *sk, struct sk_buff *skb, long *timeo);
 130
 131 extern void dccp_init_xmit_timers(struct sock *sk);
 132 static inline void dccp_clear_xmit_timers(struct sock *sk)
 133 {
 134         inet_csk_clear_xmit_timers(sk);
 135 }
 136
 137 extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
 138
 139 extern const char *dccp_packet_name(const int type);
 140 extern const char *dccp_state_name(const int state);
 141
 142 static inline void dccp_set_state(struct sock *sk, const int state)
 143 {
 144         const int oldstate = sk->sk_state;
 145
 146         dccp_pr_debug("%s(%p) %-10.10s -> %s\n",
 147                       dccp_role(sk), sk,
 148                       dccp_state_name(oldstate), dccp_state_name(state));
 149         WARN_ON(state == oldstate);
 150
 151         switch (state) {
 152         case DCCP_OPEN:
 153                 if (oldstate != DCCP_OPEN)
 154                         DCCP_INC_STATS(DCCP_MIB_CURRESTAB);
 155                 break;
 156
 157         case DCCP_CLOSED:
 158                 if (oldstate == DCCP_CLOSING || oldstate == DCCP_OPEN)
 159                         DCCP_INC_STATS(DCCP_MIB_ESTABRESETS);
 160
 161                 sk->sk_prot->unhash(sk);
 162                 if (inet_csk(sk)->icsk_bind_hash != NULL &&
 163                     !(sk->sk_userlocks & SOCK_BINDPORT_LOCK))
 164                         inet_put_port(&dccp_hashinfo, sk);
 165                 /* fall through */
 166         default:
 167                 if (oldstate == DCCP_OPEN)
 168                         DCCP_DEC_STATS(DCCP_MIB_CURRESTAB);
 169         }
 170
 171         /* Change state AFTER socket is unhashed to avoid closed
 172          * socket sitting in hash tables.
 173          */
 174         sk->sk_state = state;
 175 }
 176
 177 static inline void dccp_done(struct sock *sk)
 178 {
 179         dccp_set_state(sk, DCCP_CLOSED);
 180         dccp_clear_xmit_timers(sk);
 181
 182         sk->sk_shutdown = SHUTDOWN_MASK;
 183
 184         if (!sock_flag(sk, SOCK_DEAD))
 185                 sk->sk_state_change(sk);
 186         else
 187                 inet_csk_destroy_sock(sk);
 188 }
 189
 190 static inline void dccp_openreq_init(struct request_sock *req,
 191                                      struct dccp_sock *dp,
 192                                      struct sk_buff *skb)
 193 {
 194         /*
 195          * FIXME: fill in the other req fields from the DCCP options
 196          * received
 197          */
 198         inet_rsk(req)->rmt_port = dccp_hdr(skb)->dccph_sport;
 199         inet_rsk(req)->acked    = 0;
 200         req->rcv_wnd = 0;
 201 }
 202
 203 extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
 204
 205 extern struct sock *dccp_create_openreq_child(struct sock *sk,
 206                                               const struct request_sock *req,
 207                                               const struct sk_buff *skb);
 208
 209 extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
 210
 211 extern void dccp_v4_err(struct sk_buff *skb, u32);
 212
 213 extern int dccp_v4_rcv(struct sk_buff *skb);
 214
 215 extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
 216                                               struct sk_buff *skb,
 217                                               struct request_sock *req,
 218                                               struct dst_entry *dst);
 219 extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
 220                                    struct request_sock *req,
 221                                    struct request_sock **prev);
 222
 223 extern int dccp_child_process(struct sock *parent, struct sock *child,
 224                               struct sk_buff *skb);
 225 extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
 226                                   struct dccp_hdr *dh, unsigned len);
 227 extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
 228                                 const struct dccp_hdr *dh, const unsigned len);
 229
 230 extern void             dccp_close(struct sock *sk, long timeout);
 231 extern struct sk_buff   *dccp_make_response(struct sock *sk,
 232                                             struct dst_entry *dst,
 233                                             struct request_sock *req);
 234 extern struct sk_buff   *dccp_make_reset(struct sock *sk,
 235                                          struct dst_entry *dst,
 236                                          enum dccp_reset_codes code);
 237
 238 extern int         dccp_connect(struct sock *sk);
 239 extern int         dccp_disconnect(struct sock *sk, int flags);
 240 extern int         dccp_getsockopt(struct sock *sk, int level, int optname,
 241                                    char __user *optval, int __user *optlen);
 242 extern int         dccp_setsockopt(struct sock *sk, int level, int optname,
 243                                    char __user *optval, int optlen);
 244 extern int         dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
 245 extern int         dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
 246                                 struct msghdr *msg, size_t size);
 247 extern int         dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
 248                                 struct msghdr *msg, size_t len, int nonblock,
 249                                 int flags, int *addr_len);
 250 extern void        dccp_shutdown(struct sock *sk, int how);
 251
 252 extern int         dccp_v4_checksum(const struct sk_buff *skb,
 253                                     const u32 saddr, const u32 daddr);
 254
 255 extern int         dccp_v4_send_reset(struct sock *sk,
 256                                       enum dccp_reset_codes code);
 257 extern void        dccp_send_close(struct sock *sk, const int active);
 258
 259 struct dccp_skb_cb {
 260         __u8 dccpd_type;
 261         __u8 dccpd_reset_code;
 262         __u8 dccpd_service;
 263         __u8 dccpd_ccval;
 264         __u64 dccpd_seq;
 265         __u64 dccpd_ack_seq;
 266         int  dccpd_opt_len;
 267 };
 268
 269 #define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
 270
 271 static inline int dccp_non_data_packet(const struct sk_buff *skb)
 272 {
 273         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 274
 275         return type == DCCP_PKT_ACK      ||
 276                type == DCCP_PKT_CLOSE    ||
 277                type == DCCP_PKT_CLOSEREQ ||
 278                type == DCCP_PKT_RESET    ||
 279                type == DCCP_PKT_SYNC     ||
 280                type == DCCP_PKT_SYNCACK;
 281 }
 282
 283 static inline int dccp_packet_without_ack(const struct sk_buff *skb)
 284 {
 285         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 286
 287         return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
 288 }
 289
 290 #define DCCP_MAX_SEQNO ((((u64)1) << 48) - 1)
 291 #define DCCP_PKT_WITHOUT_ACK_SEQ (DCCP_MAX_SEQNO << 2)
 292
 293 static inline void dccp_set_seqno(u64 *seqno, u64 value)
 294 {
 295         if (value > DCCP_MAX_SEQNO)
 296                 value -= DCCP_MAX_SEQNO + 1;
 297         *seqno = value;
 298 }
 299
 300 static inline u64 dccp_delta_seqno(u64 seqno1, u64 seqno2)
 301 {
 302         return ((seqno2 << 16) - (seqno1 << 16)) >> 16;
 303 }
 304
 305 static inline void dccp_inc_seqno(u64 *seqno)
 306 {
 307         if (++*seqno > DCCP_MAX_SEQNO)
 308                 *seqno = 0;
 309 }
 310
 311 static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
 312 {
 313         struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
 314                                                            sizeof(*dh));
 315
 316 #if defined(__LITTLE_ENDIAN_BITFIELD)
 317         dh->dccph_seq      = htonl((gss >> 32)) >> 8;
 318 #elif defined(__BIG_ENDIAN_BITFIELD)
 319         dh->dccph_seq      = htonl((gss >> 32));
 320 #else
 321 #error  "Adjust your <asm/byteorder.h> defines"
 322 #endif
 323         dhx->dccph_seq_low = htonl(gss & 0xffffffff);
 324 }
 325
 326 static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
 327                                     const u64 gsr)
 328 {
 329 #if defined(__LITTLE_ENDIAN_BITFIELD)
 330         dhack->dccph_ack_nr_high = htonl((gsr >> 32)) >> 8;
 331 #elif defined(__BIG_ENDIAN_BITFIELD)
 332         dhack->dccph_ack_nr_high = htonl((gsr >> 32));
 333 #else
 334 #error  "Adjust your <asm/byteorder.h> defines"
 335 #endif
 336         dhack->dccph_ack_nr_low  = htonl(gsr & 0xffffffff);
 337 }
 338
 339 static inline void dccp_update_gsr(struct sock *sk, u64 seq)
 340 {
 341         struct dccp_sock *dp = dccp_sk(sk);
 342
 343         dp->dccps_gsr = seq;
 344         dccp_set_seqno(&dp->dccps_swl,
 345                        (dp->dccps_gsr + 1 -
 346                         (dp->dccps_options.dccpo_sequence_window / 4)));
 347         dccp_set_seqno(&dp->dccps_swh,
 348                        (dp->dccps_gsr +
 349                         (3 * dp->dccps_options.dccpo_sequence_window) / 4));
 350 }
 351
 352 static inline void dccp_update_gss(struct sock *sk, u64 seq)
 353 {
 354         struct dccp_sock *dp = dccp_sk(sk);
 355
 356         dp->dccps_awh = dp->dccps_gss = seq;
 357         dccp_set_seqno(&dp->dccps_awl,
 358                        (dp->dccps_gss -
 359                         dp->dccps_options.dccpo_sequence_window + 1));
 360 }
 361
 362 extern void dccp_insert_options(struct sock *sk, struct sk_buff *skb);
 363 extern void dccp_insert_option_elapsed_time(struct sock *sk,
 364                                             struct sk_buff *skb,
 365                                             u32 elapsed_time);
 366 extern void dccp_insert_option_timestamp(struct sock *sk,
 367                                          struct sk_buff *skb);
 368 extern void dccp_insert_option(struct sock *sk, struct sk_buff *skb,
 369                                unsigned char option,
 370                                const void *value, unsigned char len);
 371
 372 extern struct socket *dccp_ctl_socket;
 373
 374 #define DCCP_ACKPKTS_STATE_RECEIVED     0
 375 #define DCCP_ACKPKTS_STATE_ECN_MARKED   (1 << 6)
 376 #define DCCP_ACKPKTS_STATE_NOT_RECEIVED (3 << 6)
 377
 378 #define DCCP_ACKPKTS_STATE_MASK         0xC0 /* 11000000 */
 379 #define DCCP_ACKPKTS_LEN_MASK           0x3F /* 00111111 */
 380
 381 /** struct dccp_ackpkts - acknowledgeable packets
 382  *
 383  * This data structure is the one defined in the DCCP draft
 384  * Appendix A.
 385  *
 386  * @dccpap_buf_head - circular buffer head
 387  * @dccpap_buf_tail - circular buffer tail
 388  * @dccpap_buf_ackno - ack # of the most recent packet acknowledgeable in the
 389  *                     buffer (i.e. %dccpap_buf_head)
 390  * @dccpap_buf_nonce - the one-bit sum of the ECN Nonces on all packets acked
 391  *                     by the buffer with State 0
 392  *
 393  * Additionally, the HC-Receiver must keep some information about the
 394  * Ack Vectors it has recently sent. For each packet sent carrying an
 395  * Ack Vector, it remembers four variables:
 396  *
 397  * @dccpap_ack_seqno - the Sequence Number used for the packet
 398  *                     (HC-Receiver seqno)
 399  * @dccpap_ack_ptr - the value of buf_head at the time of acknowledgement.
 400  * @dccpap_ack_ackno - the Acknowledgement Number used for the packet
 401  *                     (HC-Sender seqno)
 402  * @dccpap_ack_nonce - the one-bit sum of the ECN Nonces for all State 0.
 403  *
 404  * @dccpap_buf_len - circular buffer length
 405  * @dccpap_time         - the time in usecs
 406  * @dccpap_buf - circular buffer of acknowledgeable packets
 407  */
 408 struct dccp_ackpkts {
 409         unsigned int            dccpap_buf_head;
 410         unsigned int            dccpap_buf_tail;
 411         u64                     dccpap_buf_ackno;
 412         u64                     dccpap_ack_seqno;
 413         u64                     dccpap_ack_ackno;
 414         unsigned int            dccpap_ack_ptr;
 415         unsigned int            dccpap_buf_vector_len;
 416         unsigned int            dccpap_ack_vector_len;
 417         unsigned int            dccpap_buf_len;
 418         struct timeval          dccpap_time;
 419         u8                      dccpap_buf_nonce;
 420         u8                      dccpap_ack_nonce;
 421         u8                      dccpap_buf[0];
 422 };
 423
 424 extern struct dccp_ackpkts *
 425                 dccp_ackpkts_alloc(unsigned int len,
 426                                   const unsigned int __nocast priority);
 427 extern void dccp_ackpkts_free(struct dccp_ackpkts *ap);
 428 extern int dccp_ackpkts_add(struct dccp_ackpkts *ap, u64 ackno, u8 state);
 429 extern void dccp_ackpkts_check_rcv_ackno(struct dccp_ackpkts *ap,
 430                                          struct sock *sk, u64 ackno);
 431
 432 static inline suseconds_t timeval_usecs(const struct timeval *tv)
 433 {
 434         return tv->tv_sec * USEC_PER_SEC + tv->tv_usec;
 435 }
 436
 437 static inline suseconds_t timeval_delta(const struct timeval *large,
 438                                         const struct timeval *small)
 439 {
 440         time_t      secs  = large->tv_sec  - small->tv_sec;
 441         suseconds_t usecs = large->tv_usec - small->tv_usec;
 442
 443         if (usecs < 0) {
 444                 secs--;
 445                 usecs += USEC_PER_SEC;
 446         }
 447         return secs * USEC_PER_SEC + usecs;
 448 }
 449
 450 static inline void timeval_add_usecs(struct timeval *tv,
 451                                      const suseconds_t usecs)
 452 {
 453         tv->tv_usec += usecs;
 454         while (tv->tv_usec >= USEC_PER_SEC) {
 455                 tv->tv_sec++;
 456                 tv->tv_usec -= USEC_PER_SEC;
 457         }
 458 }
 459
 460 static inline void timeval_sub_usecs(struct timeval *tv,
 461                                      const suseconds_t usecs)
 462 {
 463         tv->tv_usec -= usecs;
 464         while (tv->tv_usec < 0) {
 465                 tv->tv_sec--;
 466                 tv->tv_usec += USEC_PER_SEC;
 467         }
 468 }
 469
 470 /*
 471  * Returns the difference in usecs between timeval
 472  * passed in and current time
 473  */
 474 static inline suseconds_t timeval_now_delta(const struct timeval *tv)
 475 {
 476         struct timeval now;
 477         do_gettimeofday(&now);
 478         return timeval_delta(&now, tv);
 479 }
 480
 481 #ifdef CONFIG_IP_DCCP_DEBUG
 482 extern void dccp_ackvector_print(const u64 ackno,
 483                                  const unsigned char *vector, int len);
 484 extern void dccp_ackpkts_print(const struct dccp_ackpkts *ap);
 485 #else
 486 static inline void dccp_ackvector_print(const u64 ackno,
 487                                         const unsigned char *vector,
 488                                         int len) { }
 489 static inline void dccp_ackpkts_print(const struct dccp_ackpkts *ap) { }
 490 #endif
 491
 492 #endif /* _DCCP_H */