user.h 22 KB

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