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