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.
7 * This file is part of the SCTP kernel implementation
9 * The base lksctp header.
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)
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.
23 * You should have received a copy of the GNU General Public License
24 * along with GNU CC; see the file COPYING. If not, see
25 * <http://www.gnu.org/licenses/>.
27 * Please send any bug reports or fixes you make to the
29 * lksctp developers <linux-sctp@vger.kernel.org>
31 * Written or modified by:
32 * La Monte H.P. Yarroll <piggy@acm.org>
33 * Xingang Guo <xingang.guo@intel.com>
34 * Jon Grimm <jgrimm@us.ibm.com>
35 * Daisy Chang <daisyc@us.ibm.com>
36 * Sridhar Samudrala <sri@us.ibm.com>
37 * Ardelle Fan <ardelle.fan@intel.com>
38 * Ryan Layer <rmlayer@us.ibm.com>
39 * Kevin Gao <kevin.gao@intel.com>
42 #ifndef __net_sctp_h__
43 #define __net_sctp_h__
46 * Start getting some control over the header file depencies:
51 * macros, externs, and inlines
53 * Move test_frame specific items out of the kernel headers
54 * and into the test frame headers. This is not perfect in any sense
55 * and will continue to evolve.
58 #include <linux/types.h>
59 #include <linux/slab.h>
61 #include <linux/tty.h>
62 #include <linux/proc_fs.h>
63 #include <linux/spinlock.h>
64 #include <linux/jiffies.h>
65 #include <linux/idr.h>
67 #if IS_ENABLED(CONFIG_IPV6)
69 #include <net/ip6_route.h>
72 #include <asm/uaccess.h>
76 #include <net/sctp/structs.h>
77 #include <net/sctp/constants.h>
79 #ifdef CONFIG_IP_SCTP_MODULE
80 #define SCTP_PROTOSW_FLAG 0
82 #define SCTP_PROTOSW_FLAG INET_PROTOSW_PERMANENT
85 /* Round an int up to the next multiple of 4. */
86 #define WORD_ROUND(s) (((s)+3)&~3)
87 /* Truncate to the previous multiple of 4. */
88 #define WORD_TRUNC(s) ((s)&~3)
91 * Function declarations.
97 int sctp_copy_local_addr_list(struct net *, struct sctp_bind_addr *,
98 sctp_scope_t, gfp_t gfp, int flags);
99 struct sctp_pf *sctp_get_pf_specific(sa_family_t family);
100 int sctp_register_pf(struct sctp_pf *, sa_family_t);
101 void sctp_addr_wq_mgmt(struct net *, struct sctp_sockaddr_entry *, int);
106 int sctp_backlog_rcv(struct sock *sk, struct sk_buff *skb);
107 int sctp_inet_listen(struct socket *sock, int backlog);
108 void sctp_write_space(struct sock *sk);
109 void sctp_data_ready(struct sock *sk);
110 unsigned int sctp_poll(struct file *file, struct socket *sock,
112 void sctp_sock_rfree(struct sk_buff *skb);
113 void sctp_copy_sock(struct sock *newsk, struct sock *sk,
114 struct sctp_association *asoc);
115 extern struct percpu_counter sctp_sockets_allocated;
116 int sctp_asconf_mgmt(struct sctp_sock *, struct sctp_sockaddr_entry *);
117 struct sk_buff *sctp_skb_recv_datagram(struct sock *, int, int, int *);
119 int sctp_get_sctp_info(struct sock *sk, struct sctp_association *asoc,
120 struct sctp_info *info);
125 int sctp_primitive_ASSOCIATE(struct net *, struct sctp_association *, void *arg);
126 int sctp_primitive_SHUTDOWN(struct net *, struct sctp_association *, void *arg);
127 int sctp_primitive_ABORT(struct net *, struct sctp_association *, void *arg);
128 int sctp_primitive_SEND(struct net *, struct sctp_association *, void *arg);
129 int sctp_primitive_REQUESTHEARTBEAT(struct net *, struct sctp_association *, void *arg);
130 int sctp_primitive_ASCONF(struct net *, struct sctp_association *, void *arg);
135 int sctp_rcv(struct sk_buff *skb);
136 void sctp_v4_err(struct sk_buff *skb, u32 info);
137 void sctp_hash_endpoint(struct sctp_endpoint *);
138 void sctp_unhash_endpoint(struct sctp_endpoint *);
139 struct sock *sctp_err_lookup(struct net *net, int family, struct sk_buff *,
140 struct sctphdr *, struct sctp_association **,
141 struct sctp_transport **);
142 void sctp_err_finish(struct sock *, struct sctp_association *);
143 void sctp_icmp_frag_needed(struct sock *, struct sctp_association *,
144 struct sctp_transport *t, __u32 pmtu);
145 void sctp_icmp_redirect(struct sock *, struct sctp_transport *,
147 void sctp_icmp_proto_unreachable(struct sock *sk,
148 struct sctp_association *asoc,
149 struct sctp_transport *t);
150 void sctp_backlog_migrate(struct sctp_association *assoc,
151 struct sock *oldsk, struct sock *newsk);
152 int sctp_transport_hashtable_init(void);
153 void sctp_transport_hashtable_destroy(void);
154 void sctp_hash_transport(struct sctp_transport *t);
155 void sctp_unhash_transport(struct sctp_transport *t);
156 struct sctp_transport *sctp_addrs_lookup_transport(
158 const union sctp_addr *laddr,
159 const union sctp_addr *paddr);
160 struct sctp_transport *sctp_epaddr_lookup_transport(
161 const struct sctp_endpoint *ep,
162 const union sctp_addr *paddr);
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);
178 * Module global variables
184 extern struct kmem_cache *sctp_chunk_cachep __read_mostly;
185 extern struct kmem_cache *sctp_bucket_cachep __read_mostly;
186 extern long sysctl_sctp_mem[3];
187 extern int sysctl_sctp_rmem[3];
188 extern int sysctl_sctp_wmem[3];
191 * Section: Macros, externs, and inlines
194 /* SCTP SNMP MIB stats handlers */
195 #define SCTP_INC_STATS(net, field) SNMP_INC_STATS((net)->sctp.sctp_statistics, field)
196 #define SCTP_INC_STATS_BH(net, field) SNMP_INC_STATS_BH((net)->sctp.sctp_statistics, field)
197 #define SCTP_INC_STATS_USER(net, field) SNMP_INC_STATS_USER((net)->sctp.sctp_statistics, field)
198 #define SCTP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->sctp.sctp_statistics, field)
200 /* sctp mib definitions */
203 SCTP_MIB_CURRESTAB, /* CurrEstab */
204 SCTP_MIB_ACTIVEESTABS, /* ActiveEstabs */
205 SCTP_MIB_PASSIVEESTABS, /* PassiveEstabs */
206 SCTP_MIB_ABORTEDS, /* Aborteds */
207 SCTP_MIB_SHUTDOWNS, /* Shutdowns */
208 SCTP_MIB_OUTOFBLUES, /* OutOfBlues */
209 SCTP_MIB_CHECKSUMERRORS, /* ChecksumErrors */
210 SCTP_MIB_OUTCTRLCHUNKS, /* OutCtrlChunks */
211 SCTP_MIB_OUTORDERCHUNKS, /* OutOrderChunks */
212 SCTP_MIB_OUTUNORDERCHUNKS, /* OutUnorderChunks */
213 SCTP_MIB_INCTRLCHUNKS, /* InCtrlChunks */
214 SCTP_MIB_INORDERCHUNKS, /* InOrderChunks */
215 SCTP_MIB_INUNORDERCHUNKS, /* InUnorderChunks */
216 SCTP_MIB_FRAGUSRMSGS, /* FragUsrMsgs */
217 SCTP_MIB_REASMUSRMSGS, /* ReasmUsrMsgs */
218 SCTP_MIB_OUTSCTPPACKS, /* OutSCTPPacks */
219 SCTP_MIB_INSCTPPACKS, /* InSCTPPacks */
220 SCTP_MIB_T1_INIT_EXPIREDS,
221 SCTP_MIB_T1_COOKIE_EXPIREDS,
222 SCTP_MIB_T2_SHUTDOWN_EXPIREDS,
223 SCTP_MIB_T3_RTX_EXPIREDS,
224 SCTP_MIB_T4_RTO_EXPIREDS,
225 SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS,
226 SCTP_MIB_DELAY_SACK_EXPIREDS,
227 SCTP_MIB_AUTOCLOSE_EXPIREDS,
228 SCTP_MIB_T1_RETRANSMITS,
229 SCTP_MIB_T3_RETRANSMITS,
230 SCTP_MIB_PMTUD_RETRANSMITS,
231 SCTP_MIB_FAST_RETRANSMITS,
232 SCTP_MIB_IN_PKT_SOFTIRQ,
233 SCTP_MIB_IN_PKT_BACKLOG,
234 SCTP_MIB_IN_PKT_DISCARDS,
235 SCTP_MIB_IN_DATA_CHUNK_DISCARDS,
239 #define SCTP_MIB_MAX __SCTP_MIB_MAX
241 unsigned long mibs[SCTP_MIB_MAX];
244 /* helper function to track stats about max rto and related transport */
245 static inline void sctp_max_rto(struct sctp_association *asoc,
246 struct sctp_transport *trans)
248 if (asoc->stats.max_obs_rto < (__u64)trans->rto) {
249 asoc->stats.max_obs_rto = trans->rto;
250 memset(&asoc->stats.obs_rto_ipaddr, 0,
251 sizeof(struct sockaddr_storage));
252 memcpy(&asoc->stats.obs_rto_ipaddr, &trans->ipaddr,
253 trans->af_specific->sockaddr_len);
258 * Macros for keeping a global reference of object allocations.
260 #ifdef CONFIG_SCTP_DBG_OBJCNT
262 extern atomic_t sctp_dbg_objcnt_sock;
263 extern atomic_t sctp_dbg_objcnt_ep;
264 extern atomic_t sctp_dbg_objcnt_assoc;
265 extern atomic_t sctp_dbg_objcnt_transport;
266 extern atomic_t sctp_dbg_objcnt_chunk;
267 extern atomic_t sctp_dbg_objcnt_bind_addr;
268 extern atomic_t sctp_dbg_objcnt_bind_bucket;
269 extern atomic_t sctp_dbg_objcnt_addr;
270 extern atomic_t sctp_dbg_objcnt_ssnmap;
271 extern atomic_t sctp_dbg_objcnt_datamsg;
272 extern atomic_t sctp_dbg_objcnt_keys;
274 /* Macros to atomically increment/decrement objcnt counters. */
275 #define SCTP_DBG_OBJCNT_INC(name) \
276 atomic_inc(&sctp_dbg_objcnt_## name)
277 #define SCTP_DBG_OBJCNT_DEC(name) \
278 atomic_dec(&sctp_dbg_objcnt_## name)
279 #define SCTP_DBG_OBJCNT(name) \
280 atomic_t sctp_dbg_objcnt_## name = ATOMIC_INIT(0)
282 /* Macro to help create new entries in in the global array of
285 #define SCTP_DBG_OBJCNT_ENTRY(name) \
286 {.label= #name, .counter= &sctp_dbg_objcnt_## name}
288 void sctp_dbg_objcnt_init(struct net *);
289 void sctp_dbg_objcnt_exit(struct net *);
293 #define SCTP_DBG_OBJCNT_INC(name)
294 #define SCTP_DBG_OBJCNT_DEC(name)
296 static inline void sctp_dbg_objcnt_init(struct net *net) { return; }
297 static inline void sctp_dbg_objcnt_exit(struct net *net) { return; }
299 #endif /* CONFIG_SCTP_DBG_OBJCOUNT */
301 #if defined CONFIG_SYSCTL
302 void sctp_sysctl_register(void);
303 void sctp_sysctl_unregister(void);
304 int sctp_sysctl_net_register(struct net *net);
305 void sctp_sysctl_net_unregister(struct net *net);
307 static inline void sctp_sysctl_register(void) { return; }
308 static inline void sctp_sysctl_unregister(void) { return; }
309 static inline int sctp_sysctl_net_register(struct net *net) { return 0; }
310 static inline void sctp_sysctl_net_unregister(struct net *net) { return; }
313 /* Size of Supported Address Parameter for 'x' address types. */
314 #define SCTP_SAT_LEN(x) (sizeof(struct sctp_paramhdr) + (x) * sizeof(__u16))
316 #if IS_ENABLED(CONFIG_IPV6)
318 void sctp_v6_pf_init(void);
319 void sctp_v6_pf_exit(void);
320 int sctp_v6_protosw_init(void);
321 void sctp_v6_protosw_exit(void);
322 int sctp_v6_add_protocol(void);
323 void sctp_v6_del_protocol(void);
325 #else /* #ifdef defined(CONFIG_IPV6) */
327 static inline void sctp_v6_pf_init(void) { return; }
328 static inline void sctp_v6_pf_exit(void) { return; }
329 static inline int sctp_v6_protosw_init(void) { return 0; }
330 static inline void sctp_v6_protosw_exit(void) { return; }
331 static inline int sctp_v6_add_protocol(void) { return 0; }
332 static inline void sctp_v6_del_protocol(void) { return; }
334 #endif /* #if defined(CONFIG_IPV6) */
337 /* Map an association to an assoc_id. */
338 static inline sctp_assoc_t sctp_assoc2id(const struct sctp_association *asoc)
340 return asoc ? asoc->assoc_id : 0;
343 static inline enum sctp_sstat_state
344 sctp_assoc_to_state(const struct sctp_association *asoc)
346 /* SCTP's uapi always had SCTP_EMPTY(=0) as a dummy state, but we
347 * got rid of it in kernel space. Therefore SCTP_CLOSED et al
348 * start at =1 in user space, but actually as =0 in kernel space.
349 * Now that we can not break user space and SCTP_EMPTY is exposed
350 * there, we need to fix it up with an ugly offset not to break
353 return asoc->state + 1;
356 /* Look up the association by its id. */
357 struct sctp_association *sctp_id2assoc(struct sock *sk, sctp_assoc_t id);
359 int sctp_do_peeloff(struct sock *sk, sctp_assoc_t id, struct socket **sockp);
361 /* A macro to walk a list of skbs. */
362 #define sctp_skb_for_each(pos, head, tmp) \
363 skb_queue_walk_safe(head, pos, tmp)
366 * sctp_list_dequeue - remove from the head of the queue
367 * @list: list to dequeue from
369 * Remove the head of the list. The head item is
370 * returned or %NULL if the list is empty.
373 static inline struct list_head *sctp_list_dequeue(struct list_head *list)
375 struct list_head *result = NULL;
377 if (!list_empty(list)) {
379 list_del_init(result);
384 /* SCTP version of skb_set_owner_r. We need this one because
385 * of the way we have to do receive buffer accounting on bundled
388 static inline void sctp_skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
390 struct sctp_ulpevent *event = sctp_skb2event(skb);
394 skb->destructor = sctp_sock_rfree;
395 atomic_add(event->rmem_len, &sk->sk_rmem_alloc);
397 * This mimics the behavior of skb_set_owner_r
399 sk->sk_forward_alloc -= event->rmem_len;
402 /* Tests if the list has one and only one entry. */
403 static inline int sctp_list_single_entry(struct list_head *head)
405 return (head->next != head) && (head->next == head->prev);
408 /* Break down data chunks at this point. */
409 static inline int sctp_frag_point(const struct sctp_association *asoc, int pmtu)
411 struct sctp_sock *sp = sctp_sk(asoc->base.sk);
414 frag -= sp->pf->af->net_header_len;
415 frag -= sizeof(struct sctphdr) + sizeof(struct sctp_data_chunk);
418 frag = min_t(int, frag, asoc->user_frag);
420 frag = WORD_TRUNC(min_t(int, frag, SCTP_MAX_CHUNK_LEN));
425 static inline void sctp_assoc_pending_pmtu(struct sock *sk, struct sctp_association *asoc)
428 sctp_assoc_sync_pmtu(sk, asoc);
429 asoc->pmtu_pending = 0;
432 static inline bool sctp_chunk_pending(const struct sctp_chunk *chunk)
434 return !list_empty(&chunk->list);
437 /* Walk through a list of TLV parameters. Don't trust the
438 * individual parameter lengths and instead depend on
439 * the chunk length to indicate when to stop. Make sure
440 * there is room for a param header too.
442 #define sctp_walk_params(pos, chunk, member)\
443 _sctp_walk_params((pos), (chunk), ntohs((chunk)->chunk_hdr.length), member)
445 #define _sctp_walk_params(pos, chunk, end, member)\
446 for (pos.v = chunk->member;\
447 pos.v <= (void *)chunk + end - ntohs(pos.p->length) &&\
448 ntohs(pos.p->length) >= sizeof(sctp_paramhdr_t);\
449 pos.v += WORD_ROUND(ntohs(pos.p->length)))
451 #define sctp_walk_errors(err, chunk_hdr)\
452 _sctp_walk_errors((err), (chunk_hdr), ntohs((chunk_hdr)->length))
454 #define _sctp_walk_errors(err, chunk_hdr, end)\
455 for (err = (sctp_errhdr_t *)((void *)chunk_hdr + \
456 sizeof(sctp_chunkhdr_t));\
457 (void *)err <= (void *)chunk_hdr + end - ntohs(err->length) &&\
458 ntohs(err->length) >= sizeof(sctp_errhdr_t); \
459 err = (sctp_errhdr_t *)((void *)err + WORD_ROUND(ntohs(err->length))))
461 #define sctp_walk_fwdtsn(pos, chunk)\
462 _sctp_walk_fwdtsn((pos), (chunk), ntohs((chunk)->chunk_hdr->length) - sizeof(struct sctp_fwdtsn_chunk))
464 #define _sctp_walk_fwdtsn(pos, chunk, end)\
465 for (pos = chunk->subh.fwdtsn_hdr->skip;\
466 (void *)pos <= (void *)chunk->subh.fwdtsn_hdr->skip + end - sizeof(struct sctp_fwdtsn_skip);\
469 /* External references. */
471 extern struct proto sctp_prot;
472 extern struct proto sctpv6_prot;
473 void sctp_put_port(struct sock *sk);
475 extern struct idr sctp_assocs_id;
476 extern spinlock_t sctp_assocs_id_lock;
478 /* Static inline functions. */
480 /* Convert from an IP version number to an Address Family symbol. */
481 static inline int ipver2af(__u8 ipver)
493 /* Convert from an address parameter type to an address family. */
494 static inline int param_type2af(__be16 type)
497 case SCTP_PARAM_IPV4_ADDRESS:
499 case SCTP_PARAM_IPV6_ADDRESS:
506 /* Warning: The following hash functions assume a power of two 'size'. */
507 /* This is the hash function for the SCTP port hash table. */
508 static inline int sctp_phashfn(struct net *net, __u16 lport)
510 return (net_hash_mix(net) + lport) & (sctp_port_hashsize - 1);
513 /* This is the hash function for the endpoint hash table. */
514 static inline int sctp_ep_hashfn(struct net *net, __u16 lport)
516 return (net_hash_mix(net) + lport) & (sctp_ep_hashsize - 1);
519 #define sctp_for_each_hentry(epb, head) \
520 hlist_for_each_entry(epb, head, node)
522 /* Is a socket of this style? */
523 #define sctp_style(sk, style) __sctp_style((sk), (SCTP_SOCKET_##style))
524 static inline int __sctp_style(const struct sock *sk, sctp_socket_type_t style)
526 return sctp_sk(sk)->type == style;
529 /* Is the association in this state? */
530 #define sctp_state(asoc, state) __sctp_state((asoc), (SCTP_STATE_##state))
531 static inline int __sctp_state(const struct sctp_association *asoc,
534 return asoc->state == state;
537 /* Is the socket in this state? */
538 #define sctp_sstate(sk, state) __sctp_sstate((sk), (SCTP_SS_##state))
539 static inline int __sctp_sstate(const struct sock *sk, sctp_sock_state_t state)
541 return sk->sk_state == state;
544 /* Map v4-mapped v6 address back to v4 address */
545 static inline void sctp_v6_map_v4(union sctp_addr *addr)
547 addr->v4.sin_family = AF_INET;
548 addr->v4.sin_port = addr->v6.sin6_port;
549 addr->v4.sin_addr.s_addr = addr->v6.sin6_addr.s6_addr32[3];
552 /* Map v4 address to v4-mapped v6 address */
553 static inline void sctp_v4_map_v6(union sctp_addr *addr)
557 port = addr->v4.sin_port;
558 addr->v6.sin6_addr.s6_addr32[3] = addr->v4.sin_addr.s_addr;
559 addr->v6.sin6_port = port;
560 addr->v6.sin6_family = AF_INET6;
561 addr->v6.sin6_flowinfo = 0;
562 addr->v6.sin6_scope_id = 0;
563 addr->v6.sin6_addr.s6_addr32[0] = 0;
564 addr->v6.sin6_addr.s6_addr32[1] = 0;
565 addr->v6.sin6_addr.s6_addr32[2] = htonl(0x0000ffff);
568 /* The cookie is always 0 since this is how it's used in the
571 static inline struct dst_entry *sctp_transport_dst_check(struct sctp_transport *t)
573 if (t->dst && !dst_check(t->dst, t->dst_cookie)) {
581 #endif /* __net_sctp_h__ */