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