sctp.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899
  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, see
  26. * <http://www.gnu.org/licenses/>.
  27. *
  28. * Please send any bug reports or fixes you make to the
  29. * email address(es):
  30. * lksctp developers <linux-sctp@vger.kernel.org>
  31. *
  32. * Or submit a bug report through the following website:
  33. * http://www.sf.net/projects/lksctp
  34. *
  35. * Written or modified by:
  36. * La Monte H.P. Yarroll <piggy@acm.org>
  37. * R. Stewart <randall@sctp.chicago.il.us>
  38. * K. Morneau <kmorneau@cisco.com>
  39. * Q. Xie <qxie1@email.mot.com>
  40. * Karl Knutson <karl@athena.chicago.il.us>
  41. * Jon Grimm <jgrimm@us.ibm.com>
  42. * Daisy Chang <daisyc@us.ibm.com>
  43. * Ryan Layer <rmlayer@us.ibm.com>
  44. * Ardelle Fan <ardelle.fan@intel.com>
  45. * Sridhar Samudrala <sri@us.ibm.com>
  46. * Inaky Perez-Gonzalez <inaky.gonzalez@intel.com>
  47. * Vlad Yasevich <vladislav.yasevich@hp.com>
  48. *
  49. * Any bugs reported given to us we will try to fix... any fixes shared will
  50. * be incorporated into the next SCTP release.
  51. */
  52. #ifndef _SCTP_H
  53. #define _SCTP_H
  54. #include <linux/types.h>
  55. #include <linux/socket.h>
  56. typedef __s32 sctp_assoc_t;
  57. /* The following symbols come from the Sockets API Extensions for
  58. * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
  59. */
  60. #define SCTP_RTOINFO 0
  61. #define SCTP_ASSOCINFO 1
  62. #define SCTP_INITMSG 2
  63. #define SCTP_NODELAY 3 /* Get/set nodelay option. */
  64. #define SCTP_AUTOCLOSE 4
  65. #define SCTP_SET_PEER_PRIMARY_ADDR 5
  66. #define SCTP_PRIMARY_ADDR 6
  67. #define SCTP_ADAPTATION_LAYER 7
  68. #define SCTP_DISABLE_FRAGMENTS 8
  69. #define SCTP_PEER_ADDR_PARAMS 9
  70. #define SCTP_DEFAULT_SEND_PARAM 10
  71. #define SCTP_EVENTS 11
  72. #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */
  73. #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */
  74. #define SCTP_STATUS 14
  75. #define SCTP_GET_PEER_ADDR_INFO 15
  76. #define SCTP_DELAYED_ACK_TIME 16
  77. #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
  78. #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
  79. #define SCTP_CONTEXT 17
  80. #define SCTP_FRAGMENT_INTERLEAVE 18
  81. #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */
  82. #define SCTP_MAX_BURST 20 /* Set/Get max burst */
  83. #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */
  84. #define SCTP_HMAC_IDENT 22
  85. #define SCTP_AUTH_KEY 23
  86. #define SCTP_AUTH_ACTIVE_KEY 24
  87. #define SCTP_AUTH_DELETE_KEY 25
  88. #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */
  89. #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */
  90. #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */
  91. #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */
  92. #define SCTP_AUTO_ASCONF 30
  93. #define SCTP_PEER_ADDR_THLDS 31
  94. #define SCTP_RECVRCVINFO 32
  95. #define SCTP_RECVNXTINFO 33
  96. #define SCTP_DEFAULT_SNDINFO 34
  97. /* Internal Socket Options. Some of the sctp library functions are
  98. * implemented using these socket options.
  99. */
  100. #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
  101. #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
  102. #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
  103. /* Options 104-106 are deprecated and removed. Do not use this space */
  104. #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
  105. #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
  106. #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
  107. #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
  108. #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
  109. #define SCTP_GET_ASSOC_STATS 112 /* Read only */
  110. /* These are bit fields for msghdr->msg_flags. See section 5.1. */
  111. /* On user space Linux, these live in <bits/socket.h> as an enum. */
  112. enum sctp_msg_flags {
  113. MSG_NOTIFICATION = 0x8000,
  114. #define MSG_NOTIFICATION MSG_NOTIFICATION
  115. };
  116. /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
  117. *
  118. * This cmsghdr structure provides information for initializing new
  119. * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
  120. * uses this same data structure. This structure is not used for
  121. * recvmsg().
  122. *
  123. * cmsg_level cmsg_type cmsg_data[]
  124. * ------------ ------------ ----------------------
  125. * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
  126. */
  127. struct sctp_initmsg {
  128. __u16 sinit_num_ostreams;
  129. __u16 sinit_max_instreams;
  130. __u16 sinit_max_attempts;
  131. __u16 sinit_max_init_timeo;
  132. };
  133. /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
  134. *
  135. * This cmsghdr structure specifies SCTP options for sendmsg() and
  136. * describes SCTP header information about a received message through
  137. * recvmsg().
  138. *
  139. * cmsg_level cmsg_type cmsg_data[]
  140. * ------------ ------------ ----------------------
  141. * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
  142. */
  143. struct sctp_sndrcvinfo {
  144. __u16 sinfo_stream;
  145. __u16 sinfo_ssn;
  146. __u16 sinfo_flags;
  147. __u32 sinfo_ppid;
  148. __u32 sinfo_context;
  149. __u32 sinfo_timetolive;
  150. __u32 sinfo_tsn;
  151. __u32 sinfo_cumtsn;
  152. sctp_assoc_t sinfo_assoc_id;
  153. };
  154. /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
  155. *
  156. * This cmsghdr structure specifies SCTP options for sendmsg().
  157. *
  158. * cmsg_level cmsg_type cmsg_data[]
  159. * ------------ ------------ -------------------
  160. * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
  161. */
  162. struct sctp_sndinfo {
  163. __u16 snd_sid;
  164. __u16 snd_flags;
  165. __u32 snd_ppid;
  166. __u32 snd_context;
  167. sctp_assoc_t snd_assoc_id;
  168. };
  169. /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
  170. *
  171. * This cmsghdr structure describes SCTP receive information
  172. * about a received message through recvmsg().
  173. *
  174. * cmsg_level cmsg_type cmsg_data[]
  175. * ------------ ------------ -------------------
  176. * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
  177. */
  178. struct sctp_rcvinfo {
  179. __u16 rcv_sid;
  180. __u16 rcv_ssn;
  181. __u16 rcv_flags;
  182. __u32 rcv_ppid;
  183. __u32 rcv_tsn;
  184. __u32 rcv_cumtsn;
  185. __u32 rcv_context;
  186. sctp_assoc_t rcv_assoc_id;
  187. };
  188. /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
  189. *
  190. * This cmsghdr structure describes SCTP receive information
  191. * of the next message that will be delivered through recvmsg()
  192. * if this information is already available when delivering
  193. * the current message.
  194. *
  195. * cmsg_level cmsg_type cmsg_data[]
  196. * ------------ ------------ -------------------
  197. * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
  198. */
  199. struct sctp_nxtinfo {
  200. __u16 nxt_sid;
  201. __u16 nxt_flags;
  202. __u32 nxt_ppid;
  203. __u32 nxt_length;
  204. sctp_assoc_t nxt_assoc_id;
  205. };
  206. /*
  207. * sinfo_flags: 16 bits (unsigned integer)
  208. *
  209. * This field may contain any of the following flags and is composed of
  210. * a bitwise OR of these values.
  211. */
  212. enum sctp_sinfo_flags {
  213. SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
  214. SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
  215. SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
  216. SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
  217. SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
  218. SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
  219. };
  220. typedef union {
  221. __u8 raw;
  222. struct sctp_initmsg init;
  223. struct sctp_sndrcvinfo sndrcv;
  224. } sctp_cmsg_data_t;
  225. /* These are cmsg_types. */
  226. typedef enum sctp_cmsg_type {
  227. SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
  228. #define SCTP_INIT SCTP_INIT
  229. SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
  230. #define SCTP_SNDRCV SCTP_SNDRCV
  231. SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
  232. #define SCTP_SNDINFO SCTP_SNDINFO
  233. SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
  234. #define SCTP_RCVINFO SCTP_RCVINFO
  235. SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
  236. #define SCTP_NXTINFO SCTP_NXTINFO
  237. } sctp_cmsg_t;
  238. /*
  239. * 5.3.1.1 SCTP_ASSOC_CHANGE
  240. *
  241. * Communication notifications inform the ULP that an SCTP association
  242. * has either begun or ended. The identifier for a new association is
  243. * provided by this notificaion. The notification information has the
  244. * following format:
  245. *
  246. */
  247. struct sctp_assoc_change {
  248. __u16 sac_type;
  249. __u16 sac_flags;
  250. __u32 sac_length;
  251. __u16 sac_state;
  252. __u16 sac_error;
  253. __u16 sac_outbound_streams;
  254. __u16 sac_inbound_streams;
  255. sctp_assoc_t sac_assoc_id;
  256. __u8 sac_info[0];
  257. };
  258. /*
  259. * sac_state: 32 bits (signed integer)
  260. *
  261. * This field holds one of a number of values that communicate the
  262. * event that happened to the association. They include:
  263. *
  264. * Note: The following state names deviate from the API draft as
  265. * the names clash too easily with other kernel symbols.
  266. */
  267. enum sctp_sac_state {
  268. SCTP_COMM_UP,
  269. SCTP_COMM_LOST,
  270. SCTP_RESTART,
  271. SCTP_SHUTDOWN_COMP,
  272. SCTP_CANT_STR_ASSOC,
  273. };
  274. /*
  275. * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
  276. *
  277. * When a destination address on a multi-homed peer encounters a change
  278. * an interface details event is sent. The information has the
  279. * following structure:
  280. */
  281. struct sctp_paddr_change {
  282. __u16 spc_type;
  283. __u16 spc_flags;
  284. __u32 spc_length;
  285. struct sockaddr_storage spc_aaddr;
  286. int spc_state;
  287. int spc_error;
  288. sctp_assoc_t spc_assoc_id;
  289. } __attribute__((packed, aligned(4)));
  290. /*
  291. * spc_state: 32 bits (signed integer)
  292. *
  293. * This field holds one of a number of values that communicate the
  294. * event that happened to the address. They include:
  295. */
  296. enum sctp_spc_state {
  297. SCTP_ADDR_AVAILABLE,
  298. SCTP_ADDR_UNREACHABLE,
  299. SCTP_ADDR_REMOVED,
  300. SCTP_ADDR_ADDED,
  301. SCTP_ADDR_MADE_PRIM,
  302. SCTP_ADDR_CONFIRMED,
  303. };
  304. /*
  305. * 5.3.1.3 SCTP_REMOTE_ERROR
  306. *
  307. * A remote peer may send an Operational Error message to its peer.
  308. * This message indicates a variety of error conditions on an
  309. * association. The entire error TLV as it appears on the wire is
  310. * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
  311. * specification [SCTP] and any extensions for a list of possible
  312. * error formats. SCTP error TLVs have the format:
  313. */
  314. struct sctp_remote_error {
  315. __u16 sre_type;
  316. __u16 sre_flags;
  317. __u32 sre_length;
  318. __u16 sre_error;
  319. sctp_assoc_t sre_assoc_id;
  320. __u8 sre_data[0];
  321. };
  322. /*
  323. * 5.3.1.4 SCTP_SEND_FAILED
  324. *
  325. * If SCTP cannot deliver a message it may return the message as a
  326. * notification.
  327. */
  328. struct sctp_send_failed {
  329. __u16 ssf_type;
  330. __u16 ssf_flags;
  331. __u32 ssf_length;
  332. __u32 ssf_error;
  333. struct sctp_sndrcvinfo ssf_info;
  334. sctp_assoc_t ssf_assoc_id;
  335. __u8 ssf_data[0];
  336. };
  337. /*
  338. * ssf_flags: 16 bits (unsigned integer)
  339. *
  340. * The flag value will take one of the following values
  341. *
  342. * SCTP_DATA_UNSENT - Indicates that the data was never put on
  343. * the wire.
  344. *
  345. * SCTP_DATA_SENT - Indicates that the data was put on the wire.
  346. * Note that this does not necessarily mean that the
  347. * data was (or was not) successfully delivered.
  348. */
  349. enum sctp_ssf_flags {
  350. SCTP_DATA_UNSENT,
  351. SCTP_DATA_SENT,
  352. };
  353. /*
  354. * 5.3.1.5 SCTP_SHUTDOWN_EVENT
  355. *
  356. * When a peer sends a SHUTDOWN, SCTP delivers this notification to
  357. * inform the application that it should cease sending data.
  358. */
  359. struct sctp_shutdown_event {
  360. __u16 sse_type;
  361. __u16 sse_flags;
  362. __u32 sse_length;
  363. sctp_assoc_t sse_assoc_id;
  364. };
  365. /*
  366. * 5.3.1.6 SCTP_ADAPTATION_INDICATION
  367. *
  368. * When a peer sends a Adaptation Layer Indication parameter , SCTP
  369. * delivers this notification to inform the application
  370. * that of the peers requested adaptation layer.
  371. */
  372. struct sctp_adaptation_event {
  373. __u16 sai_type;
  374. __u16 sai_flags;
  375. __u32 sai_length;
  376. __u32 sai_adaptation_ind;
  377. sctp_assoc_t sai_assoc_id;
  378. };
  379. /*
  380. * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
  381. *
  382. * When a receiver is engaged in a partial delivery of a
  383. * message this notification will be used to indicate
  384. * various events.
  385. */
  386. struct sctp_pdapi_event {
  387. __u16 pdapi_type;
  388. __u16 pdapi_flags;
  389. __u32 pdapi_length;
  390. __u32 pdapi_indication;
  391. sctp_assoc_t pdapi_assoc_id;
  392. };
  393. enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
  394. /*
  395. * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
  396. *
  397. * When a receiver is using authentication this message will provide
  398. * notifications regarding new keys being made active as well as errors.
  399. */
  400. struct sctp_authkey_event {
  401. __u16 auth_type;
  402. __u16 auth_flags;
  403. __u32 auth_length;
  404. __u16 auth_keynumber;
  405. __u16 auth_altkeynumber;
  406. __u32 auth_indication;
  407. sctp_assoc_t auth_assoc_id;
  408. };
  409. enum { SCTP_AUTH_NEWKEY = 0, };
  410. /*
  411. * 6.1.9. SCTP_SENDER_DRY_EVENT
  412. *
  413. * When the SCTP stack has no more user data to send or retransmit, this
  414. * notification is given to the user. Also, at the time when a user app
  415. * subscribes to this event, if there is no data to be sent or
  416. * retransmit, the stack will immediately send up this notification.
  417. */
  418. struct sctp_sender_dry_event {
  419. __u16 sender_dry_type;
  420. __u16 sender_dry_flags;
  421. __u32 sender_dry_length;
  422. sctp_assoc_t sender_dry_assoc_id;
  423. };
  424. /*
  425. * Described in Section 7.3
  426. * Ancillary Data and Notification Interest Options
  427. */
  428. struct sctp_event_subscribe {
  429. __u8 sctp_data_io_event;
  430. __u8 sctp_association_event;
  431. __u8 sctp_address_event;
  432. __u8 sctp_send_failure_event;
  433. __u8 sctp_peer_error_event;
  434. __u8 sctp_shutdown_event;
  435. __u8 sctp_partial_delivery_event;
  436. __u8 sctp_adaptation_layer_event;
  437. __u8 sctp_authentication_event;
  438. __u8 sctp_sender_dry_event;
  439. };
  440. /*
  441. * 5.3.1 SCTP Notification Structure
  442. *
  443. * The notification structure is defined as the union of all
  444. * notification types.
  445. *
  446. */
  447. union sctp_notification {
  448. struct {
  449. __u16 sn_type; /* Notification type. */
  450. __u16 sn_flags;
  451. __u32 sn_length;
  452. } sn_header;
  453. struct sctp_assoc_change sn_assoc_change;
  454. struct sctp_paddr_change sn_paddr_change;
  455. struct sctp_remote_error sn_remote_error;
  456. struct sctp_send_failed sn_send_failed;
  457. struct sctp_shutdown_event sn_shutdown_event;
  458. struct sctp_adaptation_event sn_adaptation_event;
  459. struct sctp_pdapi_event sn_pdapi_event;
  460. struct sctp_authkey_event sn_authkey_event;
  461. struct sctp_sender_dry_event sn_sender_dry_event;
  462. };
  463. /* Section 5.3.1
  464. * All standard values for sn_type flags are greater than 2^15.
  465. * Values from 2^15 and down are reserved.
  466. */
  467. enum sctp_sn_type {
  468. SCTP_SN_TYPE_BASE = (1<<15),
  469. SCTP_ASSOC_CHANGE,
  470. #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
  471. SCTP_PEER_ADDR_CHANGE,
  472. #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
  473. SCTP_SEND_FAILED,
  474. #define SCTP_SEND_FAILED SCTP_SEND_FAILED
  475. SCTP_REMOTE_ERROR,
  476. #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
  477. SCTP_SHUTDOWN_EVENT,
  478. #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
  479. SCTP_PARTIAL_DELIVERY_EVENT,
  480. #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
  481. SCTP_ADAPTATION_INDICATION,
  482. #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
  483. SCTP_AUTHENTICATION_EVENT,
  484. #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
  485. SCTP_SENDER_DRY_EVENT,
  486. #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
  487. };
  488. /* Notification error codes used to fill up the error fields in some
  489. * notifications.
  490. * SCTP_PEER_ADDRESS_CHAGE : spc_error
  491. * SCTP_ASSOC_CHANGE : sac_error
  492. * These names should be potentially included in the draft 04 of the SCTP
  493. * sockets API specification.
  494. */
  495. typedef enum sctp_sn_error {
  496. SCTP_FAILED_THRESHOLD,
  497. SCTP_RECEIVED_SACK,
  498. SCTP_HEARTBEAT_SUCCESS,
  499. SCTP_RESPONSE_TO_USER_REQ,
  500. SCTP_INTERNAL_ERROR,
  501. SCTP_SHUTDOWN_GUARD_EXPIRES,
  502. SCTP_PEER_FAULTY,
  503. } sctp_sn_error_t;
  504. /*
  505. * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
  506. *
  507. * The protocol parameters used to initialize and bound retransmission
  508. * timeout (RTO) are tunable. See [SCTP] for more information on how
  509. * these parameters are used in RTO calculation.
  510. */
  511. struct sctp_rtoinfo {
  512. sctp_assoc_t srto_assoc_id;
  513. __u32 srto_initial;
  514. __u32 srto_max;
  515. __u32 srto_min;
  516. };
  517. /*
  518. * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
  519. *
  520. * This option is used to both examine and set various association and
  521. * endpoint parameters.
  522. */
  523. struct sctp_assocparams {
  524. sctp_assoc_t sasoc_assoc_id;
  525. __u16 sasoc_asocmaxrxt;
  526. __u16 sasoc_number_peer_destinations;
  527. __u32 sasoc_peer_rwnd;
  528. __u32 sasoc_local_rwnd;
  529. __u32 sasoc_cookie_life;
  530. };
  531. /*
  532. * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
  533. *
  534. * Requests that the peer mark the enclosed address as the association
  535. * primary. The enclosed address must be one of the association's
  536. * locally bound addresses. The following structure is used to make a
  537. * set primary request:
  538. */
  539. struct sctp_setpeerprim {
  540. sctp_assoc_t sspp_assoc_id;
  541. struct sockaddr_storage sspp_addr;
  542. } __attribute__((packed, aligned(4)));
  543. /*
  544. * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
  545. *
  546. * Requests that the local SCTP stack use the enclosed peer address as
  547. * the association primary. The enclosed address must be one of the
  548. * association peer's addresses. The following structure is used to
  549. * make a set peer primary request:
  550. */
  551. struct sctp_prim {
  552. sctp_assoc_t ssp_assoc_id;
  553. struct sockaddr_storage ssp_addr;
  554. } __attribute__((packed, aligned(4)));
  555. /* For backward compatibility use, define the old name too */
  556. #define sctp_setprim sctp_prim
  557. /*
  558. * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
  559. *
  560. * Requests that the local endpoint set the specified Adaptation Layer
  561. * Indication parameter for all future INIT and INIT-ACK exchanges.
  562. */
  563. struct sctp_setadaptation {
  564. __u32 ssb_adaptation_ind;
  565. };
  566. /*
  567. * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
  568. *
  569. * Applications can enable or disable heartbeats for any peer address
  570. * of an association, modify an address's heartbeat interval, force a
  571. * heartbeat to be sent immediately, and adjust the address's maximum
  572. * number of retransmissions sent before an address is considered
  573. * unreachable. The following structure is used to access and modify an
  574. * address's parameters:
  575. */
  576. enum sctp_spp_flags {
  577. SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
  578. SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
  579. SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
  580. SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
  581. SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
  582. SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
  583. SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
  584. SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
  585. SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
  586. SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
  587. SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
  588. };
  589. struct sctp_paddrparams {
  590. sctp_assoc_t spp_assoc_id;
  591. struct sockaddr_storage spp_address;
  592. __u32 spp_hbinterval;
  593. __u16 spp_pathmaxrxt;
  594. __u32 spp_pathmtu;
  595. __u32 spp_sackdelay;
  596. __u32 spp_flags;
  597. } __attribute__((packed, aligned(4)));
  598. /*
  599. * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
  600. *
  601. * This set option adds a chunk type that the user is requesting to be
  602. * received only in an authenticated way. Changes to the list of chunks
  603. * will only effect future associations on the socket.
  604. */
  605. struct sctp_authchunk {
  606. __u8 sauth_chunk;
  607. };
  608. /*
  609. * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
  610. *
  611. * This option gets or sets the list of HMAC algorithms that the local
  612. * endpoint requires the peer to use.
  613. */
  614. /* This here is only used by user space as is. It might not be a good idea
  615. * to export/reveal the whole structure with reserved fields etc.
  616. */
  617. enum {
  618. SCTP_AUTH_HMAC_ID_SHA1 = 1,
  619. SCTP_AUTH_HMAC_ID_SHA256 = 3,
  620. };
  621. struct sctp_hmacalgo {
  622. __u32 shmac_num_idents;
  623. __u16 shmac_idents[];
  624. };
  625. /* Sadly, user and kernel space have different names for
  626. * this structure member, so this is to not break anything.
  627. */
  628. #define shmac_number_of_idents shmac_num_idents
  629. /*
  630. * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
  631. *
  632. * This option will set a shared secret key which is used to build an
  633. * association shared key.
  634. */
  635. struct sctp_authkey {
  636. sctp_assoc_t sca_assoc_id;
  637. __u16 sca_keynumber;
  638. __u16 sca_keylength;
  639. __u8 sca_key[];
  640. };
  641. /*
  642. * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
  643. *
  644. * This option will get or set the active shared key to be used to build
  645. * the association shared key.
  646. */
  647. struct sctp_authkeyid {
  648. sctp_assoc_t scact_assoc_id;
  649. __u16 scact_keynumber;
  650. };
  651. /*
  652. * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
  653. *
  654. * This option will effect the way delayed acks are performed. This
  655. * option allows you to get or set the delayed ack time, in
  656. * milliseconds. It also allows changing the delayed ack frequency.
  657. * Changing the frequency to 1 disables the delayed sack algorithm. If
  658. * the assoc_id is 0, then this sets or gets the endpoints default
  659. * values. If the assoc_id field is non-zero, then the set or get
  660. * effects the specified association for the one to many model (the
  661. * assoc_id field is ignored by the one to one model). Note that if
  662. * sack_delay or sack_freq are 0 when setting this option, then the
  663. * current values will remain unchanged.
  664. */
  665. struct sctp_sack_info {
  666. sctp_assoc_t sack_assoc_id;
  667. uint32_t sack_delay;
  668. uint32_t sack_freq;
  669. };
  670. struct sctp_assoc_value {
  671. sctp_assoc_t assoc_id;
  672. uint32_t assoc_value;
  673. };
  674. /*
  675. * 7.2.2 Peer Address Information
  676. *
  677. * Applications can retrieve information about a specific peer address
  678. * of an association, including its reachability state, congestion
  679. * window, and retransmission timer values. This information is
  680. * read-only. The following structure is used to access this
  681. * information:
  682. */
  683. struct sctp_paddrinfo {
  684. sctp_assoc_t spinfo_assoc_id;
  685. struct sockaddr_storage spinfo_address;
  686. __s32 spinfo_state;
  687. __u32 spinfo_cwnd;
  688. __u32 spinfo_srtt;
  689. __u32 spinfo_rto;
  690. __u32 spinfo_mtu;
  691. } __attribute__((packed, aligned(4)));
  692. /* Peer addresses's state. */
  693. /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
  694. * calls.
  695. * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
  696. * Not yet confirmed by a heartbeat and not available for data
  697. * transfers.
  698. * ACTIVE : Peer address confirmed, active and available for data transfers.
  699. * INACTIVE: Peer address inactive and not available for data transfers.
  700. */
  701. enum sctp_spinfo_state {
  702. SCTP_INACTIVE,
  703. SCTP_PF,
  704. SCTP_ACTIVE,
  705. SCTP_UNCONFIRMED,
  706. SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
  707. };
  708. /*
  709. * 7.2.1 Association Status (SCTP_STATUS)
  710. *
  711. * Applications can retrieve current status information about an
  712. * association, including association state, peer receiver window size,
  713. * number of unacked data chunks, and number of data chunks pending
  714. * receipt. This information is read-only. The following structure is
  715. * used to access this information:
  716. */
  717. struct sctp_status {
  718. sctp_assoc_t sstat_assoc_id;
  719. __s32 sstat_state;
  720. __u32 sstat_rwnd;
  721. __u16 sstat_unackdata;
  722. __u16 sstat_penddata;
  723. __u16 sstat_instrms;
  724. __u16 sstat_outstrms;
  725. __u32 sstat_fragmentation_point;
  726. struct sctp_paddrinfo sstat_primary;
  727. };
  728. /*
  729. * 7.2.3. Get the list of chunks the peer requires to be authenticated
  730. * (SCTP_PEER_AUTH_CHUNKS)
  731. *
  732. * This option gets a list of chunks for a specified association that
  733. * the peer requires to be received authenticated only.
  734. */
  735. struct sctp_authchunks {
  736. sctp_assoc_t gauth_assoc_id;
  737. __u32 gauth_number_of_chunks;
  738. uint8_t gauth_chunks[];
  739. };
  740. /* The broken spelling has been released already in lksctp-tools header,
  741. * so don't break anyone, now that it's fixed.
  742. */
  743. #define guth_number_of_chunks gauth_number_of_chunks
  744. /* Association states. */
  745. enum sctp_sstat_state {
  746. SCTP_EMPTY = 0,
  747. SCTP_CLOSED = 1,
  748. SCTP_COOKIE_WAIT = 2,
  749. SCTP_COOKIE_ECHOED = 3,
  750. SCTP_ESTABLISHED = 4,
  751. SCTP_SHUTDOWN_PENDING = 5,
  752. SCTP_SHUTDOWN_SENT = 6,
  753. SCTP_SHUTDOWN_RECEIVED = 7,
  754. SCTP_SHUTDOWN_ACK_SENT = 8,
  755. };
  756. /*
  757. * 8.2.6. Get the Current Identifiers of Associations
  758. * (SCTP_GET_ASSOC_ID_LIST)
  759. *
  760. * This option gets the current list of SCTP association identifiers of
  761. * the SCTP associations handled by a one-to-many style socket.
  762. */
  763. struct sctp_assoc_ids {
  764. __u32 gaids_number_of_ids;
  765. sctp_assoc_t gaids_assoc_id[];
  766. };
  767. /*
  768. * 8.3, 8.5 get all peer/local addresses in an association.
  769. * This parameter struct is used by SCTP_GET_PEER_ADDRS and
  770. * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
  771. * sctp_getpaddrs() and sctp_getladdrs() API.
  772. */
  773. struct sctp_getaddrs_old {
  774. sctp_assoc_t assoc_id;
  775. int addr_num;
  776. struct sockaddr *addrs;
  777. };
  778. struct sctp_getaddrs {
  779. sctp_assoc_t assoc_id; /*input*/
  780. __u32 addr_num; /*output*/
  781. __u8 addrs[0]; /*output, variable size*/
  782. };
  783. /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
  784. * association stats. All stats are counts except sas_maxrto and
  785. * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
  786. * the last call. Will return 0 when RTO was not update since last call
  787. */
  788. struct sctp_assoc_stats {
  789. sctp_assoc_t sas_assoc_id; /* Input */
  790. /* Transport of observed max RTO */
  791. struct sockaddr_storage sas_obs_rto_ipaddr;
  792. __u64 sas_maxrto; /* Maximum Observed RTO for period */
  793. __u64 sas_isacks; /* SACKs received */
  794. __u64 sas_osacks; /* SACKs sent */
  795. __u64 sas_opackets; /* Packets sent */
  796. __u64 sas_ipackets; /* Packets received */
  797. __u64 sas_rtxchunks; /* Retransmitted Chunks */
  798. __u64 sas_outofseqtsns;/* TSN received > next expected */
  799. __u64 sas_idupchunks; /* Dups received (ordered+unordered) */
  800. __u64 sas_gapcnt; /* Gap Acknowledgements Received */
  801. __u64 sas_ouodchunks; /* Unordered data chunks sent */
  802. __u64 sas_iuodchunks; /* Unordered data chunks received */
  803. __u64 sas_oodchunks; /* Ordered data chunks sent */
  804. __u64 sas_iodchunks; /* Ordered data chunks received */
  805. __u64 sas_octrlchunks; /* Control chunks sent */
  806. __u64 sas_ictrlchunks; /* Control chunks received */
  807. };
  808. /*
  809. * 8.1 sctp_bindx()
  810. *
  811. * The flags parameter is formed from the bitwise OR of zero or more of the
  812. * following currently defined flags:
  813. */
  814. #define SCTP_BINDX_ADD_ADDR 0x01
  815. #define SCTP_BINDX_REM_ADDR 0x02
  816. /* This is the structure that is passed as an argument(optval) to
  817. * getsockopt(SCTP_SOCKOPT_PEELOFF).
  818. */
  819. typedef struct {
  820. sctp_assoc_t associd;
  821. int sd;
  822. } sctp_peeloff_arg_t;
  823. /*
  824. * Peer Address Thresholds socket option
  825. */
  826. struct sctp_paddrthlds {
  827. sctp_assoc_t spt_assoc_id;
  828. struct sockaddr_storage spt_address;
  829. __u16 spt_pathmaxrxt;
  830. __u16 spt_pathpfthld;
  831. };
  832. #endif /* _SCTP_H */