1 /* SCTP kernel reference 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.
7 * This file is part of the SCTP kernel reference Implementation
9 * The base lksctp header.
11 * The SCTP reference 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)
17 * The SCTP reference 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.
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.
28 * Please send any bug reports or fixes you make to the
30 * lksctp developers <lksctp-developers@lists.sourceforge.net>
32 * Or submit a bug report through the following website:
33 * http://www.sf.net/projects/lksctp
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>
45 * Any bugs reported given to us we will try to fix... any fixes shared will
46 * be incorporated into the next SCTP release.
49 #ifndef __net_sctp_h__
50 #define __net_sctp_h__
53 * Start getting some control over the header file depencies:
58 * macros, externs, and inlines
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.
66 #include <linux/config.h>
70 #undef CONFIG_SCTP_DBG_OBJCNT
72 #endif /* TEST_FRAME */
74 #include <linux/types.h>
75 #include <linux/slab.h>
77 #include <linux/tty.h>
78 #include <linux/proc_fs.h>
79 #include <linux/spinlock.h>
80 #include <linux/jiffies.h>
81 #include <linux/idr.h>
83 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
85 #include <net/ip6_route.h>
88 #include <asm/uaccess.h>
92 #include <net/sctp/structs.h>
93 #include <net/sctp/constants.h>
96 /* Set SCTP_DEBUG flag via config if not already set. */
98 #ifdef CONFIG_SCTP_DBG_MSG
102 #endif /* CONFIG_SCTP_DBG */
103 #endif /* SCTP_DEBUG */
105 #ifdef CONFIG_IP_SCTP_MODULE
106 #define SCTP_PROTOSW_FLAG 0
108 #define SCTP_PROTOSW_FLAG INET_PROTOSW_PERMANENT
112 /* Certain internal static functions need to be exported when
113 * compiled into the test frame.
116 #define SCTP_STATIC static
120 * Function declarations.
126 extern struct sock *sctp_get_ctl_sock(void);
127 extern int sctp_copy_local_addr_list(struct sctp_bind_addr *,
128 sctp_scope_t, int gfp, int flags);
129 extern struct sctp_pf *sctp_get_pf_specific(sa_family_t family);
130 extern int sctp_register_pf(struct sctp_pf *, sa_family_t);
135 int sctp_backlog_rcv(struct sock *sk, struct sk_buff *skb);
136 int sctp_inet_listen(struct socket *sock, int backlog);
137 void sctp_write_space(struct sock *sk);
138 unsigned int sctp_poll(struct file *file, struct socket *sock,
144 int sctp_primitive_ASSOCIATE(struct sctp_association *, void *arg);
145 int sctp_primitive_SHUTDOWN(struct sctp_association *, void *arg);
146 int sctp_primitive_ABORT(struct sctp_association *, void *arg);
147 int sctp_primitive_SEND(struct sctp_association *, void *arg);
148 int sctp_primitive_REQUESTHEARTBEAT(struct sctp_association *, void *arg);
149 int sctp_primitive_ASCONF(struct sctp_association *, void *arg);
154 __u32 sctp_start_cksum(__u8 *ptr, __u16 count);
155 __u32 sctp_update_cksum(__u8 *ptr, __u16 count, __u32 cksum);
156 __u32 sctp_end_cksum(__u32 cksum);
157 __u32 sctp_update_copy_cksum(__u8 *, __u8 *, __u16 count, __u32 cksum);
162 int sctp_rcv(struct sk_buff *skb);
163 void sctp_v4_err(struct sk_buff *skb, u32 info);
164 void sctp_hash_established(struct sctp_association *);
165 void __sctp_hash_established(struct sctp_association *);
166 void sctp_unhash_established(struct sctp_association *);
167 void __sctp_unhash_established(struct sctp_association *);
168 void sctp_hash_endpoint(struct sctp_endpoint *);
169 void __sctp_hash_endpoint(struct sctp_endpoint *);
170 void sctp_unhash_endpoint(struct sctp_endpoint *);
171 void __sctp_unhash_endpoint(struct sctp_endpoint *);
172 struct sctp_association *__sctp_lookup_association(
173 const union sctp_addr *,
174 const union sctp_addr *,
175 struct sctp_transport **);
176 struct sock *sctp_err_lookup(int family, struct sk_buff *,
177 struct sctphdr *, struct sctp_endpoint **,
178 struct sctp_association **,
179 struct sctp_transport **);
180 void sctp_err_finish(struct sock *, struct sctp_endpoint *,
181 struct sctp_association *);
182 void sctp_icmp_frag_needed(struct sock *, struct sctp_association *,
183 struct sctp_transport *t, __u32 pmtu);
186 * Section: Macros, externs, and inlines
191 #include <test_frame.h>
194 /* spin lock wrappers. */
195 #define sctp_spin_lock_irqsave(lock, flags) spin_lock_irqsave(lock, flags)
196 #define sctp_spin_unlock_irqrestore(lock, flags) \
197 spin_unlock_irqrestore(lock, flags)
198 #define sctp_local_bh_disable() local_bh_disable()
199 #define sctp_local_bh_enable() local_bh_enable()
200 #define sctp_spin_lock(lock) spin_lock(lock)
201 #define sctp_spin_unlock(lock) spin_unlock(lock)
202 #define sctp_write_lock(lock) write_lock(lock)
203 #define sctp_write_unlock(lock) write_unlock(lock)
204 #define sctp_read_lock(lock) read_lock(lock)
205 #define sctp_read_unlock(lock) read_unlock(lock)
207 /* sock lock wrappers. */
208 #define sctp_lock_sock(sk) lock_sock(sk)
209 #define sctp_release_sock(sk) release_sock(sk)
210 #define sctp_bh_lock_sock(sk) bh_lock_sock(sk)
211 #define sctp_bh_unlock_sock(sk) bh_unlock_sock(sk)
212 #define SCTP_SOCK_SLEEP_PRE(sk) SOCK_SLEEP_PRE(sk)
213 #define SCTP_SOCK_SLEEP_POST(sk) SOCK_SLEEP_POST(sk)
215 /* SCTP SNMP MIB stats handlers */
216 DECLARE_SNMP_STAT(struct sctp_mib, sctp_statistics);
217 #define SCTP_INC_STATS(field) SNMP_INC_STATS(sctp_statistics, field)
218 #define SCTP_INC_STATS_BH(field) SNMP_INC_STATS_BH(sctp_statistics, field)
219 #define SCTP_INC_STATS_USER(field) SNMP_INC_STATS_USER(sctp_statistics, field)
220 #define SCTP_DEC_STATS(field) SNMP_DEC_STATS(sctp_statistics, field)
222 #endif /* !TEST_FRAME */
225 /* Print debugging messages. */
227 extern int sctp_debug_flag;
228 #define SCTP_DEBUG_PRINTK(whatever...) \
229 ((void) (sctp_debug_flag && printk(KERN_DEBUG whatever)))
230 #define SCTP_ENABLE_DEBUG { sctp_debug_flag = 1; }
231 #define SCTP_DISABLE_DEBUG { sctp_debug_flag = 0; }
233 #define SCTP_ASSERT(expr, str, func) \
235 SCTP_DEBUG_PRINTK("Assertion Failed: %s(%s) at %s:%s:%d\n", \
236 str, (#expr), __FILE__, __FUNCTION__, __LINE__); \
240 #else /* SCTP_DEBUG */
242 #define SCTP_DEBUG_PRINTK(whatever...)
243 #define SCTP_ENABLE_DEBUG
244 #define SCTP_DISABLE_DEBUG
245 #define SCTP_ASSERT(expr, str, func)
247 #endif /* SCTP_DEBUG */
251 * Macros for keeping a global reference of object allocations.
253 #ifdef CONFIG_SCTP_DBG_OBJCNT
255 extern atomic_t sctp_dbg_objcnt_sock;
256 extern atomic_t sctp_dbg_objcnt_ep;
257 extern atomic_t sctp_dbg_objcnt_assoc;
258 extern atomic_t sctp_dbg_objcnt_transport;
259 extern atomic_t sctp_dbg_objcnt_chunk;
260 extern atomic_t sctp_dbg_objcnt_bind_addr;
261 extern atomic_t sctp_dbg_objcnt_bind_bucket;
262 extern atomic_t sctp_dbg_objcnt_addr;
263 extern atomic_t sctp_dbg_objcnt_ssnmap;
264 extern atomic_t sctp_dbg_objcnt_datamsg;
266 /* Macros to atomically increment/decrement objcnt counters. */
267 #define SCTP_DBG_OBJCNT_INC(name) \
268 atomic_inc(&sctp_dbg_objcnt_## name)
269 #define SCTP_DBG_OBJCNT_DEC(name) \
270 atomic_dec(&sctp_dbg_objcnt_## name)
271 #define SCTP_DBG_OBJCNT(name) \
272 atomic_t sctp_dbg_objcnt_## name = ATOMIC_INIT(0)
274 /* Macro to help create new entries in in the global array of
277 #define SCTP_DBG_OBJCNT_ENTRY(name) \
278 {.label= #name, .counter= &sctp_dbg_objcnt_## name}
280 void sctp_dbg_objcnt_init(void);
281 void sctp_dbg_objcnt_exit(void);
285 #define SCTP_DBG_OBJCNT_INC(name)
286 #define SCTP_DBG_OBJCNT_DEC(name)
288 static inline void sctp_dbg_objcnt_init(void) { return; }
289 static inline void sctp_dbg_objcnt_exit(void) { return; }
291 #endif /* CONFIG_SCTP_DBG_OBJCOUNT */
293 #if defined CONFIG_SYSCTL
294 void sctp_sysctl_register(void);
295 void sctp_sysctl_unregister(void);
297 static inline void sctp_sysctl_register(void) { return; }
298 static inline void sctp_sysctl_unregister(void) { return; }
299 static inline int sctp_sysctl_jiffies_ms(ctl_table *table, int __user *name, int nlen,
300 void __user *oldval, size_t __user *oldlenp,
301 void __user *newval, size_t newlen, void **context) {
306 /* Size of Supported Address Parameter for 'x' address types. */
307 #define SCTP_SAT_LEN(x) (sizeof(struct sctp_paramhdr) + (x) * sizeof(__u16))
309 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
311 int sctp_v6_init(void);
312 void sctp_v6_exit(void);
313 void sctp_v6_err(struct sk_buff *skb, struct inet6_skb_parm *opt,
314 int type, int code, int offset, __u32 info);
316 #else /* #ifdef defined(CONFIG_IPV6) */
318 static inline int sctp_v6_init(void) { return 0; }
319 static inline void sctp_v6_exit(void) { return; }
321 #endif /* #if defined(CONFIG_IPV6) */
323 /* Some wrappers, in case crypto not available. */
324 #if defined (CONFIG_CRYPTO_HMAC)
325 #define sctp_crypto_alloc_tfm crypto_alloc_tfm
326 #define sctp_crypto_free_tfm crypto_free_tfm
327 #define sctp_crypto_hmac crypto_hmac
329 #define sctp_crypto_alloc_tfm(x...) NULL
330 #define sctp_crypto_free_tfm(x...)
331 #define sctp_crypto_hmac(x...)
335 /* Map an association to an assoc_id. */
336 static inline sctp_assoc_t sctp_assoc2id(const struct sctp_association *asoc)
338 return (asoc?asoc->assoc_id:NULL);
341 /* Look up the association by its id. */
342 struct sctp_association *sctp_id2assoc(struct sock *sk, sctp_assoc_t id);
345 /* A macro to walk a list of skbs. */
346 #define sctp_skb_for_each(pos, head, tmp) \
347 for (pos = (head)->next;\
348 tmp = (pos)->next, pos != ((struct sk_buff *)(head));\
352 /* A helper to append an entire skb list (list) to another (head). */
353 static inline void sctp_skb_list_tail(struct sk_buff_head *list,
354 struct sk_buff_head *head)
358 sctp_spin_lock_irqsave(&head->lock, flags);
359 sctp_spin_lock(&list->lock);
361 list_splice((struct list_head *)list, (struct list_head *)head->prev);
363 head->qlen += list->qlen;
366 sctp_spin_unlock(&list->lock);
367 sctp_spin_unlock_irqrestore(&head->lock, flags);
371 * sctp_list_dequeue - remove from the head of the queue
372 * @list: list to dequeue from
374 * Remove the head of the list. The head item is
375 * returned or %NULL if the list is empty.
378 static inline struct list_head *sctp_list_dequeue(struct list_head *list)
380 struct list_head *result = NULL;
382 if (list->next != list) {
384 list->next = result->next;
385 list->next->prev = list;
386 INIT_LIST_HEAD(result);
391 /* Tests if the list has one and only one entry. */
392 static inline int sctp_list_single_entry(struct list_head *head)
394 return ((head->next != head) && (head->next == head->prev));
397 /* Calculate the size (in bytes) occupied by the data of an iovec. */
398 static inline size_t get_user_iov_size(struct iovec *iov, int iovlen)
402 for (; iovlen > 0; --iovlen) {
403 retval += iov->iov_len;
410 /* Generate a random jitter in the range of -50% ~ +50% of input RTO. */
411 static inline __s32 sctp_jitter(__u32 rto)
413 static __u32 sctp_rand;
416 /* Avoid divide by zero. */
420 sctp_rand += jiffies;
421 sctp_rand ^= (sctp_rand << 12);
422 sctp_rand ^= (sctp_rand >> 20);
424 /* Choose random number from 0 to rto, then move to -50% ~ +50%
427 ret = sctp_rand % rto - (rto >> 1);
431 /* Break down data chunks at this point. */
432 static inline int sctp_frag_point(const struct sctp_opt *sp, int pmtu)
436 frag -= sp->pf->af->net_header_len;
437 frag -= sizeof(struct sctphdr) + sizeof(struct sctp_data_chunk);
440 frag = min_t(int, frag, sp->user_frag);
442 frag = min_t(int, frag, SCTP_MAX_CHUNK_LEN);
447 /* Walk through a list of TLV parameters. Don't trust the
448 * individual parameter lengths and instead depend on
449 * the chunk length to indicate when to stop. Make sure
450 * there is room for a param header too.
452 #define sctp_walk_params(pos, chunk, member)\
453 _sctp_walk_params((pos), (chunk), WORD_ROUND(ntohs((chunk)->chunk_hdr.length)), member)
455 #define _sctp_walk_params(pos, chunk, end, member)\
456 for (pos.v = chunk->member;\
457 pos.v <= (void *)chunk + end - sizeof(sctp_paramhdr_t) &&\
458 pos.v <= (void *)chunk + end - WORD_ROUND(ntohs(pos.p->length)); \
459 pos.v += WORD_ROUND(ntohs(pos.p->length)))
461 #define sctp_walk_errors(err, chunk_hdr)\
462 _sctp_walk_errors((err), (chunk_hdr), ntohs((chunk_hdr)->length))
464 #define _sctp_walk_errors(err, chunk_hdr, end)\
465 for (err = (sctp_errhdr_t *)((void *)chunk_hdr + \
466 sizeof(sctp_chunkhdr_t));\
467 (void *)err <= (void *)chunk_hdr + end - sizeof(sctp_errhdr_t) &&\
468 (void *)err <= (void *)chunk_hdr + end - \
469 WORD_ROUND(ntohs(err->length));\
470 err = (sctp_errhdr_t *)((void *)err + \
471 WORD_ROUND(ntohs(err->length))))
473 #define sctp_walk_fwdtsn(pos, chunk)\
474 _sctp_walk_fwdtsn((pos), (chunk), ntohs((chunk)->chunk_hdr->length) - sizeof(struct sctp_fwdtsn_chunk))
476 #define _sctp_walk_fwdtsn(pos, chunk, end)\
477 for (pos = chunk->subh.fwdtsn_hdr->skip;\
478 (void *)pos <= (void *)chunk->subh.fwdtsn_hdr->skip + end - sizeof(struct sctp_fwdtsn_skip);\
481 /* Round an int up to the next multiple of 4. */
482 #define WORD_ROUND(s) (((s)+3)&~3)
484 /* Make a new instance of type. */
485 #define t_new(type, flags) (type *)kmalloc(sizeof(type), flags)
487 /* Compare two timevals. */
488 #define tv_lt(s, t) \
489 (s.tv_sec < t.tv_sec || (s.tv_sec == t.tv_sec && s.tv_usec < t.tv_usec))
491 /* Add tv1 to tv2. */
492 #define TIMEVAL_ADD(tv1, tv2) \
494 suseconds_t usecs = (tv2).tv_usec + (tv1).tv_usec; \
495 time_t secs = (tv2).tv_sec + (tv1).tv_sec; \
497 if (usecs >= 1000000) { \
501 (tv2).tv_sec = secs; \
502 (tv2).tv_usec = usecs; \
505 /* External references. */
507 extern struct proto sctp_prot;
508 extern struct proc_dir_entry *proc_net_sctp;
509 void sctp_put_port(struct sock *sk);
511 extern struct idr sctp_assocs_id;
512 extern spinlock_t sctp_assocs_id_lock;
514 /* Static inline functions. */
516 /* Convert from an IP version number to an Address Family symbol. */
517 static inline int ipver2af(__u8 ipver)
529 /* Convert from an address parameter type to an address family. */
530 static inline int param_type2af(__u16 type)
533 case SCTP_PARAM_IPV4_ADDRESS:
535 case SCTP_PARAM_IPV6_ADDRESS:
542 /* Perform some sanity checks. */
543 static inline int sctp_sanity_check(void)
545 SCTP_ASSERT(sizeof(struct sctp_ulpevent) <=
546 sizeof(((struct sk_buff *)0)->cb),
547 "SCTP: ulpevent does not fit in skb!\n", return 0);
552 /* Warning: The following hash functions assume a power of two 'size'. */
553 /* This is the hash function for the SCTP port hash table. */
554 static inline int sctp_phashfn(__u16 lport)
556 return (lport & (sctp_port_hashsize - 1));
559 /* This is the hash function for the endpoint hash table. */
560 static inline int sctp_ep_hashfn(__u16 lport)
562 return (lport & (sctp_ep_hashsize - 1));
565 /* This is the hash function for the association hash table. */
566 static inline int sctp_assoc_hashfn(__u16 lport, __u16 rport)
568 int h = (lport << 16) + rport;
570 return (h & (sctp_assoc_hashsize - 1));
573 /* This is the hash function for the association hash table. This is
574 * not used yet, but could be used as a better hash function when
577 static inline int sctp_vtag_hashfn(__u16 lport, __u16 rport, __u32 vtag)
579 int h = (lport << 16) + rport;
581 return (h & (sctp_assoc_hashsize-1));
584 /* WARNING: Do not change the layout of the members in sctp_sock! */
587 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
588 struct ipv6_pinfo *pinet6;
589 #endif /* CONFIG_IPV6 */
590 struct inet_opt inet;
591 struct sctp_opt sctp;
594 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
597 struct ipv6_pinfo *pinet6;
598 struct inet_opt inet;
599 struct sctp_opt sctp;
600 struct ipv6_pinfo inet6;
602 #endif /* CONFIG_IPV6 */
604 #define sctp_sk(__sk) (&((struct sctp_sock *)__sk)->sctp)
605 #define sctp_opt2sk(__sp) &container_of(__sp, struct sctp_sock, sctp)->sk
607 /* Is a socket of this style? */
608 #define sctp_style(sk, style) __sctp_style((sk), (SCTP_SOCKET_##style))
609 int static inline __sctp_style(const struct sock *sk, sctp_socket_type_t style)
611 return sctp_sk(sk)->type == style;
614 /* Is the association in this state? */
615 #define sctp_state(asoc, state) __sctp_state((asoc), (SCTP_STATE_##state))
616 int static inline __sctp_state(const struct sctp_association *asoc,
619 return asoc->state == state;
622 /* Is the socket in this state? */
623 #define sctp_sstate(sk, state) __sctp_sstate((sk), (SCTP_SS_##state))
624 int static inline __sctp_sstate(const struct sock *sk, sctp_sock_state_t state)
626 return sk->sk_state == state;
629 /* Map v4-mapped v6 address back to v4 address */
630 static inline void sctp_v6_map_v4(union sctp_addr *addr)
632 addr->v4.sin_family = AF_INET;
633 addr->v4.sin_port = addr->v6.sin6_port;
634 addr->v4.sin_addr.s_addr = addr->v6.sin6_addr.s6_addr32[3];
637 /* Map v4 address to v4-mapped v6 address */
638 static inline void sctp_v4_map_v6(union sctp_addr *addr)
640 addr->v6.sin6_family = AF_INET6;
641 addr->v6.sin6_port = addr->v4.sin_port;
642 addr->v6.sin6_addr.s6_addr32[3] = addr->v4.sin_addr.s_addr;
643 addr->v6.sin6_addr.s6_addr32[0] = 0;
644 addr->v6.sin6_addr.s6_addr32[1] = 0;
645 addr->v6.sin6_addr.s6_addr32[2] = htonl(0x0000ffff);
648 #endif /* __net_sctp_h__ */