2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * a) Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
10 * b) Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the distribution.
14 * c) Neither the name of Cisco Systems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28 * THE POSSIBILITY OF SUCH DAMAGE.
31 /* $KAME: sctp_pcb.h,v 1.21 2005/07/16 01:18:47 suz Exp $ */
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef __sctp_pcb_h__
37 #define __sctp_pcb_h__
39 #include <netinet/sctp_os.h>
40 #include <netinet/sctp.h>
41 #include <netinet/sctp_constants.h>
43 LIST_HEAD(sctppcbhead, sctp_inpcb);
44 LIST_HEAD(sctpasochead, sctp_tcb);
45 LIST_HEAD(sctpladdr, sctp_laddr);
46 LIST_HEAD(sctpvtaghead, sctp_tagblock);
47 LIST_HEAD(sctp_vrflist, sctp_vrf);
48 LIST_HEAD(sctp_ifnlist, sctp_ifn);
49 LIST_HEAD(sctp_ifalist, sctp_ifa);
50 TAILQ_HEAD(sctp_readhead, sctp_queued_to_read);
51 TAILQ_HEAD(sctp_streamhead, sctp_stream_queue_pending);
53 #include <netinet/sctp_structs.h>
54 #include <netinet/sctp_auth.h>
56 #define SCTP_PCBHASH_ALLADDR(port, mask) (port & mask)
57 #define SCTP_PCBHASH_ASOC(tag, mask) (tag & mask)
60 LIST_ENTRY(sctp_vrf) next_vrf;
61 struct sctp_ifalist *vrf_addr_hash;
62 struct sctp_ifnlist ifnlist;
64 uint32_t tbl_id_v4; /* default v4 table id */
65 uint32_t tbl_id_v6; /* default v6 table id */
66 uint32_t total_ifa_count;
67 u_long vrf_addr_hashmark;
72 struct sctp_ifalist ifalist;
74 LIST_ENTRY(sctp_ifn) next_ifn;
75 LIST_ENTRY(sctp_ifn) next_bucket;
76 void *ifn_p; /* never access without appropriate lock */
79 uint32_t ifn_index; /* shorthand way to look at ifn for reference */
80 uint32_t refcount; /* number of reference held should be >=
82 uint32_t ifa_count; /* IFA's we hold (in our list - ifalist) */
83 uint32_t num_v6; /* number of v6 addresses */
84 uint32_t num_v4; /* number of v4 addresses */
85 uint32_t registered_af; /* registered address family for i/f events */
86 char ifn_name[SCTP_IFNAMSIZ];
89 /* SCTP local IFA flags */
90 #define SCTP_ADDR_VALID 0x00000001 /* its up and active */
91 #define SCTP_BEING_DELETED 0x00000002 /* being deleted, when
92 * refcount = 0. Note that it
93 * is pulled from the ifn list
94 * and ifa_p is nulled right
95 * away but it cannot be freed
97 * pointing to it is deleted. */
98 #define SCTP_ADDR_DEFER_USE 0x00000004 /* Hold off using this one */
99 #define SCTP_ADDR_IFA_UNUSEABLE 0x00000008
102 LIST_ENTRY(sctp_ifa) next_ifa;
103 LIST_ENTRY(sctp_ifa) next_bucket;
104 struct sctp_ifn *ifn_p; /* back pointer to parent ifn */
105 void *ifa; /* pointer to ifa, needed for flag update for
106 * that we MUST lock appropriate locks. This
108 union sctp_sockstore address;
109 uint32_t refcount; /* number of folks refering to this */
111 uint32_t localifa_flags;
112 uint32_t vrf_id; /* vrf_id of this addr (for deleting) */
120 LIST_ENTRY(sctp_laddr) sctp_nxt_addr; /* next in list */
121 struct sctp_ifa *ifa;
122 uint32_t action; /* Used during asconf and adding if no-zero
123 * src-addr selection will not consider this
125 struct timeval start_time; /* time when this address was created */
128 struct sctp_block_entry {
132 struct sctp_timewait {
133 uint32_t tv_sec_at_expire; /* the seconds from boot to expire */
134 uint32_t v_tag; /* the vtag that can not be reused */
137 struct sctp_tagblock {
138 LIST_ENTRY(sctp_tagblock) sctp_nxt_tagblock;
139 struct sctp_timewait vtag_block[SCTP_NUMBER_IN_VTAG_BLOCK];
143 struct sctpasochead *sctp_asochash;
146 struct sctppcbhead *sctp_ephash;
149 struct sctpasochead *sctp_restarthash;
150 u_long hashrestartmark;
152 * The TCP model represents a substantial overhead in that we get an
153 * additional hash table to keep explicit connections in. The
154 * listening TCP endpoint will exist in the usual ephash above and
155 * accept only INIT's. It will be incapable of sending off an INIT.
156 * When a dg arrives we must look in the normal ephash. If we find a
157 * TCP endpoint that will tell us to go to the specific endpoint
158 * hash and re-hash to find the right assoc/socket. If we find a UDP
159 * model socket we then must complete the lookup. If this fails,
160 * i.e. no association can be found then we must continue to see if
161 * a sctp_peeloff()'d socket is in the tcpephash (a spun off socket
162 * acts like a TCP model connected socket).
164 struct sctppcbhead *sctp_tcpephash;
166 uint32_t hashtblsize;
168 struct sctp_vrflist *sctp_vrfhash;
171 struct sctp_ifnlist *vrf_ifn_hash;
172 u_long vrf_ifn_hashmark;
174 struct sctppcbhead listhead;
175 struct sctpladdr addr_wq;
177 struct sctpiterators iteratorhead;
180 sctp_zone_t ipi_zone_ep;
181 sctp_zone_t ipi_zone_asoc;
182 sctp_zone_t ipi_zone_laddr;
183 sctp_zone_t ipi_zone_net;
184 sctp_zone_t ipi_zone_chunk;
185 sctp_zone_t ipi_zone_readq;
186 sctp_zone_t ipi_zone_strmoq;
187 sctp_zone_t ipi_zone_asconf_ack;
189 struct rwlock ipi_ep_mtx;
191 struct mtx ipi_iterator_wq_mtx;
192 struct rwlock ipi_addr_mtx;
193 struct mtx ipi_pktlog_mtx;
194 uint32_t ipi_count_ep;
196 /* assoc/tcb zone info */
197 uint32_t ipi_count_asoc;
199 /* local addrlist zone info */
200 uint32_t ipi_count_laddr;
202 /* remote addrlist zone info */
203 uint32_t ipi_count_raddr;
205 /* chunk structure list for output */
206 uint32_t ipi_count_chunk;
208 /* socket queue zone info */
209 uint32_t ipi_count_readq;
211 /* socket queue zone info */
212 uint32_t ipi_count_strmoq;
215 uint32_t ipi_count_vrfs;
218 uint32_t ipi_count_ifns;
221 uint32_t ipi_count_ifas;
223 /* system wide number of free chunks hanging around */
224 uint32_t ipi_free_chunks;
225 uint32_t ipi_free_strmoq;
228 struct sctpvtaghead vtag_timewait[SCTP_STACK_VTAG_HASH_SIZE_A];
230 /* address work queue handling */
231 #if defined(SCTP_USE_THREAD_BASED_ITERATOR)
232 uint32_t iterator_running;
233 SCTP_PROCESS_STRUCT thread_proc;
235 struct sctp_timer addr_wq_timer;
240 * Here we have all the relevant information for each SCTP entity created. We
241 * will need to modify this as approprate. We also need to figure out how to
242 * access /dev/random.
245 unsigned int time_of_secret_change; /* number of seconds from
247 uint32_t secret_key[SCTP_HOW_MANY_SECRETS][SCTP_NUMBER_OF_SECRETS];
248 unsigned int size_of_a_cookie;
250 unsigned int sctp_timeoutticks[SCTP_NUM_TMRS];
251 unsigned int sctp_minrto;
252 unsigned int sctp_maxrto;
253 unsigned int initial_rto;
254 int initial_init_rto_max;
256 unsigned int sctp_sack_freq;
257 uint32_t sctp_sws_sender;
258 uint32_t sctp_sws_receiver;
260 uint32_t sctp_default_cc_module;
261 /* authentication related fields */
262 struct sctp_keyhead shared_keys;
263 sctp_auth_chklist_t *local_auth_chunks;
264 sctp_hmaclist_t *local_hmacs;
265 uint16_t default_keyid;
267 /* various thresholds */
268 /* Max times I will init at a guy */
269 uint16_t max_init_times;
271 /* Max times I will send before we consider someone dead */
272 uint16_t max_send_times;
274 uint16_t def_net_failure;
276 /* number of streams to pre-open on a association */
277 uint16_t pre_open_stream_count;
278 uint16_t max_open_streams_intome;
280 /* random number generator */
281 uint32_t random_counter;
282 uint8_t random_numbers[SCTP_SIGNATURE_ALOC_SIZE];
283 uint8_t random_store[SCTP_SIGNATURE_ALOC_SIZE];
286 * This timer is kept running per endpoint. When it fires it will
287 * change the secret key. The default is once a hour
289 struct sctp_timer signature_change;
291 /* Zero copy full buffer timer */
292 struct sctp_timer zero_copy_timer;
293 /* Zero copy app to transport (sendq) read repulse timer */
294 struct sctp_timer zero_copy_sendq_timer;
295 uint32_t def_cookie_life;
298 uint32_t initial_sequence_debug;
299 uint32_t adaptation_layer_indicator;
302 char current_secret_number;
303 char last_secret_number;
306 #ifndef SCTP_ALIGNMENT
307 #define SCTP_ALIGNMENT 32
311 #define SCTP_ALIGNM1 (SCTP_ALIGNMENT-1)
314 #define sctp_lport ip_inp.inp.inp_lport
316 struct sctp_pcbtsn_rlog {
324 #define SCTP_READ_LOG_SIZE 135 /* we choose the number to make a pcb a page */
329 * put an inpcb in front of it all, kind of a waste but we need to
330 * for compatability with all the other stuff.
334 char align[(sizeof(struct in6pcb) + SCTP_ALIGNM1) &
339 /* Socket buffer lock protects read_queue and of course sb_cc */
340 struct sctp_readhead read_queue;
342 LIST_ENTRY(sctp_inpcb) sctp_list; /* lists all endpoints */
343 /* hash of all endpoints for model */
344 LIST_ENTRY(sctp_inpcb) sctp_hash;
345 /* count of local addresses bound, 0 if bound all */
348 /* list of addrs in use by the EP, NULL if bound-all */
349 struct sctpladdr sctp_addr_list;
351 * used for source address selection rotation when we are subset
354 struct sctp_laddr *next_addr_touse;
356 /* back pointer to our socket */
357 struct socket *sctp_socket;
358 uint32_t sctp_flags; /* INP state flag set */
359 uint32_t sctp_features; /* Feature flags */
360 uint32_t sctp_mobility_features; /* Mobility Feature flags */
361 struct sctp_pcb sctp_ep;/* SCTP ep data */
362 /* head of the hash of all associations */
363 struct sctpasochead *sctp_tcbhash;
364 u_long sctp_hashmark;
365 /* head of the list of all associations */
366 struct sctpasochead sctp_asoc_list;
367 #ifdef SCTP_TRACK_FREED_ASOCS
368 struct sctpasochead sctp_asoc_free_list;
370 struct sctp_iterator *inp_starting_point_for_iterator;
371 uint32_t sctp_frag_point;
372 uint32_t partial_delivery_point;
373 uint32_t sctp_context;
374 struct sctp_nonpad_sndrcvinfo def_send;
376 * These three are here for the sosend_dgram
377 * (pkt, pkt_last and control).
378 * routine. However, I don't think anyone in
379 * the current FreeBSD kernel calls this. So
380 * they are candidates with sctp_sendm for
383 struct mbuf *pkt, *pkt_last;
384 struct mbuf *control;
386 struct mtx inp_create_mtx;
387 struct mtx inp_rdata_mtx;
390 uint32_t total_sends;
391 uint32_t total_recvs;
392 uint32_t last_abort_code;
393 uint32_t total_nospaces;
394 #ifdef SCTP_ASOCLOG_OF_TSNS
395 struct sctp_pcbtsn_rlog readlog[SCTP_READ_LOG_SIZE];
396 uint32_t readlog_index;
401 struct socket *sctp_socket; /* back pointer to socket */
402 struct sctp_inpcb *sctp_ep; /* back pointer to ep */
403 LIST_ENTRY(sctp_tcb) sctp_tcbhash; /* next link in hash
405 LIST_ENTRY(sctp_tcb) sctp_tcblist; /* list of all of the
407 LIST_ENTRY(sctp_tcb) sctp_tcbrestarhash; /* next link in restart
409 LIST_ENTRY(sctp_tcb) sctp_asocs; /* vtag hash list */
410 struct sctp_block_entry *block_entry; /* pointer locked by socket
412 struct sctp_association asoc;
414 * freed_by_sorcv_sincelast is protected by the sockbuf_lock NOT the
415 * tcb_lock. Its special in this way to help avoid extra mutex calls
416 * in the reading of data.
418 uint32_t freed_by_sorcv_sincelast;
419 uint32_t total_sends;
420 uint32_t total_recvs;
421 int freed_from_where;
422 uint16_t rport; /* remote port in network format */
425 struct mtx tcb_send_mtx;
430 #include <netinet/sctp_lock_bsd.h>
435 extern struct sctp_epinfo sctppcbinfo;
437 int SCTP6_ARE_ADDR_EQUAL(struct in6_addr *a, struct in6_addr *b);
439 void sctp_fill_pcbinfo(struct sctp_pcbinfo *);
442 sctp_find_ifn(void *ifn, uint32_t ifn_index);
444 struct sctp_vrf *sctp_allocate_vrf(int vrfid);
445 struct sctp_vrf *sctp_find_vrf(uint32_t vrfid);
446 void sctp_free_vrf(struct sctp_vrf *vrf);
449 * Change address state, can be used if
450 * O/S supports telling transports about
451 * changes to IFA/IFN's (link layer triggers).
452 * If a ifn goes down, we will do src-addr-selection
453 * and NOT use that, as a source address. This does
454 * not stop the routing system from routing out
455 * that interface, but we won't put it as a source.
457 void sctp_mark_ifa_addr_down(uint32_t vrf_id, struct sockaddr *addr, const char *if_name, uint32_t ifn_index);
458 void sctp_mark_ifa_addr_up(uint32_t vrf_id, struct sockaddr *addr, const char *if_name, uint32_t ifn_index);
461 sctp_add_addr_to_vrf(uint32_t vrfid,
462 void *ifn, uint32_t ifn_index, uint32_t ifn_type,
464 void *ifa, struct sockaddr *addr, uint32_t ifa_flags,
467 void sctp_update_ifn_mtu(uint32_t ifn_index, uint32_t mtu);
469 void sctp_free_ifn(struct sctp_ifn *sctp_ifnp);
470 void sctp_free_ifa(struct sctp_ifa *sctp_ifap);
474 sctp_del_addr_from_vrf(uint32_t vrfid, struct sockaddr *addr,
475 uint32_t ifn_index, const char *if_name);
479 struct sctp_nets *sctp_findnet(struct sctp_tcb *, struct sockaddr *);
481 struct sctp_inpcb *sctp_pcb_findep(struct sockaddr *, int, int, uint32_t);
484 sctp_inpcb_bind(struct socket *, struct sockaddr *,
485 struct sctp_ifa *, struct thread *);
488 sctp_findassociation_addr(struct mbuf *, int, int,
489 struct sctphdr *, struct sctp_chunkhdr *, struct sctp_inpcb **,
490 struct sctp_nets **, uint32_t vrf_id);
493 sctp_findassociation_addr_sa(struct sockaddr *,
494 struct sockaddr *, struct sctp_inpcb **, struct sctp_nets **, int, uint32_t);
497 sctp_move_pcb_and_assoc(struct sctp_inpcb *, struct sctp_inpcb *,
501 * For this call ep_addr, the to is the destination endpoint address of the
502 * peer (relative to outbound). The from field is only used if the TCP model
503 * is enabled and helps distingush amongst the subset bound (non-boundall).
504 * The TCP model MAY change the actual ep field, this is why it is passed.
507 sctp_findassociation_ep_addr(struct sctp_inpcb **,
508 struct sockaddr *, struct sctp_nets **, struct sockaddr *,
512 sctp_findassociation_ep_asocid(struct sctp_inpcb *,
516 sctp_findassociation_ep_asconf(struct mbuf *, int, int,
517 struct sctphdr *, struct sctp_inpcb **, struct sctp_nets **);
519 int sctp_inpcb_alloc(struct socket *so, uint32_t vrf_id);
521 int sctp_is_address_on_local_host(struct sockaddr *addr, uint32_t vrf_id);
523 void sctp_inpcb_free(struct sctp_inpcb *, int, int);
526 sctp_aloc_assoc(struct sctp_inpcb *, struct sockaddr *,
527 int, int *, uint32_t, uint32_t, struct thread *);
529 int sctp_free_assoc(struct sctp_inpcb *, struct sctp_tcb *, int, int);
532 void sctp_delete_from_timewait(uint32_t);
534 int sctp_is_in_timewait(uint32_t tag);
537 sctp_add_vtag_to_timewait(uint32_t, uint32_t);
539 void sctp_add_local_addr_ep(struct sctp_inpcb *, struct sctp_ifa *, uint32_t);
541 int sctp_insert_laddr(struct sctpladdr *, struct sctp_ifa *, uint32_t);
543 void sctp_remove_laddr(struct sctp_laddr *);
545 void sctp_del_local_addr_ep(struct sctp_inpcb *, struct sctp_ifa *);
547 int sctp_add_remote_addr(struct sctp_tcb *, struct sockaddr *, int, int);
549 void sctp_remove_net(struct sctp_tcb *, struct sctp_nets *);
551 int sctp_del_remote_addr(struct sctp_tcb *, struct sockaddr *);
553 void sctp_pcb_init(void);
556 void sctp_add_local_addr_restricted(struct sctp_tcb *, struct sctp_ifa *);
557 void sctp_del_local_addr_restricted(struct sctp_tcb *, struct sctp_ifa *);
560 sctp_load_addresses_from_init(struct sctp_tcb *, struct mbuf *, int, int,
561 int, struct sctphdr *, struct sockaddr *);
564 sctp_set_primary_addr(struct sctp_tcb *, struct sockaddr *,
567 int sctp_is_vtag_good(struct sctp_inpcb *, uint32_t, struct timeval *, int);
569 /* void sctp_drain(void); */
571 int sctp_destination_is_reachable(struct sctp_tcb *, struct sockaddr *);
574 * Null in last arg inpcb indicate run on ALL ep's. Specific inp in last arg
575 * indicates run on ONLY assoc's of the specified endpoint.
578 sctp_initiate_iterator(inp_func inpf,
589 #endif /* !__sctp_pcb_h__ */