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 extern void dccp_set_state(struct sock *sk, const int state);
 142 extern void dccp_done(struct sock *sk);
 143
 144 static inline void dccp_openreq_init(struct request_sock *req,
 145                                      struct dccp_sock *dp,
 146                                      struct sk_buff *skb)
 147 {
 148         /*
 149          * FIXME: fill in the other req fields from the DCCP options
 150          * received
 151          */
 152         inet_rsk(req)->rmt_port = dccp_hdr(skb)->dccph_sport;
 153         inet_rsk(req)->acked    = 0;
 154         req->rcv_wnd = 0;
 155 }
 156
 157 extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
 158
 159 extern struct sock *dccp_create_openreq_child(struct sock *sk,
 160                                               const struct request_sock *req,
 161                                               const struct sk_buff *skb);
 162
 163 extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
 164
 165 extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
 166                                               struct sk_buff *skb,
 167                                               struct request_sock *req,
 168                                               struct dst_entry *dst);
 169 extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
 170                                    struct request_sock *req,
 171                                    struct request_sock **prev);
 172
 173 extern int dccp_child_process(struct sock *parent, struct sock *child,
 174                               struct sk_buff *skb);
 175 extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
 176                                   struct dccp_hdr *dh, unsigned len);
 177 extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
 178                                 const struct dccp_hdr *dh, const unsigned len);
 179
 180 extern int dccp_init_sock(struct sock *sk, const __u8 ctl_sock_initialized);
 181 extern int dccp_destroy_sock(struct sock *sk);
 182
 183 extern void             dccp_close(struct sock *sk, long timeout);
 184 extern struct sk_buff   *dccp_make_response(struct sock *sk,
 185                                             struct dst_entry *dst,
 186                                             struct request_sock *req);
 187
 188 extern int         dccp_connect(struct sock *sk);
 189 extern int         dccp_disconnect(struct sock *sk, int flags);
 190 extern void        dccp_hash(struct sock *sk);
 191 extern void        dccp_unhash(struct sock *sk);
 192 extern int         dccp_getsockopt(struct sock *sk, int level, int optname,
 193                                    char __user *optval, int __user *optlen);
 194 extern int         dccp_setsockopt(struct sock *sk, int level, int optname,
 195                                    char __user *optval, int optlen);
 196 extern int         dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
 197 extern int         dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
 198                                 struct msghdr *msg, size_t size);
 199 extern int         dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
 200                                 struct msghdr *msg, size_t len, int nonblock,
 201                                 int flags, int *addr_len);
 202 extern void        dccp_shutdown(struct sock *sk, int how);
 203 extern int         inet_dccp_listen(struct socket *sock, int backlog);
 204 extern unsigned int dccp_poll(struct file *file, struct socket *sock,
 205                              poll_table *wait);
 206 extern void        dccp_v4_send_check(struct sock *sk, int len,
 207                                       struct sk_buff *skb);
 208 extern int         dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
 209                                    int addr_len);
 210
 211 extern int         dccp_v4_checksum(const struct sk_buff *skb,
 212                                     const __be32 saddr, const __be32 daddr);
 213
 214 extern int         dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
 215 extern void        dccp_send_close(struct sock *sk, const int active);
 216 extern int         dccp_invalid_packet(struct sk_buff *skb);
 217
 218 static inline int dccp_bad_service_code(const struct sock *sk,
 219                                         const __be32 service)
 220 {
 221         const struct dccp_sock *dp = dccp_sk(sk);
 222
 223         if (dp->dccps_service == service)
 224                 return 0;
 225         return !dccp_list_has_service(dp->dccps_service_list, service);
 226 }
 227
 228 struct dccp_skb_cb {
 229         __u8  dccpd_type:4;
 230         __u8  dccpd_ccval:4;
 231         __u8  dccpd_reset_code;
 232         __u16 dccpd_opt_len;
 233         __u64 dccpd_seq;
 234         __u64 dccpd_ack_seq;
 235 };
 236
 237 #define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
 238
 239 static inline int dccp_non_data_packet(const struct sk_buff *skb)
 240 {
 241         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 242
 243         return type == DCCP_PKT_ACK      ||
 244                type == DCCP_PKT_CLOSE    ||
 245                type == DCCP_PKT_CLOSEREQ ||
 246                type == DCCP_PKT_RESET    ||
 247                type == DCCP_PKT_SYNC     ||
 248                type == DCCP_PKT_SYNCACK;
 249 }
 250
 251 static inline int dccp_packet_without_ack(const struct sk_buff *skb)
 252 {
 253         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
 254
 255         return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
 256 }
 257
 258 #define DCCP_MAX_SEQNO ((((u64)1) << 48) - 1)
 259 #define DCCP_PKT_WITHOUT_ACK_SEQ (DCCP_MAX_SEQNO << 2)
 260
 261 static inline void dccp_set_seqno(u64 *seqno, u64 value)
 262 {
 263         if (value > DCCP_MAX_SEQNO)
 264                 value -= DCCP_MAX_SEQNO + 1;
 265         *seqno = value;
 266 }
 267
 268 static inline u64 dccp_delta_seqno(u64 seqno1, u64 seqno2)
 269 {
 270         return ((seqno2 << 16) - (seqno1 << 16)) >> 16;
 271 }
 272
 273 static inline void dccp_inc_seqno(u64 *seqno)
 274 {
 275         if (++*seqno > DCCP_MAX_SEQNO)
 276                 *seqno = 0;
 277 }
 278
 279 static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
 280 {
 281         struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
 282                                                            sizeof(*dh));
 283         dh->dccph_seq2 = 0;
 284         dh->dccph_seq = htons((gss >> 32) & 0xfffff);
 285         dhx->dccph_seq_low = htonl(gss & 0xffffffff);
 286 }
 287
 288 static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
 289                                     const u64 gsr)
 290 {
 291         dhack->dccph_reserved1 = 0;
 292         dhack->dccph_ack_nr_high = htons(gsr >> 32);
 293         dhack->dccph_ack_nr_low  = htonl(gsr & 0xffffffff);
 294 }
 295
 296 static inline void dccp_update_gsr(struct sock *sk, u64 seq)
 297 {
 298         struct dccp_sock *dp = dccp_sk(sk);
 299
 300         dp->dccps_gsr = seq;
 301         dccp_set_seqno(&dp->dccps_swl,
 302                        (dp->dccps_gsr + 1 -
 303                         (dp->dccps_options.dccpo_sequence_window / 4)));
 304         dccp_set_seqno(&dp->dccps_swh,
 305                        (dp->dccps_gsr +
 306                         (3 * dp->dccps_options.dccpo_sequence_window) / 4));
 307 }
 308
 309 static inline void dccp_update_gss(struct sock *sk, u64 seq)
 310 {
 311         struct dccp_sock *dp = dccp_sk(sk);
 312
 313         dp->dccps_awh = dp->dccps_gss = seq;
 314         dccp_set_seqno(&dp->dccps_awl,
 315                        (dp->dccps_gss -
 316                         dp->dccps_options.dccpo_sequence_window + 1));
 317 }
 318
 319 static inline int dccp_ack_pending(const struct sock *sk)
 320 {
 321         const struct dccp_sock *dp = dccp_sk(sk);
 322         return dp->dccps_timestamp_echo != 0 ||
 323 #ifdef CONFIG_IP_DCCP_ACKVEC
 324                (dp->dccps_options.dccpo_send_ack_vector &&
 325                 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
 326 #endif
 327                inet_csk_ack_scheduled(sk);
 328 }
 329
 330 extern void dccp_insert_options(struct sock *sk, struct sk_buff *skb);
 331 extern void dccp_insert_option_elapsed_time(struct sock *sk,
 332                                             struct sk_buff *skb,
 333                                             u32 elapsed_time);
 334 extern void dccp_insert_option_timestamp(struct sock *sk,
 335                                          struct sk_buff *skb);
 336 extern void dccp_insert_option(struct sock *sk, struct sk_buff *skb,
 337                                unsigned char option,
 338                                const void *value, unsigned char len);
 339
 340 extern void dccp_timestamp(const struct sock *sk, struct timeval *tv);
 341
 342 static inline suseconds_t timeval_usecs(const struct timeval *tv)
 343 {
 344         return tv->tv_sec * USEC_PER_SEC + tv->tv_usec;
 345 }
 346
 347 static inline suseconds_t timeval_delta(const struct timeval *large,
 348                                         const struct timeval *small)
 349 {
 350         time_t      secs  = large->tv_sec  - small->tv_sec;
 351         suseconds_t usecs = large->tv_usec - small->tv_usec;
 352
 353         if (usecs < 0) {
 354                 secs--;
 355                 usecs += USEC_PER_SEC;
 356         }
 357         return secs * USEC_PER_SEC + usecs;
 358 }
 359
 360 static inline void timeval_add_usecs(struct timeval *tv,
 361                                      const suseconds_t usecs)
 362 {
 363         tv->tv_usec += usecs;
 364         while (tv->tv_usec >= USEC_PER_SEC) {
 365                 tv->tv_sec++;
 366                 tv->tv_usec -= USEC_PER_SEC;
 367         }
 368 }
 369
 370 static inline void timeval_sub_usecs(struct timeval *tv,
 371                                      const suseconds_t usecs)
 372 {
 373         tv->tv_usec -= usecs;
 374         while (tv->tv_usec < 0) {
 375                 tv->tv_sec--;
 376                 tv->tv_usec += USEC_PER_SEC;
 377         }
 378 }
 379
 380 #ifdef CONFIG_SYSCTL
 381 extern int dccp_sysctl_init(void);
 382 extern void dccp_sysctl_exit(void);
 383 #else
 384 static inline int dccp_sysctl_init(void)
 385 {
 386         return 0;
 387 }
 388
 389 static inline void dccp_sysctl_exit(void)
 390 {
 391 }
 392 #endif
 393
 394 #endif /* _DCCP_H */