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