2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_PCB_H_
39 #define _NETINET_SCTP_PCB_H_
41 #include <netinet/sctp_os.h>
42 #include <netinet/sctp.h>
43 #include <netinet/sctp_constants.h>
44 #include <netinet/sctp_sysctl.h>
46 LIST_HEAD(sctppcbhead, sctp_inpcb);
47 LIST_HEAD(sctpasochead, sctp_tcb);
48 LIST_HEAD(sctpladdr, sctp_laddr);
49 LIST_HEAD(sctpvtaghead, sctp_tagblock);
50 LIST_HEAD(sctp_vrflist, sctp_vrf);
51 LIST_HEAD(sctp_ifnlist, sctp_ifn);
52 LIST_HEAD(sctp_ifalist, sctp_ifa);
53 TAILQ_HEAD(sctp_readhead, sctp_queued_to_read);
54 TAILQ_HEAD(sctp_streamhead, sctp_stream_queue_pending);
56 #include <netinet/sctp_structs.h>
57 #include <netinet/sctp_auth.h>
59 #define SCTP_PCBHASH_ALLADDR(port, mask) (port & mask)
60 #define SCTP_PCBHASH_ASOC(tag, mask) (tag & mask)
63 LIST_ENTRY(sctp_vrf) next_vrf;
64 struct sctp_ifalist *vrf_addr_hash;
65 struct sctp_ifnlist ifnlist;
67 uint32_t tbl_id_v4; /* default v4 table id */
68 uint32_t tbl_id_v6; /* default v6 table id */
69 uint32_t total_ifa_count;
70 u_long vrf_addr_hashmark;
75 struct sctp_ifalist ifalist;
77 LIST_ENTRY(sctp_ifn) next_ifn;
78 LIST_ENTRY(sctp_ifn) next_bucket;
79 void *ifn_p; /* never access without appropriate lock */
82 uint32_t ifn_index; /* shorthand way to look at ifn for reference */
83 uint32_t refcount; /* number of reference held should be >=
85 uint32_t ifa_count; /* IFA's we hold (in our list - ifalist) */
86 uint32_t num_v6; /* number of v6 addresses */
87 uint32_t num_v4; /* number of v4 addresses */
88 uint32_t registered_af; /* registered address family for i/f events */
89 char ifn_name[SCTP_IFNAMSIZ];
92 /* SCTP local IFA flags */
93 #define SCTP_ADDR_VALID 0x00000001 /* its up and active */
94 #define SCTP_BEING_DELETED 0x00000002 /* being deleted, when
95 * refcount = 0. Note that it
96 * is pulled from the ifn list
97 * and ifa_p is nulled right
98 * away but it cannot be freed
100 * pointing to it is deleted. */
101 #define SCTP_ADDR_DEFER_USE 0x00000004 /* Hold off using this one */
102 #define SCTP_ADDR_IFA_UNUSEABLE 0x00000008
105 LIST_ENTRY(sctp_ifa) next_ifa;
106 LIST_ENTRY(sctp_ifa) next_bucket;
107 struct sctp_ifn *ifn_p; /* back pointer to parent ifn */
108 void *ifa; /* pointer to ifa, needed for flag update for
109 * that we MUST lock appropriate locks. This
111 union sctp_sockstore address;
112 uint32_t refcount; /* number of folks referring to this */
114 uint32_t localifa_flags;
115 uint32_t vrf_id; /* vrf_id of this addr (for deleting) */
123 LIST_ENTRY(sctp_laddr) sctp_nxt_addr; /* next in list */
124 struct sctp_ifa *ifa;
125 uint32_t action; /* Used during asconf and adding if no-zero
126 * src-addr selection will not consider this
128 struct timeval start_time; /* time when this address was created */
131 struct sctp_block_entry {
135 struct sctp_timewait {
136 uint32_t tv_sec_at_expire; /* the seconds from boot to expire */
137 uint32_t v_tag; /* the vtag that can not be reused */
138 uint16_t lport; /* the local port used in vtag */
139 uint16_t rport; /* the remote port used in vtag */
142 struct sctp_tagblock {
143 LIST_ENTRY(sctp_tagblock) sctp_nxt_tagblock;
144 struct sctp_timewait vtag_block[SCTP_NUMBER_IN_VTAG_BLOCK];
149 struct socket *udp4_tun_socket;
152 struct socket *udp6_tun_socket;
154 struct sctpasochead *sctp_asochash;
157 struct sctppcbhead *sctp_ephash;
161 * The TCP model represents a substantial overhead in that we get an
162 * additional hash table to keep explicit connections in. The
163 * listening TCP endpoint will exist in the usual ephash above and
164 * accept only INIT's. It will be incapable of sending off an INIT.
165 * When a dg arrives we must look in the normal ephash. If we find a
166 * TCP endpoint that will tell us to go to the specific endpoint
167 * hash and re-hash to find the right assoc/socket. If we find a UDP
168 * model socket we then must complete the lookup. If this fails,
169 * i.e. no association can be found then we must continue to see if
170 * a sctp_peeloff()'d socket is in the tcpephash (a spun off socket
171 * acts like a TCP model connected socket).
173 struct sctppcbhead *sctp_tcpephash;
175 uint32_t hashtblsize;
177 struct sctp_vrflist *sctp_vrfhash;
180 struct sctp_ifnlist *vrf_ifn_hash;
181 u_long vrf_ifn_hashmark;
183 struct sctppcbhead listhead;
184 struct sctpladdr addr_wq;
187 sctp_zone_t ipi_zone_ep;
188 sctp_zone_t ipi_zone_asoc;
189 sctp_zone_t ipi_zone_laddr;
190 sctp_zone_t ipi_zone_net;
191 sctp_zone_t ipi_zone_chunk;
192 sctp_zone_t ipi_zone_readq;
193 sctp_zone_t ipi_zone_strmoq;
194 sctp_zone_t ipi_zone_asconf;
195 sctp_zone_t ipi_zone_asconf_ack;
197 struct rwlock ipi_ep_mtx;
198 struct mtx ipi_iterator_wq_mtx;
199 struct rwlock ipi_addr_mtx;
200 struct mtx ipi_pktlog_mtx;
201 struct mtx wq_addr_mtx;
202 uint32_t ipi_count_ep;
204 /* assoc/tcb zone info */
205 uint32_t ipi_count_asoc;
207 /* local addrlist zone info */
208 uint32_t ipi_count_laddr;
210 /* remote addrlist zone info */
211 uint32_t ipi_count_raddr;
213 /* chunk structure list for output */
214 uint32_t ipi_count_chunk;
216 /* socket queue zone info */
217 uint32_t ipi_count_readq;
219 /* socket queue zone info */
220 uint32_t ipi_count_strmoq;
223 uint32_t ipi_count_vrfs;
226 uint32_t ipi_count_ifns;
229 uint32_t ipi_count_ifas;
231 /* system wide number of free chunks hanging around */
232 uint32_t ipi_free_chunks;
233 uint32_t ipi_free_strmoq;
235 struct sctpvtaghead vtag_timewait[SCTP_STACK_VTAG_HASH_SIZE];
237 /* address work queue handling */
238 struct sctp_timer addr_wq_timer;
242 struct sctp_base_info {
244 * All static structures that anchor the system must be here.
246 struct sctp_epinfo sctppcbinfo;
247 #if defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
248 struct sctpstat *sctpstat;
250 struct sctpstat sctpstat;
252 struct sctp_sysctl sctpsysctl;
254 char sctp_pcb_initialized;
255 #if defined(SCTP_PACKET_LOGGING)
256 int packet_log_writers;
258 uint8_t packet_log_buffer[SCTP_PACKET_LOG_SIZE];
260 eventhandler_tag eh_tag;
264 * Here we have all the relevant information for each SCTP entity created. We
265 * will need to modify this as approprate. We also need to figure out how to
266 * access /dev/random.
269 unsigned int time_of_secret_change; /* number of seconds from
271 uint32_t secret_key[SCTP_HOW_MANY_SECRETS][SCTP_NUMBER_OF_SECRETS];
272 unsigned int size_of_a_cookie;
274 uint32_t sctp_timeoutticks[SCTP_NUM_TMRS];
275 uint32_t sctp_minrto;
276 uint32_t sctp_maxrto;
277 uint32_t initial_rto;
278 uint32_t initial_init_rto_max;
280 unsigned int sctp_sack_freq;
281 uint32_t sctp_sws_sender;
282 uint32_t sctp_sws_receiver;
284 uint32_t sctp_default_cc_module;
285 uint32_t sctp_default_ss_module;
286 /* authentication related fields */
287 struct sctp_keyhead shared_keys;
288 sctp_auth_chklist_t *local_auth_chunks;
289 sctp_hmaclist_t *local_hmacs;
290 uint16_t default_keyid;
291 uint32_t default_mtu;
293 /* various thresholds */
294 /* Max times I will init at a guy */
295 uint16_t max_init_times;
297 /* Max times I will send before we consider someone dead */
298 uint16_t max_send_times;
300 uint16_t def_net_failure;
302 uint16_t def_net_pf_threshold;
304 /* number of streams to pre-open on a association */
305 uint16_t pre_open_stream_count;
306 uint16_t max_open_streams_intome;
308 /* random number generator */
309 uint32_t random_counter;
310 uint8_t random_numbers[SCTP_SIGNATURE_ALOC_SIZE];
311 uint8_t random_store[SCTP_SIGNATURE_ALOC_SIZE];
314 * This timer is kept running per endpoint. When it fires it will
315 * change the secret key. The default is once a hour
317 struct sctp_timer signature_change;
319 uint32_t def_cookie_life;
321 uint32_t auto_close_time;
322 uint32_t initial_sequence_debug;
323 uint32_t adaptation_layer_indicator;
324 uint8_t adaptation_layer_indicator_provided;
327 uint32_t fr_max_burst;
329 uint32_t default_flowlabel;
331 uint8_t default_dscp;
332 char current_secret_number;
333 char last_secret_number;
334 uint16_t port; /* remote UDP encapsulation port */
337 #ifndef SCTP_ALIGNMENT
338 #define SCTP_ALIGNMENT 32
342 #define SCTP_ALIGNM1 (SCTP_ALIGNMENT-1)
345 #define sctp_lport ip_inp.inp.inp_lport
347 struct sctp_pcbtsn_rlog {
354 #define SCTP_READ_LOG_SIZE 135 /* we choose the number to make a pcb a page */
358 * put an inpcb in front of it all, kind of a waste but we need to
359 * for compatibility with all the other stuff.
363 char align[(sizeof(struct inpcb) + SCTP_ALIGNM1) &
367 /* Socket buffer lock protects read_queue and of course sb_cc */
368 struct sctp_readhead read_queue;
370 LIST_ENTRY(sctp_inpcb) sctp_list; /* lists all endpoints */
371 /* hash of all endpoints for model */
372 LIST_ENTRY(sctp_inpcb) sctp_hash;
373 /* count of local addresses bound, 0 if bound all */
376 /* list of addrs in use by the EP, NULL if bound-all */
377 struct sctpladdr sctp_addr_list;
379 * used for source address selection rotation when we are subset
382 struct sctp_laddr *next_addr_touse;
384 /* back pointer to our socket */
385 struct socket *sctp_socket;
386 uint64_t sctp_features; /* Feature flags */
387 uint32_t sctp_flags; /* INP state flag set */
388 uint32_t sctp_mobility_features; /* Mobility Feature flags */
389 struct sctp_pcb sctp_ep; /* SCTP ep data */
390 /* head of the hash of all associations */
391 struct sctpasochead *sctp_tcbhash;
392 u_long sctp_hashmark;
393 /* head of the list of all associations */
394 struct sctpasochead sctp_asoc_list;
395 #ifdef SCTP_TRACK_FREED_ASOCS
396 struct sctpasochead sctp_asoc_free_list;
398 struct sctp_iterator *inp_starting_point_for_iterator;
399 uint32_t sctp_frag_point;
400 uint32_t partial_delivery_point;
401 uint32_t sctp_context;
403 uint8_t local_strreset_support;
404 uint32_t sctp_cmt_on_off;
405 uint8_t ecn_supported;
406 uint8_t prsctp_supported;
407 uint8_t auth_supported;
408 uint8_t idata_supported;
409 uint8_t asconf_supported;
410 uint8_t reconfig_supported;
411 uint8_t nrsack_supported;
412 uint8_t pktdrop_supported;
413 struct sctp_nonpad_sndrcvinfo def_send;
415 * These three are here for the sosend_dgram
416 * (pkt, pkt_last and control).
417 * routine. However, I don't think anyone in
418 * the current FreeBSD kernel calls this. So
419 * they are candidates with sctp_sendm for
422 struct mbuf *pkt, *pkt_last;
423 struct mbuf *control;
425 struct mtx inp_create_mtx;
426 struct mtx inp_rdata_mtx;
430 uint32_t total_sends;
431 uint32_t total_recvs;
432 uint32_t last_abort_code;
433 uint32_t total_nospaces;
434 struct sctpasochead *sctp_asocidhash;
435 u_long hashasocidmark;
436 uint32_t sctp_associd_counter;
438 #ifdef SCTP_ASOCLOG_OF_TSNS
439 struct sctp_pcbtsn_rlog readlog[SCTP_READ_LOG_SIZE];
440 uint32_t readlog_index;
445 struct socket *sctp_socket; /* back pointer to socket */
446 struct sctp_inpcb *sctp_ep; /* back pointer to ep */
447 LIST_ENTRY(sctp_tcb) sctp_tcbhash; /* next link in hash
449 LIST_ENTRY(sctp_tcb) sctp_tcblist; /* list of all of the
451 LIST_ENTRY(sctp_tcb) sctp_tcbasocidhash; /* next link in asocid
453 LIST_ENTRY(sctp_tcb) sctp_asocs; /* vtag hash list */
454 struct sctp_block_entry *block_entry; /* pointer locked by socket
456 struct sctp_association asoc;
458 * freed_by_sorcv_sincelast is protected by the sockbuf_lock NOT the
459 * tcb_lock. Its special in this way to help avoid extra mutex calls
460 * in the reading of data.
462 uint32_t freed_by_sorcv_sincelast;
463 uint32_t total_sends;
464 uint32_t total_recvs;
465 int freed_from_where;
466 uint16_t rport; /* remote port in network format */
469 struct mtx tcb_send_mtx;
472 #include <netinet/sctp_lock_bsd.h>
474 #if defined(_KERNEL) || defined(__Userspace__)
476 /* Attention Julian, this is the extern that
477 * goes with the base info. sctp_pcb.c has
478 * the real definition.
480 VNET_DECLARE(struct sctp_base_info, system_base_info);
483 int SCTP6_ARE_ADDR_EQUAL(struct sockaddr_in6 *a, struct sockaddr_in6 *b);
486 void sctp_fill_pcbinfo(struct sctp_pcbinfo *);
488 struct sctp_ifn *sctp_find_ifn(void *ifn, uint32_t ifn_index);
490 struct sctp_vrf *sctp_allocate_vrf(int vrfid);
491 struct sctp_vrf *sctp_find_vrf(uint32_t vrfid);
492 void sctp_free_vrf(struct sctp_vrf *vrf);
495 * Change address state, can be used if
496 * O/S supports telling transports about
497 * changes to IFA/IFN's (link layer triggers).
498 * If a ifn goes down, we will do src-addr-selection
499 * and NOT use that, as a source address. This does
500 * not stop the routing system from routing out
501 * that interface, but we won't put it as a source.
503 void sctp_mark_ifa_addr_down(uint32_t vrf_id, struct sockaddr *addr, const char *if_name, uint32_t ifn_index);
504 void sctp_mark_ifa_addr_up(uint32_t vrf_id, struct sockaddr *addr, const char *if_name, uint32_t ifn_index);
507 sctp_add_addr_to_vrf(uint32_t vrfid,
508 void *ifn, uint32_t ifn_index, uint32_t ifn_type,
510 void *ifa, struct sockaddr *addr, uint32_t ifa_flags,
513 void sctp_update_ifn_mtu(uint32_t ifn_index, uint32_t mtu);
515 void sctp_free_ifn(struct sctp_ifn *sctp_ifnp);
516 void sctp_free_ifa(struct sctp_ifa *sctp_ifap);
519 sctp_del_addr_from_vrf(uint32_t vrfid, struct sockaddr *addr,
520 uint32_t ifn_index, const char *if_name);
522 struct sctp_nets *sctp_findnet(struct sctp_tcb *, struct sockaddr *);
524 struct sctp_inpcb *sctp_pcb_findep(struct sockaddr *, int, int, uint32_t);
527 sctp_inpcb_bind(struct socket *, struct sockaddr *,
528 struct sctp_ifa *, struct thread *);
530 sctp_inpcb_bind_locked(struct sctp_inpcb *, struct sockaddr *,
531 struct sctp_ifa *, struct thread *);
534 sctp_findassociation_addr(struct mbuf *, int,
535 struct sockaddr *, struct sockaddr *,
536 struct sctphdr *, struct sctp_chunkhdr *, struct sctp_inpcb **,
537 struct sctp_nets **, uint32_t vrf_id);
540 sctp_findassociation_addr_sa(struct sockaddr *,
541 struct sockaddr *, struct sctp_inpcb **, struct sctp_nets **, int, uint32_t);
544 sctp_move_pcb_and_assoc(struct sctp_inpcb *, struct sctp_inpcb *,
548 * For this call ep_addr, the to is the destination endpoint address of the
549 * peer (relative to outbound). The from field is only used if the TCP model
550 * is enabled and helps distingush amongst the subset bound (non-boundall).
551 * The TCP model MAY change the actual ep field, this is why it is passed.
554 sctp_findassociation_ep_addr(struct sctp_inpcb **,
555 struct sockaddr *, struct sctp_nets **, struct sockaddr *,
558 struct sctp_tcb *sctp_findasoc_ep_asocid_locked(struct sctp_inpcb *inp, sctp_assoc_t asoc_id, int want_lock);
561 sctp_findassociation_ep_asocid(struct sctp_inpcb *,
565 sctp_findassociation_ep_asconf(struct mbuf *, int, struct sockaddr *,
566 struct sctphdr *, struct sctp_inpcb **, struct sctp_nets **, uint32_t vrf_id);
568 int sctp_inpcb_alloc(struct socket *so, uint32_t vrf_id);
570 int sctp_is_address_on_local_host(struct sockaddr *addr, uint32_t vrf_id);
572 void sctp_inpcb_free(struct sctp_inpcb *, int, int);
574 #define SCTP_DONT_INITIALIZE_AUTH_PARAMS 0
575 #define SCTP_INITIALIZE_AUTH_PARAMS 1
578 sctp_aloc_assoc(struct sctp_inpcb *, struct sockaddr *,
579 int *, uint32_t, uint32_t, uint32_t, uint16_t, uint16_t,
580 struct thread *, int);
582 int sctp_free_assoc(struct sctp_inpcb *, struct sctp_tcb *, int, int);
584 void sctp_delete_from_timewait(uint32_t, uint16_t, uint16_t);
586 int sctp_is_in_timewait(uint32_t tag, uint16_t lport, uint16_t rport);
589 sctp_add_vtag_to_timewait(uint32_t tag, uint32_t time, uint16_t lport, uint16_t rport);
591 void sctp_add_local_addr_ep(struct sctp_inpcb *, struct sctp_ifa *, uint32_t);
593 void sctp_del_local_addr_ep(struct sctp_inpcb *, struct sctp_ifa *);
595 int sctp_add_remote_addr(struct sctp_tcb *, struct sockaddr *, struct sctp_nets **, uint16_t, int, int);
597 void sctp_remove_net(struct sctp_tcb *, struct sctp_nets *);
599 int sctp_del_remote_addr(struct sctp_tcb *, struct sockaddr *);
601 void sctp_pcb_init(void);
603 void sctp_pcb_finish(void);
605 void sctp_add_local_addr_restricted(struct sctp_tcb *, struct sctp_ifa *);
606 void sctp_del_local_addr_restricted(struct sctp_tcb *, struct sctp_ifa *);
609 sctp_load_addresses_from_init(struct sctp_tcb *, struct mbuf *, int, int,
610 struct sockaddr *, struct sockaddr *, struct sockaddr *, uint16_t);
613 sctp_set_primary_addr(struct sctp_tcb *, struct sockaddr *,
616 int sctp_is_vtag_good(uint32_t, uint16_t lport, uint16_t rport, struct timeval *);
618 /* void sctp_drain(void); */
620 int sctp_destination_is_reachable(struct sctp_tcb *, struct sockaddr *);
622 int sctp_swap_inpcb_for_listen(struct sctp_inpcb *inp);
624 void sctp_clean_up_stream(struct sctp_tcb *stcb, struct sctp_readhead *rh);
627 * Null in last arg inpcb indicate run on ALL ep's. Specific inp in last arg
628 * indicates run on ONLY assoc's of the specified endpoint.
631 sctp_initiate_iterator(inp_func inpf,
640 #if defined(SCTP_MCORE_INPUT) && defined(SMP)
642 sctp_queue_to_mcore(struct mbuf *m, int off, int cpu_to_use);
647 #endif /* !__sctp_pcb_h__ */