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