blob: 9c6414f553f91f2256698323ea5d8ec72db4e868 [file] [log] [blame]
Vlad Yasevich60c778b2008-01-11 09:57:09 -05001/* SCTP kernel implementation
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * (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 *
Vlad Yasevich60c778b2008-01-11 09:57:09 -05007 * This file is part of the SCTP kernel implementation
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * The base lksctp header.
10 *
Vlad Yasevich60c778b2008-01-11 09:57:09 -050011 * This SCTP implementation is free software;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * 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 *
Vlad Yasevich60c778b2008-01-11 09:57:09 -050017 * This SCTP implementation is distributed in the hope that it
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#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
Eric Dumazetdfd56b82011-12-10 09:48:31 +000074#if IS_ENABLED(CONFIG_IPV6)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075#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/* Certain internal static functions need to be exported when
104 * compiled into the test frame.
105 */
106#ifndef SCTP_STATIC
107#define SCTP_STATIC static
108#endif
109
110/*
111 * Function declarations.
112 */
113
114/*
115 * sctp/protocol.c
116 */
Eric W. Biederman4db67e82012-08-06 08:42:04 +0000117extern int sctp_copy_local_addr_list(struct net *, struct sctp_bind_addr *,
Al Virodd0fc662005-10-07 07:46:04 +0100118 sctp_scope_t, gfp_t gfp,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -0700119 int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120extern struct sctp_pf *sctp_get_pf_specific(sa_family_t family);
121extern int sctp_register_pf(struct sctp_pf *, sa_family_t);
Eric W. Biederman4db67e82012-08-06 08:42:04 +0000122extern void sctp_addr_wq_mgmt(struct net *, struct sctp_sockaddr_entry *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124/*
125 * sctp/socket.c
126 */
127int sctp_backlog_rcv(struct sock *sk, struct sk_buff *skb);
128int sctp_inet_listen(struct socket *sock, int backlog);
129void sctp_write_space(struct sock *sk);
Wei Yongjun561b1732010-04-28 08:47:18 +0000130void sctp_data_ready(struct sock *sk, int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131unsigned int sctp_poll(struct file *file, struct socket *sock,
132 poll_table *wait);
Vlad Yasevich331c4ee2006-10-09 21:34:04 -0700133void sctp_sock_rfree(struct sk_buff *skb);
Vlad Yasevich914e1c82009-02-13 08:33:44 +0000134void sctp_copy_sock(struct sock *newsk, struct sock *sk,
135 struct sctp_association *asoc);
Eric Dumazet17483762008-11-25 21:16:35 -0800136extern struct percpu_counter sctp_sockets_allocated;
Michio Honda9f7d6532011-04-26 19:32:51 +0900137extern int sctp_asconf_mgmt(struct sctp_sock *, struct sctp_sockaddr_entry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/*
140 * sctp/primitive.c
141 */
Eric W. Biederman55e26eb2012-08-07 07:25:24 +0000142int sctp_primitive_ASSOCIATE(struct net *, struct sctp_association *, void *arg);
143int sctp_primitive_SHUTDOWN(struct net *, struct sctp_association *, void *arg);
144int sctp_primitive_ABORT(struct net *, struct sctp_association *, void *arg);
145int sctp_primitive_SEND(struct net *, struct sctp_association *, void *arg);
146int sctp_primitive_REQUESTHEARTBEAT(struct net *, struct sctp_association *, void *arg);
147int sctp_primitive_ASCONF(struct net *, struct sctp_association *, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * sctp/input.c
151 */
152int sctp_rcv(struct sk_buff *skb);
153void sctp_v4_err(struct sk_buff *skb, u32 info);
154void sctp_hash_established(struct sctp_association *);
155void sctp_unhash_established(struct sctp_association *);
156void sctp_hash_endpoint(struct sctp_endpoint *);
157void sctp_unhash_endpoint(struct sctp_endpoint *);
Eric W. Biederman4110cc22012-08-06 08:41:13 +0000158struct sock *sctp_err_lookup(struct net *net, int family, struct sk_buff *,
Sridhar Samudralad1ad1ff2005-07-18 13:44:10 -0700159 struct sctphdr *, struct sctp_association **,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 struct sctp_transport **);
Sridhar Samudralad1ad1ff2005-07-18 13:44:10 -0700161void sctp_err_finish(struct sock *, struct sctp_association *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162void sctp_icmp_frag_needed(struct sock *, struct sctp_association *,
163 struct sctp_transport *t, __u32 pmtu);
David S. Millerec18d9a2012-07-12 00:25:15 -0700164void sctp_icmp_redirect(struct sock *, struct sctp_transport *,
165 struct sk_buff *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166void sctp_icmp_proto_unreachable(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 struct sctp_association *asoc,
168 struct sctp_transport *t);
Sridhar Samudralac4d24442006-01-17 11:56:26 -0800169void sctp_backlog_migrate(struct sctp_association *assoc,
170 struct sock *oldsk, struct sock *newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172/*
Adrian Bunk16164362006-09-18 00:40:38 -0700173 * sctp/proc.c
174 */
Eric W. Biederman13d782f2012-08-06 08:45:15 +0000175int sctp_snmp_proc_init(struct net *net);
176void sctp_snmp_proc_exit(struct net *net);
177int sctp_eps_proc_init(struct net *net);
178void sctp_eps_proc_exit(struct net *net);
179int sctp_assocs_proc_init(struct net *net);
180void sctp_assocs_proc_exit(struct net *net);
181int sctp_remaddr_proc_init(struct net *net);
182void sctp_remaddr_proc_exit(struct net *net);
Adrian Bunk16164362006-09-18 00:40:38 -0700183
184
185/*
sebastian@breakpoint.cc0a5fcb92007-07-26 23:21:32 +0200186 * Module global variables
187 */
188
189 /*
190 * sctp/protocol.c
191 */
192extern struct kmem_cache *sctp_chunk_cachep __read_mostly;
193extern struct kmem_cache *sctp_bucket_cachep __read_mostly;
194
195/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 * Section: Macros, externs, and inlines
197 */
198
199
200#ifdef TEST_FRAME
201#include <test_frame.h>
202#else
203
204/* spin lock wrappers. */
205#define sctp_spin_lock_irqsave(lock, flags) spin_lock_irqsave(lock, flags)
206#define sctp_spin_unlock_irqrestore(lock, flags) \
207 spin_unlock_irqrestore(lock, flags)
208#define sctp_local_bh_disable() local_bh_disable()
209#define sctp_local_bh_enable() local_bh_enable()
210#define sctp_spin_lock(lock) spin_lock(lock)
211#define sctp_spin_unlock(lock) spin_unlock(lock)
212#define sctp_write_lock(lock) write_lock(lock)
213#define sctp_write_unlock(lock) write_unlock(lock)
214#define sctp_read_lock(lock) read_lock(lock)
215#define sctp_read_unlock(lock) read_unlock(lock)
216
217/* sock lock wrappers. */
218#define sctp_lock_sock(sk) lock_sock(sk)
219#define sctp_release_sock(sk) release_sock(sk)
220#define sctp_bh_lock_sock(sk) bh_lock_sock(sk)
221#define sctp_bh_unlock_sock(sk) bh_unlock_sock(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223/* SCTP SNMP MIB stats handlers */
Eric W. Biedermanb01a2402012-08-06 08:47:55 +0000224#define SCTP_INC_STATS(net, field) SNMP_INC_STATS((net)->sctp.sctp_statistics, field)
225#define SCTP_INC_STATS_BH(net, field) SNMP_INC_STATS_BH((net)->sctp.sctp_statistics, field)
226#define SCTP_INC_STATS_USER(net, field) SNMP_INC_STATS_USER((net)->sctp.sctp_statistics, field)
227#define SCTP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->sctp.sctp_statistics, field)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229#endif /* !TEST_FRAME */
230
Sridhar Samudralaac0b0462006-08-22 00:15:33 -0700231/* sctp mib definitions */
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000232enum {
Sridhar Samudralaac0b0462006-08-22 00:15:33 -0700233 SCTP_MIB_NUM = 0,
234 SCTP_MIB_CURRESTAB, /* CurrEstab */
235 SCTP_MIB_ACTIVEESTABS, /* ActiveEstabs */
236 SCTP_MIB_PASSIVEESTABS, /* PassiveEstabs */
237 SCTP_MIB_ABORTEDS, /* Aborteds */
238 SCTP_MIB_SHUTDOWNS, /* Shutdowns */
239 SCTP_MIB_OUTOFBLUES, /* OutOfBlues */
240 SCTP_MIB_CHECKSUMERRORS, /* ChecksumErrors */
241 SCTP_MIB_OUTCTRLCHUNKS, /* OutCtrlChunks */
242 SCTP_MIB_OUTORDERCHUNKS, /* OutOrderChunks */
243 SCTP_MIB_OUTUNORDERCHUNKS, /* OutUnorderChunks */
244 SCTP_MIB_INCTRLCHUNKS, /* InCtrlChunks */
245 SCTP_MIB_INORDERCHUNKS, /* InOrderChunks */
246 SCTP_MIB_INUNORDERCHUNKS, /* InUnorderChunks */
247 SCTP_MIB_FRAGUSRMSGS, /* FragUsrMsgs */
248 SCTP_MIB_REASMUSRMSGS, /* ReasmUsrMsgs */
249 SCTP_MIB_OUTSCTPPACKS, /* OutSCTPPacks */
250 SCTP_MIB_INSCTPPACKS, /* InSCTPPacks */
251 SCTP_MIB_T1_INIT_EXPIREDS,
252 SCTP_MIB_T1_COOKIE_EXPIREDS,
253 SCTP_MIB_T2_SHUTDOWN_EXPIREDS,
254 SCTP_MIB_T3_RTX_EXPIREDS,
255 SCTP_MIB_T4_RTO_EXPIREDS,
256 SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS,
257 SCTP_MIB_DELAY_SACK_EXPIREDS,
258 SCTP_MIB_AUTOCLOSE_EXPIREDS,
Vlad Yasevichb6157d82007-10-24 15:59:16 -0400259 SCTP_MIB_T1_RETRANSMITS,
Sridhar Samudralaac0b0462006-08-22 00:15:33 -0700260 SCTP_MIB_T3_RETRANSMITS,
261 SCTP_MIB_PMTUD_RETRANSMITS,
262 SCTP_MIB_FAST_RETRANSMITS,
263 SCTP_MIB_IN_PKT_SOFTIRQ,
264 SCTP_MIB_IN_PKT_BACKLOG,
265 SCTP_MIB_IN_PKT_DISCARDS,
266 SCTP_MIB_IN_DATA_CHUNK_DISCARDS,
267 __SCTP_MIB_MAX
268};
269
270#define SCTP_MIB_MAX __SCTP_MIB_MAX
271struct sctp_mib {
272 unsigned long mibs[SCTP_MIB_MAX];
Eric Dumazetec733b152010-03-18 20:36:06 +0000273};
Sridhar Samudralaac0b0462006-08-22 00:15:33 -0700274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276/* Print debugging messages. */
277#if SCTP_DEBUG
278extern int sctp_debug_flag;
Joe Perches145ce502010-08-24 13:21:08 +0000279#define SCTP_DEBUG_PRINTK(fmt, args...) \
280do { \
281 if (sctp_debug_flag) \
282 printk(KERN_DEBUG pr_fmt(fmt), ##args); \
283} while (0)
284#define SCTP_DEBUG_PRINTK_CONT(fmt, args...) \
285do { \
286 if (sctp_debug_flag) \
287 pr_cont(fmt, ##args); \
288} while (0)
289#define SCTP_DEBUG_PRINTK_IPADDR(fmt_lead, fmt_trail, \
YOSHIFUJI Hideaki3ced2dd2011-04-26 19:23:24 +0900290 args_lead, addr, args_trail...) \
Joe Perches145ce502010-08-24 13:21:08 +0000291do { \
YOSHIFUJI Hideaki3ced2dd2011-04-26 19:23:24 +0900292 const union sctp_addr *_addr = (addr); \
Joe Perches145ce502010-08-24 13:21:08 +0000293 if (sctp_debug_flag) { \
YOSHIFUJI Hideaki3ced2dd2011-04-26 19:23:24 +0900294 if (_addr->sa.sa_family == AF_INET6) { \
Joe Perches145ce502010-08-24 13:21:08 +0000295 printk(KERN_DEBUG \
296 pr_fmt(fmt_lead "%pI6" fmt_trail), \
297 args_lead, \
YOSHIFUJI Hideaki3ced2dd2011-04-26 19:23:24 +0900298 &_addr->v6.sin6_addr, \
Joe Perches145ce502010-08-24 13:21:08 +0000299 args_trail); \
300 } else { \
301 printk(KERN_DEBUG \
302 pr_fmt(fmt_lead "%pI4" fmt_trail), \
303 args_lead, \
YOSHIFUJI Hideaki3ced2dd2011-04-26 19:23:24 +0900304 &_addr->v4.sin_addr.s_addr, \
Joe Perches145ce502010-08-24 13:21:08 +0000305 args_trail); \
306 } \
307 } \
308} while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309#define SCTP_ENABLE_DEBUG { sctp_debug_flag = 1; }
310#define SCTP_DISABLE_DEBUG { sctp_debug_flag = 0; }
311
312#define SCTP_ASSERT(expr, str, func) \
313 if (!(expr)) { \
314 SCTP_DEBUG_PRINTK("Assertion Failed: %s(%s) at %s:%s:%d\n", \
Harvey Harrisond5c003b2008-10-15 22:01:24 -0700315 str, (#expr), __FILE__, __func__, __LINE__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 func; \
317 }
318
319#else /* SCTP_DEBUG */
320
321#define SCTP_DEBUG_PRINTK(whatever...)
Joe Perches145ce502010-08-24 13:21:08 +0000322#define SCTP_DEBUG_PRINTK_CONT(fmt, args...)
Frank Filz3f7a87d2005-06-20 13:14:57 -0700323#define SCTP_DEBUG_PRINTK_IPADDR(whatever...)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324#define SCTP_ENABLE_DEBUG
325#define SCTP_DISABLE_DEBUG
David S. Miller65fd28f2006-06-20 00:07:52 -0700326#define SCTP_ASSERT(expr, str, func)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328#endif /* SCTP_DEBUG */
329
330
331/*
332 * Macros for keeping a global reference of object allocations.
333 */
334#ifdef CONFIG_SCTP_DBG_OBJCNT
335
336extern atomic_t sctp_dbg_objcnt_sock;
337extern atomic_t sctp_dbg_objcnt_ep;
338extern atomic_t sctp_dbg_objcnt_assoc;
339extern atomic_t sctp_dbg_objcnt_transport;
340extern atomic_t sctp_dbg_objcnt_chunk;
341extern atomic_t sctp_dbg_objcnt_bind_addr;
342extern atomic_t sctp_dbg_objcnt_bind_bucket;
343extern atomic_t sctp_dbg_objcnt_addr;
344extern atomic_t sctp_dbg_objcnt_ssnmap;
345extern atomic_t sctp_dbg_objcnt_datamsg;
Vlad Yasevich1f485642007-10-09 01:15:59 -0700346extern atomic_t sctp_dbg_objcnt_keys;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348/* Macros to atomically increment/decrement objcnt counters. */
349#define SCTP_DBG_OBJCNT_INC(name) \
350atomic_inc(&sctp_dbg_objcnt_## name)
351#define SCTP_DBG_OBJCNT_DEC(name) \
352atomic_dec(&sctp_dbg_objcnt_## name)
353#define SCTP_DBG_OBJCNT(name) \
354atomic_t sctp_dbg_objcnt_## name = ATOMIC_INIT(0)
355
356/* Macro to help create new entries in in the global array of
357 * objcnt counters.
358 */
359#define SCTP_DBG_OBJCNT_ENTRY(name) \
360{.label= #name, .counter= &sctp_dbg_objcnt_## name}
361
Eric W. Biederman13d782f2012-08-06 08:45:15 +0000362void sctp_dbg_objcnt_init(struct net *);
363void sctp_dbg_objcnt_exit(struct net *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365#else
366
367#define SCTP_DBG_OBJCNT_INC(name)
368#define SCTP_DBG_OBJCNT_DEC(name)
369
Cong Wang1f07b622012-08-15 18:18:11 +0800370static inline void sctp_dbg_objcnt_init(struct net *net) { return; }
371static inline void sctp_dbg_objcnt_exit(struct net *net) { return; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373#endif /* CONFIG_SCTP_DBG_OBJCOUNT */
374
375#if defined CONFIG_SYSCTL
376void sctp_sysctl_register(void);
377void sctp_sysctl_unregister(void);
Eric W. Biedermanebb7e952012-08-07 07:23:59 +0000378int sctp_sysctl_net_register(struct net *net);
379void sctp_sysctl_net_unregister(struct net *net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380#else
381static inline void sctp_sysctl_register(void) { return; }
382static inline void sctp_sysctl_unregister(void) { return; }
Eric W. Biedermanebb7e952012-08-07 07:23:59 +0000383static inline int sctp_sysctl_net_register(struct net *net) { return 0; }
384static inline void sctp_sysctl_net_unregister(struct net *net) { return; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385#endif
386
387/* Size of Supported Address Parameter for 'x' address types. */
388#define SCTP_SAT_LEN(x) (sizeof(struct sctp_paramhdr) + (x) * sizeof(__u16))
389
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000390#if IS_ENABLED(CONFIG_IPV6)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Vlad Yasevich270637a2008-03-20 15:17:14 -0700392void sctp_v6_pf_init(void);
393void sctp_v6_pf_exit(void);
394int sctp_v6_protosw_init(void);
395void sctp_v6_protosw_exit(void);
Sridhar Samudrala827bf122007-05-04 13:36:30 -0700396int sctp_v6_add_protocol(void);
397void sctp_v6_del_protocol(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399#else /* #ifdef defined(CONFIG_IPV6) */
400
David S. Miller12338232008-03-21 15:40:47 -0700401static inline void sctp_v6_pf_init(void) { return; }
Vlad Yasevich270637a2008-03-20 15:17:14 -0700402static inline void sctp_v6_pf_exit(void) { return; }
403static inline int sctp_v6_protosw_init(void) { return 0; }
404static inline void sctp_v6_protosw_exit(void) { return; }
Sridhar Samudrala827bf122007-05-04 13:36:30 -0700405static inline int sctp_v6_add_protocol(void) { return 0; }
406static inline void sctp_v6_del_protocol(void) { return; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408#endif /* #if defined(CONFIG_IPV6) */
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411/* Map an association to an assoc_id. */
412static inline sctp_assoc_t sctp_assoc2id(const struct sctp_association *asoc)
413{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000414 return asoc ? asoc->assoc_id : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415}
416
417/* Look up the association by its id. */
418struct sctp_association *sctp_id2assoc(struct sock *sk, sctp_assoc_t id);
419
Benjamin Poirier0343c552012-03-08 05:55:58 +0000420int sctp_do_peeloff(struct sock *sk, sctp_assoc_t id, struct socket **sockp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422/* A macro to walk a list of skbs. */
423#define sctp_skb_for_each(pos, head, tmp) \
David S. Miller3d092742008-09-22 22:14:36 -0700424 skb_queue_walk_safe(head, pos, tmp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426/* A helper to append an entire skb list (list) to another (head). */
427static inline void sctp_skb_list_tail(struct sk_buff_head *list,
428 struct sk_buff_head *head)
429{
430 unsigned long flags;
431
432 sctp_spin_lock_irqsave(&head->lock, flags);
433 sctp_spin_lock(&list->lock);
434
David S. Miller3d092742008-09-22 22:14:36 -0700435 skb_queue_splice_tail_init(list, head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437 sctp_spin_unlock(&list->lock);
438 sctp_spin_unlock_irqrestore(&head->lock, flags);
439}
440
441/**
442 * sctp_list_dequeue - remove from the head of the queue
443 * @list: list to dequeue from
444 *
445 * Remove the head of the list. The head item is
446 * returned or %NULL if the list is empty.
447 */
448
449static inline struct list_head *sctp_list_dequeue(struct list_head *list)
450{
451 struct list_head *result = NULL;
452
453 if (list->next != list) {
454 result = list->next;
455 list->next = result->next;
456 list->next->prev = list;
457 INIT_LIST_HEAD(result);
458 }
459 return result;
460}
461
Vlad Yasevich331c4ee2006-10-09 21:34:04 -0700462/* SCTP version of skb_set_owner_r. We need this one because
463 * of the way we have to do receive buffer accounting on bundled
464 * chunks.
465 */
466static inline void sctp_skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
467{
468 struct sctp_ulpevent *event = sctp_skb2event(skb);
469
Herbert Xud55d87f2009-06-22 02:25:25 +0000470 skb_orphan(skb);
Vlad Yasevich331c4ee2006-10-09 21:34:04 -0700471 skb->sk = sk;
472 skb->destructor = sctp_sock_rfree;
473 atomic_add(event->rmem_len, &sk->sk_rmem_alloc);
Neil Horman4d93df02007-08-15 16:07:44 -0700474 /*
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800475 * This mimics the behavior of skb_set_owner_r
Neil Horman4d93df02007-08-15 16:07:44 -0700476 */
477 sk->sk_forward_alloc -= event->rmem_len;
Vlad Yasevich331c4ee2006-10-09 21:34:04 -0700478}
479
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480/* Tests if the list has one and only one entry. */
481static inline int sctp_list_single_entry(struct list_head *head)
482{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000483 return (head->next != head) && (head->next == head->prev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484}
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486/* Generate a random jitter in the range of -50% ~ +50% of input RTO. */
487static inline __s32 sctp_jitter(__u32 rto)
488{
489 static __u32 sctp_rand;
490 __s32 ret;
491
492 /* Avoid divide by zero. */
493 if (!rto)
494 rto = 1;
495
496 sctp_rand += jiffies;
497 sctp_rand ^= (sctp_rand << 12);
498 sctp_rand ^= (sctp_rand >> 20);
499
500 /* Choose random number from 0 to rto, then move to -50% ~ +50%
501 * of rto.
502 */
503 ret = sctp_rand % rto - (rto >> 1);
504 return ret;
505}
506
507/* Break down data chunks at this point. */
Vlad Yasevichf68b2e02009-09-04 18:21:00 -0400508static inline int sctp_frag_point(const struct sctp_association *asoc, int pmtu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Vlad Yasevichf68b2e02009-09-04 18:21:00 -0400510 struct sctp_sock *sp = sctp_sk(asoc->base.sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 int frag = pmtu;
512
513 frag -= sp->pf->af->net_header_len;
514 frag -= sizeof(struct sctphdr) + sizeof(struct sctp_data_chunk);
515
Vlad Yasevichf68b2e02009-09-04 18:21:00 -0400516 if (asoc->user_frag)
517 frag = min_t(int, frag, asoc->user_frag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519 frag = min_t(int, frag, SCTP_MAX_CHUNK_LEN);
520
521 return frag;
522}
523
David S. Miller02f3d4c2012-07-16 03:57:14 -0700524static inline void sctp_assoc_pending_pmtu(struct sock *sk, struct sctp_association *asoc)
Vlad Yasevich8a479492007-06-07 14:21:05 -0400525{
526
David S. Miller02f3d4c2012-07-16 03:57:14 -0700527 sctp_assoc_sync_pmtu(sk, asoc);
Vlad Yasevich8a479492007-06-07 14:21:05 -0400528 asoc->pmtu_pending = 0;
529}
530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531/* Walk through a list of TLV parameters. Don't trust the
532 * individual parameter lengths and instead depend on
533 * the chunk length to indicate when to stop. Make sure
534 * there is room for a param header too.
535 */
536#define sctp_walk_params(pos, chunk, member)\
Vladislav Yasevichdd2d1c62006-05-19 11:52:20 -0700537_sctp_walk_params((pos), (chunk), ntohs((chunk)->chunk_hdr.length), member)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
539#define _sctp_walk_params(pos, chunk, end, member)\
540for (pos.v = chunk->member;\
Vladislav Yasevichdd2d1c62006-05-19 11:52:20 -0700541 pos.v <= (void *)chunk + end - ntohs(pos.p->length) &&\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 ntohs(pos.p->length) >= sizeof(sctp_paramhdr_t);\
543 pos.v += WORD_ROUND(ntohs(pos.p->length)))
544
545#define sctp_walk_errors(err, chunk_hdr)\
546_sctp_walk_errors((err), (chunk_hdr), ntohs((chunk_hdr)->length))
547
548#define _sctp_walk_errors(err, chunk_hdr, end)\
549for (err = (sctp_errhdr_t *)((void *)chunk_hdr + \
550 sizeof(sctp_chunkhdr_t));\
Vladislav Yasevichdd2d1c62006-05-19 11:52:20 -0700551 (void *)err <= (void *)chunk_hdr + end - ntohs(err->length) &&\
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 ntohs(err->length) >= sizeof(sctp_errhdr_t); \
553 err = (sctp_errhdr_t *)((void *)err + WORD_ROUND(ntohs(err->length))))
554
555#define sctp_walk_fwdtsn(pos, chunk)\
556_sctp_walk_fwdtsn((pos), (chunk), ntohs((chunk)->chunk_hdr->length) - sizeof(struct sctp_fwdtsn_chunk))
557
558#define _sctp_walk_fwdtsn(pos, chunk, end)\
559for (pos = chunk->subh.fwdtsn_hdr->skip;\
560 (void *)pos <= (void *)chunk->subh.fwdtsn_hdr->skip + end - sizeof(struct sctp_fwdtsn_skip);\
561 pos++)
562
563/* Round an int up to the next multiple of 4. */
564#define WORD_ROUND(s) (((s)+3)&~3)
565
566/* Make a new instance of type. */
Vlad Yasevichb2cf9b62010-04-30 22:41:10 -0400567#define t_new(type, flags) (type *)kzalloc(sizeof(type), flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
569/* Compare two timevals. */
570#define tv_lt(s, t) \
571 (s.tv_sec < t.tv_sec || (s.tv_sec == t.tv_sec && s.tv_usec < t.tv_usec))
572
573/* Add tv1 to tv2. */
574#define TIMEVAL_ADD(tv1, tv2) \
575({ \
576 suseconds_t usecs = (tv2).tv_usec + (tv1).tv_usec; \
577 time_t secs = (tv2).tv_sec + (tv1).tv_sec; \
578\
579 if (usecs >= 1000000) { \
580 usecs -= 1000000; \
581 secs++; \
582 } \
583 (tv2).tv_sec = secs; \
584 (tv2).tv_usec = usecs; \
585})
586
587/* External references. */
588
589extern struct proto sctp_prot;
590extern struct proto sctpv6_prot;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591void sctp_put_port(struct sock *sk);
592
593extern struct idr sctp_assocs_id;
594extern spinlock_t sctp_assocs_id_lock;
595
596/* Static inline functions. */
597
598/* Convert from an IP version number to an Address Family symbol. */
599static inline int ipver2af(__u8 ipver)
600{
601 switch (ipver) {
602 case 4:
603 return AF_INET;
604 case 6:
605 return AF_INET6;
606 default:
607 return 0;
Joe Perchese3cc0552011-06-03 11:51:21 +0000608 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609}
610
611/* Convert from an address parameter type to an address family. */
Al Virodbc16db2006-11-20 17:01:42 -0800612static inline int param_type2af(__be16 type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
614 switch (type) {
615 case SCTP_PARAM_IPV4_ADDRESS:
616 return AF_INET;
617 case SCTP_PARAM_IPV6_ADDRESS:
618 return AF_INET6;
619 default:
620 return 0;
Joe Perchese3cc0552011-06-03 11:51:21 +0000621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622}
623
624/* Perform some sanity checks. */
625static inline int sctp_sanity_check(void)
626{
627 SCTP_ASSERT(sizeof(struct sctp_ulpevent) <=
628 sizeof(((struct sk_buff *)0)->cb),
629 "SCTP: ulpevent does not fit in skb!\n", return 0);
630
631 return 1;
632}
633
634/* Warning: The following hash functions assume a power of two 'size'. */
635/* This is the hash function for the SCTP port hash table. */
Eric W. Biedermanf1f43762012-08-06 08:39:38 +0000636static inline int sctp_phashfn(struct net *net, __u16 lport)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
Eric W. Biedermanf1f43762012-08-06 08:39:38 +0000638 return (net_hash_mix(net) + lport) & (sctp_port_hashsize - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639}
640
641/* This is the hash function for the endpoint hash table. */
Eric W. Biederman4cdadcb2012-08-06 08:40:21 +0000642static inline int sctp_ep_hashfn(struct net *net, __u16 lport)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
Eric W. Biederman4cdadcb2012-08-06 08:40:21 +0000644 return (net_hash_mix(net) + lport) & (sctp_ep_hashsize - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645}
646
647/* This is the hash function for the association hash table. */
Eric W. Biederman4110cc22012-08-06 08:41:13 +0000648static inline int sctp_assoc_hashfn(struct net *net, __u16 lport, __u16 rport)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
Eric W. Biederman4110cc22012-08-06 08:41:13 +0000650 int h = (lport << 16) + rport + net_hash_mix(net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 h ^= h>>8;
Eric Dumazeta02cec22010-09-22 20:43:57 +0000652 return h & (sctp_assoc_hashsize - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
654
655/* This is the hash function for the association hash table. This is
656 * not used yet, but could be used as a better hash function when
657 * we have a vtag.
658 */
659static inline int sctp_vtag_hashfn(__u16 lport, __u16 rport, __u32 vtag)
660{
661 int h = (lport << 16) + rport;
662 h ^= vtag;
Eric Dumazeta02cec22010-09-22 20:43:57 +0000663 return h & (sctp_assoc_hashsize - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664}
665
Vlad Yasevichd970dbf2007-11-09 11:43:40 -0500666#define sctp_for_each_hentry(epb, node, head) \
667 hlist_for_each_entry(epb, node, head, node)
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669/* Is a socket of this style? */
670#define sctp_style(sk, style) __sctp_style((sk), (SCTP_SOCKET_##style))
671static inline int __sctp_style(const struct sock *sk, sctp_socket_type_t style)
672{
673 return sctp_sk(sk)->type == style;
674}
675
676/* Is the association in this state? */
677#define sctp_state(asoc, state) __sctp_state((asoc), (SCTP_STATE_##state))
678static inline int __sctp_state(const struct sctp_association *asoc,
679 sctp_state_t state)
680{
681 return asoc->state == state;
682}
683
684/* Is the socket in this state? */
685#define sctp_sstate(sk, state) __sctp_sstate((sk), (SCTP_SS_##state))
686static inline int __sctp_sstate(const struct sock *sk, sctp_sock_state_t state)
687{
688 return sk->sk_state == state;
689}
690
691/* Map v4-mapped v6 address back to v4 address */
692static inline void sctp_v6_map_v4(union sctp_addr *addr)
693{
694 addr->v4.sin_family = AF_INET;
695 addr->v4.sin_port = addr->v6.sin6_port;
696 addr->v4.sin_addr.s_addr = addr->v6.sin6_addr.s6_addr32[3];
697}
698
699/* Map v4 address to v4-mapped v6 address */
700static inline void sctp_v4_map_v6(union sctp_addr *addr)
701{
702 addr->v6.sin6_family = AF_INET6;
703 addr->v6.sin6_port = addr->v4.sin_port;
704 addr->v6.sin6_addr.s6_addr32[3] = addr->v4.sin_addr.s_addr;
705 addr->v6.sin6_addr.s6_addr32[0] = 0;
706 addr->v6.sin6_addr.s6_addr32[1] = 0;
707 addr->v6.sin6_addr.s6_addr32[2] = htonl(0x0000ffff);
708}
709
Nicolas Dichtele0268862012-05-04 05:24:54 +0000710/* The cookie is always 0 since this is how it's used in the
711 * pmtu code.
712 */
713static inline struct dst_entry *sctp_transport_dst_check(struct sctp_transport *t)
714{
715 if (t->dst && !dst_check(t->dst, 0)) {
716 dst_release(t->dst);
717 t->dst = NULL;
718 }
719
720 return t->dst;
721}
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723#endif /* __net_sctp_h__ */