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 *);
122 int sctp_primitive_ASSOCIATE(struct net
*, struct sctp_association
*, void *arg
);
123 int sctp_primitive_SHUTDOWN(struct net
*, struct sctp_association
*, void *arg
);
124 int sctp_primitive_ABORT(struct net
*, struct sctp_association
*, void *arg
);
125 int sctp_primitive_SEND(struct net
*, struct sctp_association
*, void *arg
);
126 int sctp_primitive_REQUESTHEARTBEAT(struct net
*, struct sctp_association
*, void *arg
);
127 int sctp_primitive_ASCONF(struct net
*, struct sctp_association
*, void *arg
);
132 int sctp_rcv(struct sk_buff
*skb
);
133 void sctp_v4_err(struct sk_buff
*skb
, u32 info
);
134 void sctp_hash_endpoint(struct sctp_endpoint
*);
135 void sctp_unhash_endpoint(struct sctp_endpoint
*);
136 struct sock
*sctp_err_lookup(struct net
*net
, int family
, struct sk_buff
*,
137 struct sctphdr
*, struct sctp_association
**,
138 struct sctp_transport
**);
139 void sctp_err_finish(struct sock
*, struct sctp_association
*);
140 void sctp_icmp_frag_needed(struct sock
*, struct sctp_association
*,
141 struct sctp_transport
*t
, __u32 pmtu
);
142 void sctp_icmp_redirect(struct sock
*, struct sctp_transport
*,
144 void sctp_icmp_proto_unreachable(struct sock
*sk
,
145 struct sctp_association
*asoc
,
146 struct sctp_transport
*t
);
147 void sctp_backlog_migrate(struct sctp_association
*assoc
,
148 struct sock
*oldsk
, struct sock
*newsk
);
149 int sctp_transport_hashtable_init(void);
150 void sctp_transport_hashtable_destroy(void);
151 void sctp_hash_transport(struct sctp_transport
*t
);
152 void sctp_unhash_transport(struct sctp_transport
*t
);
153 struct sctp_transport
*sctp_addrs_lookup_transport(
155 const union sctp_addr
*laddr
,
156 const union sctp_addr
*paddr
);
157 struct sctp_transport
*sctp_epaddr_lookup_transport(
158 const struct sctp_endpoint
*ep
,
159 const union sctp_addr
*paddr
);
164 int sctp_snmp_proc_init(struct net
*net
);
165 void sctp_snmp_proc_exit(struct net
*net
);
166 int sctp_eps_proc_init(struct net
*net
);
167 void sctp_eps_proc_exit(struct net
*net
);
168 int sctp_assocs_proc_init(struct net
*net
);
169 void sctp_assocs_proc_exit(struct net
*net
);
170 int sctp_remaddr_proc_init(struct net
*net
);
171 void sctp_remaddr_proc_exit(struct net
*net
);
175 * Module global variables
181 extern struct kmem_cache
*sctp_chunk_cachep __read_mostly
;
182 extern struct kmem_cache
*sctp_bucket_cachep __read_mostly
;
183 extern long sysctl_sctp_mem
[3];
184 extern int sysctl_sctp_rmem
[3];
185 extern int sysctl_sctp_wmem
[3];
188 * Section: Macros, externs, and inlines
191 /* SCTP SNMP MIB stats handlers */
192 #define SCTP_INC_STATS(net, field) SNMP_INC_STATS((net)->sctp.sctp_statistics, field)
193 #define SCTP_INC_STATS_BH(net, field) SNMP_INC_STATS_BH((net)->sctp.sctp_statistics, field)
194 #define SCTP_INC_STATS_USER(net, field) SNMP_INC_STATS_USER((net)->sctp.sctp_statistics, field)
195 #define SCTP_DEC_STATS(net, field) SNMP_DEC_STATS((net)->sctp.sctp_statistics, field)
197 /* sctp mib definitions */
200 SCTP_MIB_CURRESTAB
, /* CurrEstab */
201 SCTP_MIB_ACTIVEESTABS
, /* ActiveEstabs */
202 SCTP_MIB_PASSIVEESTABS
, /* PassiveEstabs */
203 SCTP_MIB_ABORTEDS
, /* Aborteds */
204 SCTP_MIB_SHUTDOWNS
, /* Shutdowns */
205 SCTP_MIB_OUTOFBLUES
, /* OutOfBlues */
206 SCTP_MIB_CHECKSUMERRORS
, /* ChecksumErrors */
207 SCTP_MIB_OUTCTRLCHUNKS
, /* OutCtrlChunks */
208 SCTP_MIB_OUTORDERCHUNKS
, /* OutOrderChunks */
209 SCTP_MIB_OUTUNORDERCHUNKS
, /* OutUnorderChunks */
210 SCTP_MIB_INCTRLCHUNKS
, /* InCtrlChunks */
211 SCTP_MIB_INORDERCHUNKS
, /* InOrderChunks */
212 SCTP_MIB_INUNORDERCHUNKS
, /* InUnorderChunks */
213 SCTP_MIB_FRAGUSRMSGS
, /* FragUsrMsgs */
214 SCTP_MIB_REASMUSRMSGS
, /* ReasmUsrMsgs */
215 SCTP_MIB_OUTSCTPPACKS
, /* OutSCTPPacks */
216 SCTP_MIB_INSCTPPACKS
, /* InSCTPPacks */
217 SCTP_MIB_T1_INIT_EXPIREDS
,
218 SCTP_MIB_T1_COOKIE_EXPIREDS
,
219 SCTP_MIB_T2_SHUTDOWN_EXPIREDS
,
220 SCTP_MIB_T3_RTX_EXPIREDS
,
221 SCTP_MIB_T4_RTO_EXPIREDS
,
222 SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS
,
223 SCTP_MIB_DELAY_SACK_EXPIREDS
,
224 SCTP_MIB_AUTOCLOSE_EXPIREDS
,
225 SCTP_MIB_T1_RETRANSMITS
,
226 SCTP_MIB_T3_RETRANSMITS
,
227 SCTP_MIB_PMTUD_RETRANSMITS
,
228 SCTP_MIB_FAST_RETRANSMITS
,
229 SCTP_MIB_IN_PKT_SOFTIRQ
,
230 SCTP_MIB_IN_PKT_BACKLOG
,
231 SCTP_MIB_IN_PKT_DISCARDS
,
232 SCTP_MIB_IN_DATA_CHUNK_DISCARDS
,
236 #define SCTP_MIB_MAX __SCTP_MIB_MAX
238 unsigned long mibs
[SCTP_MIB_MAX
];
241 /* helper function to track stats about max rto and related transport */
242 static inline void sctp_max_rto(struct sctp_association
*asoc
,
243 struct sctp_transport
*trans
)
245 if (asoc
->stats
.max_obs_rto
< (__u64
)trans
->rto
) {
246 asoc
->stats
.max_obs_rto
= trans
->rto
;
247 memset(&asoc
->stats
.obs_rto_ipaddr
, 0,
248 sizeof(struct sockaddr_storage
));
249 memcpy(&asoc
->stats
.obs_rto_ipaddr
, &trans
->ipaddr
,
250 trans
->af_specific
->sockaddr_len
);
255 * Macros for keeping a global reference of object allocations.
257 #ifdef CONFIG_SCTP_DBG_OBJCNT
259 extern atomic_t sctp_dbg_objcnt_sock
;
260 extern atomic_t sctp_dbg_objcnt_ep
;
261 extern atomic_t sctp_dbg_objcnt_assoc
;
262 extern atomic_t sctp_dbg_objcnt_transport
;
263 extern atomic_t sctp_dbg_objcnt_chunk
;
264 extern atomic_t sctp_dbg_objcnt_bind_addr
;
265 extern atomic_t sctp_dbg_objcnt_bind_bucket
;
266 extern atomic_t sctp_dbg_objcnt_addr
;
267 extern atomic_t sctp_dbg_objcnt_ssnmap
;
268 extern atomic_t sctp_dbg_objcnt_datamsg
;
269 extern atomic_t sctp_dbg_objcnt_keys
;
271 /* Macros to atomically increment/decrement objcnt counters. */
272 #define SCTP_DBG_OBJCNT_INC(name) \
273 atomic_inc(&sctp_dbg_objcnt_## name)
274 #define SCTP_DBG_OBJCNT_DEC(name) \
275 atomic_dec(&sctp_dbg_objcnt_## name)
276 #define SCTP_DBG_OBJCNT(name) \
277 atomic_t sctp_dbg_objcnt_## name = ATOMIC_INIT(0)
279 /* Macro to help create new entries in in the global array of
282 #define SCTP_DBG_OBJCNT_ENTRY(name) \
283 {.label= #name, .counter= &sctp_dbg_objcnt_## name}
285 void sctp_dbg_objcnt_init(struct net
*);
286 void sctp_dbg_objcnt_exit(struct net
*);
290 #define SCTP_DBG_OBJCNT_INC(name)
291 #define SCTP_DBG_OBJCNT_DEC(name)
293 static inline void sctp_dbg_objcnt_init(struct net
*net
) { return; }
294 static inline void sctp_dbg_objcnt_exit(struct net
*net
) { return; }
296 #endif /* CONFIG_SCTP_DBG_OBJCOUNT */
298 #if defined CONFIG_SYSCTL
299 void sctp_sysctl_register(void);
300 void sctp_sysctl_unregister(void);
301 int sctp_sysctl_net_register(struct net
*net
);
302 void sctp_sysctl_net_unregister(struct net
*net
);
304 static inline void sctp_sysctl_register(void) { return; }
305 static inline void sctp_sysctl_unregister(void) { return; }
306 static inline int sctp_sysctl_net_register(struct net
*net
) { return 0; }
307 static inline void sctp_sysctl_net_unregister(struct net
*net
) { return; }
310 /* Size of Supported Address Parameter for 'x' address types. */
311 #define SCTP_SAT_LEN(x) (sizeof(struct sctp_paramhdr) + (x) * sizeof(__u16))
313 #if IS_ENABLED(CONFIG_IPV6)
315 void sctp_v6_pf_init(void);
316 void sctp_v6_pf_exit(void);
317 int sctp_v6_protosw_init(void);
318 void sctp_v6_protosw_exit(void);
319 int sctp_v6_add_protocol(void);
320 void sctp_v6_del_protocol(void);
322 #else /* #ifdef defined(CONFIG_IPV6) */
324 static inline void sctp_v6_pf_init(void) { return; }
325 static inline void sctp_v6_pf_exit(void) { return; }
326 static inline int sctp_v6_protosw_init(void) { return 0; }
327 static inline void sctp_v6_protosw_exit(void) { return; }
328 static inline int sctp_v6_add_protocol(void) { return 0; }
329 static inline void sctp_v6_del_protocol(void) { return; }
331 #endif /* #if defined(CONFIG_IPV6) */
334 /* Map an association to an assoc_id. */
335 static inline sctp_assoc_t
sctp_assoc2id(const struct sctp_association
*asoc
)
337 return asoc
? asoc
->assoc_id
: 0;
340 static inline enum sctp_sstat_state
341 sctp_assoc_to_state(const struct sctp_association
*asoc
)
343 /* SCTP's uapi always had SCTP_EMPTY(=0) as a dummy state, but we
344 * got rid of it in kernel space. Therefore SCTP_CLOSED et al
345 * start at =1 in user space, but actually as =0 in kernel space.
346 * Now that we can not break user space and SCTP_EMPTY is exposed
347 * there, we need to fix it up with an ugly offset not to break
350 return asoc
->state
+ 1;
353 /* Look up the association by its id. */
354 struct sctp_association
*sctp_id2assoc(struct sock
*sk
, sctp_assoc_t id
);
356 int sctp_do_peeloff(struct sock
*sk
, sctp_assoc_t id
, struct socket
**sockp
);
358 /* A macro to walk a list of skbs. */
359 #define sctp_skb_for_each(pos, head, tmp) \
360 skb_queue_walk_safe(head, pos, tmp)
363 * sctp_list_dequeue - remove from the head of the queue
364 * @list: list to dequeue from
366 * Remove the head of the list. The head item is
367 * returned or %NULL if the list is empty.
370 static inline struct list_head
*sctp_list_dequeue(struct list_head
*list
)
372 struct list_head
*result
= NULL
;
374 if (!list_empty(list
)) {
376 list_del_init(result
);
381 /* SCTP version of skb_set_owner_r. We need this one because
382 * of the way we have to do receive buffer accounting on bundled
385 static inline void sctp_skb_set_owner_r(struct sk_buff
*skb
, struct sock
*sk
)
387 struct sctp_ulpevent
*event
= sctp_skb2event(skb
);
391 skb
->destructor
= sctp_sock_rfree
;
392 atomic_add(event
->rmem_len
, &sk
->sk_rmem_alloc
);
394 * This mimics the behavior of skb_set_owner_r
396 sk
->sk_forward_alloc
-= event
->rmem_len
;
399 /* Tests if the list has one and only one entry. */
400 static inline int sctp_list_single_entry(struct list_head
*head
)
402 return (head
->next
!= head
) && (head
->next
== head
->prev
);
405 /* Break down data chunks at this point. */
406 static inline int sctp_frag_point(const struct sctp_association
*asoc
, int pmtu
)
408 struct sctp_sock
*sp
= sctp_sk(asoc
->base
.sk
);
411 frag
-= sp
->pf
->af
->net_header_len
;
412 frag
-= sizeof(struct sctphdr
) + sizeof(struct sctp_data_chunk
);
415 frag
= min_t(int, frag
, asoc
->user_frag
);
417 frag
= WORD_TRUNC(min_t(int, frag
, SCTP_MAX_CHUNK_LEN
));
422 static inline void sctp_assoc_pending_pmtu(struct sock
*sk
, struct sctp_association
*asoc
)
425 sctp_assoc_sync_pmtu(sk
, asoc
);
426 asoc
->pmtu_pending
= 0;
429 static inline bool sctp_chunk_pending(const struct sctp_chunk
*chunk
)
431 return !list_empty(&chunk
->list
);
434 /* Walk through a list of TLV parameters. Don't trust the
435 * individual parameter lengths and instead depend on
436 * the chunk length to indicate when to stop. Make sure
437 * there is room for a param header too.
439 #define sctp_walk_params(pos, chunk, member)\
440 _sctp_walk_params((pos), (chunk), ntohs((chunk)->chunk_hdr.length), member)
442 #define _sctp_walk_params(pos, chunk, end, member)\
443 for (pos.v = chunk->member;\
444 pos.v <= (void *)chunk + end - ntohs(pos.p->length) &&\
445 ntohs(pos.p->length) >= sizeof(sctp_paramhdr_t);\
446 pos.v += WORD_ROUND(ntohs(pos.p->length)))
448 #define sctp_walk_errors(err, chunk_hdr)\
449 _sctp_walk_errors((err), (chunk_hdr), ntohs((chunk_hdr)->length))
451 #define _sctp_walk_errors(err, chunk_hdr, end)\
452 for (err = (sctp_errhdr_t *)((void *)chunk_hdr + \
453 sizeof(sctp_chunkhdr_t));\
454 (void *)err <= (void *)chunk_hdr + end - ntohs(err->length) &&\
455 ntohs(err->length) >= sizeof(sctp_errhdr_t); \
456 err = (sctp_errhdr_t *)((void *)err + WORD_ROUND(ntohs(err->length))))
458 #define sctp_walk_fwdtsn(pos, chunk)\
459 _sctp_walk_fwdtsn((pos), (chunk), ntohs((chunk)->chunk_hdr->length) - sizeof(struct sctp_fwdtsn_chunk))
461 #define _sctp_walk_fwdtsn(pos, chunk, end)\
462 for (pos = chunk->subh.fwdtsn_hdr->skip;\
463 (void *)pos <= (void *)chunk->subh.fwdtsn_hdr->skip + end - sizeof(struct sctp_fwdtsn_skip);\
466 /* External references. */
468 extern struct proto sctp_prot
;
469 extern struct proto sctpv6_prot
;
470 void sctp_put_port(struct sock
*sk
);
472 extern struct idr sctp_assocs_id
;
473 extern spinlock_t sctp_assocs_id_lock
;
475 /* Static inline functions. */
477 /* Convert from an IP version number to an Address Family symbol. */
478 static inline int ipver2af(__u8 ipver
)
490 /* Convert from an address parameter type to an address family. */
491 static inline int param_type2af(__be16 type
)
494 case SCTP_PARAM_IPV4_ADDRESS
:
496 case SCTP_PARAM_IPV6_ADDRESS
:
503 /* Warning: The following hash functions assume a power of two 'size'. */
504 /* This is the hash function for the SCTP port hash table. */
505 static inline int sctp_phashfn(struct net
*net
, __u16 lport
)
507 return (net_hash_mix(net
) + lport
) & (sctp_port_hashsize
- 1);
510 /* This is the hash function for the endpoint hash table. */
511 static inline int sctp_ep_hashfn(struct net
*net
, __u16 lport
)
513 return (net_hash_mix(net
) + lport
) & (sctp_ep_hashsize
- 1);
516 #define sctp_for_each_hentry(epb, head) \
517 hlist_for_each_entry(epb, head, node)
519 /* Is a socket of this style? */
520 #define sctp_style(sk, style) __sctp_style((sk), (SCTP_SOCKET_##style))
521 static inline int __sctp_style(const struct sock
*sk
, sctp_socket_type_t style
)
523 return sctp_sk(sk
)->type
== style
;
526 /* Is the association in this state? */
527 #define sctp_state(asoc, state) __sctp_state((asoc), (SCTP_STATE_##state))
528 static inline int __sctp_state(const struct sctp_association
*asoc
,
531 return asoc
->state
== state
;
534 /* Is the socket in this state? */
535 #define sctp_sstate(sk, state) __sctp_sstate((sk), (SCTP_SS_##state))
536 static inline int __sctp_sstate(const struct sock
*sk
, sctp_sock_state_t state
)
538 return sk
->sk_state
== state
;
541 /* Map v4-mapped v6 address back to v4 address */
542 static inline void sctp_v6_map_v4(union sctp_addr
*addr
)
544 addr
->v4
.sin_family
= AF_INET
;
545 addr
->v4
.sin_port
= addr
->v6
.sin6_port
;
546 addr
->v4
.sin_addr
.s_addr
= addr
->v6
.sin6_addr
.s6_addr32
[3];
549 /* Map v4 address to v4-mapped v6 address */
550 static inline void sctp_v4_map_v6(union sctp_addr
*addr
)
554 port
= addr
->v4
.sin_port
;
555 addr
->v6
.sin6_addr
.s6_addr32
[3] = addr
->v4
.sin_addr
.s_addr
;
556 addr
->v6
.sin6_port
= port
;
557 addr
->v6
.sin6_family
= AF_INET6
;
558 addr
->v6
.sin6_flowinfo
= 0;
559 addr
->v6
.sin6_scope_id
= 0;
560 addr
->v6
.sin6_addr
.s6_addr32
[0] = 0;
561 addr
->v6
.sin6_addr
.s6_addr32
[1] = 0;
562 addr
->v6
.sin6_addr
.s6_addr32
[2] = htonl(0x0000ffff);
565 /* The cookie is always 0 since this is how it's used in the
568 static inline struct dst_entry
*sctp_transport_dst_check(struct sctp_transport
*t
)
570 if (t
->dst
&& !dst_check(t
->dst
, t
->dst_cookie
)) {
578 #endif /* __net_sctp_h__ */