include/net/sctp/sctp.h

   1 /* SCTP kernel implementation
   2  * (C) Copyright IBM Corp. 2001, 2004
   3  * Copyright (c) 1999-2000 Cisco, Inc.
   4  * Copyright (c) 1999-2001 Motorola, Inc.
   5  * Copyright (c) 2001-2003 Intel Corp.
   6  *
   7  * This file is part of the SCTP kernel implementation
   8  *
   9  * The base lksctp header.
  10  *
  11  * This SCTP implementation is free software;
  12  * you can redistribute it and/or modify it under the terms of
  13  * the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2, or (at your option)
  15  * any later version.
  16  *
  17  * This SCTP implementation is distributed in the hope that it
  18  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  19  *                 ************************
  20  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  21  * See the GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with GNU CC; see the file COPYING.  If not, write to
  25  * the Free Software Foundation, 59 Temple Place - Suite 330,
  26  * Boston, MA 02111-1307, USA.
  27  *
  28  * Please send any bug reports or fixes you make to the
  29  * email address(es):
  30  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
  31  *
  32  * Or submit a bug report through the following website:
  33  *    http://www.sf.net/projects/lksctp
  34  *
  35  * Written or modified by:
  36  *    La Monte H.P. Yarroll <piggy@acm.org>
  37  *    Xingang Guo           <xingang.guo@intel.com>
  38  *    Jon Grimm             <jgrimm@us.ibm.com>
  39  *    Daisy Chang           <daisyc@us.ibm.com>
  40  *    Sridhar Samudrala     <sri@us.ibm.com>
  41  *    Ardelle Fan           <ardelle.fan@intel.com>
  42  *    Ryan Layer            <rmlayer@us.ibm.com>
  43  *    Kevin Gao             <kevin.gao@intel.com>
  44  *
  45  * Any bugs reported given to us we will try to fix... any fixes shared will
  46  * be incorporated into the next SCTP release.
  47  */
  48
  49 #ifndef __net_sctp_h__
  50 #define __net_sctp_h__
  51
  52 /* Header Strategy.
  53  *    Start getting some control over the header file depencies:
  54  *       includes
  55  *       constants
  56  *       structs
  57  *       prototypes
  58  *       macros, externs, and inlines
  59  *
  60  *   Move test_frame specific items out of the kernel headers
  61  *   and into the test frame headers.   This is not perfect in any sense
  62  *   and will continue to evolve.
  63  */
  64
  65 #include <linux/types.h>
  66 #include <linux/slab.h>
  67 #include <linux/in.h>
  68 #include <linux/tty.h>
  69 #include <linux/proc_fs.h>
  70 #include <linux/spinlock.h>
  71 #include <linux/jiffies.h>
  72 #include <linux/idr.h>
  73
  74 #if IS_ENABLED(CONFIG_IPV6)
  75 #include <net/ipv6.h>
  76 #include <net/ip6_route.h>
  77 #endif
  78
  79 #include <asm/uaccess.h>
  80 #include <asm/page.h>
  81 #include <net/sock.h>
  82 #include <net/snmp.h>
  83 #include <net/sctp/structs.h>
  84 #include <net/sctp/constants.h>
  85
  86
  87 /* Set SCTP_DEBUG flag via config if not already set. */
  88 #ifndef SCTP_DEBUG
  89 #ifdef CONFIG_SCTP_DBG_MSG
  90 #define SCTP_DEBUG      1
  91 #else
  92 #define SCTP_DEBUG      0
  93 #endif /* CONFIG_SCTP_DBG */
  94 #endif /* SCTP_DEBUG */
  95
  96 #ifdef CONFIG_IP_SCTP_MODULE
  97 #define SCTP_PROTOSW_FLAG 0
  98 #else /* static! */
  99 #define SCTP_PROTOSW_FLAG INET_PROTOSW_PERMANENT
 100 #endif
 101
 102 /*
 103  * Function declarations.
 104  */
 105
 106 /*
 107  * sctp/protocol.c
 108  */
 109 extern int sctp_copy_local_addr_list(struct net *, struct sctp_bind_addr *,
 110                                      sctp_scope_t, gfp_t gfp,
 111                                      int flags);
 112 extern struct sctp_pf *sctp_get_pf_specific(sa_family_t family);
 113 extern int sctp_register_pf(struct sctp_pf *, sa_family_t);
 114 extern void sctp_addr_wq_mgmt(struct net *, struct sctp_sockaddr_entry *, int);
 115
 116 /*
 117  * sctp/socket.c
 118  */
 119 int sctp_backlog_rcv(struct sock *sk, struct sk_buff *skb);
 120 int sctp_inet_listen(struct socket *sock, int backlog);
 121 void sctp_write_space(struct sock *sk);
 122 void sctp_data_ready(struct sock *sk, int len);
 123 unsigned int sctp_poll(struct file *file, struct socket *sock,
 124                 poll_table *wait);
 125 void sctp_sock_rfree(struct sk_buff *skb);
 126 void sctp_copy_sock(struct sock *newsk, struct sock *sk,
 127                     struct sctp_association *asoc);
 128 extern struct percpu_counter sctp_sockets_allocated;
 129 extern int sctp_asconf_mgmt(struct sctp_sock *, struct sctp_sockaddr_entry *);
 130
 131 /*
 132  * sctp/primitive.c
 133  */
 134 int sctp_primitive_ASSOCIATE(struct net *, struct sctp_association *, void *arg);
 135 int sctp_primitive_SHUTDOWN(struct net *, struct sctp_association *, void *arg);
 136 int sctp_primitive_ABORT(struct net *, struct sctp_association *, void *arg);
 137 int sctp_primitive_SEND(struct net *, struct sctp_association *, void *arg);
 138 int sctp_primitive_REQUESTHEARTBEAT(struct net *, struct sctp_association *, void *arg);
 139 int sctp_primitive_ASCONF(struct net *, struct sctp_association *, void *arg);
 140
 141 /*
 142  * sctp/input.c
 143  */
 144 int sctp_rcv(struct sk_buff *skb);
 145 void sctp_v4_err(struct sk_buff *skb, u32 info);
 146 void sctp_hash_established(struct sctp_association *);
 147 void sctp_unhash_established(struct sctp_association *);
 148 void sctp_hash_endpoint(struct sctp_endpoint *);
 149 void sctp_unhash_endpoint(struct sctp_endpoint *);
 150 struct sock *sctp_err_lookup(struct net *net, int family, struct sk_buff *,
 151                              struct sctphdr *, struct sctp_association **,
 152                              struct sctp_transport **);
 153 void sctp_err_finish(struct sock *, struct sctp_association *);
 154 void sctp_icmp_frag_needed(struct sock *, struct sctp_association *,
 155                            struct sctp_transport *t, __u32 pmtu);
 156 void sctp_icmp_redirect(struct sock *, struct sctp_transport *,
 157                         struct sk_buff *);
 158 void sctp_icmp_proto_unreachable(struct sock *sk,
 159                                  struct sctp_association *asoc,
 160                                  struct sctp_transport *t);
 161 void sctp_backlog_migrate(struct sctp_association *assoc,
 162                           struct sock *oldsk, struct sock *newsk);
 163
 164 /*
 165  * sctp/proc.c
 166  */
 167 int sctp_snmp_proc_init(struct net *net);
 168 void sctp_snmp_proc_exit(struct net *net);
 169 int sctp_eps_proc_init(struct net *net);
 170 void sctp_eps_proc_exit(struct net *net);
 171 int sctp_assocs_proc_init(struct net *net);
 172 void sctp_assocs_proc_exit(struct net *net);
 173 int sctp_remaddr_proc_init(struct net *net);
 174 void sctp_remaddr_proc_exit(struct net *net);
 175
 176
 177 /*
 178  * Module global variables
 179  */
 180
 181  /*
 182   * sctp/protocol.c
 183   */
 184 extern struct kmem_cache *sctp_chunk_cachep __read_mostly;
 185 extern struct kmem_cache *sctp_bucket_cachep __read_mostly;
 186
 187 /*
 188  *  Section:  Macros, externs, and inlines
 189  */
 190
 191
 192 #ifdef TEST_FRAME
 193 #include <test_frame.h>
 194 #else
 195
 196 /* spin lock wrappers. */
 197 #define sctp_spin_lock_irqsave(lock, flags) spin_lock_irqsave(lock, flags)
 198 #define sctp_spin_unlock_irqrestore(lock, flags)  \
 199        spin_unlock_irqrestore(lock, flags)
 200 #define sctp_local_bh_disable() local_bh_disable()
 201 #define sctp_local_bh_enable()  local_bh_enable()
 202 #define sctp_spin_lock(lock)    spin_lock(lock)
 203 #define sctp_spin_unlock(lock)  spin_unlock(lock)
 204 #define sctp_write_lock(lock)   write_lock(lock)
 205 #define sctp_write_unlock(lock) write_unlock(lock)
 206 #define sctp_read_lock(lock)    read_lock(lock)
 207 #define sctp_read_unlock(lock)  read_unlock(lock)
 208
 209 /* sock lock wrappers. */
 210 #define sctp_lock_sock(sk)       lock_sock(sk)
 211 #define sctp_release_sock(sk)    release_sock(sk)
 212 #define sctp_bh_lock_sock(sk)    bh_lock_sock(sk)
 213 #define sctp_bh_unlock_sock(sk)  bh_unlock_sock(sk)
 214
 215 /* SCTP SNMP MIB stats handlers */
 216 #define SCTP_INC_STATS(net, field)      SNMP_INC_STATS((net)->sctp.sctp_statistics, field)
 217 #define SCTP_INC_STATS_BH(net, field)   SNMP_INC_STATS_BH((net)->sctp.sctp_statistics, field)
 218 #define SCTP_INC_STATS_USER(net, field) SNMP_INC_STATS_USER((net)->sctp.sctp_statistics, field)
 219 #define SCTP_DEC_STATS(net, field)      SNMP_DEC_STATS((net)->sctp.sctp_statistics, field)
 220
 221 #endif /* !TEST_FRAME */
 222
 223 /* sctp mib definitions */
 224 enum {
 225         SCTP_MIB_NUM = 0,
 226         SCTP_MIB_CURRESTAB,                     /* CurrEstab */
 227         SCTP_MIB_ACTIVEESTABS,                  /* ActiveEstabs */
 228         SCTP_MIB_PASSIVEESTABS,                 /* PassiveEstabs */
 229         SCTP_MIB_ABORTEDS,                      /* Aborteds */
 230         SCTP_MIB_SHUTDOWNS,                     /* Shutdowns */
 231         SCTP_MIB_OUTOFBLUES,                    /* OutOfBlues */
 232         SCTP_MIB_CHECKSUMERRORS,                /* ChecksumErrors */
 233         SCTP_MIB_OUTCTRLCHUNKS,                 /* OutCtrlChunks */
 234         SCTP_MIB_OUTORDERCHUNKS,                /* OutOrderChunks */
 235         SCTP_MIB_OUTUNORDERCHUNKS,              /* OutUnorderChunks */
 236         SCTP_MIB_INCTRLCHUNKS,                  /* InCtrlChunks */
 237         SCTP_MIB_INORDERCHUNKS,                 /* InOrderChunks */
 238         SCTP_MIB_INUNORDERCHUNKS,               /* InUnorderChunks */
 239         SCTP_MIB_FRAGUSRMSGS,                   /* FragUsrMsgs */
 240         SCTP_MIB_REASMUSRMSGS,                  /* ReasmUsrMsgs */
 241         SCTP_MIB_OUTSCTPPACKS,                  /* OutSCTPPacks */
 242         SCTP_MIB_INSCTPPACKS,                   /* InSCTPPacks */
 243         SCTP_MIB_T1_INIT_EXPIREDS,
 244         SCTP_MIB_T1_COOKIE_EXPIREDS,
 245         SCTP_MIB_T2_SHUTDOWN_EXPIREDS,
 246         SCTP_MIB_T3_RTX_EXPIREDS,
 247         SCTP_MIB_T4_RTO_EXPIREDS,
 248         SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS,
 249         SCTP_MIB_DELAY_SACK_EXPIREDS,
 250         SCTP_MIB_AUTOCLOSE_EXPIREDS,
 251         SCTP_MIB_T1_RETRANSMITS,
 252         SCTP_MIB_T3_RETRANSMITS,
 253         SCTP_MIB_PMTUD_RETRANSMITS,
 254         SCTP_MIB_FAST_RETRANSMITS,
 255         SCTP_MIB_IN_PKT_SOFTIRQ,
 256         SCTP_MIB_IN_PKT_BACKLOG,
 257         SCTP_MIB_IN_PKT_DISCARDS,
 258         SCTP_MIB_IN_DATA_CHUNK_DISCARDS,
 259         __SCTP_MIB_MAX
 260 };
 261
 262 #define SCTP_MIB_MAX    __SCTP_MIB_MAX
 263 struct sctp_mib {
 264         unsigned long   mibs[SCTP_MIB_MAX];
 265 };
 266
 267 /* helper function to track stats about max rto and related transport */
 268 static inline void sctp_max_rto(struct sctp_association *asoc,
 269                                 struct sctp_transport *trans)
 270 {
 271         if (asoc->stats.max_obs_rto < (__u64)trans->rto) {
 272                 asoc->stats.max_obs_rto = trans->rto;
 273                 memset(&asoc->stats.obs_rto_ipaddr, 0,
 274                         sizeof(struct sockaddr_storage));
 275                 memcpy(&asoc->stats.obs_rto_ipaddr, &trans->ipaddr,
 276                         trans->af_specific->sockaddr_len);
 277         }
 278 }
 279
 280 /* Print debugging messages.  */
 281 #if SCTP_DEBUG
 282 extern int sctp_debug_flag;
 283 #define SCTP_DEBUG_PRINTK(fmt, args...)                 \
 284 do {                                                    \
 285         if (sctp_debug_flag)                            \
 286                 printk(KERN_DEBUG pr_fmt(fmt), ##args); \
 287 } while (0)
 288 #define SCTP_DEBUG_PRINTK_CONT(fmt, args...)            \
 289 do {                                                    \
 290         if (sctp_debug_flag)                            \
 291                 pr_cont(fmt, ##args);                   \
 292 } while (0)
 293 #define SCTP_DEBUG_PRINTK_IPADDR(fmt_lead, fmt_trail,                   \
 294                                  args_lead, addr, args_trail...)        \
 295 do {                                                                    \
 296         const union sctp_addr *_addr = (addr);                          \
 297         if (sctp_debug_flag) {                                          \
 298                 if (_addr->sa.sa_family == AF_INET6) {                  \
 299                         printk(KERN_DEBUG                               \
 300                                pr_fmt(fmt_lead "%pI6" fmt_trail),       \
 301                                args_lead,                               \
 302                                &_addr->v6.sin6_addr,                    \
 303                                args_trail);                             \
 304                 } else {                                                \
 305                         printk(KERN_DEBUG                               \
 306                                pr_fmt(fmt_lead "%pI4" fmt_trail),       \
 307                                args_lead,                               \
 308                                &_addr->v4.sin_addr.s_addr,              \
 309                                args_trail);                             \
 310                 }                                                       \
 311         }                                                               \
 312 } while (0)
 313 #define SCTP_ENABLE_DEBUG { sctp_debug_flag = 1; }
 314 #define SCTP_DISABLE_DEBUG { sctp_debug_flag = 0; }
 315
 316 #define SCTP_ASSERT(expr, str, func) \
 317         if (!(expr)) { \
 318                 SCTP_DEBUG_PRINTK("Assertion Failed: %s(%s) at %s:%s:%d\n", \
 319                         str, (#expr), __FILE__, __func__, __LINE__); \
 320                 func; \
 321         }
 322
 323 #else   /* SCTP_DEBUG */
 324
 325 #define SCTP_DEBUG_PRINTK(whatever...)
 326 #define SCTP_DEBUG_PRINTK_CONT(fmt, args...)
 327 #define SCTP_DEBUG_PRINTK_IPADDR(whatever...)
 328 #define SCTP_ENABLE_DEBUG
 329 #define SCTP_DISABLE_DEBUG
 330 #define SCTP_ASSERT(expr, str, func)
 331
 332 #endif /* SCTP_DEBUG */
 333
 334
 335 /*
 336  * Macros for keeping a global reference of object allocations.
 337  */
 338 #ifdef CONFIG_SCTP_DBG_OBJCNT
 339
 340 extern atomic_t sctp_dbg_objcnt_sock;
 341 extern atomic_t sctp_dbg_objcnt_ep;
 342 extern atomic_t sctp_dbg_objcnt_assoc;
 343 extern atomic_t sctp_dbg_objcnt_transport;
 344 extern atomic_t sctp_dbg_objcnt_chunk;
 345 extern atomic_t sctp_dbg_objcnt_bind_addr;
 346 extern atomic_t sctp_dbg_objcnt_bind_bucket;
 347 extern atomic_t sctp_dbg_objcnt_addr;
 348 extern atomic_t sctp_dbg_objcnt_ssnmap;
 349 extern atomic_t sctp_dbg_objcnt_datamsg;
 350 extern atomic_t sctp_dbg_objcnt_keys;
 351
 352 /* Macros to atomically increment/decrement objcnt counters.  */
 353 #define SCTP_DBG_OBJCNT_INC(name) \
 354 atomic_inc(&sctp_dbg_objcnt_## name)
 355 #define SCTP_DBG_OBJCNT_DEC(name) \
 356 atomic_dec(&sctp_dbg_objcnt_## name)
 357 #define SCTP_DBG_OBJCNT(name) \
 358 atomic_t sctp_dbg_objcnt_## name = ATOMIC_INIT(0)
 359
 360 /* Macro to help create new entries in in the global array of
 361  * objcnt counters.
 362  */
 363 #define SCTP_DBG_OBJCNT_ENTRY(name) \
 364 {.label= #name, .counter= &sctp_dbg_objcnt_## name}
 365
 366 void sctp_dbg_objcnt_init(struct net *);
 367 void sctp_dbg_objcnt_exit(struct net *);
 368
 369 #else
 370
 371 #define SCTP_DBG_OBJCNT_INC(name)
 372 #define SCTP_DBG_OBJCNT_DEC(name)
 373
 374 static inline void sctp_dbg_objcnt_init(struct net *net) { return; }
 375 static inline void sctp_dbg_objcnt_exit(struct net *net) { return; }
 376
 377 #endif /* CONFIG_SCTP_DBG_OBJCOUNT */
 378
 379 #if defined CONFIG_SYSCTL
 380 void sctp_sysctl_register(void);
 381 void sctp_sysctl_unregister(void);
 382 int sctp_sysctl_net_register(struct net *net);
 383 void sctp_sysctl_net_unregister(struct net *net);
 384 #else
 385 static inline void sctp_sysctl_register(void) { return; }
 386 static inline void sctp_sysctl_unregister(void) { return; }
 387 static inline int sctp_sysctl_net_register(struct net *net) { return 0; }
 388 static inline void sctp_sysctl_net_unregister(struct net *net) { return; }
 389 #endif
 390
 391 /* Size of Supported Address Parameter for 'x' address types. */
 392 #define SCTP_SAT_LEN(x) (sizeof(struct sctp_paramhdr) + (x) * sizeof(__u16))
 393
 394 #if IS_ENABLED(CONFIG_IPV6)
 395
 396 void sctp_v6_pf_init(void);
 397 void sctp_v6_pf_exit(void);
 398 int sctp_v6_protosw_init(void);
 399 void sctp_v6_protosw_exit(void);
 400 int sctp_v6_add_protocol(void);
 401 void sctp_v6_del_protocol(void);
 402
 403 #else /* #ifdef defined(CONFIG_IPV6) */
 404
 405 static inline void sctp_v6_pf_init(void) { return; }
 406 static inline void sctp_v6_pf_exit(void) { return; }
 407 static inline int sctp_v6_protosw_init(void) { return 0; }
 408 static inline void sctp_v6_protosw_exit(void) { return; }
 409 static inline int sctp_v6_add_protocol(void) { return 0; }
 410 static inline void sctp_v6_del_protocol(void) { return; }
 411
 412 #endif /* #if defined(CONFIG_IPV6) */
 413
 414
 415 /* Map an association to an assoc_id. */
 416 static inline sctp_assoc_t sctp_assoc2id(const struct sctp_association *asoc)
 417 {
 418         return asoc ? asoc->assoc_id : 0;
 419 }
 420
 421 /* Look up the association by its id.  */
 422 struct sctp_association *sctp_id2assoc(struct sock *sk, sctp_assoc_t id);
 423
 424 int sctp_do_peeloff(struct sock *sk, sctp_assoc_t id, struct socket **sockp);
 425
 426 /* A macro to walk a list of skbs.  */
 427 #define sctp_skb_for_each(pos, head, tmp) \
 428         skb_queue_walk_safe(head, pos, tmp)
 429
 430 /* A helper to append an entire skb list (list) to another (head). */
 431 static inline void sctp_skb_list_tail(struct sk_buff_head *list,
 432                                       struct sk_buff_head *head)
 433 {
 434         unsigned long flags;
 435
 436         sctp_spin_lock_irqsave(&head->lock, flags);
 437         sctp_spin_lock(&list->lock);
 438
 439         skb_queue_splice_tail_init(list, head);
 440
 441         sctp_spin_unlock(&list->lock);
 442         sctp_spin_unlock_irqrestore(&head->lock, flags);
 443 }
 444
 445 /**
 446  *      sctp_list_dequeue - remove from the head of the queue
 447  *      @list: list to dequeue from
 448  *
 449  *      Remove the head of the list. The head item is
 450  *      returned or %NULL if the list is empty.
 451  */
 452
 453 static inline struct list_head *sctp_list_dequeue(struct list_head *list)
 454 {
 455         struct list_head *result = NULL;
 456
 457         if (list->next != list) {
 458                 result = list->next;
 459                 list->next = result->next;
 460                 list->next->prev = list;
 461                 INIT_LIST_HEAD(result);
 462         }
 463         return result;
 464 }
 465
 466 /* SCTP version of skb_set_owner_r.  We need this one because
 467  * of the way we have to do receive buffer accounting on bundled
 468  * chunks.
 469  */
 470 static inline void sctp_skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
 471 {
 472         struct sctp_ulpevent *event = sctp_skb2event(skb);
 473
 474         skb_orphan(skb);
 475         skb->sk = sk;
 476         skb->destructor = sctp_sock_rfree;
 477         atomic_add(event->rmem_len, &sk->sk_rmem_alloc);
 478         /*
 479          * This mimics the behavior of skb_set_owner_r
 480          */
 481         sk->sk_forward_alloc -= event->rmem_len;
 482 }
 483
 484 /* Tests if the list has one and only one entry. */
 485 static inline int sctp_list_single_entry(struct list_head *head)
 486 {
 487         return (head->next != head) && (head->next == head->prev);
 488 }
 489
 490 /* Generate a random jitter in the range of -50% ~ +50% of input RTO. */
 491 static inline __s32 sctp_jitter(__u32 rto)
 492 {
 493         static __u32 sctp_rand;
 494         __s32 ret;
 495
 496         /* Avoid divide by zero. */
 497         if (!rto)
 498                 rto = 1;
 499
 500         sctp_rand += jiffies;
 501         sctp_rand ^= (sctp_rand << 12);
 502         sctp_rand ^= (sctp_rand >> 20);
 503
 504         /* Choose random number from 0 to rto, then move to -50% ~ +50%
 505          * of rto.
 506          */
 507         ret = sctp_rand % rto - (rto >> 1);
 508         return ret;
 509 }
 510
 511 /* Break down data chunks at this point.  */
 512 static inline int sctp_frag_point(const struct sctp_association *asoc, int pmtu)
 513 {
 514         struct sctp_sock *sp = sctp_sk(asoc->base.sk);
 515         int frag = pmtu;
 516
 517         frag -= sp->pf->af->net_header_len;
 518         frag -= sizeof(struct sctphdr) + sizeof(struct sctp_data_chunk);
 519
 520         if (asoc->user_frag)
 521                 frag = min_t(int, frag, asoc->user_frag);
 522
 523         frag = min_t(int, frag, SCTP_MAX_CHUNK_LEN);
 524
 525         return frag;
 526 }
 527
 528 static inline void sctp_assoc_pending_pmtu(struct sock *sk, struct sctp_association *asoc)
 529 {
 530
 531         sctp_assoc_sync_pmtu(sk, asoc);
 532         asoc->pmtu_pending = 0;
 533 }
 534
 535 /* Walk through a list of TLV parameters.  Don't trust the
 536  * individual parameter lengths and instead depend on
 537  * the chunk length to indicate when to stop.  Make sure
 538  * there is room for a param header too.
 539  */
 540 #define sctp_walk_params(pos, chunk, member)\
 541 _sctp_walk_params((pos), (chunk), ntohs((chunk)->chunk_hdr.length), member)
 542
 543 #define _sctp_walk_params(pos, chunk, end, member)\
 544 for (pos.v = chunk->member;\
 545      pos.v <= (void *)chunk + end - ntohs(pos.p->length) &&\
 546      ntohs(pos.p->length) >= sizeof(sctp_paramhdr_t);\
 547      pos.v += WORD_ROUND(ntohs(pos.p->length)))
 548
 549 #define sctp_walk_errors(err, chunk_hdr)\
 550 _sctp_walk_errors((err), (chunk_hdr), ntohs((chunk_hdr)->length))
 551
 552 #define _sctp_walk_errors(err, chunk_hdr, end)\
 553 for (err = (sctp_errhdr_t *)((void *)chunk_hdr + \
 554             sizeof(sctp_chunkhdr_t));\
 555      (void *)err <= (void *)chunk_hdr + end - ntohs(err->length) &&\
 556      ntohs(err->length) >= sizeof(sctp_errhdr_t); \
 557      err = (sctp_errhdr_t *)((void *)err + WORD_ROUND(ntohs(err->length))))
 558
 559 #define sctp_walk_fwdtsn(pos, chunk)\
 560 _sctp_walk_fwdtsn((pos), (chunk), ntohs((chunk)->chunk_hdr->length) - sizeof(struct sctp_fwdtsn_chunk))
 561
 562 #define _sctp_walk_fwdtsn(pos, chunk, end)\
 563 for (pos = chunk->subh.fwdtsn_hdr->skip;\
 564      (void *)pos <= (void *)chunk->subh.fwdtsn_hdr->skip + end - sizeof(struct sctp_fwdtsn_skip);\
 565      pos++)
 566
 567 /* Round an int up to the next multiple of 4.  */
 568 #define WORD_ROUND(s) (((s)+3)&~3)
 569
 570 /* Compare two timevals.  */
 571 #define tv_lt(s, t) \
 572    (s.tv_sec < t.tv_sec || (s.tv_sec == t.tv_sec && s.tv_usec < t.tv_usec))
 573
 574 /* Add tv1 to tv2. */
 575 #define TIMEVAL_ADD(tv1, tv2) \
 576 ({ \
 577         suseconds_t usecs = (tv2).tv_usec + (tv1).tv_usec; \
 578         time_t secs = (tv2).tv_sec + (tv1).tv_sec; \
 579 \
 580         if (usecs >= 1000000) { \
 581                 usecs -= 1000000; \
 582                 secs++; \
 583         } \
 584         (tv2).tv_sec = secs; \
 585         (tv2).tv_usec = usecs; \
 586 })
 587
 588 /* External references. */
 589
 590 extern struct proto sctp_prot;
 591 extern struct proto sctpv6_prot;
 592 void sctp_put_port(struct sock *sk);
 593
 594 extern struct idr sctp_assocs_id;
 595 extern spinlock_t sctp_assocs_id_lock;
 596
 597 /* Static inline functions. */
 598
 599 /* Convert from an IP version number to an Address Family symbol.  */
 600 static inline int ipver2af(__u8 ipver)
 601 {
 602         switch (ipver) {
 603         case 4:
 604                 return  AF_INET;
 605         case 6:
 606                 return AF_INET6;
 607         default:
 608                 return 0;
 609         }
 610 }
 611
 612 /* Convert from an address parameter type to an address family.  */
 613 static inline int param_type2af(__be16 type)
 614 {
 615         switch (type) {
 616         case SCTP_PARAM_IPV4_ADDRESS:
 617                 return  AF_INET;
 618         case SCTP_PARAM_IPV6_ADDRESS:
 619                 return AF_INET6;
 620         default:
 621                 return 0;
 622         }
 623 }
 624
 625 /* Perform some sanity checks. */
 626 static inline int sctp_sanity_check(void)
 627 {
 628         SCTP_ASSERT(sizeof(struct sctp_ulpevent) <=
 629                     sizeof(((struct sk_buff *)0)->cb),
 630                     "SCTP: ulpevent does not fit in skb!\n", return 0);
 631
 632         return 1;
 633 }
 634
 635 /* Warning: The following hash functions assume a power of two 'size'. */
 636 /* This is the hash function for the SCTP port hash table. */
 637 static inline int sctp_phashfn(struct net *net, __u16 lport)
 638 {
 639         return (net_hash_mix(net) + lport) & (sctp_port_hashsize - 1);
 640 }
 641
 642 /* This is the hash function for the endpoint hash table. */
 643 static inline int sctp_ep_hashfn(struct net *net, __u16 lport)
 644 {
 645         return (net_hash_mix(net) + lport) & (sctp_ep_hashsize - 1);
 646 }
 647
 648 /* This is the hash function for the association hash table. */
 649 static inline int sctp_assoc_hashfn(struct net *net, __u16 lport, __u16 rport)
 650 {
 651         int h = (lport << 16) + rport + net_hash_mix(net);
 652         h ^= h>>8;
 653         return h & (sctp_assoc_hashsize - 1);
 654 }
 655
 656 /* This is the hash function for the association hash table.  This is
 657  * not used yet, but could be used as a better hash function when
 658  * we have a vtag.
 659  */
 660 static inline int sctp_vtag_hashfn(__u16 lport, __u16 rport, __u32 vtag)
 661 {
 662         int h = (lport << 16) + rport;
 663         h ^= vtag;
 664         return h & (sctp_assoc_hashsize - 1);
 665 }
 666
 667 #define sctp_for_each_hentry(epb, head) \
 668         hlist_for_each_entry(epb, head, node)
 669
 670 /* Is a socket of this style? */
 671 #define sctp_style(sk, style) __sctp_style((sk), (SCTP_SOCKET_##style))
 672 static inline int __sctp_style(const struct sock *sk, sctp_socket_type_t style)
 673 {
 674         return sctp_sk(sk)->type == style;
 675 }
 676
 677 /* Is the association in this state? */
 678 #define sctp_state(asoc, state) __sctp_state((asoc), (SCTP_STATE_##state))
 679 static inline int __sctp_state(const struct sctp_association *asoc,
 680                                sctp_state_t state)
 681 {
 682         return asoc->state == state;
 683 }
 684
 685 /* Is the socket in this state? */
 686 #define sctp_sstate(sk, state) __sctp_sstate((sk), (SCTP_SS_##state))
 687 static inline int __sctp_sstate(const struct sock *sk, sctp_sock_state_t state)
 688 {
 689         return sk->sk_state == state;
 690 }
 691
 692 /* Map v4-mapped v6 address back to v4 address */
 693 static inline void sctp_v6_map_v4(union sctp_addr *addr)
 694 {
 695         addr->v4.sin_family = AF_INET;
 696         addr->v4.sin_port = addr->v6.sin6_port;
 697         addr->v4.sin_addr.s_addr = addr->v6.sin6_addr.s6_addr32[3];
 698 }
 699
 700 /* Map v4 address to v4-mapped v6 address */
 701 static inline void sctp_v4_map_v6(union sctp_addr *addr)
 702 {
 703         addr->v6.sin6_family = AF_INET6;
 704         addr->v6.sin6_port = addr->v4.sin_port;
 705         addr->v6.sin6_addr.s6_addr32[3] = addr->v4.sin_addr.s_addr;
 706         addr->v6.sin6_addr.s6_addr32[0] = 0;
 707         addr->v6.sin6_addr.s6_addr32[1] = 0;
 708         addr->v6.sin6_addr.s6_addr32[2] = htonl(0x0000ffff);
 709 }
 710
 711 /* The cookie is always 0 since this is how it's used in the
 712  * pmtu code.
 713  */
 714 static inline struct dst_entry *sctp_transport_dst_check(struct sctp_transport *t)
 715 {
 716         if (t->dst && !dst_check(t->dst, 0)) {
 717                 dst_release(t->dst);
 718                 t->dst = NULL;
 719         }
 720
 721         return t->dst;
 722 }
 723
 724 #endif /* __net_sctp_h__ */