user.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651
  1. /* SCTP kernel reference 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 reference Implementation
  8. *
  9. * This header represents the structures and constants needed to support
  10. * the SCTP Extension to the Sockets API.
  11. *
  12. * The SCTP reference 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. * The SCTP reference 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. enum sctp_optname {
  60. SCTP_RTOINFO,
  61. #define SCTP_RTOINFO SCTP_RTOINFO
  62. SCTP_ASSOCINFO,
  63. #define SCTP_ASSOCINFO SCTP_ASSOCINFO
  64. SCTP_INITMSG,
  65. #define SCTP_INITMSG SCTP_INITMSG
  66. SCTP_NODELAY, /* Get/set nodelay option. */
  67. #define SCTP_NODELAY SCTP_NODELAY
  68. SCTP_AUTOCLOSE,
  69. #define SCTP_AUTOCLOSE SCTP_AUTOCLOSE
  70. SCTP_SET_PEER_PRIMARY_ADDR,
  71. #define SCTP_SET_PEER_PRIMARY_ADDR SCTP_SET_PEER_PRIMARY_ADDR
  72. SCTP_PRIMARY_ADDR,
  73. #define SCTP_PRIMARY_ADDR SCTP_PRIMARY_ADDR
  74. SCTP_ADAPTATION_LAYER,
  75. #define SCTP_ADAPTATION_LAYER SCTP_ADAPTATION_LAYER
  76. SCTP_DISABLE_FRAGMENTS,
  77. #define SCTP_DISABLE_FRAGMENTS SCTP_DISABLE_FRAGMENTS
  78. SCTP_PEER_ADDR_PARAMS,
  79. #define SCTP_PEER_ADDR_PARAMS SCTP_PEER_ADDR_PARAMS
  80. SCTP_DEFAULT_SEND_PARAM,
  81. #define SCTP_DEFAULT_SEND_PARAM SCTP_DEFAULT_SEND_PARAM
  82. SCTP_EVENTS,
  83. #define SCTP_EVENTS SCTP_EVENTS
  84. SCTP_I_WANT_MAPPED_V4_ADDR, /* Turn on/off mapped v4 addresses */
  85. #define SCTP_I_WANT_MAPPED_V4_ADDR SCTP_I_WANT_MAPPED_V4_ADDR
  86. SCTP_MAXSEG, /* Get/set maximum fragment. */
  87. #define SCTP_MAXSEG SCTP_MAXSEG
  88. SCTP_STATUS,
  89. #define SCTP_STATUS SCTP_STATUS
  90. SCTP_GET_PEER_ADDR_INFO,
  91. #define SCTP_GET_PEER_ADDR_INFO SCTP_GET_PEER_ADDR_INFO
  92. SCTP_DELAYED_ACK_TIME,
  93. #define SCTP_DELAYED_ACK_TIME SCTP_DELAYED_ACK_TIME
  94. SCTP_CONTEXT, /* Receive Context */
  95. #define SCTP_CONTEXT SCTP_CONTEXT
  96. SCTP_FRAGMENT_INTERLEAVE,
  97. #define SCTP_FRAGMENT_INTERLEAVE SCTP_FRAGMENT_INTERLEAVE
  98. SCTP_PARTIAL_DELIVERY_POINT, /* Set/Get partial delivery point */
  99. #define SCTP_PARTIAL_DELIVERY_POINT SCTP_PARTIAL_DELIVERY_POINT
  100. SCTP_MAX_BURST, /* Set/Get max burst */
  101. #define SCTP_MAX_BURST SCTP_MAX_BURST
  102. /* Internal Socket Options. Some of the sctp library functions are
  103. * implemented using these socket options.
  104. */
  105. SCTP_SOCKOPT_BINDX_ADD = 100,/* BINDX requests for adding addresses. */
  106. #define SCTP_SOCKOPT_BINDX_ADD SCTP_SOCKOPT_BINDX_ADD
  107. SCTP_SOCKOPT_BINDX_REM, /* BINDX requests for removing addresses. */
  108. #define SCTP_SOCKOPT_BINDX_REM SCTP_SOCKOPT_BINDX_REM
  109. SCTP_SOCKOPT_PEELOFF, /* peel off association. */
  110. #define SCTP_SOCKOPT_PEELOFF SCTP_SOCKOPT_PEELOFF
  111. SCTP_GET_PEER_ADDRS_NUM_OLD, /* Get number of peer addresss. */
  112. #define SCTP_GET_PEER_ADDRS_NUM_OLD SCTP_GET_PEER_ADDRS_NUM_OLD
  113. SCTP_GET_PEER_ADDRS_OLD, /* Get all peer addresss. */
  114. #define SCTP_GET_PEER_ADDRS_OLD SCTP_GET_PEER_ADDRS_OLD
  115. SCTP_GET_LOCAL_ADDRS_NUM_OLD, /* Get number of local addresss. */
  116. #define SCTP_GET_LOCAL_ADDRS_NUM_OLD SCTP_GET_LOCAL_ADDRS_NUM_OLD
  117. SCTP_GET_LOCAL_ADDRS_OLD, /* Get all local addresss. */
  118. #define SCTP_GET_LOCAL_ADDRS_OLD SCTP_GET_LOCAL_ADDRS_OLD
  119. SCTP_SOCKOPT_CONNECTX, /* CONNECTX requests. */
  120. #define SCTP_SOCKOPT_CONNECTX SCTP_SOCKOPT_CONNECTX
  121. SCTP_GET_PEER_ADDRS, /* Get all peer addresss. */
  122. #define SCTP_GET_PEER_ADDRS SCTP_GET_PEER_ADDRS
  123. SCTP_GET_LOCAL_ADDRS, /* Get all local addresss. */
  124. #define SCTP_GET_LOCAL_ADDRS SCTP_GET_LOCAL_ADDRS
  125. };
  126. /*
  127. * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
  128. *
  129. * This cmsghdr structure provides information for initializing new
  130. * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
  131. * uses this same data structure. This structure is not used for
  132. * recvmsg().
  133. *
  134. * cmsg_level cmsg_type cmsg_data[]
  135. * ------------ ------------ ----------------------
  136. * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
  137. *
  138. */
  139. struct sctp_initmsg {
  140. __u16 sinit_num_ostreams;
  141. __u16 sinit_max_instreams;
  142. __u16 sinit_max_attempts;
  143. __u16 sinit_max_init_timeo;
  144. };
  145. /*
  146. * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
  147. *
  148. * This cmsghdr structure specifies SCTP options for sendmsg() and
  149. * describes SCTP header information about a received message through
  150. * recvmsg().
  151. *
  152. * cmsg_level cmsg_type cmsg_data[]
  153. * ------------ ------------ ----------------------
  154. * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
  155. *
  156. */
  157. struct sctp_sndrcvinfo {
  158. __u16 sinfo_stream;
  159. __u16 sinfo_ssn;
  160. __u16 sinfo_flags;
  161. __u32 sinfo_ppid;
  162. __u32 sinfo_context;
  163. __u32 sinfo_timetolive;
  164. __u32 sinfo_tsn;
  165. __u32 sinfo_cumtsn;
  166. sctp_assoc_t sinfo_assoc_id;
  167. };
  168. /*
  169. * sinfo_flags: 16 bits (unsigned integer)
  170. *
  171. * This field may contain any of the following flags and is composed of
  172. * a bitwise OR of these values.
  173. */
  174. enum sctp_sinfo_flags {
  175. SCTP_UNORDERED = 1, /* Send/receive message unordered. */
  176. SCTP_ADDR_OVER = 2, /* Override the primary destination. */
  177. SCTP_ABORT=4, /* Send an ABORT message to the peer. */
  178. SCTP_EOF=MSG_FIN, /* Initiate graceful shutdown process. */
  179. };
  180. typedef union {
  181. __u8 raw;
  182. struct sctp_initmsg init;
  183. struct sctp_sndrcvinfo sndrcv;
  184. } sctp_cmsg_data_t;
  185. /* These are cmsg_types. */
  186. typedef enum sctp_cmsg_type {
  187. SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
  188. SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
  189. } sctp_cmsg_t;
  190. /*
  191. * 5.3.1.1 SCTP_ASSOC_CHANGE
  192. *
  193. * Communication notifications inform the ULP that an SCTP association
  194. * has either begun or ended. The identifier for a new association is
  195. * provided by this notificaion. The notification information has the
  196. * following format:
  197. *
  198. */
  199. struct sctp_assoc_change {
  200. __u16 sac_type;
  201. __u16 sac_flags;
  202. __u32 sac_length;
  203. __u16 sac_state;
  204. __u16 sac_error;
  205. __u16 sac_outbound_streams;
  206. __u16 sac_inbound_streams;
  207. sctp_assoc_t sac_assoc_id;
  208. __u8 sac_info[0];
  209. };
  210. /*
  211. * sac_state: 32 bits (signed integer)
  212. *
  213. * This field holds one of a number of values that communicate the
  214. * event that happened to the association. They include:
  215. *
  216. * Note: The following state names deviate from the API draft as
  217. * the names clash too easily with other kernel symbols.
  218. */
  219. enum sctp_sac_state {
  220. SCTP_COMM_UP,
  221. SCTP_COMM_LOST,
  222. SCTP_RESTART,
  223. SCTP_SHUTDOWN_COMP,
  224. SCTP_CANT_STR_ASSOC,
  225. };
  226. /*
  227. * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
  228. *
  229. * When a destination address on a multi-homed peer encounters a change
  230. * an interface details event is sent. The information has the
  231. * following structure:
  232. */
  233. struct sctp_paddr_change {
  234. __u16 spc_type;
  235. __u16 spc_flags;
  236. __u32 spc_length;
  237. struct sockaddr_storage spc_aaddr;
  238. int spc_state;
  239. int spc_error;
  240. sctp_assoc_t spc_assoc_id;
  241. } __attribute__((packed, aligned(4)));
  242. /*
  243. * spc_state: 32 bits (signed integer)
  244. *
  245. * This field holds one of a number of values that communicate the
  246. * event that happened to the address. They include:
  247. */
  248. enum sctp_spc_state {
  249. SCTP_ADDR_AVAILABLE,
  250. SCTP_ADDR_UNREACHABLE,
  251. SCTP_ADDR_REMOVED,
  252. SCTP_ADDR_ADDED,
  253. SCTP_ADDR_MADE_PRIM,
  254. SCTP_ADDR_CONFIRMED,
  255. };
  256. /*
  257. * 5.3.1.3 SCTP_REMOTE_ERROR
  258. *
  259. * A remote peer may send an Operational Error message to its peer.
  260. * This message indicates a variety of error conditions on an
  261. * association. The entire error TLV as it appears on the wire is
  262. * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
  263. * specification [SCTP] and any extensions for a list of possible
  264. * error formats. SCTP error TLVs have the format:
  265. */
  266. struct sctp_remote_error {
  267. __u16 sre_type;
  268. __u16 sre_flags;
  269. __u32 sre_length;
  270. __u16 sre_error;
  271. sctp_assoc_t sre_assoc_id;
  272. __u8 sre_data[0];
  273. };
  274. /*
  275. * 5.3.1.4 SCTP_SEND_FAILED
  276. *
  277. * If SCTP cannot deliver a message it may return the message as a
  278. * notification.
  279. */
  280. struct sctp_send_failed {
  281. __u16 ssf_type;
  282. __u16 ssf_flags;
  283. __u32 ssf_length;
  284. __u32 ssf_error;
  285. struct sctp_sndrcvinfo ssf_info;
  286. sctp_assoc_t ssf_assoc_id;
  287. __u8 ssf_data[0];
  288. };
  289. /*
  290. * ssf_flags: 16 bits (unsigned integer)
  291. *
  292. * The flag value will take one of the following values
  293. *
  294. * SCTP_DATA_UNSENT - Indicates that the data was never put on
  295. * the wire.
  296. *
  297. * SCTP_DATA_SENT - Indicates that the data was put on the wire.
  298. * Note that this does not necessarily mean that the
  299. * data was (or was not) successfully delivered.
  300. */
  301. enum sctp_ssf_flags {
  302. SCTP_DATA_UNSENT,
  303. SCTP_DATA_SENT,
  304. };
  305. /*
  306. * 5.3.1.5 SCTP_SHUTDOWN_EVENT
  307. *
  308. * When a peer sends a SHUTDOWN, SCTP delivers this notification to
  309. * inform the application that it should cease sending data.
  310. */
  311. struct sctp_shutdown_event {
  312. __u16 sse_type;
  313. __u16 sse_flags;
  314. __u32 sse_length;
  315. sctp_assoc_t sse_assoc_id;
  316. };
  317. /*
  318. * 5.3.1.6 SCTP_ADAPTATION_INDICATION
  319. *
  320. * When a peer sends a Adaptation Layer Indication parameter , SCTP
  321. * delivers this notification to inform the application
  322. * that of the peers requested adaptation layer.
  323. */
  324. struct sctp_adaptation_event {
  325. __u16 sai_type;
  326. __u16 sai_flags;
  327. __u32 sai_length;
  328. __u32 sai_adaptation_ind;
  329. sctp_assoc_t sai_assoc_id;
  330. };
  331. /*
  332. * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
  333. *
  334. * When a receiver is engaged in a partial delivery of a
  335. * message this notification will be used to indicate
  336. * various events.
  337. */
  338. struct sctp_pdapi_event {
  339. __u16 pdapi_type;
  340. __u16 pdapi_flags;
  341. __u32 pdapi_length;
  342. __u32 pdapi_indication;
  343. sctp_assoc_t pdapi_assoc_id;
  344. };
  345. enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
  346. /*
  347. * Described in Section 7.3
  348. * Ancillary Data and Notification Interest Options
  349. */
  350. struct sctp_event_subscribe {
  351. __u8 sctp_data_io_event;
  352. __u8 sctp_association_event;
  353. __u8 sctp_address_event;
  354. __u8 sctp_send_failure_event;
  355. __u8 sctp_peer_error_event;
  356. __u8 sctp_shutdown_event;
  357. __u8 sctp_partial_delivery_event;
  358. __u8 sctp_adaptation_layer_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. };
  381. /* Section 5.3.1
  382. * All standard values for sn_type flags are greater than 2^15.
  383. * Values from 2^15 and down are reserved.
  384. */
  385. enum sctp_sn_type {
  386. SCTP_SN_TYPE_BASE = (1<<15),
  387. SCTP_ASSOC_CHANGE,
  388. SCTP_PEER_ADDR_CHANGE,
  389. SCTP_SEND_FAILED,
  390. SCTP_REMOTE_ERROR,
  391. SCTP_SHUTDOWN_EVENT,
  392. SCTP_PARTIAL_DELIVERY_EVENT,
  393. SCTP_ADAPTATION_INDICATION,
  394. };
  395. /* Notification error codes used to fill up the error fields in some
  396. * notifications.
  397. * SCTP_PEER_ADDRESS_CHAGE : spc_error
  398. * SCTP_ASSOC_CHANGE : sac_error
  399. * These names should be potentially included in the draft 04 of the SCTP
  400. * sockets API specification.
  401. */
  402. typedef enum sctp_sn_error {
  403. SCTP_FAILED_THRESHOLD,
  404. SCTP_RECEIVED_SACK,
  405. SCTP_HEARTBEAT_SUCCESS,
  406. SCTP_RESPONSE_TO_USER_REQ,
  407. SCTP_INTERNAL_ERROR,
  408. SCTP_SHUTDOWN_GUARD_EXPIRES,
  409. SCTP_PEER_FAULTY,
  410. } sctp_sn_error_t;
  411. /*
  412. * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
  413. *
  414. * The protocol parameters used to initialize and bound retransmission
  415. * timeout (RTO) are tunable. See [SCTP] for more information on how
  416. * these parameters are used in RTO calculation.
  417. */
  418. struct sctp_rtoinfo {
  419. sctp_assoc_t srto_assoc_id;
  420. __u32 srto_initial;
  421. __u32 srto_max;
  422. __u32 srto_min;
  423. };
  424. /*
  425. * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
  426. *
  427. * This option is used to both examine and set various association and
  428. * endpoint parameters.
  429. */
  430. struct sctp_assocparams {
  431. sctp_assoc_t sasoc_assoc_id;
  432. __u16 sasoc_asocmaxrxt;
  433. __u16 sasoc_number_peer_destinations;
  434. __u32 sasoc_peer_rwnd;
  435. __u32 sasoc_local_rwnd;
  436. __u32 sasoc_cookie_life;
  437. };
  438. /*
  439. * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
  440. *
  441. * Requests that the peer mark the enclosed address as the association
  442. * primary. The enclosed address must be one of the association's
  443. * locally bound addresses. The following structure is used to make a
  444. * set primary request:
  445. */
  446. struct sctp_setpeerprim {
  447. sctp_assoc_t sspp_assoc_id;
  448. struct sockaddr_storage sspp_addr;
  449. } __attribute__((packed, aligned(4)));
  450. /*
  451. * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
  452. *
  453. * Requests that the local SCTP stack use the enclosed peer address as
  454. * the association primary. The enclosed address must be one of the
  455. * association peer's addresses. The following structure is used to
  456. * make a set peer primary request:
  457. */
  458. struct sctp_prim {
  459. sctp_assoc_t ssp_assoc_id;
  460. struct sockaddr_storage ssp_addr;
  461. } __attribute__((packed, aligned(4)));
  462. /*
  463. * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
  464. *
  465. * Requests that the local endpoint set the specified Adaptation Layer
  466. * Indication parameter for all future INIT and INIT-ACK exchanges.
  467. */
  468. struct sctp_setadaptation {
  469. __u32 ssb_adaptation_ind;
  470. };
  471. /*
  472. * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
  473. *
  474. * Applications can enable or disable heartbeats for any peer address
  475. * of an association, modify an address's heartbeat interval, force a
  476. * heartbeat to be sent immediately, and adjust the address's maximum
  477. * number of retransmissions sent before an address is considered
  478. * unreachable. The following structure is used to access and modify an
  479. * address's parameters:
  480. */
  481. enum sctp_spp_flags {
  482. SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
  483. SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
  484. SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
  485. SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
  486. SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
  487. SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
  488. SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
  489. SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
  490. SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
  491. SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
  492. SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
  493. };
  494. struct sctp_paddrparams {
  495. sctp_assoc_t spp_assoc_id;
  496. struct sockaddr_storage spp_address;
  497. __u32 spp_hbinterval;
  498. __u16 spp_pathmaxrxt;
  499. __u32 spp_pathmtu;
  500. __u32 spp_sackdelay;
  501. __u32 spp_flags;
  502. } __attribute__((packed, aligned(4)));
  503. /* 7.1.23. Delayed Ack Timer (SCTP_DELAYED_ACK_TIME)
  504. *
  505. * This options will get or set the delayed ack timer. The time is set
  506. * in milliseconds. If the assoc_id is 0, then this sets or gets the
  507. * endpoints default delayed ack timer value. If the assoc_id field is
  508. * non-zero, then the set or get effects the specified association.
  509. */
  510. struct sctp_assoc_value {
  511. sctp_assoc_t assoc_id;
  512. uint32_t assoc_value;
  513. };
  514. /*
  515. * 7.2.2 Peer Address Information
  516. *
  517. * Applications can retrieve information about a specific peer address
  518. * of an association, including its reachability state, congestion
  519. * window, and retransmission timer values. This information is
  520. * read-only. The following structure is used to access this
  521. * information:
  522. */
  523. struct sctp_paddrinfo {
  524. sctp_assoc_t spinfo_assoc_id;
  525. struct sockaddr_storage spinfo_address;
  526. __s32 spinfo_state;
  527. __u32 spinfo_cwnd;
  528. __u32 spinfo_srtt;
  529. __u32 spinfo_rto;
  530. __u32 spinfo_mtu;
  531. } __attribute__((packed, aligned(4)));
  532. /* Peer addresses's state. */
  533. /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
  534. * calls.
  535. * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
  536. * Not yet confirmed by a heartbeat and not available for data
  537. * transfers.
  538. * ACTIVE : Peer address confirmed, active and available for data transfers.
  539. * INACTIVE: Peer address inactive and not available for data transfers.
  540. */
  541. enum sctp_spinfo_state {
  542. SCTP_INACTIVE,
  543. SCTP_ACTIVE,
  544. SCTP_UNCONFIRMED,
  545. SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
  546. };
  547. /*
  548. * 7.2.1 Association Status (SCTP_STATUS)
  549. *
  550. * Applications can retrieve current status information about an
  551. * association, including association state, peer receiver window size,
  552. * number of unacked data chunks, and number of data chunks pending
  553. * receipt. This information is read-only. The following structure is
  554. * used to access this information:
  555. */
  556. struct sctp_status {
  557. sctp_assoc_t sstat_assoc_id;
  558. __s32 sstat_state;
  559. __u32 sstat_rwnd;
  560. __u16 sstat_unackdata;
  561. __u16 sstat_penddata;
  562. __u16 sstat_instrms;
  563. __u16 sstat_outstrms;
  564. __u32 sstat_fragmentation_point;
  565. struct sctp_paddrinfo sstat_primary;
  566. };
  567. /*
  568. * 8.3, 8.5 get all peer/local addresses in an association.
  569. * This parameter struct is used by SCTP_GET_PEER_ADDRS and
  570. * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
  571. * sctp_getpaddrs() and sctp_getladdrs() API.
  572. */
  573. struct sctp_getaddrs_old {
  574. sctp_assoc_t assoc_id;
  575. int addr_num;
  576. struct sockaddr __user *addrs;
  577. };
  578. struct sctp_getaddrs {
  579. sctp_assoc_t assoc_id; /*input*/
  580. __u32 addr_num; /*output*/
  581. __u8 addrs[0]; /*output, variable size*/
  582. };
  583. /* These are bit fields for msghdr->msg_flags. See section 5.1. */
  584. /* On user space Linux, these live in <bits/socket.h> as an enum. */
  585. enum sctp_msg_flags {
  586. MSG_NOTIFICATION = 0x8000,
  587. #define MSG_NOTIFICATION MSG_NOTIFICATION
  588. };
  589. /*
  590. * 8.1 sctp_bindx()
  591. *
  592. * The flags parameter is formed from the bitwise OR of zero or more of the
  593. * following currently defined flags:
  594. */
  595. #define SCTP_BINDX_ADD_ADDR 0x01
  596. #define SCTP_BINDX_REM_ADDR 0x02
  597. /* This is the structure that is passed as an argument(optval) to
  598. * getsockopt(SCTP_SOCKOPT_PEELOFF).
  599. */
  600. typedef struct {
  601. sctp_assoc_t associd;
  602. int sd;
  603. } sctp_peeloff_arg_t;
  604. #endif /* __net_sctp_user_h__ */