sctp_uio.h revision 172157
1/*-
2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * a) Redistributions of source code must retain the above copyright notice,
8 *   this list of conditions and the following disclaimer.
9 *
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.
13 *
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.
17 *
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.
29 */
30
31/* $KAME: sctp_uio.h,v 1.11 2005/03/06 16:04:18 itojun Exp $	 */
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD: head/sys/netinet/sctp_uio.h 172157 2007-09-13 14:43:54Z rrs $");
34
35#ifndef __sctp_uio_h__
36#define __sctp_uio_h__
37
38
39#if ! defined(_KERNEL)
40#include <stdint.h>
41#endif
42#include <sys/types.h>
43#include <sys/socket.h>
44#include <netinet/in.h>
45
46typedef uint32_t sctp_assoc_t;
47
48/* On/Off setup for subscription to events */
49struct sctp_event_subscribe {
50	uint8_t sctp_data_io_event;
51	uint8_t sctp_association_event;
52	uint8_t sctp_address_event;
53	uint8_t sctp_send_failure_event;
54	uint8_t sctp_peer_error_event;
55	uint8_t sctp_shutdown_event;
56	uint8_t sctp_partial_delivery_event;
57	uint8_t sctp_adaptation_layer_event;
58	uint8_t sctp_authentication_event;
59	uint8_t sctp_stream_reset_events;
60};
61
62/* ancillary data types */
63#define SCTP_INIT	0x0001
64#define SCTP_SNDRCV	0x0002
65#define SCTP_EXTRCV	0x0003
66/*
67 * ancillary data structures
68 */
69struct sctp_initmsg {
70	uint32_t sinit_num_ostreams;
71	uint32_t sinit_max_instreams;
72	uint16_t sinit_max_attempts;
73	uint16_t sinit_max_init_timeo;
74};
75
76/* We add 96 bytes to the size of sctp_sndrcvinfo.
77 * This makes the current structure 128 bytes long
78 * which is nicely 64 bit aligned but also has room
79 * for us to add more and keep ABI compatability.
80 * For example, already we have the sctp_extrcvinfo
81 * when enabled which is 48 bytes.
82 */
83
84/*
85 * The assoc up needs a verfid
86 * all sendrcvinfo's need a verfid for SENDING only.
87 */
88
89
90#define SCTP_ALIGN_RESV_PAD 96
91#define SCTP_ALIGN_RESV_PAD_SHORT 80
92
93struct sctp_sndrcvinfo {
94	uint16_t sinfo_stream;
95	uint16_t sinfo_ssn;
96	uint16_t sinfo_flags;
97	uint16_t sinfo_pr_policy;
98	uint32_t sinfo_ppid;
99	uint32_t sinfo_context;
100	uint32_t sinfo_timetolive;
101	uint32_t sinfo_tsn;
102	uint32_t sinfo_cumtsn;
103	sctp_assoc_t sinfo_assoc_id;
104	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
105};
106
107struct sctp_extrcvinfo {
108	uint16_t sinfo_stream;
109	uint16_t sinfo_ssn;
110	uint16_t sinfo_flags;
111	uint16_t sinfo_pr_policy;
112	uint32_t sinfo_ppid;
113	uint32_t sinfo_context;
114	uint32_t sinfo_timetolive;
115	uint32_t sinfo_tsn;
116	uint32_t sinfo_cumtsn;
117	sctp_assoc_t sinfo_assoc_id;
118	uint16_t sreinfo_next_flags;
119	uint16_t sreinfo_next_stream;
120	uint32_t sreinfo_next_aid;
121	uint32_t sreinfo_next_length;
122	uint32_t sreinfo_next_ppid;
123	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
124};
125
126#define SCTP_NO_NEXT_MSG           0x0000
127#define SCTP_NEXT_MSG_AVAIL        0x0001
128#define SCTP_NEXT_MSG_ISCOMPLETE   0x0002
129#define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
130#define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
131
132struct sctp_snd_all_completes {
133	uint16_t sall_stream;
134	uint16_t sall_flags;
135	uint32_t sall_ppid;
136	uint32_t sall_context;
137	uint32_t sall_num_sent;
138	uint32_t sall_num_failed;
139};
140
141/* Flags that go into the sinfo->sinfo_flags field */
142#define SCTP_EOF 	  0x0100/* Start shutdown procedures */
143#define SCTP_ABORT	  0x0200/* Send an ABORT to peer */
144#define SCTP_UNORDERED 	  0x0400/* Message is un-ordered */
145#define SCTP_ADDR_OVER	  0x0800/* Override the primary-address */
146#define SCTP_SENDALL      0x1000/* Send this on all associations */
147#define SCTP_EOR          0x2000/* end of message signal */
148#define SCTP_PR_POLICY_VALID 0x4000	/* pr sctp policy valid */
149
150#define INVALID_SINFO_FLAG(x) (((x) & 0xffffff00 \
151                                    & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
152				        SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR)) != 0)
153/* for the endpoint */
154
155/* The lower byte is an enumeration of PR-SCTP policies */
156#define SCTP_PR_SCTP_TTL  0x0001/* Time based PR-SCTP */
157#define SCTP_PR_SCTP_BUF  0x0002/* Buffer based PR-SCTP */
158#define SCTP_PR_SCTP_RTX  0x0003/* Number of retransmissions based PR-SCTP */
159
160#define PR_SCTP_POLICY(x)         ((x) & 0xff)
161#define PR_SCTP_ENABLED(x)        (PR_SCTP_POLICY(x) != 0)
162#define PR_SCTP_TTL_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
163#define PR_SCTP_BUF_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
164#define PR_SCTP_RTX_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
165#define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
166/* Stat's */
167struct sctp_pcbinfo {
168	uint32_t ep_count;
169	uint32_t asoc_count;
170	uint32_t laddr_count;
171	uint32_t raddr_count;
172	uint32_t chk_count;
173	uint32_t readq_count;
174	uint32_t free_chunks;
175	uint32_t stream_oque;
176};
177
178struct sctp_sockstat {
179	sctp_assoc_t ss_assoc_id;
180	uint32_t ss_total_sndbuf;
181	uint32_t ss_total_recv_buf;
182};
183
184/*
185 * notification event structures
186 */
187
188/*
189 * association change event
190 */
191struct sctp_assoc_change {
192	uint16_t sac_type;
193	uint16_t sac_flags;
194	uint32_t sac_length;
195	uint16_t sac_state;
196	uint16_t sac_error;
197	uint16_t sac_outbound_streams;
198	uint16_t sac_inbound_streams;
199	sctp_assoc_t sac_assoc_id;
200};
201
202/* sac_state values */
203#define SCTP_COMM_UP		0x0001
204#define SCTP_COMM_LOST		0x0002
205#define SCTP_RESTART		0x0003
206#define SCTP_SHUTDOWN_COMP	0x0004
207#define SCTP_CANT_STR_ASSOC	0x0005
208
209
210/*
211 * Address event
212 */
213struct sctp_paddr_change {
214	uint16_t spc_type;
215	uint16_t spc_flags;
216	uint32_t spc_length;
217	struct sockaddr_storage spc_aaddr;
218	uint32_t spc_state;
219	uint32_t spc_error;
220	sctp_assoc_t spc_assoc_id;
221	uint8_t spc_padding[4];
222};
223
224/* paddr state values */
225#define SCTP_ADDR_AVAILABLE	0x0001
226#define SCTP_ADDR_UNREACHABLE	0x0002
227#define SCTP_ADDR_REMOVED	0x0003
228#define SCTP_ADDR_ADDED		0x0004
229#define SCTP_ADDR_MADE_PRIM	0x0005
230#define SCTP_ADDR_CONFIRMED	0x0006
231
232/*
233 * CAUTION: these are user exposed SCTP addr reachability states must be
234 * compatible with SCTP_ADDR states in sctp_constants.h
235 */
236#ifdef SCTP_ACTIVE
237#undef SCTP_ACTIVE
238#endif
239#define SCTP_ACTIVE		0x0001	/* SCTP_ADDR_REACHABLE */
240
241#ifdef SCTP_INACTIVE
242#undef SCTP_INACTIVE
243#endif
244#define SCTP_INACTIVE		0x0002	/* SCTP_ADDR_NOT_REACHABLE */
245
246#ifdef SCTP_UNCONFIRMED
247#undef SCTP_UNCONFIRMED
248#endif
249#define SCTP_UNCONFIRMED	0x0200	/* SCTP_ADDR_UNCONFIRMED */
250
251#ifdef SCTP_NOHEARTBEAT
252#undef SCTP_NOHEARTBEAT
253#endif
254#define SCTP_NOHEARTBEAT	0x0040	/* SCTP_ADDR_NOHB */
255
256
257/* remote error events */
258struct sctp_remote_error {
259	uint16_t sre_type;
260	uint16_t sre_flags;
261	uint32_t sre_length;
262	uint16_t sre_error;
263	sctp_assoc_t sre_assoc_id;
264	uint8_t sre_data[4];
265};
266
267/* data send failure event */
268struct sctp_send_failed {
269	uint16_t ssf_type;
270	uint16_t ssf_flags;
271	uint32_t ssf_length;
272	uint32_t ssf_error;
273	struct sctp_sndrcvinfo ssf_info;
274	sctp_assoc_t ssf_assoc_id;
275	uint8_t ssf_data[0];
276};
277
278/* flag that indicates state of data */
279#define SCTP_DATA_UNSENT	0x0001	/* inqueue never on wire */
280#define SCTP_DATA_SENT		0x0002	/* on wire at failure */
281
282/* shutdown event */
283struct sctp_shutdown_event {
284	uint16_t sse_type;
285	uint16_t sse_flags;
286	uint32_t sse_length;
287	sctp_assoc_t sse_assoc_id;
288};
289
290/* Adaptation layer indication stuff */
291struct sctp_adaptation_event {
292	uint16_t sai_type;
293	uint16_t sai_flags;
294	uint32_t sai_length;
295	uint32_t sai_adaptation_ind;
296	sctp_assoc_t sai_assoc_id;
297};
298
299struct sctp_setadaptation {
300	uint32_t ssb_adaptation_ind;
301};
302
303/* compatable old spelling */
304struct sctp_adaption_event {
305	uint16_t sai_type;
306	uint16_t sai_flags;
307	uint32_t sai_length;
308	uint32_t sai_adaption_ind;
309	sctp_assoc_t sai_assoc_id;
310};
311
312struct sctp_setadaption {
313	uint32_t ssb_adaption_ind;
314};
315
316
317/*
318 * Partial Delivery API event
319 */
320struct sctp_pdapi_event {
321	uint16_t pdapi_type;
322	uint16_t pdapi_flags;
323	uint32_t pdapi_length;
324	uint32_t pdapi_indication;
325	uint16_t pdapi_stream;
326	uint16_t pdapi_seq;
327	sctp_assoc_t pdapi_assoc_id;
328};
329
330/* indication values */
331#define SCTP_PARTIAL_DELIVERY_ABORTED	0x0001
332
333
334/*
335 * authentication key event
336 */
337struct sctp_authkey_event {
338	uint16_t auth_type;
339	uint16_t auth_flags;
340	uint32_t auth_length;
341	uint16_t auth_keynumber;
342	uint16_t auth_altkeynumber;
343	uint32_t auth_indication;
344	sctp_assoc_t auth_assoc_id;
345};
346
347/* indication values */
348#define SCTP_AUTH_NEWKEY	0x0001
349
350
351/*
352 * stream reset event
353 */
354struct sctp_stream_reset_event {
355	uint16_t strreset_type;
356	uint16_t strreset_flags;
357	uint32_t strreset_length;
358	sctp_assoc_t strreset_assoc_id;
359	uint16_t strreset_list[0];
360};
361
362/* flags in strreset_flags field */
363#define SCTP_STRRESET_INBOUND_STR  0x0001
364#define SCTP_STRRESET_OUTBOUND_STR 0x0002
365#define SCTP_STRRESET_ALL_STREAMS  0x0004
366#define SCTP_STRRESET_STREAM_LIST  0x0008
367#define SCTP_STRRESET_FAILED       0x0010
368
369
370/* SCTP notification event */
371struct sctp_tlv {
372	uint16_t sn_type;
373	uint16_t sn_flags;
374	uint32_t sn_length;
375};
376
377union sctp_notification {
378	struct sctp_tlv sn_header;
379	struct sctp_assoc_change sn_assoc_change;
380	struct sctp_paddr_change sn_paddr_change;
381	struct sctp_remote_error sn_remote_error;
382	struct sctp_send_failed sn_send_failed;
383	struct sctp_shutdown_event sn_shutdown_event;
384	struct sctp_adaptation_event sn_adaptation_event;
385	/* compatability same as above */
386	struct sctp_adaption_event sn_adaption_event;
387	struct sctp_pdapi_event sn_pdapi_event;
388	struct sctp_authkey_event sn_auth_event;
389	struct sctp_stream_reset_event sn_strreset_event;
390};
391
392/* notification types */
393#define SCTP_ASSOC_CHANGE		0x0001
394#define SCTP_PEER_ADDR_CHANGE		0x0002
395#define SCTP_REMOTE_ERROR		0x0003
396#define SCTP_SEND_FAILED		0x0004
397#define SCTP_SHUTDOWN_EVENT		0x0005
398#define SCTP_ADAPTATION_INDICATION	0x0006
399/* same as above */
400#define SCTP_ADAPTION_INDICATION	0x0006
401#define SCTP_PARTIAL_DELIVERY_EVENT	0x0007
402#define SCTP_AUTHENTICATION_EVENT	0x0008
403#define SCTP_STREAM_RESET_EVENT		0x0009
404
405
406/*
407 * socket option structs
408 */
409
410struct sctp_paddrparams {
411	struct sockaddr_storage spp_address;
412	sctp_assoc_t spp_assoc_id;
413	uint32_t spp_hbinterval;
414	uint32_t spp_pathmtu;
415	uint32_t spp_flags;
416	uint32_t spp_ipv6_flowlabel;
417	uint16_t spp_pathmaxrxt;
418	uint8_t spp_ipv4_tos;
419};
420
421#define SPP_HB_ENABLE		0x00000001
422#define SPP_HB_DISABLE		0x00000002
423#define SPP_HB_DEMAND		0x00000004
424#define SPP_PMTUD_ENABLE	0x00000008
425#define SPP_PMTUD_DISABLE	0x00000010
426#define SPP_HB_TIME_IS_ZERO     0x00000080
427#define SPP_IPV6_FLOWLABEL      0x00000100
428#define SPP_IPV4_TOS            0x00000200
429
430struct sctp_paddrinfo {
431	struct sockaddr_storage spinfo_address;
432	sctp_assoc_t spinfo_assoc_id;
433	int32_t spinfo_state;
434	uint32_t spinfo_cwnd;
435	uint32_t spinfo_srtt;
436	uint32_t spinfo_rto;
437	uint32_t spinfo_mtu;
438};
439
440struct sctp_rtoinfo {
441	sctp_assoc_t srto_assoc_id;
442	uint32_t srto_initial;
443	uint32_t srto_max;
444	uint32_t srto_min;
445};
446
447struct sctp_assocparams {
448	sctp_assoc_t sasoc_assoc_id;
449	uint32_t sasoc_peer_rwnd;
450	uint32_t sasoc_local_rwnd;
451	uint32_t sasoc_cookie_life;
452	uint16_t sasoc_asocmaxrxt;
453	uint16_t sasoc_number_peer_destinations;
454};
455
456struct sctp_setprim {
457	struct sockaddr_storage ssp_addr;
458	sctp_assoc_t ssp_assoc_id;
459	uint8_t ssp_padding[4];
460};
461
462struct sctp_setpeerprim {
463	struct sockaddr_storage sspp_addr;
464	sctp_assoc_t sspp_assoc_id;
465	uint8_t sspp_padding[4];
466};
467
468struct sctp_getaddresses {
469	sctp_assoc_t sget_assoc_id;
470	/* addr is filled in for N * sockaddr_storage */
471	struct sockaddr addr[1];
472};
473
474struct sctp_setstrm_timeout {
475	sctp_assoc_t ssto_assoc_id;
476	uint32_t ssto_timeout;
477	uint32_t ssto_streamid_start;
478	uint32_t ssto_streamid_end;
479};
480
481struct sctp_status {
482	sctp_assoc_t sstat_assoc_id;
483	int32_t sstat_state;
484	uint32_t sstat_rwnd;
485	uint16_t sstat_unackdata;
486	uint16_t sstat_penddata;
487	uint16_t sstat_instrms;
488	uint16_t sstat_outstrms;
489	uint32_t sstat_fragmentation_point;
490	struct sctp_paddrinfo sstat_primary;
491};
492
493/*
494 * AUTHENTICATION support
495 */
496/* SCTP_AUTH_CHUNK */
497struct sctp_authchunk {
498	uint8_t sauth_chunk;
499};
500
501/* SCTP_AUTH_KEY */
502struct sctp_authkey {
503	sctp_assoc_t sca_assoc_id;
504	uint16_t sca_keynumber;
505	uint8_t sca_key[0];
506};
507
508/* SCTP_HMAC_IDENT */
509struct sctp_hmacalgo {
510	uint16_t shmac_idents[0];
511};
512
513/* AUTH hmac_id */
514#define SCTP_AUTH_HMAC_ID_RSVD		0x0000
515#define SCTP_AUTH_HMAC_ID_SHA1		0x0001	/* default, mandatory */
516#define SCTP_AUTH_HMAC_ID_MD5		0x0002	/* deprecated */
517#define SCTP_AUTH_HMAC_ID_SHA256	0x0003
518#define SCTP_AUTH_HMAC_ID_SHA224	0x0004
519#define SCTP_AUTH_HMAC_ID_SHA384	0x0005
520#define SCTP_AUTH_HMAC_ID_SHA512	0x0006
521
522
523/* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
524struct sctp_authkeyid {
525	sctp_assoc_t scact_assoc_id;
526	uint16_t scact_keynumber;
527};
528
529/* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
530struct sctp_authchunks {
531	sctp_assoc_t gauth_assoc_id;
532	uint8_t gauth_chunks[0];
533};
534
535struct sctp_assoc_value {
536	sctp_assoc_t assoc_id;
537	uint32_t assoc_value;
538};
539
540struct sctp_assoc_ids {
541	sctp_assoc_t gaids_assoc_id[0];
542};
543
544struct sctp_sack_info {
545	sctp_assoc_t sack_assoc_id;
546	uint32_t sack_delay;
547	uint32_t sack_freq;
548};
549
550struct sctp_cwnd_args {
551	struct sctp_nets *net;	/* network to *//* FIXME: LP64 issue */
552	uint32_t cwnd_new_value;/* cwnd in k */
553	uint32_t inflight;	/* flightsize in k */
554	uint32_t pseudo_cumack;
555	uint32_t cwnd_augment;	/* increment to it */
556	uint8_t meets_pseudo_cumack;
557	uint8_t need_new_pseudo_cumack;
558	uint8_t cnt_in_send;
559	uint8_t cnt_in_str;
560};
561
562struct sctp_blk_args {
563	uint32_t onsb;		/* in 1k bytes */
564	uint32_t sndlen;	/* len of send being attempted */
565	uint32_t peer_rwnd;	/* rwnd of peer */
566	uint16_t send_sent_qcnt;/* chnk cnt */
567	uint16_t stream_qcnt;	/* chnk cnt */
568	uint16_t chunks_on_oque;/* chunks out */
569	uint16_t flight_size;	/* flight size in k */
570};
571
572/*
573 * Max we can reset in one setting, note this is dictated not by the define
574 * but the size of a mbuf cluster so don't change this define and think you
575 * can specify more. You must do multiple resets if you want to reset more
576 * than SCTP_MAX_EXPLICIT_STR_RESET.
577 */
578#define SCTP_MAX_EXPLICT_STR_RESET   1000
579
580#define SCTP_RESET_LOCAL_RECV  0x0001
581#define SCTP_RESET_LOCAL_SEND  0x0002
582#define SCTP_RESET_BOTH        0x0003
583#define SCTP_RESET_TSN         0x0004
584
585struct sctp_stream_reset {
586	sctp_assoc_t strrst_assoc_id;
587	uint16_t strrst_flags;
588	uint16_t strrst_num_streams;	/* 0 == ALL */
589	uint16_t strrst_list[0];/* list if strrst_num_streams is not 0 */
590};
591
592
593struct sctp_get_nonce_values {
594	sctp_assoc_t gn_assoc_id;
595	uint32_t gn_peers_tag;
596	uint32_t gn_local_tag;
597};
598
599/* Debugging logs */
600struct sctp_str_log {
601	void *stcb;		/* FIXME: LP64 issue */
602	uint32_t n_tsn;
603	uint32_t e_tsn;
604	uint16_t n_sseq;
605	uint16_t e_sseq;
606	uint16_t strm;
607};
608
609struct sctp_sb_log {
610	void *stcb;		/* FIXME: LP64 issue */
611	uint32_t so_sbcc;
612	uint32_t stcb_sbcc;
613	uint32_t incr;
614};
615
616struct sctp_fr_log {
617	uint32_t largest_tsn;
618	uint32_t largest_new_tsn;
619	uint32_t tsn;
620};
621
622struct sctp_fr_map {
623	uint32_t base;
624	uint32_t cum;
625	uint32_t high;
626};
627
628struct sctp_rwnd_log {
629	uint32_t rwnd;
630	uint32_t send_size;
631	uint32_t overhead;
632	uint32_t new_rwnd;
633};
634
635struct sctp_mbcnt_log {
636	uint32_t total_queue_size;
637	uint32_t size_change;
638	uint32_t total_queue_mb_size;
639	uint32_t mbcnt_change;
640};
641
642struct sctp_sack_log {
643	uint32_t cumack;
644	uint32_t oldcumack;
645	uint32_t tsn;
646	uint16_t numGaps;
647	uint16_t numDups;
648};
649
650struct sctp_lock_log {
651	void *sock;		/* FIXME: LP64 issue */
652	void *inp;		/* FIXME: LP64 issue */
653	uint8_t tcb_lock;
654	uint8_t inp_lock;
655	uint8_t info_lock;
656	uint8_t sock_lock;
657	uint8_t sockrcvbuf_lock;
658	uint8_t socksndbuf_lock;
659	uint8_t create_lock;
660	uint8_t resv;
661};
662
663struct sctp_rto_log {
664	void *net;		/* FIXME: LP64 issue */
665	uint32_t rtt;
666};
667
668struct sctp_nagle_log {
669	void *stcb;		/* FIXME: LP64 issue */
670	uint32_t total_flight;
671	uint32_t total_in_queue;
672	uint16_t count_in_queue;
673	uint16_t count_in_flight;
674};
675
676struct sctp_sbwake_log {
677	void *stcb;		/* FIXME: LP64 issue */
678	uint16_t send_q;
679	uint16_t sent_q;
680	uint16_t flight;
681	uint16_t wake_cnt;
682	uint8_t stream_qcnt;	/* chnk cnt */
683	uint8_t chunks_on_oque;	/* chunks out */
684	uint8_t sbflags;
685	uint8_t sctpflags;
686};
687
688struct sctp_misc_info {
689	uint32_t log1;
690	uint32_t log2;
691	uint32_t log3;
692	uint32_t log4;
693};
694
695struct sctp_log_closing {
696	void *inp;		/* FIXME: LP64 issue */
697	void *stcb;		/* FIXME: LP64 issue */
698	uint32_t sctp_flags;
699	uint16_t state;
700	int16_t loc;
701};
702
703struct sctp_mbuf_log {
704	struct mbuf *mp;	/* FIXME: LP64 issue */
705	caddr_t ext;
706	caddr_t data;
707	uint16_t size;
708	uint8_t refcnt;
709	uint8_t mbuf_flags;
710};
711
712struct sctp_cwnd_log {
713	uint64_t time_event;
714	uint8_t from;
715	uint8_t event_type;
716	uint8_t resv[2];
717	union {
718		struct sctp_log_closing close;
719		struct sctp_blk_args blk;
720		struct sctp_cwnd_args cwnd;
721		struct sctp_str_log strlog;
722		struct sctp_fr_log fr;
723		struct sctp_fr_map map;
724		struct sctp_rwnd_log rwnd;
725		struct sctp_mbcnt_log mbcnt;
726		struct sctp_sack_log sack;
727		struct sctp_lock_log lock;
728		struct sctp_rto_log rto;
729		struct sctp_sb_log sb;
730		struct sctp_nagle_log nagle;
731		struct sctp_sbwake_log wake;
732		struct sctp_mbuf_log mb;
733		struct sctp_misc_info misc;
734	}     x;
735};
736
737struct sctp_cwnd_log_req {
738	int32_t num_in_log;	/* Number in log */
739	int32_t num_ret;	/* Number returned */
740	int32_t start_at;	/* start at this one */
741	int32_t end_at;		/* end at this one */
742	struct sctp_cwnd_log log[0];
743};
744
745struct sctp_timeval {
746	uint32_t tv_sec;
747	uint32_t tv_usec;
748};
749
750struct sctpstat {
751	/* MIB according to RFC 3873 */
752	uint32_t sctps_currestab;	/* sctpStats  1   (Gauge32) */
753	uint32_t sctps_activeestab;	/* sctpStats  2 (Counter32) */
754	uint32_t sctps_restartestab;
755	uint32_t sctps_collisionestab;
756	uint32_t sctps_passiveestab;	/* sctpStats  3 (Counter32) */
757	uint32_t sctps_aborted;	/* sctpStats  4 (Counter32) */
758	uint32_t sctps_shutdown;/* sctpStats  5 (Counter32) */
759	uint32_t sctps_outoftheblue;	/* sctpStats  6 (Counter32) */
760	uint32_t sctps_checksumerrors;	/* sctpStats  7 (Counter32) */
761	uint32_t sctps_outcontrolchunks;	/* sctpStats  8 (Counter64) */
762	uint32_t sctps_outorderchunks;	/* sctpStats  9 (Counter64) */
763	uint32_t sctps_outunorderchunks;	/* sctpStats 10 (Counter64) */
764	uint32_t sctps_incontrolchunks;	/* sctpStats 11 (Counter64) */
765	uint32_t sctps_inorderchunks;	/* sctpStats 12 (Counter64) */
766	uint32_t sctps_inunorderchunks;	/* sctpStats 13 (Counter64) */
767	uint32_t sctps_fragusrmsgs;	/* sctpStats 14 (Counter64) */
768	uint32_t sctps_reasmusrmsgs;	/* sctpStats 15 (Counter64) */
769	uint32_t sctps_outpackets;	/* sctpStats 16 (Counter64) */
770	uint32_t sctps_inpackets;	/* sctpStats 17 (Counter64) */
771
772	/* input statistics: */
773	uint32_t sctps_recvpackets;	/* total input packets        */
774	uint32_t sctps_recvdatagrams;	/* total input datagrams      */
775	uint32_t sctps_recvpktwithdata;	/* total packets that had data */
776	uint32_t sctps_recvsacks;	/* total input SACK chunks    */
777	uint32_t sctps_recvdata;/* total input DATA chunks    */
778	uint32_t sctps_recvdupdata;	/* total input duplicate DATA chunks */
779	uint32_t sctps_recvheartbeat;	/* total input HB chunks      */
780	uint32_t sctps_recvheartbeatack;	/* total input HB-ACK chunks  */
781	uint32_t sctps_recvecne;/* total input ECNE chunks    */
782	uint32_t sctps_recvauth;/* total input AUTH chunks    */
783	uint32_t sctps_recvauthmissing;	/* total input chunks missing AUTH */
784	uint32_t sctps_recvivalhmacid;	/* total number of invalid HMAC ids
785					 * received */
786	uint32_t sctps_recvivalkeyid;	/* total number of invalid secret ids
787					 * received */
788	uint32_t sctps_recvauthfailed;	/* total number of auth failed */
789	uint32_t sctps_recvexpress;	/* total fast path receives all one
790					 * chunk */
791	uint32_t sctps_recvexpressm;	/* total fast path multi-part data */
792	/* output statistics: */
793	uint32_t sctps_sendpackets;	/* total output packets       */
794	uint32_t sctps_sendsacks;	/* total output SACKs         */
795	uint32_t sctps_senddata;/* total output DATA chunks   */
796	uint32_t sctps_sendretransdata;	/* total output retransmitted DATA
797					 * chunks */
798	uint32_t sctps_sendfastretrans;	/* total output fast retransmitted
799					 * DATA chunks */
800	uint32_t sctps_sendmultfastretrans;	/* total FR's that happened
801						 * more than once to same
802						 * chunk (u-del multi-fr
803						 * algo). */
804	uint32_t sctps_sendheartbeat;	/* total output HB chunks     */
805	uint32_t sctps_sendecne;/* total output ECNE chunks    */
806	uint32_t sctps_sendauth;/* total output AUTH chunks FIXME   */
807	uint32_t sctps_senderrors;	/* ip_output error counter */
808	/* PCKDROPREP statistics: */
809	uint32_t sctps_pdrpfmbox;	/* Packet drop from middle box */
810	uint32_t sctps_pdrpfehos;	/* P-drop from end host */
811	uint32_t sctps_pdrpmbda;/* P-drops with data */
812	uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
813	uint32_t sctps_pdrpbwrpt;	/* P-drop, non-endhost, bandwidth rep
814					 * only */
815	uint32_t sctps_pdrpcrupt;	/* P-drop, not enough for chunk header */
816	uint32_t sctps_pdrpnedat;	/* P-drop, not enough data to confirm */
817	uint32_t sctps_pdrppdbrk;	/* P-drop, where process_chunk_drop
818					 * said break */
819	uint32_t sctps_pdrptsnnf;	/* P-drop, could not find TSN */
820	uint32_t sctps_pdrpdnfnd;	/* P-drop, attempt reverse TSN lookup */
821	uint32_t sctps_pdrpdiwnp;	/* P-drop, e-host confirms zero-rwnd */
822	uint32_t sctps_pdrpdizrw;	/* P-drop, midbox confirms no space */
823	uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
824	uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
825	/* timeouts */
826	uint32_t sctps_timoiterator;	/* Number of iterator timers that
827					 * fired */
828	uint32_t sctps_timodata;/* Number of T3 data time outs */
829	uint32_t sctps_timowindowprobe;	/* Number of window probe (T3) timers
830					 * that fired */
831	uint32_t sctps_timoinit;/* Number of INIT timers that fired */
832	uint32_t sctps_timosack;/* Number of sack timers that fired */
833	uint32_t sctps_timoshutdown;	/* Number of shutdown timers that
834					 * fired */
835	uint32_t sctps_timoheartbeat;	/* Number of heartbeat timers that
836					 * fired */
837	uint32_t sctps_timocookie;	/* Number of times a cookie timeout
838					 * fired */
839	uint32_t sctps_timosecret;	/* Number of times an endpoint changed
840					 * its cookie secret */
841	uint32_t sctps_timopathmtu;	/* Number of PMTU timers that fired */
842	uint32_t sctps_timoshutdownack;	/* Number of shutdown ack timers that
843					 * fired */
844	uint32_t sctps_timoshutdownguard;	/* Number of shutdown guard
845						 * timers that fired */
846	uint32_t sctps_timostrmrst;	/* Number of stream reset timers that
847					 * fired */
848	uint32_t sctps_timoearlyfr;	/* Number of early FR timers that
849					 * fired */
850	uint32_t sctps_timoasconf;	/* Number of times an asconf timer
851					 * fired */
852	uint32_t sctps_timodelprim;	/* Number of times a prim_deleted
853					 * timer fired */
854	uint32_t sctps_timoautoclose;	/* Number of times auto close timer
855					 * fired */
856	uint32_t sctps_timoassockill;	/* Number of asoc free timers expired */
857	uint32_t sctps_timoinpkill;	/* Number of inp free timers expired */
858	/* Early fast retransmission counters */
859	uint32_t sctps_earlyfrstart;
860	uint32_t sctps_earlyfrstop;
861	uint32_t sctps_earlyfrmrkretrans;
862	uint32_t sctps_earlyfrstpout;
863	uint32_t sctps_earlyfrstpidsck1;
864	uint32_t sctps_earlyfrstpidsck2;
865	uint32_t sctps_earlyfrstpidsck3;
866	uint32_t sctps_earlyfrstpidsck4;
867	uint32_t sctps_earlyfrstrid;
868	uint32_t sctps_earlyfrstrout;
869	uint32_t sctps_earlyfrstrtmr;
870	/* otheres */
871	uint32_t sctps_hdrops;	/* packet shorter than header */
872	uint32_t sctps_badsum;	/* checksum error             */
873	uint32_t sctps_noport;	/* no endpoint for port       */
874	uint32_t sctps_badvtag;	/* bad v-tag                  */
875	uint32_t sctps_badsid;	/* bad SID                    */
876	uint32_t sctps_nomem;	/* no memory                  */
877	uint32_t sctps_fastretransinrtt;	/* number of multiple FR in a
878						 * RTT window */
879	uint32_t sctps_markedretrans;
880	uint32_t sctps_naglesent;	/* nagle allowed sending      */
881	uint32_t sctps_naglequeued;	/* nagle does't allow sending */
882	uint32_t sctps_maxburstqueued;	/* max burst dosn't allow sending */
883	uint32_t sctps_ifnomemqueued;	/* look ahead tells us no memory in
884					 * interface ring buffer OR we had a
885					 * send error and are queuing one
886					 * send. */
887	uint32_t sctps_windowprobed;	/* total number of window probes sent */
888	uint32_t sctps_lowlevelerr;	/* total times an output error causes
889					 * us to clamp down on next user send. */
890	uint32_t sctps_lowlevelerrusr;	/* total times sctp_senderrors were
891					 * caused from a user send from a user
892					 * invoked send not a sack response */
893	uint32_t sctps_datadropchklmt;	/* Number of in data drops due to
894					 * chunk limit reached */
895	uint32_t sctps_datadroprwnd;	/* Number of in data drops due to rwnd
896					 * limit reached */
897	uint32_t sctps_ecnereducedcwnd;	/* Number of times a ECN reduced the
898					 * cwnd */
899	uint32_t sctps_vtagexpress;	/* Used express lookup via vtag */
900	uint32_t sctps_vtagbogus;	/* Collision in express lookup. */
901	uint32_t sctps_primary_randry;	/* Number of times the sender ran dry
902					 * of user data on primary */
903	uint32_t sctps_cmt_randry;	/* Same for above */
904	uint32_t sctps_slowpath_sack;	/* Sacks the slow way */
905	uint32_t sctps_wu_sacks_sent;	/* Window Update only sacks sent */
906	uint32_t sctps_sends_with_flags;	/* number of sends with
907						 * sinfo_flags !=0 */
908	uint32_t sctps_sends_with_unord /* number of undordered sends */ ;
909	uint32_t sctps_sends_with_eof;	/* number of sends with EOF flag set */
910	uint32_t sctps_sends_with_abort;	/* number of sends with ABORT
911						 * flag set */
912	uint32_t sctps_protocol_drain_calls;	/* number of times protocol
913						 * drain called */
914	uint32_t sctps_protocol_drains_done;	/* number of times we did a
915						 * protocol drain */
916	uint32_t sctps_read_peeks;	/* Number of times recv was called
917					 * with peek */
918	uint32_t sctps_cached_chk;	/* Number of cached chunks used */
919	uint32_t sctps_cached_strmoq;	/* Number of cached stream oq's used */
920	uint32_t sctps_left_abandon;	/* Number of unread message abandonded
921					 * by close */
922	uint32_t sctps_send_burst_avoid;	/* Send burst avoidance,
923						 * already max burst inflight
924						 * to net */
925	uint32_t sctps_send_cwnd_avoid;	/* Send cwnd full  avoidance, already
926					 * max burst inflight to net */
927	uint32_t sctps_fwdtsn_map_over;	/* number of map array over-runs via
928					 * fwd-tsn's */
929
930	struct sctp_timeval sctps_discontinuitytime;	/* sctpStats 18
931							 * (TimeStamp) */
932};
933
934#define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
935#define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
936#define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&sctpstat._x, _d)
937#define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&sctpstat._x, _d)
938
939/* The following macros are for handling MIB values, */
940#define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
941#define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
942#define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
943#define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
944#define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
945#define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
946
947union sctp_sockstore {
948#if defined(INET) || !defined(_KERNEL)
949	struct sockaddr_in sin;
950#endif
951#if defined(INET6) || !defined(_KERNEL)
952	struct sockaddr_in6 sin6;
953#endif
954	struct sockaddr sa;
955};
956
957struct xsctp_inpcb {
958	uint32_t last;
959	uint32_t flags;
960	uint32_t features;
961	uint32_t total_sends;
962	uint32_t total_recvs;
963	uint32_t total_nospaces;
964	uint32_t fragmentation_point;
965	uint16_t local_port;
966	uint16_t qlen;
967	uint16_t maxqlen;
968};
969
970struct xsctp_tcb {
971	union sctp_sockstore primary_addr;	/* sctpAssocEntry 5/6 */
972	uint32_t last;
973	uint32_t heartbeat_interval;	/* sctpAssocEntry 7   */
974	uint32_t state;		/* sctpAssocEntry 8   */
975	uint32_t in_streams;	/* sctpAssocEntry 9   */
976	uint32_t out_streams;	/* sctpAssocEntry 10  */
977	uint32_t max_nr_retrans;/* sctpAssocEntry 11  */
978	uint32_t primary_process;	/* sctpAssocEntry 12  */
979	uint32_t T1_expireries;	/* sctpAssocEntry 13  */
980	uint32_t T2_expireries;	/* sctpAssocEntry 14  */
981	uint32_t retransmitted_tsns;	/* sctpAssocEntry 15  */
982	uint32_t total_sends;
983	uint32_t total_recvs;
984	uint32_t local_tag;
985	uint32_t remote_tag;
986	uint32_t initial_tsn;
987	uint32_t highest_tsn;
988	uint32_t cumulative_tsn;
989	uint32_t cumulative_tsn_ack;
990	uint32_t mtu;
991	uint32_t refcnt;
992	uint16_t local_port;	/* sctpAssocEntry 3   */
993	uint16_t remote_port;	/* sctpAssocEntry 4   */
994	struct sctp_timeval start_time;	/* sctpAssocEntry 16  */
995	struct sctp_timeval discontinuity_time;	/* sctpAssocEntry 17  */
996};
997
998struct xsctp_laddr {
999	union sctp_sockstore address;	/* sctpAssocLocalAddrEntry 1/2 */
1000	uint32_t last;
1001	struct sctp_timeval start_time;	/* sctpAssocLocalAddrEntry 3   */
1002};
1003
1004struct xsctp_raddr {
1005	union sctp_sockstore address;	/* sctpAssocLocalRemEntry 1/2 */
1006	uint32_t last;
1007	uint32_t rto;		/* sctpAssocLocalRemEntry 5   */
1008	uint32_t max_path_rtx;	/* sctpAssocLocalRemEntry 6   */
1009	uint32_t rtx;		/* sctpAssocLocalRemEntry 7   */
1010	uint32_t error_counter;	/* */
1011	uint32_t cwnd;		/* */
1012	uint32_t flight_size;	/* */
1013	uint32_t mtu;		/* */
1014	uint8_t active;		/* sctpAssocLocalRemEntry 3   */
1015	uint8_t confirmed;	/* */
1016	uint8_t heartbeat_enabled;	/* sctpAssocLocalRemEntry 4   */
1017	struct sctp_timeval start_time;	/* sctpAssocLocalRemEntry 8   */
1018};
1019
1020#define SCTP_MAX_LOGGING_SIZE 30000
1021#define SCTP_TRACE_PARAMS 6	/* This number MUST be even   */
1022
1023struct sctp_log_entry {
1024	u_int64_t timestamp;
1025	uint32_t subsys;
1026	uint32_t padding;
1027	uint32_t params[SCTP_TRACE_PARAMS];
1028};
1029
1030struct sctp_log {
1031	struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1032	uint32_t index;
1033	uint32_t padding;
1034};
1035
1036/*
1037 * Kernel defined for sctp_send
1038 */
1039#if defined(_KERNEL)
1040int
1041sctp_lower_sosend(struct socket *so,
1042    struct sockaddr *addr,
1043    struct uio *uio,
1044    struct mbuf *i_pak,
1045    struct mbuf *control,
1046    int flags,
1047    int use_rcvinfo,
1048    struct sctp_sndrcvinfo *srcv
1049    ,struct thread *p
1050);
1051
1052int
1053sctp_sorecvmsg(struct socket *so,
1054    struct uio *uio,
1055    struct mbuf **mp,
1056    struct sockaddr *from,
1057    int fromlen,
1058    int *msg_flags,
1059    struct sctp_sndrcvinfo *sinfo,
1060    int filling_sinfo);
1061
1062#endif
1063
1064/*
1065 * API system calls
1066 */
1067#if !(defined(_KERNEL))
1068
1069__BEGIN_DECLS
1070int sctp_peeloff __P((int, sctp_assoc_t));
1071int sctp_bindx __P((int, struct sockaddr *, int, int));
1072int sctp_connectx __P((int, const struct sockaddr *, int, sctp_assoc_t *));
1073int sctp_getaddrlen __P((sa_family_t));
1074int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
1075void sctp_freepaddrs __P((struct sockaddr *));
1076int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
1077void sctp_freeladdrs __P((struct sockaddr *));
1078int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
1079
1080ssize_t sctp_sendmsg
1081__P((int, const void *, size_t,
1082    const struct sockaddr *,
1083    socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1084
1085	ssize_t sctp_send __P((int sd, const void *msg, size_t len,
1086              const struct sctp_sndrcvinfo *sinfo, int flags));
1087
1088	ssize_t sctp_sendx __P((int sd, const void *msg, size_t len,
1089               struct sockaddr *addrs, int addrcnt,
1090               struct sctp_sndrcvinfo *sinfo, int flags));
1091
1092	ssize_t sctp_sendmsgx __P((int sd, const void *, size_t,
1093                  struct sockaddr *, int,
1094                  uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1095
1096	sctp_assoc_t sctp_getassocid __P((int sd, struct sockaddr *sa));
1097
1098	ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *,
1099                 socklen_t *, struct sctp_sndrcvinfo *, int *));
1100
1101__END_DECLS
1102
1103#endif				/* !_KERNEL */
1104#endif				/* !__sctp_uio_h__ */
1105