user.h 19 KB

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