1 /* SCTP kernel reference Implementation
2 * (C) Copyright IBM Corp. 2001, 2003
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>
81 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
83 #include <net/ip6_route.h>
86 #include <net/sctp/compat.h>
87 #include <asm/uaccess.h>
91 #include <net/sctp/structs.h>
92 #include <net/sctp/constants.h>
95 /* Set SCTP_DEBUG flag via config if not already set. */
97 #ifdef CONFIG_SCTP_DBG_MSG
101 #endif /* CONFIG_SCTP_DBG */
102 #endif /* SCTP_DEBUG */
104 #ifdef CONFIG_IP_SCTP_MODULE
105 #define SCTP_PROTOSW_FLAG 0
107 #define SCTP_PROTOSW_FLAG INET_PROTOSW_PERMANENT
111 /* Certain internal static functions need to be exported when
112 * compiled into the test frame.
115 #define SCTP_STATIC static
118 #define SCTP_MSECS_TO_JIFFIES(msec) \
119 (((msec / 1000) * HZ) + ((msec % 1000) * HZ) / 1000)
120 #define JIFFIES_TO_MSECS(jiff) \
121 (((jiff / HZ) * 1000) + ((jiff % HZ) * 1000) / HZ)
124 * Function declarations.
130 extern struct sock *sctp_get_ctl_sock(void);
131 extern int sctp_copy_local_addr_list(struct sctp_bind_addr *,
132 sctp_scope_t, int gfp, int flags);
133 extern struct sctp_pf *sctp_get_pf_specific(sa_family_t family);
134 extern int sctp_register_pf(struct sctp_pf *, sa_family_t);
139 int sctp_backlog_rcv(struct sock *sk, struct sk_buff *skb);
140 int sctp_inet_listen(struct socket *sock, int backlog);
141 void sctp_write_space(struct sock *sk);
142 unsigned int sctp_poll(struct file *file, struct socket *sock,
148 int sctp_primitive_ASSOCIATE(struct sctp_association *, void *arg);
149 int sctp_primitive_SHUTDOWN(struct sctp_association *, void *arg);
150 int sctp_primitive_ABORT(struct sctp_association *, void *arg);
151 int sctp_primitive_SEND(struct sctp_association *, void *arg);
152 int sctp_primitive_REQUESTHEARTBEAT(struct sctp_association *, void *arg);
153 int sctp_primitive_ASCONF(struct sctp_association *, void *arg);
158 __u32 sctp_start_cksum(__u8 *ptr, __u16 count);
159 __u32 sctp_update_cksum(__u8 *ptr, __u16 count, __u32 cksum);
160 __u32 sctp_end_cksum(__u32 cksum);
161 __u32 sctp_update_copy_cksum(__u8 *, __u8 *, __u16 count, __u32 cksum);
166 int sctp_rcv(struct sk_buff *skb);
167 void sctp_v4_err(struct sk_buff *skb, u32 info);
168 void sctp_hash_established(struct sctp_association *);
169 void sctp_unhash_established(struct sctp_association *);
170 void sctp_hash_endpoint(struct sctp_endpoint *);
171 void sctp_unhash_endpoint(struct sctp_endpoint *);
172 struct sock *sctp_err_lookup(int family, struct sk_buff *,
173 struct sctphdr *, struct sctp_endpoint **,
174 struct sctp_association **,
175 struct sctp_transport **);
176 void sctp_err_finish(struct sock *, struct sctp_endpoint *,
177 struct sctp_association *);
178 void sctp_icmp_frag_needed(struct sock *, struct sctp_association *,
179 struct sctp_transport *t, __u32 pmtu);
180 void sctp_icmp_proto_unreachable(struct sock *sk,
181 struct sctp_endpoint *ep,
182 struct sctp_association *asoc,
183 struct sctp_transport *t);
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 /* Determine if this is a valid kernel address. */
223 static inline int sctp_is_valid_kaddr(unsigned long addr)
227 /* Make sure the address is not in the user address space. */
228 if (addr < PAGE_OFFSET)
231 page = virt_to_page(addr);
233 /* Is this page valid? */
234 if (!virt_addr_valid(addr) || PageReserved(page))
240 #endif /* !TEST_FRAME */
243 /* Print debugging messages. */
245 extern int sctp_debug_flag;
246 #define SCTP_DEBUG_PRINTK(whatever...) \
247 ((void) (sctp_debug_flag && printk(KERN_DEBUG whatever)))
248 #define SCTP_ENABLE_DEBUG { sctp_debug_flag = 1; }
249 #define SCTP_DISABLE_DEBUG { sctp_debug_flag = 0; }
251 #define SCTP_ASSERT(expr, str, func) \
253 SCTP_DEBUG_PRINTK("Assertion Failed: %s(%s) at %s:%s:%d\n", \
254 str, (#expr), __FILE__, __FUNCTION__, __LINE__); \
258 #else /* SCTP_DEBUG */
260 #define SCTP_DEBUG_PRINTK(whatever...)
261 #define SCTP_ENABLE_DEBUG
262 #define SCTP_DISABLE_DEBUG
263 #define SCTP_ASSERT(expr, str, func)
265 #endif /* SCTP_DEBUG */
269 * Macros for keeping a global reference of object allocations.
271 #ifdef CONFIG_SCTP_DBG_OBJCNT
273 extern atomic_t sctp_dbg_objcnt_sock;
274 extern atomic_t sctp_dbg_objcnt_ep;
275 extern atomic_t sctp_dbg_objcnt_assoc;
276 extern atomic_t sctp_dbg_objcnt_transport;
277 extern atomic_t sctp_dbg_objcnt_chunk;
278 extern atomic_t sctp_dbg_objcnt_bind_addr;
279 extern atomic_t sctp_dbg_objcnt_addr;
280 extern atomic_t sctp_dbg_objcnt_ssnmap;
281 extern atomic_t sctp_dbg_objcnt_datamsg;
283 /* Macros to atomically increment/decrement objcnt counters. */
284 #define SCTP_DBG_OBJCNT_INC(name) \
285 atomic_inc(&sctp_dbg_objcnt_## name)
286 #define SCTP_DBG_OBJCNT_DEC(name) \
287 atomic_dec(&sctp_dbg_objcnt_## name)
288 #define SCTP_DBG_OBJCNT(name) \
289 atomic_t sctp_dbg_objcnt_## name = ATOMIC_INIT(0)
291 /* Macro to help create new entries in in the global array of
294 #define SCTP_DBG_OBJCNT_ENTRY(name) \
295 {.label= #name, .counter= &sctp_dbg_objcnt_## name}
297 void sctp_dbg_objcnt_init(void);
298 void sctp_dbg_objcnt_exit(void);
302 #define SCTP_DBG_OBJCNT_INC(name)
303 #define SCTP_DBG_OBJCNT_DEC(name)
305 static inline void sctp_dbg_objcnt_init(void) { return; }
306 static inline void sctp_dbg_objcnt_exit(void) { return; }
308 #endif /* CONFIG_SCTP_DBG_OBJCOUNT */
310 #if defined CONFIG_SYSCTL
311 void sctp_sysctl_register(void);
312 void sctp_sysctl_unregister(void);
314 static inline void sctp_sysctl_register(void) { return; }
315 static inline void sctp_sysctl_unregister(void) { return; }
316 static inline int sctp_sysctl_jiffies_ms(ctl_table *table, int *name, int nlen,
317 void *oldval, size_t *oldlenp, void *newval,
318 size_t newlen, void **context)
324 /* Size of Supported Address Parameter for 'x' address types. */
325 #define SCTP_SAT_LEN(x) (sizeof(struct sctp_paramhdr) + (x) * sizeof(__u16))
327 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
329 int sctp_v6_init(void);
330 void sctp_v6_exit(void);
332 #else /* #ifdef defined(CONFIG_IPV6) */
334 static inline int sctp_v6_init(void) { return 0; }
335 static inline void sctp_v6_exit(void) { return; }
337 #endif /* #if defined(CONFIG_IPV6) */
339 /* Some wrappers, in case crypto not available. */
340 #if defined (CONFIG_CRYPTO_HMAC)
341 #define sctp_crypto_alloc_tfm crypto_alloc_tfm
342 #define sctp_crypto_free_tfm crypto_free_tfm
343 #define sctp_crypto_hmac crypto_hmac
345 #define sctp_crypto_alloc_tfm(x...) NULL
346 #define sctp_crypto_free_tfm(x...)
347 #define sctp_crypto_hmac(x...)
351 /* Map an association to an assoc_id. */
352 static inline sctp_assoc_t sctp_assoc2id(const struct sctp_association *asoc)
354 return (sctp_assoc_t) asoc;
357 /* Look up the association by its id. */
358 struct sctp_association *sctp_id2assoc(struct sock *sk, sctp_assoc_t id);
361 /* A macro to walk a list of skbs. */
362 #define sctp_skb_for_each(pos, head, tmp) \
363 for (pos = (head)->next;\
364 tmp = (pos)->next, pos != ((struct sk_buff *)(head));\
368 /* A helper to append an entire skb list (list) to another (head). */
369 static inline void sctp_skb_list_tail(struct sk_buff_head *list,
370 struct sk_buff_head *head)
374 sctp_spin_lock_irqsave(&head->lock, flags);
375 sctp_spin_lock(&list->lock);
377 list_splice((struct list_head *)list, (struct list_head *)head->prev);
379 head->qlen += list->qlen;
382 sctp_spin_unlock(&list->lock);
383 sctp_spin_unlock_irqrestore(&head->lock, flags);
387 * sctp_list_dequeue - remove from the head of the queue
388 * @list: list to dequeue from
390 * Remove the head of the list. The head item is
391 * returned or %NULL if the list is empty.
394 static inline struct list_head *sctp_list_dequeue(struct list_head *list)
396 struct list_head *result = NULL;
398 if (list->next != list) {
400 list->next = result->next;
401 list->next->prev = list;
402 INIT_LIST_HEAD(result);
407 /* Tests if the list has one and only one entry. */
408 static inline int sctp_list_single_entry(struct list_head *head)
410 return ((head->next != head) && (head->next == head->prev));
413 /* Generate a random jitter in the range of -50% ~ +50% of input RTO. */
414 static inline __s32 sctp_jitter(__u32 rto)
416 static __u32 sctp_rand;
419 /* Avoid divide by zero. */
423 sctp_rand += jiffies;
424 sctp_rand ^= (sctp_rand << 12);
425 sctp_rand ^= (sctp_rand >> 20);
427 /* Choose random number from 0 to rto, then move to -50% ~ +50%
430 ret = sctp_rand % rto - (rto >> 1);
434 /* Break down data chunks at this point. */
435 static inline int sctp_frag_point(const struct sctp_opt *sp, int pmtu)
439 frag -= sp->pf->af->net_header_len;
440 frag -= sizeof(struct sctphdr) + sizeof(struct sctp_data_chunk);
443 frag = min_t(int, frag, sp->user_frag);
445 frag = min_t(int, frag, SCTP_MAX_CHUNK_LEN);
450 /* Walk through a list of TLV parameters. Don't trust the
451 * individual parameter lengths and instead depend on
452 * the chunk length to indicate when to stop. Make sure
453 * there is room for a param header too.
455 #define sctp_walk_params(pos, chunk, member)\
456 _sctp_walk_params((pos), (chunk), ntohs((chunk)->chunk_hdr.length), member)
458 #define _sctp_walk_params(pos, chunk, end, member)\
459 for (pos.v = chunk->member;\
460 pos.v <= (void *)chunk + end - sizeof(sctp_paramhdr_t) &&\
461 pos.v <= (void *)chunk + end - ntohs(pos.p->length) &&\
462 ntohs(pos.p->length) >= sizeof(sctp_paramhdr_t);\
463 pos.v += WORD_ROUND(ntohs(pos.p->length)))
465 #define sctp_walk_errors(err, chunk_hdr)\
466 _sctp_walk_errors((err), (chunk_hdr), ntohs((chunk_hdr)->length))
468 #define _sctp_walk_errors(err, chunk_hdr, end)\
469 for (err = (sctp_errhdr_t *)((void *)chunk_hdr + \
470 sizeof(sctp_chunkhdr_t));\
471 (void *)err <= (void *)chunk_hdr + end - sizeof(sctp_errhdr_t) &&\
472 (void *)err <= (void *)chunk_hdr + end - ntohs(err->length) &&\
473 ntohs(err->length) >= sizeof(sctp_errhdr_t); \
474 err = (sctp_errhdr_t *)((void *)err + WORD_ROUND(ntohs(err->length))))
476 #define sctp_walk_fwdtsn(pos, chunk)\
477 _sctp_walk_fwdtsn((pos), (chunk), ntohs((chunk)->chunk_hdr->length) - sizeof(struct sctp_fwdtsn_chunk))
479 #define _sctp_walk_fwdtsn(pos, chunk, end)\
480 for (pos = chunk->subh.fwdtsn_hdr->skip;\
481 (void *)pos <= (void *)chunk->subh.fwdtsn_hdr->skip + end - sizeof(struct sctp_fwdtsn_skip);\
484 /* Round an int up to the next multiple of 4. */
485 #define WORD_ROUND(s) (((s)+3)&~3)
487 /* Make a new instance of type. */
488 #define t_new(type, flags) (type *)kmalloc(sizeof(type), flags)
490 /* Compare two timevals. */
491 #define tv_lt(s, t) \
492 (s.tv_sec < t.tv_sec || (s.tv_sec == t.tv_sec && s.tv_usec < t.tv_usec))
494 /* Add tv1 to tv2. */
495 #define TIMEVAL_ADD(tv1, tv2) \
497 suseconds_t usecs = (tv2).tv_usec + (tv1).tv_usec; \
498 time_t secs = (tv2).tv_sec + (tv1).tv_sec; \
500 if (usecs >= 1000000) { \
504 (tv2).tv_sec = secs; \
505 (tv2).tv_usec = usecs; \
508 /* External references. */
510 extern struct proto sctp_prot;
511 extern struct proc_dir_entry *proc_net_sctp;
512 void sctp_put_port(struct sock *sk);
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 #define sctp_sk(__sk) (&(((struct sock *)__sk)->tp_pinfo.af_sctp))
585 #define sctp_opt2sk(__sp) container_of(__sp, struct sock, tp_pinfo.af_sctp)
587 /* Is a socket of this style? */
588 #define sctp_style(sk, style) __sctp_style((sk), (SCTP_SOCKET_##style))
589 int static inline __sctp_style(const struct sock *sk, sctp_socket_type_t style)
591 return sctp_sk(sk)->type == style;
594 /* Is the association in this state? */
595 #define sctp_state(asoc, state) __sctp_state((asoc), (SCTP_STATE_##state))
596 int static inline __sctp_state(const struct sctp_association *asoc,
599 return asoc->state == state;
602 /* Is the socket in this state? */
603 #define sctp_sstate(sk, state) __sctp_sstate((sk), (SCTP_SS_##state))
604 int static inline __sctp_sstate(const struct sock *sk, sctp_sock_state_t state)
606 return sk->state == state;
609 /* Map v4-mapped v6 address back to v4 address */
610 static inline void sctp_v6_map_v4(union sctp_addr *addr)
612 addr->v4.sin_family = AF_INET;
613 addr->v4.sin_port = addr->v6.sin6_port;
614 addr->v4.sin_addr.s_addr = addr->v6.sin6_addr.s6_addr32[3];
617 /* Map v4 address to v4-mapped v6 address */
618 static inline void sctp_v4_map_v6(union sctp_addr *addr)
620 addr->v6.sin6_family = AF_INET6;
621 addr->v6.sin6_port = addr->v4.sin_port;
622 addr->v6.sin6_addr.s6_addr32[3] = addr->v4.sin_addr.s_addr;
623 addr->v6.sin6_addr.s6_addr32[0] = 0;
624 addr->v6.sin6_addr.s6_addr32[1] = 0;
625 addr->v6.sin6_addr.s6_addr32[2] = htonl(0x0000ffff);
628 #endif /* __net_sctp_h__ */