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