2 * Copyright (c) 2001-2007, 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_uio.h>
55 #include <netinet/sctp_auth.h>
56 #include <netinet/sctp_bsd_addr.h>
59 * PCB flags (in sctp_flags bitmask)
61 #define SCTP_PCB_FLAGS_UDPTYPE 0x00000001
62 #define SCTP_PCB_FLAGS_TCPTYPE 0x00000002
63 #define SCTP_PCB_FLAGS_BOUNDALL 0x00000004
64 #define SCTP_PCB_FLAGS_ACCEPTING 0x00000008
65 #define SCTP_PCB_FLAGS_UNBOUND 0x00000010
66 #define SCTP_PCB_FLAGS_CLOSE_IP 0x00040000
67 #define SCTP_PCB_FLAGS_WAS_CONNECTED 0x00080000
68 #define SCTP_PCB_FLAGS_WAS_ABORTED 0x00100000
69 /* TCP model support */
71 #define SCTP_PCB_FLAGS_CONNECTED 0x00200000
72 #define SCTP_PCB_FLAGS_IN_TCPPOOL 0x00400000
73 #define SCTP_PCB_FLAGS_DONT_WAKE 0x00800000
74 #define SCTP_PCB_FLAGS_WAKEOUTPUT 0x01000000
75 #define SCTP_PCB_FLAGS_WAKEINPUT 0x02000000
76 #define SCTP_PCB_FLAGS_BOUND_V6 0x04000000
77 #define SCTP_PCB_FLAGS_NEEDS_MAPPED_V4 0x08000000
78 #define SCTP_PCB_FLAGS_BLOCKING_IO 0x10000000
79 #define SCTP_PCB_FLAGS_SOCKET_GONE 0x20000000
80 #define SCTP_PCB_FLAGS_SOCKET_ALLGONE 0x40000000
81 /* flags to copy to new PCB */
82 #define SCTP_PCB_COPY_FLAGS 0x0e000004
86 * PCB Features (in sctp_features bitmask)
88 #define SCTP_PCB_FLAGS_EXT_RCVINFO 0x00000004
89 #define SCTP_PCB_FLAGS_DONOT_HEARTBEAT 0x00000008
90 #define SCTP_PCB_FLAGS_FRAG_INTERLEAVE 0x00000010
91 #define SCTP_PCB_FLAGS_DO_ASCONF 0x00000020
92 #define SCTP_PCB_FLAGS_AUTO_ASCONF 0x00000040
94 #define SCTP_PCB_FLAGS_NODELAY 0x00000100
95 #define SCTP_PCB_FLAGS_AUTOCLOSE 0x00000200
96 #define SCTP_PCB_FLAGS_RECVDATAIOEVNT 0x00000400
97 #define SCTP_PCB_FLAGS_RECVASSOCEVNT 0x00000800
98 #define SCTP_PCB_FLAGS_RECVPADDREVNT 0x00001000
99 #define SCTP_PCB_FLAGS_RECVPEERERR 0x00002000
100 #define SCTP_PCB_FLAGS_RECVSENDFAILEVNT 0x00004000
101 #define SCTP_PCB_FLAGS_RECVSHUTDOWNEVNT 0x00008000
102 #define SCTP_PCB_FLAGS_ADAPTATIONEVNT 0x00010000
103 #define SCTP_PCB_FLAGS_PDAPIEVNT 0x00020000
104 #define SCTP_PCB_FLAGS_AUTHEVNT 0x00040000
105 #define SCTP_PCB_FLAGS_STREAM_RESETEVNT 0x00080000
106 #define SCTP_PCB_FLAGS_NO_FRAGMENT 0x00100000
107 #define SCTP_PCB_FLAGS_EXPLICIT_EOR 0x00200000
110 #define SCTP_PCBHASH_ALLADDR(port, mask) (port & mask)
111 #define SCTP_PCBHASH_ASOC(tag, mask) (tag & mask)
114 LIST_ENTRY(sctp_vrf) next_vrf;
115 struct sctp_ifnlist ifnlist;
117 uint32_t total_ifa_count;
121 struct sctp_ifalist ifalist;
122 struct sctp_vrf *vrf;
123 LIST_ENTRY(sctp_ifn) next_ifn;
124 void *ifn_p; /* never access without appropriate lock */
126 uint32_t ifn_index; /* shorthand way to look at ifn for reference */
127 uint32_t refcount; /* number of reference held should be >=
129 uint32_t ifa_count; /* IFA's we hold (in our list - ifalist) */
130 char ifn_name[SCTP_IFNAMSIZ];
133 /* SCTP local IFA flags */
134 #define SCTP_ADDR_VALID 0x00000001 /* its up and active */
135 #define SCTP_BEING_DELETED 0x00000002 /* being deleted, when
136 * refcount = 0. Note that it
137 * is pulled from the ifn list
138 * and ifa_p is nulled right
139 * away but it cannot be freed
140 * until the last *net
141 * pointing to it is deleted. */
142 #define SCTP_ADDR_DEFER_USE 0x00000004 /* Hold off using this one */
143 #define SCTP_ADDR_IFA_UNUSEABLE 0x00000008
146 LIST_ENTRY(sctp_ifa) next_ifa;
147 struct sctp_ifn *ifn_p; /* back pointer to parent ifn */
148 void *ifa; /* pointer to ifa, needed for flag update for
149 * that we MUST lock appropriate locks. This
151 union sctp_sockstore address;
152 uint32_t refcount; /* number of folks refering to this */
154 uint32_t localifa_flags;
162 LIST_ENTRY(sctp_laddr) sctp_nxt_addr; /* next in list */
163 struct sctp_ifa *ifa;
164 uint32_t action; /* Used during asconf and adding if no-zero
165 * src-addr selection will not consider this
169 struct sctp_block_entry {
173 struct sctp_timewait {
174 uint32_t tv_sec_at_expire; /* the seconds from boot to expire */
175 uint32_t v_tag; /* the vtag that can not be reused */
178 struct sctp_tagblock {
179 LIST_ENTRY(sctp_tagblock) sctp_nxt_tagblock;
180 struct sctp_timewait vtag_block[SCTP_NUMBER_IN_VTAG_BLOCK];
184 struct sctpasochead *sctp_asochash;
187 struct sctppcbhead *sctp_ephash;
190 struct sctpasochead *sctp_restarthash;
191 u_long hashrestartmark;
193 * The TCP model represents a substantial overhead in that we get an
194 * additional hash table to keep explicit connections in. The
195 * listening TCP endpoint will exist in the usual ephash above and
196 * accept only INIT's. It will be incapable of sending off an INIT.
197 * When a dg arrives we must look in the normal ephash. If we find a
198 * TCP endpoint that will tell us to go to the specific endpoint
199 * hash and re-hash to find the right assoc/socket. If we find a UDP
200 * model socket we then must complete the lookup. If this fails,
201 * i.e. no association can be found then we must continue to see if
202 * a sctp_peeloff()'d socket is in the tcpephash (a spun off socket
203 * acts like a TCP model connected socket).
205 struct sctppcbhead *sctp_tcpephash;
207 uint32_t hashtblsize;
209 struct sctp_vrflist *sctp_vrfhash;
212 struct sctppcbhead listhead;
213 struct sctpladdr addr_wq;
215 struct sctpiterators iteratorhead;
218 sctp_zone_t ipi_zone_ep;
219 sctp_zone_t ipi_zone_asoc;
220 sctp_zone_t ipi_zone_laddr;
221 sctp_zone_t ipi_zone_net;
222 sctp_zone_t ipi_zone_chunk;
223 sctp_zone_t ipi_zone_readq;
224 sctp_zone_t ipi_zone_strmoq;
226 struct mtx ipi_ep_mtx;
228 struct mtx ipi_iterator_wq_mtx;
229 struct mtx ipi_addr_mtx;
230 uint32_t ipi_count_ep;
232 /* assoc/tcb zone info */
233 uint32_t ipi_count_asoc;
235 /* local addrlist zone info */
236 uint32_t ipi_count_laddr;
238 /* remote addrlist zone info */
239 uint32_t ipi_count_raddr;
241 /* chunk structure list for output */
242 uint32_t ipi_count_chunk;
244 /* socket queue zone info */
245 uint32_t ipi_count_readq;
247 /* socket queue zone info */
248 uint32_t ipi_count_strmoq;
250 /* system wide number of free chunks hanging around */
251 uint32_t ipi_free_chunks;
252 uint32_t ipi_free_strmoq;
254 struct sctpvtaghead vtag_timewait[SCTP_STACK_VTAG_HASH_SIZE];
256 /* address work queue handling */
257 #if defined(SCTP_USE_THREAD_BASED_ITERATOR)
258 uint32_t iterator_running;
259 SCTP_PROCESS_STRUCT thread_proc;
261 struct sctp_timer addr_wq_timer;
266 * Here we have all the relevant information for each SCTP entity created. We
267 * will need to modify this as approprate. We also need to figure out how to
268 * access /dev/random.
271 unsigned int time_of_secret_change; /* number of seconds from
273 uint32_t secret_key[SCTP_HOW_MANY_SECRETS][SCTP_NUMBER_OF_SECRETS];
274 unsigned int size_of_a_cookie;
276 unsigned int sctp_timeoutticks[SCTP_NUM_TMRS];
277 unsigned int sctp_minrto;
278 unsigned int sctp_maxrto;
279 unsigned int initial_rto;
280 int initial_init_rto_max;
282 unsigned int sctp_sack_freq;
283 uint32_t sctp_sws_sender;
284 uint32_t sctp_sws_receiver;
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;
292 /* various thresholds */
293 /* Max times I will init at a guy */
294 uint16_t max_init_times;
296 /* Max times I will send before we consider someone dead */
297 uint16_t max_send_times;
299 uint16_t def_net_failure;
301 /* number of streams to pre-open on a association */
302 uint16_t pre_open_stream_count;
303 uint16_t max_open_streams_intome;
305 /* random number generator */
306 uint32_t random_counter;
307 uint8_t random_numbers[SCTP_SIGNATURE_ALOC_SIZE];
308 uint8_t random_store[SCTP_SIGNATURE_ALOC_SIZE];
311 * This timer is kept running per endpoint. When it fires it will
312 * change the secret key. The default is once a hour
314 struct sctp_timer signature_change;
318 uint32_t initial_sequence_debug;
319 uint32_t adaptation_layer_indicator;
322 char current_secret_number;
323 char last_secret_number;
326 #ifndef SCTP_ALIGNMENT
327 #define SCTP_ALIGNMENT 32
331 #define SCTP_ALIGNM1 (SCTP_ALIGNMENT-1)
334 #define sctp_lport ip_inp.inp.inp_lport
338 * put an inpcb in front of it all, kind of a waste but we need to
339 * for compatability with all the other stuff.
343 char align[(sizeof(struct in6pcb) + SCTP_ALIGNM1) &
348 /* Socket buffer lock protects read_queue and of course sb_cc */
349 struct sctp_readhead read_queue;
351 LIST_ENTRY(sctp_inpcb) sctp_list; /* lists all endpoints */
352 /* hash of all endpoints for model */
353 LIST_ENTRY(sctp_inpcb) sctp_hash;
354 /* count of local addresses bound, 0 if bound all */
357 /* list of addrs in use by the EP, NULL if bound-all */
358 struct sctpladdr sctp_addr_list;
360 * used for source address selection rotation when we are subset
363 struct sctp_laddr *next_addr_touse;
365 /* back pointer to our socket */
366 struct socket *sctp_socket;
367 uint32_t sctp_flags; /* INP state flag set */
368 uint32_t sctp_features; /* Feature flags */
369 struct sctp_pcb sctp_ep;/* SCTP ep data */
370 /* head of the hash of all associations */
371 struct sctpasochead *sctp_tcbhash;
372 u_long sctp_hashmark;
373 /* head of the list of all associations */
374 struct sctpasochead sctp_asoc_list;
375 #ifdef SCTP_TRACK_FREED_ASOCS
376 struct sctpasochead sctp_asoc_free_list;
378 struct sctp_iterator *inp_starting_point_for_iterator;
379 uint32_t sctp_frag_point;
380 uint32_t partial_delivery_point;
381 uint32_t sctp_context;
382 struct sctp_sndrcvinfo def_send;
384 * These three are here for the sosend_dgram (pkt, pkt_last and
385 * control). routine. However, I don't think anyone in the current
386 * FreeBSD kernel calls this. So they are candidates with sctp_sendm
389 struct mbuf *pkt, *pkt_last;
390 struct mbuf *control;
392 struct mtx inp_create_mtx;
393 struct mtx inp_rdata_mtx;
396 uint32_t total_sends;
397 uint32_t total_recvs;
398 uint32_t last_abort_code;
399 uint32_t total_nospaces;
403 struct socket *sctp_socket; /* back pointer to socket */
404 struct sctp_inpcb *sctp_ep; /* back pointer to ep */
405 LIST_ENTRY(sctp_tcb) sctp_tcbhash; /* next link in hash
407 LIST_ENTRY(sctp_tcb) sctp_tcblist; /* list of all of the
409 LIST_ENTRY(sctp_tcb) sctp_tcbrestarhash; /* next link in restart
411 LIST_ENTRY(sctp_tcb) sctp_asocs; /* vtag hash list */
412 struct sctp_block_entry *block_entry; /* pointer locked by socket
414 struct sctp_association asoc;
416 * freed_by_sorcv_sincelast is protected by the sockbuf_lock NOT the
417 * tcb_lock. Its special in this way to help avoid extra mutex calls
418 * in the reading of data.
420 uint32_t freed_by_sorcv_sincelast;
421 uint32_t total_sends;
422 uint32_t total_recvs;
423 int freed_from_where;
424 uint16_t rport; /* remote port in network format */
427 struct mtx tcb_send_mtx;
432 #include <netinet/sctp_lock_bsd.h>
437 extern struct sctp_epinfo sctppcbinfo;
439 int SCTP6_ARE_ADDR_EQUAL(struct in6_addr *a, struct in6_addr *b);
441 void sctp_fill_pcbinfo(struct sctp_pcbinfo *);
444 sctp_find_ifn(struct sctp_vrf *vrf, void *ifn, uint32_t ifn_index);
446 struct sctp_vrf *sctp_allocate_vrf(int vrfid);
448 struct sctp_vrf *sctp_find_vrf(uint32_t vrfid);
451 sctp_add_addr_to_vrf(uint32_t vrfid,
452 void *ifn, uint32_t ifn_index, uint32_t ifn_type,
454 void *ifa, struct sockaddr *addr, uint32_t ifa_flags);
456 void sctp_free_ifa(struct sctp_ifa *sctp_ifap);
459 sctp_del_addr_from_vrf(uint32_t vrfid, struct sockaddr *addr,
465 struct sctp_nets *sctp_findnet(struct sctp_tcb *, struct sockaddr *);
467 struct sctp_inpcb *sctp_pcb_findep(struct sockaddr *, int, int, uint32_t);
469 int sctp_inpcb_bind(struct socket *, struct sockaddr *, struct thread *);
473 sctp_findassociation_addr(struct mbuf *, int, int,
474 struct sctphdr *, struct sctp_chunkhdr *, struct sctp_inpcb **,
475 struct sctp_nets **);
478 sctp_findassociation_addr_sa(struct sockaddr *,
479 struct sockaddr *, struct sctp_inpcb **, struct sctp_nets **, int, uint32_t);
482 sctp_move_pcb_and_assoc(struct sctp_inpcb *, struct sctp_inpcb *,
486 * For this call ep_addr, the to is the destination endpoint address of the
487 * peer (relative to outbound). The from field is only used if the TCP model
488 * is enabled and helps distingush amongst the subset bound (non-boundall).
489 * The TCP model MAY change the actual ep field, this is why it is passed.
492 sctp_findassociation_ep_addr(struct sctp_inpcb **,
493 struct sockaddr *, struct sctp_nets **, struct sockaddr *,
497 sctp_findassociation_ep_asocid(struct sctp_inpcb *,
501 sctp_findassociation_ep_asconf(struct mbuf *, int, int,
502 struct sctphdr *, struct sctp_inpcb **, struct sctp_nets **);
504 int sctp_inpcb_alloc(struct socket *);
506 int sctp_is_address_on_local_host(struct sockaddr *addr, uint32_t vrf_id);
508 void sctp_inpcb_free(struct sctp_inpcb *, int, int);
511 sctp_aloc_assoc(struct sctp_inpcb *, struct sockaddr *,
512 int, int *, uint32_t, uint32_t);
514 int sctp_free_assoc(struct sctp_inpcb *, struct sctp_tcb *, int, int);
517 sctp_add_vtag_to_timewait(struct sctp_inpcb *, uint32_t, uint32_t);
519 int sctp_add_local_addr_ep(struct sctp_inpcb *, struct sctp_ifa *, uint32_t);
521 int sctp_insert_laddr(struct sctpladdr *, struct sctp_ifa *, uint32_t);
523 void sctp_remove_laddr(struct sctp_laddr *);
525 int sctp_del_local_addr_ep(struct sctp_inpcb *, struct sctp_ifa *);
527 void sctp_set_initial_cc_param(struct sctp_tcb *, struct sctp_nets *net);
530 int sctp_add_remote_addr(struct sctp_tcb *, struct sockaddr *, int, int);
532 void sctp_remove_net(struct sctp_tcb *, struct sctp_nets *);
534 int sctp_del_remote_addr(struct sctp_tcb *, struct sockaddr *);
536 void sctp_pcb_init(void);
538 int sctp_add_local_addr_assoc(struct sctp_tcb *, struct sctp_ifa *, int);
540 int sctp_del_local_addr_assoc(struct sctp_tcb *, struct sctp_ifa *);
543 sctp_load_addresses_from_init(struct sctp_tcb *, struct mbuf *, int, int,
544 int, struct sctphdr *, struct sockaddr *);
547 sctp_set_primary_addr(struct sctp_tcb *, struct sockaddr *,
550 int sctp_is_vtag_good(struct sctp_inpcb *, uint32_t, struct timeval *);
552 /* void sctp_drain(void); */
554 int sctp_destination_is_reachable(struct sctp_tcb *, struct sockaddr *);
557 * Null in last arg inpcb indicate run on ALL ep's. Specific inp in last arg
558 * indicates run on ONLY assoc's of the specified endpoint.
561 sctp_initiate_iterator(inp_func inpf,
573 #endif /* !__sctp_pcb_h__ */