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 #include "ackvec.h"
  21
  22 #ifdef CONFIG_IP_DCCP_DEBUG
  23 extern int dccp_debug;
  24
  25 #define dccp_pr_debug(format, a...) \
  26         do { if (dccp_debug) \
  27                 printk(KERN_DEBUG "%s: " format, __FUNCTION__ , ##a); \
  28         } while (0)
  29 #define dccp_pr_debug_cat(format, a...) do { if (dccp_debug) \
  30                                              printk(format, ##a); } while (0)
  31 #else
  32 #define dccp_pr_debug(format, a...)
  33 #define dccp_pr_debug_cat(format, a...)
  34 #endif
  35
  36 extern struct inet_hashinfo dccp_hashinfo;
  37
  38 extern atomic_t dccp_orphan_count;
  39 extern int dccp_tw_count;
  40 extern void dccp_tw_deschedule(struct inet_timewait_sock *tw);
  41
  42 extern void dccp_time_wait(struct sock *sk, int state, int timeo);
  43
  44 /* FIXME: Right size this */
  45 #define DCCP_MAX_OPT_LEN 128
  46
  47 #define DCCP_MAX_PACKET_HDR 32
  48
  49 #define MAX_DCCP_HEADER  (DCCP_MAX_PACKET_HDR + DCCP_MAX_OPT_LEN + MAX_HEADER)
  50
  51 #define DCCP_TIMEWAIT_LEN (60 * HZ) /* how long to wait to destroy TIME-WAIT
  52                                      * state, about 60 seconds */
  53
  54 /* draft-ietf-dccp-spec-11.txt initial RTO value */
  55 #define DCCP_TIMEOUT_INIT ((unsigned)(3 * HZ))
  56
  57 /* Maximal interval between probes for local resources.  */
  58 #define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
  59
  60 #define DCCP_RTO_MAX ((unsigned)(120 * HZ)) /* FIXME: using TCP value */
  61
  62 /* is seq1 < seq2 ? */
  63 static inline int before48(const u64 seq1, const u64 seq2)
  64 {
  65         return (s64)((seq1 << 16) - (seq2 << 16)) < 0;
  66 }
  67
  68 /* is seq1 > seq2 ? */
  69 static inline int after48(const u64 seq1, const u64 seq2)
  70 {
  71         return (s64)((seq2 << 16) - (seq1 << 16)) < 0;
  72 }
  73
  74 /* is seq2 <= seq1 <= seq3 ? */
  75 static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
  76 {
  77         return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
  78 }
  79
  80 static inline u64 max48(const u64 seq1, const u64 seq2)
  81 {
  82         return after48(seq1, seq2) ? seq1 : seq2;
  83 }
  84
  85 enum {
  86         DCCP_MIB_NUM = 0,
  87         DCCP_MIB_ACTIVEOPENS,                   /* ActiveOpens */
  88         DCCP_MIB_ESTABRESETS,                   /* EstabResets */
  89         DCCP_MIB_CURRESTAB,                     /* CurrEstab */
  90         DCCP_MIB_OUTSEGS,                       /* OutSegs */
  91         DCCP_MIB_OUTRSTS,
  92         DCCP_MIB_ABORTONTIMEOUT,
  93         DCCP_MIB_TIMEOUTS,
  94         DCCP_MIB_ABORTFAILED,
  95         DCCP_MIB_PASSIVEOPENS,
  96         DCCP_MIB_ATTEMPTFAILS,
  97         DCCP_MIB_OUTDATAGRAMS,
  98         DCCP_MIB_INERRS,
  99         DCCP_MIB_OPTMANDATORYERROR,
 100         DCCP_MIB_INVALIDOPT,
 101         __DCCP_MIB_MAX
 102 };
 103
 104 #define DCCP_MIB_MAX    __DCCP_MIB_MAX
 105 struct dccp_mib {
 106         unsigned long   mibs[DCCP_MIB_MAX];
 107 } __SNMP_MIB_ALIGN__;
 108
 109 DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
 110 #define DCCP_INC_STATS(field)       SNMP_INC_STATS(dccp_statistics, field)
 111 #define DCCP_INC_STATS_BH(field)    SNMP_INC_STATS_BH(dccp_statistics, field)
 112 #define DCCP_INC_STATS_USER(field)  SNMP_INC_STATS_USER(dccp_statistics, field)
 113 #define DCCP_DEC_STATS(field)       SNMP_DEC_STATS(dccp_statistics, field)
 114 #define DCCP_ADD_STATS_BH(field, val) \
 115                         SNMP_ADD_STATS_BH(dccp_statistics, field, val)
 116 #define DCCP_ADD_STATS_USER(field, val) \
 117                         SNMP_ADD_STATS_USER(dccp_statistics, field, val)
 118
 119 extern int  dccp_retransmit_skb(struct sock *sk, struct sk_buff *skb);
 120
 121 extern int dccp_send_response(struct sock *sk);
 122 extern void dccp_send_ack(struct sock *sk);
 123 extern void dccp_send_delayed_ack(struct sock *sk);
 124 extern void dccp_send_sync(struct sock *sk, const u64 seq,
 125                            const enum dccp_pkt_type pkt_type);
 126
 127 extern int dccp_write_xmit(struct sock *sk, struct sk_buff *skb, long *timeo);
 128 extern void dccp_write_space(struct sock *sk);
 129
 130 extern void dccp_init_xmit_timers(struct sock *sk);
 131 static inline void dccp_clear_xmit_timers(struct sock *sk)
 132 {
 133         inet_csk_clear_xmit_timers(sk);
 134 }
 135
 136 extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
 137
 138 extern const char *dccp_packet_name(const int type);
 139 extern const char *dccp_state_name(const int state);
 140
 141 static inline void dccp_set_state(struct sock *sk, const int state)
 142 {
 143         const int oldstate = sk->sk_state;
 144
 145         dccp_pr_debug("%s(%p) %-10.10s -> %s\n",
 146                       dccp_role(sk), sk,
 147                       dccp_state_name(oldstate), dccp_state_name(state));
 148         WARN_ON(state == oldstate);
 149
 150         switch (state) {
 151         case DCCP_OPEN:
 152                 if (oldstate != DCCP_OPEN)
 153                         DCCP_INC_STATS(DCCP_MIB_CURRESTAB);
 154                 break;
 155
 156         case DCCP_CLOSED:
 157                 if (oldstate == DCCP_CLOSING || oldstate == DCCP_OPEN)
 158                         DCCP_INC_STATS(DCCP_MIB_ESTABRESETS);
 159
 160                 sk->sk_prot->unhash(sk);
 161                 if (inet_csk(sk)->icsk_bind_hash != NULL &&
 162                     !(sk->sk_userlocks & SOCK_BINDPORT_LOCK))
 163                         inet_put_port(&dccp_hashinfo, sk);
 164                 /* fall through */
 165         default:
 166                 if (oldstate == DCCP_OPEN)
 167                         DCCP_DEC_STATS(DCCP_MIB_CURRESTAB);
 168         }
 169
 170         /* Change state AFTER socket is unhashed to avoid closed
 171          * socket sitting in hash tables.
 172          */
 173         sk->sk_state = state;
 174 }
 175
 176 static inline void dccp_done(struct sock *sk)
 177 {
 178         dccp_set_state(sk, DCCP_CLOSED);
 179         dccp_clear_xmit_timers(sk);
 180
 181         sk->sk_shutdown = SHUTDOWN_MASK;
 182
 183         if (!sock_flag(sk, SOCK_DEAD))
 184                 sk->sk_state_change(sk);
 185         else
 186                 inet_csk_destroy_sock(sk);
 187 }
 188
 189 static inline void dccp_openreq_init(struct request_sock *req,
 190                                      struct dccp_sock *dp,
 191                                      struct sk_buff *skb)
 192 {
 193         /*
 194          * FIXME: fill in the other req fields from the DCCP options
 195          * received
 196          */
 197         inet_rsk(req)->rmt_port = dccp_hdr(skb)->dccph_sport;
 198         inet_rsk(req)->acked    = 0;
 199         req->rcv_wnd = 0;
 200 }
 201
 202 extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
 203
 204 extern struct sock *dccp_create_openreq_child(struct sock *sk,
 205                                               const struct request_sock *req,
 206                                               const struct sk_buff *skb);
 207
 208 extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
 209
 210 extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
 211                                               struct sk_buff *skb,
 212                                               struct request_sock *req,
 213                                               struct dst_entry *dst);
 214 extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
 215                                    struct request_sock *req,
 216                                    struct request_sock **prev);
 217
 218 extern int dccp_child_process(struct sock *parent, struct sock *child,
 219                               struct sk_buff *skb);
 220 extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
 221                                   struct dccp_hdr *dh, unsigned len);
 222 extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
 223                                 const struct dccp_hdr *dh, const unsigned len);
 224
 225 extern int dccp_init_sock(struct sock *sk);
 226 extern int dccp_destroy_sock(struct sock *sk);
 227
 228 extern void             dccp_close(struct sock *sk, long timeout);
 229 extern struct sk_buff   *dccp_make_response(struct sock *sk,
 230                                             struct dst_entry *dst,
 231                                             struct request_sock *req);
 232
 233 extern int         dccp_connect(struct sock *sk);
 234 extern int         dccp_disconnect(struct sock *sk, int flags);
 235 extern void        dccp_hash(struct sock *sk);
 236 extern void        dccp_unhash(struct sock *sk);
 237 extern int         dccp_getsockopt(struct sock *sk, int level, int optname,
 238                                    char __user *optval, int __user *optlen);
 239 extern int         dccp_setsockopt(struct sock *sk, int level, int optname,
 240                                    char __user *optval, int optlen);
 241 extern int         dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
 242 extern int         dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
 243                                 struct msghdr *msg, size_t size);
 244 extern int         dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
 245                                 struct msghdr *msg, size_t len, int nonblock,
 246                                 int flags, int *addr_len);
 247 extern void        dccp_shutdown(struct sock *sk, int how);
 248 extern int         inet_dccp_listen(struct socket *sock, int backlog);
 249 extern unsigned int dccp_poll(struct file *file, struct socket *sock,
 250                              poll_table *wait);
 251 extern void        dccp_v4_send_check(struct sock *sk, int len,
 252                                       struct sk_buff *skb);
 253 extern int         dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
 254                                    int addr_len);
 255
 256 extern int         dccp_v4_checksum(const struct sk_buff *skb,
 257                                     const __be32 saddr, const __be32 daddr);
 258
 259 extern int         dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
 260 extern void        dccp_send_close(struct sock *sk, const int active);
 261 extern int         dccp_invalid_packet(struct sk_buff *skb);
 262
 263 static inline int dccp_bad_service_code(const struct sock *sk,
 264                                         const __be32 service)
 265 {
 266         const struct dccp_sock *dp = dccp_sk(sk);
 267
 268         if (dp->dccps_service == service)
 269                 return 0;
 270         return !dccp_list_has_service(dp->dccps_service_list, service);
 271 }
 272
 273 struct dccp_skb_cb {
 274         __u8  dccpd_type:4;
 275         __u8  dccpd_ccval:4;
 276         __u8  dccpd_reset_code;
 277         __u16 dccpd_opt_len;
 278         __u64 dccpd_seq;
 279         __u64 dccpd_ack_seq;
 280 };
 281
 282 #define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
 283
 284 static inline int dccp_non_data_packet(const struct sk_buff *skb)
 285 {
 286         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 287
 288         return type == DCCP_PKT_ACK      ||
 289                type == DCCP_PKT_CLOSE    ||
 290                type == DCCP_PKT_CLOSEREQ ||
 291                type == DCCP_PKT_RESET    ||
 292                type == DCCP_PKT_SYNC     ||
 293                type == DCCP_PKT_SYNCACK;
 294 }
 295
 296 static inline int dccp_packet_without_ack(const struct sk_buff *skb)
 297 {
 298         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 299
 300         return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
 301 }
 302
 303 #define DCCP_MAX_SEQNO ((((u64)1) << 48) - 1)
 304 #define DCCP_PKT_WITHOUT_ACK_SEQ (DCCP_MAX_SEQNO << 2)
 305
 306 static inline void dccp_set_seqno(u64 *seqno, u64 value)
 307 {
 308         if (value > DCCP_MAX_SEQNO)
 309                 value -= DCCP_MAX_SEQNO + 1;
 310         *seqno = value;
 311 }
 312
 313 static inline u64 dccp_delta_seqno(u64 seqno1, u64 seqno2)
 314 {
 315         return ((seqno2 << 16) - (seqno1 << 16)) >> 16;
 316 }
 317
 318 static inline void dccp_inc_seqno(u64 *seqno)
 319 {
 320         if (++*seqno > DCCP_MAX_SEQNO)
 321                 *seqno = 0;
 322 }
 323
 324 static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
 325 {
 326         struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
 327                                                            sizeof(*dh));
 328         dh->dccph_seq2 = 0;
 329         dh->dccph_seq = htons((gss >> 32) & 0xfffff);
 330         dhx->dccph_seq_low = htonl(gss & 0xffffffff);
 331 }
 332
 333 static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
 334                                     const u64 gsr)
 335 {
 336         dhack->dccph_reserved1 = 0;
 337         dhack->dccph_ack_nr_high = htons(gsr >> 32);
 338         dhack->dccph_ack_nr_low  = htonl(gsr & 0xffffffff);
 339 }
 340
 341 static inline void dccp_update_gsr(struct sock *sk, u64 seq)
 342 {
 343         struct dccp_sock *dp = dccp_sk(sk);
 344
 345         dp->dccps_gsr = seq;
 346         dccp_set_seqno(&dp->dccps_swl,
 347                        (dp->dccps_gsr + 1 -
 348                         (dp->dccps_options.dccpo_sequence_window / 4)));
 349         dccp_set_seqno(&dp->dccps_swh,
 350                        (dp->dccps_gsr +
 351                         (3 * dp->dccps_options.dccpo_sequence_window) / 4));
 352 }
 353
 354 static inline void dccp_update_gss(struct sock *sk, u64 seq)
 355 {
 356         struct dccp_sock *dp = dccp_sk(sk);
 357
 358         dp->dccps_awh = dp->dccps_gss = seq;
 359         dccp_set_seqno(&dp->dccps_awl,
 360                        (dp->dccps_gss -
 361                         dp->dccps_options.dccpo_sequence_window + 1));
 362 }
 363
 364 static inline int dccp_ack_pending(const struct sock *sk)
 365 {
 366         const struct dccp_sock *dp = dccp_sk(sk);
 367         return dp->dccps_timestamp_echo != 0 ||
 368 #ifdef CONFIG_IP_DCCP_ACKVEC
 369                (dp->dccps_options.dccpo_send_ack_vector &&
 370                 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
 371 #endif
 372                inet_csk_ack_scheduled(sk);
 373 }
 374
 375 extern void dccp_insert_options(struct sock *sk, struct sk_buff *skb);
 376 extern void dccp_insert_option_elapsed_time(struct sock *sk,
 377                                             struct sk_buff *skb,
 378                                             u32 elapsed_time);
 379 extern void dccp_insert_option_timestamp(struct sock *sk,
 380                                          struct sk_buff *skb);
 381 extern void dccp_insert_option(struct sock *sk, struct sk_buff *skb,
 382                                unsigned char option,
 383                                const void *value, unsigned char len);
 384
 385 extern struct socket *dccp_ctl_socket;
 386
 387 extern void dccp_timestamp(const struct sock *sk, struct timeval *tv);
 388
 389 static inline suseconds_t timeval_usecs(const struct timeval *tv)
 390 {
 391         return tv->tv_sec * USEC_PER_SEC + tv->tv_usec;
 392 }
 393
 394 static inline suseconds_t timeval_delta(const struct timeval *large,
 395                                         const struct timeval *small)
 396 {
 397         time_t      secs  = large->tv_sec  - small->tv_sec;
 398         suseconds_t usecs = large->tv_usec - small->tv_usec;
 399
 400         if (usecs < 0) {
 401                 secs--;
 402                 usecs += USEC_PER_SEC;
 403         }
 404         return secs * USEC_PER_SEC + usecs;
 405 }
 406
 407 static inline void timeval_add_usecs(struct timeval *tv,
 408                                      const suseconds_t usecs)
 409 {
 410         tv->tv_usec += usecs;
 411         while (tv->tv_usec >= USEC_PER_SEC) {
 412                 tv->tv_sec++;
 413                 tv->tv_usec -= USEC_PER_SEC;
 414         }
 415 }
 416
 417 static inline void timeval_sub_usecs(struct timeval *tv,
 418                                      const suseconds_t usecs)
 419 {
 420         tv->tv_usec -= usecs;
 421         while (tv->tv_usec < 0) {
 422                 tv->tv_sec--;
 423                 tv->tv_usec += USEC_PER_SEC;
 424         }
 425 }
 426
 427 #ifdef CONFIG_SYSCTL
 428 extern int dccp_sysctl_init(void);
 429 extern void dccp_sysctl_exit(void);
 430 #else
 431 static inline int dccp_sysctl_init(void)
 432 {
 433         return 0;
 434 }
 435
 436 static inline void dccp_sysctl_exit(void)
 437 {
 438 }
 439 #endif
 440
 441 #endif /* _DCCP_H */