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