user.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712
  1. /* SCTP kernel implementation
  2. * (C) Copyright IBM Corp. 2001, 2004
  3. * Copyright (c) 1999-2000 Cisco, Inc.
  4. * Copyright (c) 1999-2001 Motorola, Inc.
  5. * Copyright (c) 2002 Intel Corp.
  6. *
  7. * This file is part of the SCTP kernel implementation
  8. *
  9. * This header represents the structures and constants needed to support
  10. * the SCTP Extension to the Sockets API.
  11. *
  12. * This SCTP implementation is free software;
  13. * you can redistribute it and/or modify it under the terms of
  14. * the GNU General Public License as published by
  15. * the Free Software Foundation; either version 2, or (at your option)
  16. * any later version.
  17. *
  18. * This SCTP implementation is distributed in the hope that it
  19. * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  20. * ************************
  21. * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  22. * See the GNU General Public License for more details.
  23. *
  24. * You should have received a copy of the GNU General Public License
  25. * along with GNU CC; see the file COPYING. If not, write to
  26. * the Free Software Foundation, 59 Temple Place - Suite 330,
  27. * Boston, MA 02111-1307, USA.
  28. *
  29. * Please send any bug reports or fixes you make to the
  30. * email address(es):
  31. * lksctp developers <lksctp-developers@lists.sourceforge.net>
  32. *
  33. * Or submit a bug report through the following website:
  34. * http://www.sf.net/projects/lksctp
  35. *
  36. * Written or modified by:
  37. * La Monte H.P. Yarroll <piggy@acm.org>
  38. * R. Stewart <randall@sctp.chicago.il.us>
  39. * K. Morneau <kmorneau@cisco.com>
  40. * Q. Xie <qxie1@email.mot.com>
  41. * Karl Knutson <karl@athena.chicago.il.us>
  42. * Jon Grimm <jgrimm@us.ibm.com>
  43. * Daisy Chang <daisyc@us.ibm.com>
  44. * Ryan Layer <rmlayer@us.ibm.com>
  45. * Ardelle Fan <ardelle.fan@intel.com>
  46. * Sridhar Samudrala <sri@us.ibm.com>
  47. *
  48. * Any bugs reported given to us we will try to fix... any fixes shared will
  49. * be incorporated into the next SCTP release.
  50. */
  51. #ifndef __net_sctp_user_h__
  52. #define __net_sctp_user_h__
  53. #include <linux/types.h>
  54. #include <linux/socket.h>
  55. typedef __s32 sctp_assoc_t;
  56. /* The following symbols come from the Sockets API Extensions for
  57. * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
  58. */
  59. #define SCTP_RTOINFO 0
  60. #define SCTP_ASSOCINFO 1
  61. #define SCTP_INITMSG 2
  62. #define SCTP_NODELAY 3 /* Get/set nodelay option. */
  63. #define SCTP_AUTOCLOSE 4
  64. #define SCTP_SET_PEER_PRIMARY_ADDR 5
  65. #define SCTP_PRIMARY_ADDR 6
  66. #define SCTP_ADAPTATION_LAYER 7
  67. #define SCTP_DISABLE_FRAGMENTS 8
  68. #define SCTP_PEER_ADDR_PARAMS 9
  69. #define SCTP_DEFAULT_SEND_PARAM 10
  70. #define SCTP_EVENTS 11
  71. #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */
  72. #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */
  73. #define SCTP_STATUS 14
  74. #define SCTP_GET_PEER_ADDR_INFO 15
  75. #define SCTP_DELAYED_ACK_TIME 16
  76. #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
  77. #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
  78. #define SCTP_CONTEXT 17
  79. #define SCTP_FRAGMENT_INTERLEAVE 18
  80. #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */
  81. #define SCTP_MAX_BURST 20 /* Set/Get max burst */
  82. #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */
  83. #define SCTP_HMAC_IDENT 22
  84. #define SCTP_AUTH_KEY 23
  85. #define SCTP_AUTH_ACTIVE_KEY 24
  86. #define SCTP_AUTH_DELETE_KEY 25
  87. #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */
  88. #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */
  89. #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */
  90. /* Internal Socket Options. Some of the sctp library functions are
  91. * implemented using these socket options.
  92. */
  93. #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
  94. #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
  95. #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
  96. /* Options 104-106 are deprecated and removed. Do not use this space */
  97. #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
  98. #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
  99. #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
  100. #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
  101. #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
  102. /*
  103. * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
  104. *
  105. * This cmsghdr structure provides information for initializing new
  106. * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
  107. * uses this same data structure. This structure is not used for
  108. * recvmsg().
  109. *
  110. * cmsg_level cmsg_type cmsg_data[]
  111. * ------------ ------------ ----------------------
  112. * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
  113. *
  114. */
  115. struct sctp_initmsg {
  116. __u16 sinit_num_ostreams;
  117. __u16 sinit_max_instreams;
  118. __u16 sinit_max_attempts;
  119. __u16 sinit_max_init_timeo;
  120. };
  121. /*
  122. * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
  123. *
  124. * This cmsghdr structure specifies SCTP options for sendmsg() and
  125. * describes SCTP header information about a received message through
  126. * recvmsg().
  127. *
  128. * cmsg_level cmsg_type cmsg_data[]
  129. * ------------ ------------ ----------------------
  130. * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
  131. *
  132. */
  133. struct sctp_sndrcvinfo {
  134. __u16 sinfo_stream;
  135. __u16 sinfo_ssn;
  136. __u16 sinfo_flags;
  137. __u32 sinfo_ppid;
  138. __u32 sinfo_context;
  139. __u32 sinfo_timetolive;
  140. __u32 sinfo_tsn;
  141. __u32 sinfo_cumtsn;
  142. sctp_assoc_t sinfo_assoc_id;
  143. };
  144. /*
  145. * sinfo_flags: 16 bits (unsigned integer)
  146. *
  147. * This field may contain any of the following flags and is composed of
  148. * a bitwise OR of these values.
  149. */
  150. enum sctp_sinfo_flags {
  151. SCTP_UNORDERED = 1, /* Send/receive message unordered. */
  152. SCTP_ADDR_OVER = 2, /* Override the primary destination. */
  153. SCTP_ABORT=4, /* Send an ABORT message to the peer. */
  154. SCTP_SACK_IMMEDIATELY = 8, /* SACK should be sent without delay */
  155. SCTP_EOF=MSG_FIN, /* Initiate graceful shutdown process. */
  156. };
  157. /* These are cmsg_types. */
  158. typedef enum sctp_cmsg_type {
  159. SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
  160. SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
  161. } sctp_cmsg_t;
  162. /*
  163. * 5.3.1.1 SCTP_ASSOC_CHANGE
  164. *
  165. * Communication notifications inform the ULP that an SCTP association
  166. * has either begun or ended. The identifier for a new association is
  167. * provided by this notificaion. The notification information has the
  168. * following format:
  169. *
  170. */
  171. struct sctp_assoc_change {
  172. __u16 sac_type;
  173. __u16 sac_flags;
  174. __u32 sac_length;
  175. __u16 sac_state;
  176. __u16 sac_error;
  177. __u16 sac_outbound_streams;
  178. __u16 sac_inbound_streams;
  179. sctp_assoc_t sac_assoc_id;
  180. __u8 sac_info[0];
  181. };
  182. /*
  183. * sac_state: 32 bits (signed integer)
  184. *
  185. * This field holds one of a number of values that communicate the
  186. * event that happened to the association. They include:
  187. *
  188. * Note: The following state names deviate from the API draft as
  189. * the names clash too easily with other kernel symbols.
  190. */
  191. enum sctp_sac_state {
  192. SCTP_COMM_UP,
  193. SCTP_COMM_LOST,
  194. SCTP_RESTART,
  195. SCTP_SHUTDOWN_COMP,
  196. SCTP_CANT_STR_ASSOC,
  197. };
  198. /*
  199. * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
  200. *
  201. * When a destination address on a multi-homed peer encounters a change
  202. * an interface details event is sent. The information has the
  203. * following structure:
  204. */
  205. struct sctp_paddr_change {
  206. __u16 spc_type;
  207. __u16 spc_flags;
  208. __u32 spc_length;
  209. struct sockaddr_storage spc_aaddr;
  210. int spc_state;
  211. int spc_error;
  212. sctp_assoc_t spc_assoc_id;
  213. } __attribute__((packed, aligned(4)));
  214. /*
  215. * spc_state: 32 bits (signed integer)
  216. *
  217. * This field holds one of a number of values that communicate the
  218. * event that happened to the address. They include:
  219. */
  220. enum sctp_spc_state {
  221. SCTP_ADDR_AVAILABLE,
  222. SCTP_ADDR_UNREACHABLE,
  223. SCTP_ADDR_REMOVED,
  224. SCTP_ADDR_ADDED,
  225. SCTP_ADDR_MADE_PRIM,
  226. SCTP_ADDR_CONFIRMED,
  227. };
  228. /*
  229. * 5.3.1.3 SCTP_REMOTE_ERROR
  230. *
  231. * A remote peer may send an Operational Error message to its peer.
  232. * This message indicates a variety of error conditions on an
  233. * association. The entire error TLV as it appears on the wire is
  234. * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
  235. * specification [SCTP] and any extensions for a list of possible
  236. * error formats. SCTP error TLVs have the format:
  237. */
  238. struct sctp_remote_error {
  239. __u16 sre_type;
  240. __u16 sre_flags;
  241. __u32 sre_length;
  242. __u16 sre_error;
  243. sctp_assoc_t sre_assoc_id;
  244. __u8 sre_data[0];
  245. };
  246. /*
  247. * 5.3.1.4 SCTP_SEND_FAILED
  248. *
  249. * If SCTP cannot deliver a message it may return the message as a
  250. * notification.
  251. */
  252. struct sctp_send_failed {
  253. __u16 ssf_type;
  254. __u16 ssf_flags;
  255. __u32 ssf_length;
  256. __u32 ssf_error;
  257. struct sctp_sndrcvinfo ssf_info;
  258. sctp_assoc_t ssf_assoc_id;
  259. __u8 ssf_data[0];
  260. };
  261. /*
  262. * ssf_flags: 16 bits (unsigned integer)
  263. *
  264. * The flag value will take one of the following values
  265. *
  266. * SCTP_DATA_UNSENT - Indicates that the data was never put on
  267. * the wire.
  268. *
  269. * SCTP_DATA_SENT - Indicates that the data was put on the wire.
  270. * Note that this does not necessarily mean that the
  271. * data was (or was not) successfully delivered.
  272. */
  273. enum sctp_ssf_flags {
  274. SCTP_DATA_UNSENT,
  275. SCTP_DATA_SENT,
  276. };
  277. /*
  278. * 5.3.1.5 SCTP_SHUTDOWN_EVENT
  279. *
  280. * When a peer sends a SHUTDOWN, SCTP delivers this notification to
  281. * inform the application that it should cease sending data.
  282. */
  283. struct sctp_shutdown_event {
  284. __u16 sse_type;
  285. __u16 sse_flags;
  286. __u32 sse_length;
  287. sctp_assoc_t sse_assoc_id;
  288. };
  289. /*
  290. * 5.3.1.6 SCTP_ADAPTATION_INDICATION
  291. *
  292. * When a peer sends a Adaptation Layer Indication parameter , SCTP
  293. * delivers this notification to inform the application
  294. * that of the peers requested adaptation layer.
  295. */
  296. struct sctp_adaptation_event {
  297. __u16 sai_type;
  298. __u16 sai_flags;
  299. __u32 sai_length;
  300. __u32 sai_adaptation_ind;
  301. sctp_assoc_t sai_assoc_id;
  302. };
  303. /*
  304. * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
  305. *
  306. * When a receiver is engaged in a partial delivery of a
  307. * message this notification will be used to indicate
  308. * various events.
  309. */
  310. struct sctp_pdapi_event {
  311. __u16 pdapi_type;
  312. __u16 pdapi_flags;
  313. __u32 pdapi_length;
  314. __u32 pdapi_indication;
  315. sctp_assoc_t pdapi_assoc_id;
  316. };
  317. enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
  318. struct sctp_authkey_event {
  319. __u16 auth_type;
  320. __u16 auth_flags;
  321. __u32 auth_length;
  322. __u16 auth_keynumber;
  323. __u16 auth_altkeynumber;
  324. __u32 auth_indication;
  325. sctp_assoc_t auth_assoc_id;
  326. };
  327. enum { SCTP_AUTH_NEWKEY = 0, };
  328. /*
  329. * Described in Section 7.3
  330. * Ancillary Data and Notification Interest Options
  331. */
  332. struct sctp_event_subscribe {
  333. __u8 sctp_data_io_event;
  334. __u8 sctp_association_event;
  335. __u8 sctp_address_event;
  336. __u8 sctp_send_failure_event;
  337. __u8 sctp_peer_error_event;
  338. __u8 sctp_shutdown_event;
  339. __u8 sctp_partial_delivery_event;
  340. __u8 sctp_adaptation_layer_event;
  341. __u8 sctp_authentication_event;
  342. };
  343. /*
  344. * 5.3.1 SCTP Notification Structure
  345. *
  346. * The notification structure is defined as the union of all
  347. * notification types.
  348. *
  349. */
  350. union sctp_notification {
  351. struct {
  352. __u16 sn_type; /* Notification type. */
  353. __u16 sn_flags;
  354. __u32 sn_length;
  355. } sn_header;
  356. struct sctp_assoc_change sn_assoc_change;
  357. struct sctp_paddr_change sn_paddr_change;
  358. struct sctp_remote_error sn_remote_error;
  359. struct sctp_send_failed sn_send_failed;
  360. struct sctp_shutdown_event sn_shutdown_event;
  361. struct sctp_adaptation_event sn_adaptation_event;
  362. struct sctp_pdapi_event sn_pdapi_event;
  363. struct sctp_authkey_event sn_authkey_event;
  364. };
  365. /* Section 5.3.1
  366. * All standard values for sn_type flags are greater than 2^15.
  367. * Values from 2^15 and down are reserved.
  368. */
  369. enum sctp_sn_type {
  370. SCTP_SN_TYPE_BASE = (1<<15),
  371. SCTP_ASSOC_CHANGE,
  372. SCTP_PEER_ADDR_CHANGE,
  373. SCTP_SEND_FAILED,
  374. SCTP_REMOTE_ERROR,
  375. SCTP_SHUTDOWN_EVENT,
  376. SCTP_PARTIAL_DELIVERY_EVENT,
  377. SCTP_ADAPTATION_INDICATION,
  378. SCTP_AUTHENTICATION_INDICATION,
  379. };
  380. /* Notification error codes used to fill up the error fields in some
  381. * notifications.
  382. * SCTP_PEER_ADDRESS_CHAGE : spc_error
  383. * SCTP_ASSOC_CHANGE : sac_error
  384. * These names should be potentially included in the draft 04 of the SCTP
  385. * sockets API specification.
  386. */
  387. typedef enum sctp_sn_error {
  388. SCTP_FAILED_THRESHOLD,
  389. SCTP_RECEIVED_SACK,
  390. SCTP_HEARTBEAT_SUCCESS,
  391. SCTP_RESPONSE_TO_USER_REQ,
  392. SCTP_INTERNAL_ERROR,
  393. SCTP_SHUTDOWN_GUARD_EXPIRES,
  394. SCTP_PEER_FAULTY,
  395. } sctp_sn_error_t;
  396. /*
  397. * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
  398. *
  399. * The protocol parameters used to initialize and bound retransmission
  400. * timeout (RTO) are tunable. See [SCTP] for more information on how
  401. * these parameters are used in RTO calculation.
  402. */
  403. struct sctp_rtoinfo {
  404. sctp_assoc_t srto_assoc_id;
  405. __u32 srto_initial;
  406. __u32 srto_max;
  407. __u32 srto_min;
  408. };
  409. /*
  410. * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
  411. *
  412. * This option is used to both examine and set various association and
  413. * endpoint parameters.
  414. */
  415. struct sctp_assocparams {
  416. sctp_assoc_t sasoc_assoc_id;
  417. __u16 sasoc_asocmaxrxt;
  418. __u16 sasoc_number_peer_destinations;
  419. __u32 sasoc_peer_rwnd;
  420. __u32 sasoc_local_rwnd;
  421. __u32 sasoc_cookie_life;
  422. };
  423. /*
  424. * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
  425. *
  426. * Requests that the peer mark the enclosed address as the association
  427. * primary. The enclosed address must be one of the association's
  428. * locally bound addresses. The following structure is used to make a
  429. * set primary request:
  430. */
  431. struct sctp_setpeerprim {
  432. sctp_assoc_t sspp_assoc_id;
  433. struct sockaddr_storage sspp_addr;
  434. } __attribute__((packed, aligned(4)));
  435. /*
  436. * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
  437. *
  438. * Requests that the local SCTP stack use the enclosed peer address as
  439. * the association primary. The enclosed address must be one of the
  440. * association peer's addresses. The following structure is used to
  441. * make a set peer primary request:
  442. */
  443. struct sctp_prim {
  444. sctp_assoc_t ssp_assoc_id;
  445. struct sockaddr_storage ssp_addr;
  446. } __attribute__((packed, aligned(4)));
  447. /*
  448. * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
  449. *
  450. * Requests that the local endpoint set the specified Adaptation Layer
  451. * Indication parameter for all future INIT and INIT-ACK exchanges.
  452. */
  453. struct sctp_setadaptation {
  454. __u32 ssb_adaptation_ind;
  455. };
  456. /*
  457. * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
  458. *
  459. * Applications can enable or disable heartbeats for any peer address
  460. * of an association, modify an address's heartbeat interval, force a
  461. * heartbeat to be sent immediately, and adjust the address's maximum
  462. * number of retransmissions sent before an address is considered
  463. * unreachable. The following structure is used to access and modify an
  464. * address's parameters:
  465. */
  466. enum sctp_spp_flags {
  467. SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
  468. SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
  469. SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
  470. SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
  471. SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
  472. SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
  473. SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
  474. SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
  475. SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
  476. SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
  477. SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
  478. };
  479. struct sctp_paddrparams {
  480. sctp_assoc_t spp_assoc_id;
  481. struct sockaddr_storage spp_address;
  482. __u32 spp_hbinterval;
  483. __u16 spp_pathmaxrxt;
  484. __u32 spp_pathmtu;
  485. __u32 spp_sackdelay;
  486. __u32 spp_flags;
  487. } __attribute__((packed, aligned(4)));
  488. /*
  489. * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
  490. *
  491. * This set option adds a chunk type that the user is requesting to be
  492. * received only in an authenticated way. Changes to the list of chunks
  493. * will only effect future associations on the socket.
  494. */
  495. struct sctp_authchunk {
  496. __u8 sauth_chunk;
  497. };
  498. /*
  499. * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
  500. *
  501. * This option gets or sets the list of HMAC algorithms that the local
  502. * endpoint requires the peer to use.
  503. */
  504. struct sctp_hmacalgo {
  505. __u32 shmac_num_idents;
  506. __u16 shmac_idents[];
  507. };
  508. /*
  509. * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
  510. *
  511. * This option will set a shared secret key which is used to build an
  512. * association shared key.
  513. */
  514. struct sctp_authkey {
  515. sctp_assoc_t sca_assoc_id;
  516. __u16 sca_keynumber;
  517. __u16 sca_keylength;
  518. __u8 sca_key[];
  519. };
  520. /*
  521. * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
  522. *
  523. * This option will get or set the active shared key to be used to build
  524. * the association shared key.
  525. */
  526. struct sctp_authkeyid {
  527. sctp_assoc_t scact_assoc_id;
  528. __u16 scact_keynumber;
  529. };
  530. /*
  531. * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
  532. *
  533. * This option will effect the way delayed acks are performed. This
  534. * option allows you to get or set the delayed ack time, in
  535. * milliseconds. It also allows changing the delayed ack frequency.
  536. * Changing the frequency to 1 disables the delayed sack algorithm. If
  537. * the assoc_id is 0, then this sets or gets the endpoints default
  538. * values. If the assoc_id field is non-zero, then the set or get
  539. * effects the specified association for the one to many model (the
  540. * assoc_id field is ignored by the one to one model). Note that if
  541. * sack_delay or sack_freq are 0 when setting this option, then the
  542. * current values will remain unchanged.
  543. */
  544. struct sctp_sack_info {
  545. sctp_assoc_t sack_assoc_id;
  546. uint32_t sack_delay;
  547. uint32_t sack_freq;
  548. };
  549. struct sctp_assoc_value {
  550. sctp_assoc_t assoc_id;
  551. uint32_t assoc_value;
  552. };
  553. /*
  554. * 7.2.2 Peer Address Information
  555. *
  556. * Applications can retrieve information about a specific peer address
  557. * of an association, including its reachability state, congestion
  558. * window, and retransmission timer values. This information is
  559. * read-only. The following structure is used to access this
  560. * information:
  561. */
  562. struct sctp_paddrinfo {
  563. sctp_assoc_t spinfo_assoc_id;
  564. struct sockaddr_storage spinfo_address;
  565. __s32 spinfo_state;
  566. __u32 spinfo_cwnd;
  567. __u32 spinfo_srtt;
  568. __u32 spinfo_rto;
  569. __u32 spinfo_mtu;
  570. } __attribute__((packed, aligned(4)));
  571. /* Peer addresses's state. */
  572. /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
  573. * calls.
  574. * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
  575. * Not yet confirmed by a heartbeat and not available for data
  576. * transfers.
  577. * ACTIVE : Peer address confirmed, active and available for data transfers.
  578. * INACTIVE: Peer address inactive and not available for data transfers.
  579. */
  580. enum sctp_spinfo_state {
  581. SCTP_INACTIVE,
  582. SCTP_ACTIVE,
  583. SCTP_UNCONFIRMED,
  584. SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
  585. };
  586. /*
  587. * 7.2.1 Association Status (SCTP_STATUS)
  588. *
  589. * Applications can retrieve current status information about an
  590. * association, including association state, peer receiver window size,
  591. * number of unacked data chunks, and number of data chunks pending
  592. * receipt. This information is read-only. The following structure is
  593. * used to access this information:
  594. */
  595. struct sctp_status {
  596. sctp_assoc_t sstat_assoc_id;
  597. __s32 sstat_state;
  598. __u32 sstat_rwnd;
  599. __u16 sstat_unackdata;
  600. __u16 sstat_penddata;
  601. __u16 sstat_instrms;
  602. __u16 sstat_outstrms;
  603. __u32 sstat_fragmentation_point;
  604. struct sctp_paddrinfo sstat_primary;
  605. };
  606. /*
  607. * 7.2.3. Get the list of chunks the peer requires to be authenticated
  608. * (SCTP_PEER_AUTH_CHUNKS)
  609. *
  610. * This option gets a list of chunks for a specified association that
  611. * the peer requires to be received authenticated only.
  612. */
  613. struct sctp_authchunks {
  614. sctp_assoc_t gauth_assoc_id;
  615. __u32 gauth_number_of_chunks;
  616. uint8_t gauth_chunks[];
  617. };
  618. /*
  619. * 8.3, 8.5 get all peer/local addresses in an association.
  620. * This parameter struct is used by SCTP_GET_PEER_ADDRS and
  621. * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
  622. * sctp_getpaddrs() and sctp_getladdrs() API.
  623. */
  624. struct sctp_getaddrs_old {
  625. sctp_assoc_t assoc_id;
  626. int addr_num;
  627. struct sockaddr __user *addrs;
  628. };
  629. struct sctp_getaddrs {
  630. sctp_assoc_t assoc_id; /*input*/
  631. __u32 addr_num; /*output*/
  632. __u8 addrs[0]; /*output, variable size*/
  633. };
  634. /* These are bit fields for msghdr->msg_flags. See section 5.1. */
  635. /* On user space Linux, these live in <bits/socket.h> as an enum. */
  636. enum sctp_msg_flags {
  637. MSG_NOTIFICATION = 0x8000,
  638. #define MSG_NOTIFICATION MSG_NOTIFICATION
  639. };
  640. /*
  641. * 8.1 sctp_bindx()
  642. *
  643. * The flags parameter is formed from the bitwise OR of zero or more of the
  644. * following currently defined flags:
  645. */
  646. #define SCTP_BINDX_ADD_ADDR 0x01
  647. #define SCTP_BINDX_REM_ADDR 0x02
  648. /* This is the structure that is passed as an argument(optval) to
  649. * getsockopt(SCTP_SOCKOPT_PEELOFF).
  650. */
  651. typedef struct {
  652. sctp_assoc_t associd;
  653. int sd;
  654. } sctp_peeloff_arg_t;
  655. #endif /* __net_sctp_user_h__ */