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-6 Ian McDonald <ian.mcdonald@jandi.co.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/dccp.h>
  16 #include <net/snmp.h>
  17 #include <net/sock.h>
  18 #include <net/tcp.h>
  19 #include "ackvec.h"
  20
  21 #define DCCP_CRIT(fmt, a...) LIMIT_NETDEBUG(KERN_CRIT fmt " at %s:%d/%s()\n",  \
  22                                          ##a, __FILE__, __LINE__, __FUNCTION__)
  23 #define DCCP_BUG(fmt, a...)  do { DCCP_CRIT(fmt, ##a); dump_stack(); } while (0)
  24 #define DCCP_BUG_ON(cond)    do { if (unlikely((cond) == 0))                   \
  25                                         DCCP_BUG("BUG: condition \"%s\" fails",\
  26                                                  __stringify((cond)));         \
  27                              } while (0)
  28
  29 #ifdef MODULE
  30 #define DCCP_PRINTK(enable, fmt, args...)       do { if (enable)             \
  31                                                         printk(fmt, ##args); \
  32                                                 } while(0)
  33 #else
  34 #define DCCP_PRINTK(enable, fmt, args...)       printk(fmt, ##args)
  35 #endif
  36 #define DCCP_PR_DEBUG(enable, fmt, a...)        DCCP_PRINTK(enable, KERN_DEBUG \
  37                                                   "%s: " fmt, __FUNCTION__, ##a)
  38
  39 #ifdef CONFIG_IP_DCCP_DEBUG
  40 extern int dccp_debug;
  41 #define dccp_pr_debug(format, a...)       DCCP_PR_DEBUG(dccp_debug, format, ##a)
  42 #define dccp_pr_debug_cat(format, a...)   DCCP_PRINTK(dccp_debug, format, ##a)
  43 #else
  44 #define dccp_pr_debug(format, a...)
  45 #define dccp_pr_debug_cat(format, a...)
  46 #endif
  47
  48 extern struct inet_hashinfo dccp_hashinfo;
  49
  50 extern atomic_t dccp_orphan_count;
  51
  52 extern void dccp_time_wait(struct sock *sk, int state, int timeo);
  53
  54 /*
  55  *  Set safe upper bounds for header and option length. Since Data Offset is 8
  56  *  bits (RFC 4340, sec. 5.1), the total header length can never be more than
  57  *  4 * 255 = 1020 bytes. The largest possible header length is 28 bytes (X=1):
  58  *    - DCCP-Response with ACK Subheader and 4 bytes of Service code      OR
  59  *    - DCCP-Reset    with ACK Subheader and 4 bytes of Reset Code fields
  60  *  Hence a safe upper bound for the maximum option length is 1020-28 = 992
  61  */
  62 #define MAX_DCCP_SPECIFIC_HEADER (255 * sizeof(int))
  63 #define DCCP_MAX_PACKET_HDR 28
  64 #define DCCP_MAX_OPT_LEN (MAX_DCCP_SPECIFIC_HEADER - DCCP_MAX_PACKET_HDR)
  65 #define MAX_DCCP_HEADER (MAX_DCCP_SPECIFIC_HEADER + MAX_HEADER)
  66
  67 #define DCCP_TIMEWAIT_LEN (60 * HZ) /* how long to wait to destroy TIME-WAIT
  68                                      * state, about 60 seconds */
  69
  70 /* RFC 1122, 4.2.3.1 initial RTO value */
  71 #define DCCP_TIMEOUT_INIT ((unsigned)(3 * HZ))
  72
  73 /* Maximal interval between probes for local resources.  */
  74 #define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
  75
  76 #define DCCP_RTO_MAX ((unsigned)(120 * HZ)) /* FIXME: using TCP value */
  77
  78 #define DCCP_XMIT_TIMEO 30000 /* Time/msecs for blocking transmit per packet */
  79
  80 /* sysctl variables for DCCP */
  81 extern int  sysctl_dccp_request_retries;
  82 extern int  sysctl_dccp_retries1;
  83 extern int  sysctl_dccp_retries2;
  84 extern int  sysctl_dccp_feat_sequence_window;
  85 extern int  sysctl_dccp_feat_rx_ccid;
  86 extern int  sysctl_dccp_feat_tx_ccid;
  87 extern int  sysctl_dccp_feat_ack_ratio;
  88 extern int  sysctl_dccp_feat_send_ack_vector;
  89 extern int  sysctl_dccp_feat_send_ndp_count;
  90 extern int  sysctl_dccp_tx_qlen;
  91
  92 /* is seq1 < seq2 ? */
  93 static inline int before48(const u64 seq1, const u64 seq2)
  94 {
  95         return (s64)((seq1 << 16) - (seq2 << 16)) < 0;
  96 }
  97
  98 /* is seq1 > seq2 ? */
  99 static inline int after48(const u64 seq1, const u64 seq2)
 100 {
 101         return (s64)((seq2 << 16) - (seq1 << 16)) < 0;
 102 }
 103
 104 /* is seq2 <= seq1 <= seq3 ? */
 105 static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
 106 {
 107         return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
 108 }
 109
 110 static inline u64 max48(const u64 seq1, const u64 seq2)
 111 {
 112         return after48(seq1, seq2) ? seq1 : seq2;
 113 }
 114
 115 /* is seq1 next seqno after seq2 */
 116 static inline int follows48(const u64 seq1, const u64 seq2)
 117 {
 118         int diff = (seq1 & 0xFFFF) - (seq2 & 0xFFFF);
 119
 120         return diff==1;
 121 }
 122
 123 enum {
 124         DCCP_MIB_NUM = 0,
 125         DCCP_MIB_ACTIVEOPENS,                   /* ActiveOpens */
 126         DCCP_MIB_ESTABRESETS,                   /* EstabResets */
 127         DCCP_MIB_CURRESTAB,                     /* CurrEstab */
 128         DCCP_MIB_OUTSEGS,                       /* OutSegs */
 129         DCCP_MIB_OUTRSTS,
 130         DCCP_MIB_ABORTONTIMEOUT,
 131         DCCP_MIB_TIMEOUTS,
 132         DCCP_MIB_ABORTFAILED,
 133         DCCP_MIB_PASSIVEOPENS,
 134         DCCP_MIB_ATTEMPTFAILS,
 135         DCCP_MIB_OUTDATAGRAMS,
 136         DCCP_MIB_INERRS,
 137         DCCP_MIB_OPTMANDATORYERROR,
 138         DCCP_MIB_INVALIDOPT,
 139         __DCCP_MIB_MAX
 140 };
 141
 142 #define DCCP_MIB_MAX    __DCCP_MIB_MAX
 143 struct dccp_mib {
 144         unsigned long   mibs[DCCP_MIB_MAX];
 145 } __SNMP_MIB_ALIGN__;
 146
 147 DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
 148 #define DCCP_INC_STATS(field)       SNMP_INC_STATS(dccp_statistics, field)
 149 #define DCCP_INC_STATS_BH(field)    SNMP_INC_STATS_BH(dccp_statistics, field)
 150 #define DCCP_INC_STATS_USER(field)  SNMP_INC_STATS_USER(dccp_statistics, field)
 151 #define DCCP_DEC_STATS(field)       SNMP_DEC_STATS(dccp_statistics, field)
 152 #define DCCP_ADD_STATS_BH(field, val) \
 153                         SNMP_ADD_STATS_BH(dccp_statistics, field, val)
 154 #define DCCP_ADD_STATS_USER(field, val) \
 155                         SNMP_ADD_STATS_USER(dccp_statistics, field, val)
 156
 157 /*
 158  *      Checksumming routines
 159  */
 160 static inline int dccp_csum_coverage(const struct sk_buff *skb)
 161 {
 162         const struct dccp_hdr* dh = dccp_hdr(skb);
 163
 164         if (dh->dccph_cscov == 0)
 165                 return skb->len;
 166         return (dh->dccph_doff + dh->dccph_cscov - 1) * sizeof(u32);
 167 }
 168
 169 static inline void dccp_csum_outgoing(struct sk_buff *skb)
 170 {
 171         int cov = dccp_csum_coverage(skb);
 172
 173         if (cov >= skb->len)
 174                 dccp_hdr(skb)->dccph_cscov = 0;
 175
 176         skb->csum = skb_checksum(skb, 0, (cov > skb->len)? skb->len : cov, 0);
 177 }
 178
 179 extern void dccp_v4_send_check(struct sock *sk, int len, struct sk_buff *skb);
 180
 181 extern int  dccp_retransmit_skb(struct sock *sk, struct sk_buff *skb);
 182
 183 extern void dccp_send_ack(struct sock *sk);
 184 extern void dccp_send_delayed_ack(struct sock *sk);
 185 extern void dccp_reqsk_send_ack(struct sk_buff *sk, struct request_sock *rsk);
 186
 187 extern void dccp_send_sync(struct sock *sk, const u64 seq,
 188                            const enum dccp_pkt_type pkt_type);
 189
 190 extern void dccp_write_xmit(struct sock *sk, int block);
 191 extern void dccp_write_space(struct sock *sk);
 192
 193 extern void dccp_init_xmit_timers(struct sock *sk);
 194 static inline void dccp_clear_xmit_timers(struct sock *sk)
 195 {
 196         inet_csk_clear_xmit_timers(sk);
 197 }
 198
 199 extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
 200
 201 extern const char *dccp_packet_name(const int type);
 202 extern const char *dccp_state_name(const int state);
 203
 204 extern void dccp_set_state(struct sock *sk, const int state);
 205 extern void dccp_done(struct sock *sk);
 206
 207 extern void dccp_reqsk_init(struct request_sock *req, struct sk_buff *skb);
 208
 209 extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
 210
 211 extern struct sock *dccp_create_openreq_child(struct sock *sk,
 212                                               const struct request_sock *req,
 213                                               const struct sk_buff *skb);
 214
 215 extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
 216
 217 extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
 218                                               struct sk_buff *skb,
 219                                               struct request_sock *req,
 220                                               struct dst_entry *dst);
 221 extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
 222                                    struct request_sock *req,
 223                                    struct request_sock **prev);
 224
 225 extern int dccp_child_process(struct sock *parent, struct sock *child,
 226                               struct sk_buff *skb);
 227 extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
 228                                   struct dccp_hdr *dh, unsigned len);
 229 extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
 230                                 const struct dccp_hdr *dh, const unsigned len);
 231
 232 extern int dccp_init_sock(struct sock *sk, const __u8 ctl_sock_initialized);
 233 extern int dccp_destroy_sock(struct sock *sk);
 234
 235 extern void             dccp_close(struct sock *sk, long timeout);
 236 extern struct sk_buff   *dccp_make_response(struct sock *sk,
 237                                             struct dst_entry *dst,
 238                                             struct request_sock *req);
 239
 240 extern int         dccp_connect(struct sock *sk);
 241 extern int         dccp_disconnect(struct sock *sk, int flags);
 242 extern void        dccp_hash(struct sock *sk);
 243 extern void        dccp_unhash(struct sock *sk);
 244 extern int         dccp_getsockopt(struct sock *sk, int level, int optname,
 245                                    char __user *optval, int __user *optlen);
 246 extern int         dccp_setsockopt(struct sock *sk, int level, int optname,
 247                                    char __user *optval, int optlen);
 248 #ifdef CONFIG_COMPAT
 249 extern int         compat_dccp_getsockopt(struct sock *sk,
 250                                 int level, int optname,
 251                                 char __user *optval, int __user *optlen);
 252 extern int         compat_dccp_setsockopt(struct sock *sk,
 253                                 int level, int optname,
 254                                 char __user *optval, int optlen);
 255 #endif
 256 extern int         dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
 257 extern int         dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
 258                                 struct msghdr *msg, size_t size);
 259 extern int         dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
 260                                 struct msghdr *msg, size_t len, int nonblock,
 261                                 int flags, int *addr_len);
 262 extern void        dccp_shutdown(struct sock *sk, int how);
 263 extern int         inet_dccp_listen(struct socket *sock, int backlog);
 264 extern unsigned int dccp_poll(struct file *file, struct socket *sock,
 265                              poll_table *wait);
 266 extern int         dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
 267                                    int addr_len);
 268
 269 extern int         dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
 270 extern void        dccp_send_close(struct sock *sk, const int active);
 271 extern int         dccp_invalid_packet(struct sk_buff *skb);
 272
 273 static inline int dccp_bad_service_code(const struct sock *sk,
 274                                         const __be32 service)
 275 {
 276         const struct dccp_sock *dp = dccp_sk(sk);
 277
 278         if (dp->dccps_service == service)
 279                 return 0;
 280         return !dccp_list_has_service(dp->dccps_service_list, service);
 281 }
 282
 283 struct dccp_skb_cb {
 284         __u8  dccpd_type:4;
 285         __u8  dccpd_ccval:4;
 286         __u8  dccpd_reset_code;
 287         __u16 dccpd_opt_len;
 288         __u64 dccpd_seq;
 289         __u64 dccpd_ack_seq;
 290 };
 291
 292 #define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
 293
 294 static inline int dccp_non_data_packet(const struct sk_buff *skb)
 295 {
 296         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 297
 298         return type == DCCP_PKT_ACK      ||
 299                type == DCCP_PKT_CLOSE    ||
 300                type == DCCP_PKT_CLOSEREQ ||
 301                type == DCCP_PKT_RESET    ||
 302                type == DCCP_PKT_SYNC     ||
 303                type == DCCP_PKT_SYNCACK;
 304 }
 305
 306 static inline int dccp_packet_without_ack(const struct sk_buff *skb)
 307 {
 308         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 309
 310         return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
 311 }
 312
 313 #define DCCP_MAX_SEQNO ((((u64)1) << 48) - 1)
 314 #define DCCP_PKT_WITHOUT_ACK_SEQ (DCCP_MAX_SEQNO << 2)
 315
 316 static inline void dccp_set_seqno(u64 *seqno, u64 value)
 317 {
 318         if (value > DCCP_MAX_SEQNO)
 319                 value -= DCCP_MAX_SEQNO + 1;
 320         *seqno = value;
 321 }
 322
 323 static inline u64 dccp_delta_seqno(u64 seqno1, u64 seqno2)
 324 {
 325         return ((seqno2 << 16) - (seqno1 << 16)) >> 16;
 326 }
 327
 328 static inline void dccp_inc_seqno(u64 *seqno)
 329 {
 330         if (++*seqno > DCCP_MAX_SEQNO)
 331                 *seqno = 0;
 332 }
 333
 334 static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
 335 {
 336         struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
 337                                                            sizeof(*dh));
 338         dh->dccph_seq2 = 0;
 339         dh->dccph_seq = htons((gss >> 32) & 0xfffff);
 340         dhx->dccph_seq_low = htonl(gss & 0xffffffff);
 341 }
 342
 343 static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
 344                                     const u64 gsr)
 345 {
 346         dhack->dccph_reserved1 = 0;
 347         dhack->dccph_ack_nr_high = htons(gsr >> 32);
 348         dhack->dccph_ack_nr_low  = htonl(gsr & 0xffffffff);
 349 }
 350
 351 static inline void dccp_update_gsr(struct sock *sk, u64 seq)
 352 {
 353         struct dccp_sock *dp = dccp_sk(sk);
 354         const struct dccp_minisock *dmsk = dccp_msk(sk);
 355
 356         dp->dccps_gsr = seq;
 357         dccp_set_seqno(&dp->dccps_swl,
 358                        dp->dccps_gsr + 1 - (dmsk->dccpms_sequence_window / 4));
 359         dccp_set_seqno(&dp->dccps_swh,
 360                        dp->dccps_gsr + (3 * dmsk->dccpms_sequence_window) / 4);
 361 }
 362
 363 static inline void dccp_update_gss(struct sock *sk, u64 seq)
 364 {
 365         struct dccp_sock *dp = dccp_sk(sk);
 366
 367         dp->dccps_awh = dp->dccps_gss = seq;
 368         dccp_set_seqno(&dp->dccps_awl,
 369                        (dp->dccps_gss -
 370                         dccp_msk(sk)->dccpms_sequence_window + 1));
 371 }
 372
 373 static inline int dccp_ack_pending(const struct sock *sk)
 374 {
 375         const struct dccp_sock *dp = dccp_sk(sk);
 376         return dp->dccps_timestamp_echo != 0 ||
 377 #ifdef CONFIG_IP_DCCP_ACKVEC
 378                (dccp_msk(sk)->dccpms_send_ack_vector &&
 379                 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
 380 #endif
 381                inet_csk_ack_scheduled(sk);
 382 }
 383
 384 extern int dccp_insert_options(struct sock *sk, struct sk_buff *skb);
 385 extern int dccp_insert_option_elapsed_time(struct sock *sk,
 386                                             struct sk_buff *skb,
 387                                             u32 elapsed_time);
 388 extern int dccp_insert_option_timestamp(struct sock *sk,
 389                                          struct sk_buff *skb);
 390 extern int dccp_insert_option(struct sock *sk, struct sk_buff *skb,
 391                                unsigned char option,
 392                                const void *value, unsigned char len);
 393
 394 extern void dccp_timestamp(const struct sock *sk, struct timeval *tv);
 395
 396 static inline suseconds_t timeval_usecs(const struct timeval *tv)
 397 {
 398         return tv->tv_sec * USEC_PER_SEC + tv->tv_usec;
 399 }
 400
 401 static inline suseconds_t timeval_delta(const struct timeval *large,
 402                                         const struct timeval *small)
 403 {
 404         time_t      secs  = large->tv_sec  - small->tv_sec;
 405         suseconds_t usecs = large->tv_usec - small->tv_usec;
 406
 407         if (usecs < 0) {
 408                 secs--;
 409                 usecs += USEC_PER_SEC;
 410         }
 411         return secs * USEC_PER_SEC + usecs;
 412 }
 413
 414 static inline void timeval_add_usecs(struct timeval *tv,
 415                                      const suseconds_t usecs)
 416 {
 417         tv->tv_usec += usecs;
 418         while (tv->tv_usec >= USEC_PER_SEC) {
 419                 tv->tv_sec++;
 420                 tv->tv_usec -= USEC_PER_SEC;
 421         }
 422 }
 423
 424 static inline void timeval_sub_usecs(struct timeval *tv,
 425                                      const suseconds_t usecs)
 426 {
 427         tv->tv_usec -= usecs;
 428         while (tv->tv_usec < 0) {
 429                 tv->tv_sec--;
 430                 tv->tv_usec += USEC_PER_SEC;
 431         }
 432 }
 433
 434 #ifdef CONFIG_SYSCTL
 435 extern int dccp_sysctl_init(void);
 436 extern void dccp_sysctl_exit(void);
 437 #else
 438 static inline int dccp_sysctl_init(void)
 439 {
 440         return 0;
 441 }
 442
 443 static inline void dccp_sysctl_exit(void)
 444 {
 445 }
 446 #endif
 447
 448 #endif /* _DCCP_H */