structs.h 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /* SCTP kernel implementation
  3. * (C) Copyright IBM Corp. 2001, 2004
  4. * Copyright (c) 1999-2000 Cisco, Inc.
  5. * Copyright (c) 1999-2001 Motorola, Inc.
  6. * Copyright (c) 2001 Intel Corp.
  7. *
  8. * This file is part of the SCTP kernel implementation
  9. *
  10. * Please send any bug reports or fixes you make to the
  11. * email addresses:
  12. * lksctp developers <linux-sctp@vger.kernel.org>
  13. *
  14. * Written or modified by:
  15. * Randall Stewart <randall@sctp.chicago.il.us>
  16. * Ken Morneau <kmorneau@cisco.com>
  17. * Qiaobing Xie <qxie1@email.mot.com>
  18. * La Monte H.P. Yarroll <piggy@acm.org>
  19. * Karl Knutson <karl@athena.chicago.il.us>
  20. * Jon Grimm <jgrimm@us.ibm.com>
  21. * Xingang Guo <xingang.guo@intel.com>
  22. * Hui Huang <hui.huang@nokia.com>
  23. * Sridhar Samudrala <sri@us.ibm.com>
  24. * Daisy Chang <daisyc@us.ibm.com>
  25. * Dajiang Zhang <dajiang.zhang@nokia.com>
  26. * Ardelle Fan <ardelle.fan@intel.com>
  27. * Ryan Layer <rmlayer@us.ibm.com>
  28. * Anup Pemmaiah <pemmaiah@cc.usu.edu>
  29. * Kevin Gao <kevin.gao@intel.com>
  30. */
  31. #ifndef __sctp_structs_h__
  32. #define __sctp_structs_h__
  33. #include <linux/ktime.h>
  34. #include <linux/generic-radix-tree.h>
  35. #include <linux/rhashtable-types.h>
  36. #include <linux/socket.h> /* linux/in.h needs this!! */
  37. #include <linux/in.h> /* We get struct sockaddr_in. */
  38. #include <linux/in6.h> /* We get struct in6_addr */
  39. #include <linux/ipv6.h>
  40. #include <asm/param.h> /* We get MAXHOSTNAMELEN. */
  41. #include <linux/atomic.h> /* This gets us atomic counters. */
  42. #include <linux/skbuff.h> /* We need sk_buff_head. */
  43. #include <linux/workqueue.h> /* We need tq_struct. */
  44. #include <linux/sctp.h> /* We need sctp* header structs. */
  45. #include <net/sctp/auth.h> /* We need auth specific structs */
  46. #include <net/ip.h> /* For inet_skb_parm */
  47. /* A convenience structure for handling sockaddr structures.
  48. * We should wean ourselves off this.
  49. */
  50. union sctp_addr {
  51. struct sockaddr_in v4;
  52. struct sockaddr_in6 v6;
  53. struct sockaddr sa;
  54. };
  55. /* Forward declarations for data structures. */
  56. struct sctp_globals;
  57. struct sctp_endpoint;
  58. struct sctp_association;
  59. struct sctp_transport;
  60. struct sctp_packet;
  61. struct sctp_chunk;
  62. struct sctp_inq;
  63. struct sctp_outq;
  64. struct sctp_bind_addr;
  65. struct sctp_ulpq;
  66. struct sctp_ep_common;
  67. struct crypto_shash;
  68. struct sctp_stream;
  69. #include <net/sctp/tsnmap.h>
  70. #include <net/sctp/ulpevent.h>
  71. #include <net/sctp/ulpqueue.h>
  72. #include <net/sctp/stream_interleave.h>
  73. /* Structures useful for managing bind/connect. */
  74. struct sctp_bind_bucket {
  75. unsigned short port;
  76. signed char fastreuse;
  77. signed char fastreuseport;
  78. kuid_t fastuid;
  79. struct hlist_node node;
  80. struct hlist_head owner;
  81. struct net *net;
  82. };
  83. struct sctp_bind_hashbucket {
  84. spinlock_t lock;
  85. struct hlist_head chain;
  86. };
  87. /* Used for hashing all associations. */
  88. struct sctp_hashbucket {
  89. rwlock_t lock;
  90. struct hlist_head chain;
  91. } __attribute__((__aligned__(8)));
  92. /* The SCTP globals structure. */
  93. extern struct sctp_globals {
  94. /* This is a list of groups of functions for each address
  95. * family that we support.
  96. */
  97. struct list_head address_families;
  98. /* This is the hash of all endpoints. */
  99. struct sctp_hashbucket *ep_hashtable;
  100. /* This is the sctp port control hash. */
  101. struct sctp_bind_hashbucket *port_hashtable;
  102. /* This is the hash of all transports. */
  103. struct rhltable transport_hashtable;
  104. /* Sizes of above hashtables. */
  105. int ep_hashsize;
  106. int port_hashsize;
  107. /* Default initialization values to be applied to new associations. */
  108. __u16 max_instreams;
  109. __u16 max_outstreams;
  110. /* Flag to indicate whether computing and verifying checksum
  111. * is disabled. */
  112. bool checksum_disable;
  113. } sctp_globals;
  114. #define sctp_max_instreams (sctp_globals.max_instreams)
  115. #define sctp_max_outstreams (sctp_globals.max_outstreams)
  116. #define sctp_address_families (sctp_globals.address_families)
  117. #define sctp_ep_hashsize (sctp_globals.ep_hashsize)
  118. #define sctp_ep_hashtable (sctp_globals.ep_hashtable)
  119. #define sctp_port_hashsize (sctp_globals.port_hashsize)
  120. #define sctp_port_hashtable (sctp_globals.port_hashtable)
  121. #define sctp_transport_hashtable (sctp_globals.transport_hashtable)
  122. #define sctp_checksum_disable (sctp_globals.checksum_disable)
  123. /* SCTP Socket type: UDP or TCP style. */
  124. enum sctp_socket_type {
  125. SCTP_SOCKET_UDP = 0,
  126. SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
  127. SCTP_SOCKET_TCP
  128. };
  129. /* Per socket SCTP information. */
  130. struct sctp_sock {
  131. /* inet_sock has to be the first member of sctp_sock */
  132. struct inet_sock inet;
  133. /* What kind of a socket is this? */
  134. enum sctp_socket_type type;
  135. /* PF_ family specific functions. */
  136. struct sctp_pf *pf;
  137. /* Access to HMAC transform. */
  138. struct crypto_shash *hmac;
  139. char *sctp_hmac_alg;
  140. /* What is our base endpointer? */
  141. struct sctp_endpoint *ep;
  142. struct sctp_bind_bucket *bind_hash;
  143. /* Various Socket Options. */
  144. __u16 default_stream;
  145. __u32 default_ppid;
  146. __u16 default_flags;
  147. __u32 default_context;
  148. __u32 default_timetolive;
  149. __u32 default_rcv_context;
  150. int max_burst;
  151. /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
  152. * the destination address every heartbeat interval. This value
  153. * will be inherited by all new associations.
  154. */
  155. __u32 hbinterval;
  156. __u32 probe_interval;
  157. __be16 udp_port;
  158. __be16 encap_port;
  159. /* This is the max_retrans value for new associations. */
  160. __u16 pathmaxrxt;
  161. __u32 flowlabel;
  162. __u8 dscp;
  163. __u16 pf_retrans;
  164. __u16 ps_retrans;
  165. /* The initial Path MTU to use for new associations. */
  166. __u32 pathmtu;
  167. /* The default SACK delay timeout for new associations. */
  168. __u32 sackdelay;
  169. __u32 sackfreq;
  170. /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
  171. __u32 param_flags;
  172. __u32 default_ss;
  173. struct sctp_rtoinfo rtoinfo;
  174. struct sctp_paddrparams paddrparam;
  175. struct sctp_assocparams assocparams;
  176. /*
  177. * These two structures must be grouped together for the usercopy
  178. * whitelist region.
  179. */
  180. __u16 subscribe;
  181. struct sctp_initmsg initmsg;
  182. int user_frag;
  183. __u32 autoclose;
  184. __u32 adaptation_ind;
  185. __u32 pd_point;
  186. __u16 nodelay:1,
  187. pf_expose:2,
  188. reuse:1,
  189. disable_fragments:1,
  190. v4mapped:1,
  191. frag_interleave:1,
  192. recvrcvinfo:1,
  193. recvnxtinfo:1,
  194. data_ready_signalled:1;
  195. atomic_t pd_mode;
  196. /* Fields after this point will be skipped on copies, like on accept
  197. * and peeloff operations
  198. */
  199. /* Receive to here while partial delivery is in effect. */
  200. struct sk_buff_head pd_lobby;
  201. struct list_head auto_asconf_list;
  202. int do_auto_asconf;
  203. };
  204. #define sctp_sk(ptr) container_of_const(ptr, struct sctp_sock, inet.sk)
  205. static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
  206. {
  207. return (struct sock *)sp;
  208. }
  209. #if IS_ENABLED(CONFIG_IPV6)
  210. struct sctp6_sock {
  211. struct sctp_sock sctp;
  212. struct ipv6_pinfo inet6;
  213. };
  214. #endif /* CONFIG_IPV6 */
  215. /* This is our APPLICATION-SPECIFIC state cookie.
  216. * THIS IS NOT DICTATED BY THE SPECIFICATION.
  217. */
  218. /* These are the parts of an association which we send in the cookie.
  219. * Most of these are straight out of:
  220. * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
  221. *
  222. */
  223. struct sctp_cookie {
  224. /* My : Tag expected in every inbound packet and sent
  225. * Verification: in the INIT or INIT ACK chunk.
  226. * Tag :
  227. */
  228. __u32 my_vtag;
  229. /* Peer's : Tag expected in every outbound packet except
  230. * Verification: in the INIT chunk.
  231. * Tag :
  232. */
  233. __u32 peer_vtag;
  234. /* The rest of these are not from the spec, but really need to
  235. * be in the cookie.
  236. */
  237. /* My Tie Tag : Assist in discovering a restarting association. */
  238. __u32 my_ttag;
  239. /* Peer's Tie Tag: Assist in discovering a restarting association. */
  240. __u32 peer_ttag;
  241. /* When does this cookie expire? */
  242. ktime_t expiration;
  243. /* Number of inbound/outbound streams which are set
  244. * and negotiated during the INIT process.
  245. */
  246. __u16 sinit_num_ostreams;
  247. __u16 sinit_max_instreams;
  248. /* This is the first sequence number I used. */
  249. __u32 initial_tsn;
  250. /* This holds the originating address of the INIT packet. */
  251. union sctp_addr peer_addr;
  252. /* IG Section 2.35.3
  253. * Include the source port of the INIT-ACK
  254. */
  255. __u16 my_port;
  256. __u8 prsctp_capable;
  257. /* Padding for future use */
  258. __u8 padding;
  259. __u32 adaptation_ind;
  260. __u8 auth_random[sizeof(struct sctp_paramhdr) +
  261. SCTP_AUTH_RANDOM_LENGTH];
  262. __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS * sizeof(__u16) + 2];
  263. __u8 auth_chunks[sizeof(struct sctp_paramhdr) + SCTP_AUTH_MAX_CHUNKS];
  264. /* This is a shim for my peer's INIT packet, followed by
  265. * a copy of the raw address list of the association.
  266. * The length of the raw address list is saved in the
  267. * raw_addr_list_len field, which will be used at the time when
  268. * the association TCB is re-constructed from the cookie.
  269. */
  270. __u32 raw_addr_list_len;
  271. /* struct sctp_init_chunk peer_init[]; */
  272. };
  273. /* The format of our cookie that we send to our peer. */
  274. struct sctp_signed_cookie {
  275. __u8 signature[SCTP_SECRET_SIZE];
  276. __u32 __pad; /* force sctp_cookie alignment to 64 bits */
  277. struct sctp_cookie c;
  278. } __packed;
  279. /* This is another convenience type to allocate memory for address
  280. * params for the maximum size and pass such structures around
  281. * internally.
  282. */
  283. union sctp_addr_param {
  284. struct sctp_paramhdr p;
  285. struct sctp_ipv4addr_param v4;
  286. struct sctp_ipv6addr_param v6;
  287. };
  288. /* A convenience type to allow walking through the various
  289. * parameters and avoid casting all over the place.
  290. */
  291. union sctp_params {
  292. void *v;
  293. struct sctp_paramhdr *p;
  294. struct sctp_cookie_preserve_param *life;
  295. struct sctp_hostname_param *dns;
  296. struct sctp_cookie_param *cookie;
  297. struct sctp_supported_addrs_param *sat;
  298. struct sctp_ipv4addr_param *v4;
  299. struct sctp_ipv6addr_param *v6;
  300. union sctp_addr_param *addr;
  301. struct sctp_adaptation_ind_param *aind;
  302. struct sctp_supported_ext_param *ext;
  303. struct sctp_random_param *random;
  304. struct sctp_chunks_param *chunks;
  305. struct sctp_hmac_algo_param *hmac_algo;
  306. struct sctp_addip_param *addip;
  307. };
  308. /* RFC 2960. Section 3.3.5 Heartbeat.
  309. * Heartbeat Information: variable length
  310. * The Sender-specific Heartbeat Info field should normally include
  311. * information about the sender's current time when this HEARTBEAT
  312. * chunk is sent and the destination transport address to which this
  313. * HEARTBEAT is sent (see Section 8.3).
  314. */
  315. struct sctp_sender_hb_info {
  316. struct sctp_paramhdr param_hdr;
  317. union sctp_addr daddr;
  318. unsigned long sent_at;
  319. __u64 hb_nonce;
  320. __u32 probe_size;
  321. };
  322. int sctp_stream_init(struct sctp_stream *stream, __u16 outcnt, __u16 incnt,
  323. gfp_t gfp);
  324. int sctp_stream_init_ext(struct sctp_stream *stream, __u16 sid);
  325. void sctp_stream_free(struct sctp_stream *stream);
  326. void sctp_stream_clear(struct sctp_stream *stream);
  327. void sctp_stream_update(struct sctp_stream *stream, struct sctp_stream *new);
  328. /* What is the current SSN number for this stream? */
  329. #define sctp_ssn_peek(stream, type, sid) \
  330. (sctp_stream_##type((stream), (sid))->ssn)
  331. /* Return the next SSN number for this stream. */
  332. #define sctp_ssn_next(stream, type, sid) \
  333. (sctp_stream_##type((stream), (sid))->ssn++)
  334. /* Skip over this ssn and all below. */
  335. #define sctp_ssn_skip(stream, type, sid, ssn) \
  336. (sctp_stream_##type((stream), (sid))->ssn = ssn + 1)
  337. /* What is the current MID number for this stream? */
  338. #define sctp_mid_peek(stream, type, sid) \
  339. (sctp_stream_##type((stream), (sid))->mid)
  340. /* Return the next MID number for this stream. */
  341. #define sctp_mid_next(stream, type, sid) \
  342. (sctp_stream_##type((stream), (sid))->mid++)
  343. /* Skip over this mid and all below. */
  344. #define sctp_mid_skip(stream, type, sid, mid) \
  345. (sctp_stream_##type((stream), (sid))->mid = mid + 1)
  346. /* What is the current MID_uo number for this stream? */
  347. #define sctp_mid_uo_peek(stream, type, sid) \
  348. (sctp_stream_##type((stream), (sid))->mid_uo)
  349. /* Return the next MID_uo number for this stream. */
  350. #define sctp_mid_uo_next(stream, type, sid) \
  351. (sctp_stream_##type((stream), (sid))->mid_uo++)
  352. /*
  353. * Pointers to address related SCTP functions.
  354. * (i.e. things that depend on the address family.)
  355. */
  356. struct sctp_af {
  357. int (*sctp_xmit) (struct sk_buff *skb,
  358. struct sctp_transport *);
  359. int (*setsockopt) (struct sock *sk,
  360. int level,
  361. int optname,
  362. sockptr_t optval,
  363. unsigned int optlen);
  364. int (*getsockopt) (struct sock *sk,
  365. int level,
  366. int optname,
  367. char __user *optval,
  368. int __user *optlen);
  369. void (*get_dst) (struct sctp_transport *t,
  370. union sctp_addr *saddr,
  371. struct flowi *fl,
  372. struct sock *sk);
  373. void (*get_saddr) (struct sctp_sock *sk,
  374. struct sctp_transport *t,
  375. struct flowi *fl);
  376. void (*copy_addrlist) (struct list_head *,
  377. struct net_device *);
  378. int (*cmp_addr) (const union sctp_addr *addr1,
  379. const union sctp_addr *addr2);
  380. void (*addr_copy) (union sctp_addr *dst,
  381. union sctp_addr *src);
  382. void (*from_skb) (union sctp_addr *,
  383. struct sk_buff *skb,
  384. int saddr);
  385. void (*from_sk) (union sctp_addr *,
  386. struct sock *sk);
  387. bool (*from_addr_param) (union sctp_addr *,
  388. union sctp_addr_param *,
  389. __be16 port, int iif);
  390. int (*to_addr_param) (const union sctp_addr *,
  391. union sctp_addr_param *);
  392. int (*addr_valid) (union sctp_addr *,
  393. struct sctp_sock *,
  394. const struct sk_buff *);
  395. enum sctp_scope (*scope)(union sctp_addr *);
  396. void (*inaddr_any) (union sctp_addr *, __be16);
  397. int (*is_any) (const union sctp_addr *);
  398. int (*available) (union sctp_addr *,
  399. struct sctp_sock *);
  400. int (*skb_iif) (const struct sk_buff *sk);
  401. int (*skb_sdif)(const struct sk_buff *sk);
  402. int (*is_ce) (const struct sk_buff *sk);
  403. void (*seq_dump_addr)(struct seq_file *seq,
  404. union sctp_addr *addr);
  405. void (*ecn_capable)(struct sock *sk);
  406. __u16 net_header_len;
  407. int sockaddr_len;
  408. int (*ip_options_len)(struct sock *sk);
  409. sa_family_t sa_family;
  410. struct list_head list;
  411. };
  412. struct sctp_af *sctp_get_af_specific(sa_family_t);
  413. int sctp_register_af(struct sctp_af *);
  414. /* Protocol family functions. */
  415. struct sctp_pf {
  416. void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
  417. void (*skb_msgname) (struct sk_buff *, char *, int *);
  418. int (*af_supported) (sa_family_t, struct sctp_sock *);
  419. int (*cmp_addr) (const union sctp_addr *,
  420. const union sctp_addr *,
  421. struct sctp_sock *);
  422. int (*bind_verify) (struct sctp_sock *, union sctp_addr *);
  423. int (*send_verify) (struct sctp_sock *, union sctp_addr *);
  424. int (*supported_addrs)(const struct sctp_sock *, __be16 *);
  425. struct sock *(*create_accept_sk) (struct sock *sk,
  426. struct sctp_association *asoc,
  427. bool kern);
  428. int (*addr_to_user)(struct sctp_sock *sk, union sctp_addr *addr);
  429. void (*to_sk_saddr)(union sctp_addr *, struct sock *sk);
  430. void (*to_sk_daddr)(union sctp_addr *, struct sock *sk);
  431. void (*copy_ip_options)(struct sock *sk, struct sock *newsk);
  432. struct sctp_af *af;
  433. };
  434. /* Structure to track chunk fragments that have been acked, but peer
  435. * fragments of the same message have not.
  436. */
  437. struct sctp_datamsg {
  438. /* Chunks waiting to be submitted to lower layer. */
  439. struct list_head chunks;
  440. /* Reference counting. */
  441. refcount_t refcnt;
  442. /* When is this message no longer interesting to the peer? */
  443. unsigned long expires_at;
  444. /* Did the message fail to send? */
  445. int send_error;
  446. u8 send_failed:1,
  447. can_delay:1, /* should this message be Nagle delayed */
  448. abandoned:1; /* should this message be abandoned */
  449. };
  450. struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
  451. struct sctp_sndrcvinfo *,
  452. struct iov_iter *);
  453. void sctp_datamsg_free(struct sctp_datamsg *);
  454. void sctp_datamsg_put(struct sctp_datamsg *);
  455. void sctp_chunk_fail(struct sctp_chunk *, int error);
  456. int sctp_chunk_abandoned(struct sctp_chunk *);
  457. /* RFC2960 1.4 Key Terms
  458. *
  459. * o Chunk: A unit of information within an SCTP packet, consisting of
  460. * a chunk header and chunk-specific content.
  461. *
  462. * As a matter of convenience, we remember the SCTP common header for
  463. * each chunk as well as a few other header pointers...
  464. */
  465. struct sctp_chunk {
  466. struct list_head list;
  467. refcount_t refcnt;
  468. /* How many times this chunk have been sent, for prsctp RTX policy */
  469. int sent_count;
  470. union {
  471. /* This is our link to the per-transport transmitted list. */
  472. struct list_head transmitted_list;
  473. /* List in specific stream outq */
  474. struct list_head stream_list;
  475. };
  476. /* This field is used by chunks that hold fragmented data.
  477. * For the first fragment this is the list that holds the rest of
  478. * fragments. For the remaining fragments, this is the link to the
  479. * frag_list maintained in the first fragment.
  480. */
  481. struct list_head frag_list;
  482. /* This points to the sk_buff containing the actual data. */
  483. struct sk_buff *skb;
  484. union {
  485. /* In case of GSO packets, this will store the head one */
  486. struct sk_buff *head_skb;
  487. /* In case of auth enabled, this will point to the shkey */
  488. struct sctp_shared_key *shkey;
  489. };
  490. /* These are the SCTP headers by reverse order in a packet.
  491. * Note that some of these may happen more than once. In that
  492. * case, we point at the "current" one, whatever that means
  493. * for that level of header.
  494. */
  495. /* We point this at the FIRST TLV parameter to chunk_hdr. */
  496. union sctp_params param_hdr;
  497. union {
  498. __u8 *v;
  499. struct sctp_datahdr *data_hdr;
  500. struct sctp_inithdr *init_hdr;
  501. struct sctp_sackhdr *sack_hdr;
  502. struct sctp_heartbeathdr *hb_hdr;
  503. struct sctp_sender_hb_info *hbs_hdr;
  504. struct sctp_shutdownhdr *shutdown_hdr;
  505. struct sctp_signed_cookie *cookie_hdr;
  506. struct sctp_ecnehdr *ecne_hdr;
  507. struct sctp_cwrhdr *ecn_cwr_hdr;
  508. struct sctp_errhdr *err_hdr;
  509. struct sctp_addiphdr *addip_hdr;
  510. struct sctp_fwdtsn_hdr *fwdtsn_hdr;
  511. struct sctp_authhdr *auth_hdr;
  512. struct sctp_idatahdr *idata_hdr;
  513. struct sctp_ifwdtsn_hdr *ifwdtsn_hdr;
  514. } subh;
  515. __u8 *chunk_end;
  516. struct sctp_chunkhdr *chunk_hdr;
  517. struct sctphdr *sctp_hdr;
  518. /* This needs to be recoverable for SCTP_SEND_FAILED events. */
  519. struct sctp_sndrcvinfo sinfo;
  520. /* Which association does this belong to? */
  521. struct sctp_association *asoc;
  522. /* What endpoint received this chunk? */
  523. struct sctp_ep_common *rcvr;
  524. /* We fill this in if we are calculating RTT. */
  525. unsigned long sent_at;
  526. /* What is the origin IP address for this chunk? */
  527. union sctp_addr source;
  528. /* Destination address for this chunk. */
  529. union sctp_addr dest;
  530. /* For outbound message, track all fragments for SEND_FAILED. */
  531. struct sctp_datamsg *msg;
  532. /* For an inbound chunk, this tells us where it came from.
  533. * For an outbound chunk, it tells us where we'd like it to
  534. * go. It is NULL if we have no preference.
  535. */
  536. struct sctp_transport *transport;
  537. /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
  538. * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
  539. * spec violates the principle premis that all chunks are processed
  540. * in order.
  541. */
  542. struct sk_buff *auth_chunk;
  543. #define SCTP_CAN_FRTX 0x0
  544. #define SCTP_NEED_FRTX 0x1
  545. #define SCTP_DONT_FRTX 0x2
  546. __u16 rtt_in_progress:1, /* This chunk used for RTT calc? */
  547. has_tsn:1, /* Does this chunk have a TSN yet? */
  548. has_ssn:1, /* Does this chunk have a SSN yet? */
  549. #define has_mid has_ssn
  550. singleton:1, /* Only chunk in the packet? */
  551. end_of_packet:1, /* Last chunk in the packet? */
  552. ecn_ce_done:1, /* Have we processed the ECN CE bit? */
  553. pdiscard:1, /* Discard the whole packet now? */
  554. tsn_gap_acked:1, /* Is this chunk acked by a GAP ACK? */
  555. data_accepted:1, /* At least 1 chunk accepted */
  556. auth:1, /* IN: was auth'ed | OUT: needs auth */
  557. has_asconf:1, /* IN: have seen an asconf before */
  558. pmtu_probe:1, /* Used by PLPMTUD, can be set in s HB chunk */
  559. tsn_missing_report:2, /* Data chunk missing counter. */
  560. fast_retransmit:2; /* Is this chunk fast retransmitted? */
  561. };
  562. #define sctp_chunk_retransmitted(chunk) (chunk->sent_count > 1)
  563. void sctp_chunk_hold(struct sctp_chunk *);
  564. void sctp_chunk_put(struct sctp_chunk *);
  565. int sctp_user_addto_chunk(struct sctp_chunk *chunk, int len,
  566. struct iov_iter *from);
  567. void sctp_chunk_free(struct sctp_chunk *);
  568. void *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
  569. struct sctp_chunk *sctp_chunkify(struct sk_buff *,
  570. const struct sctp_association *,
  571. struct sock *, gfp_t gfp);
  572. void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
  573. union sctp_addr *);
  574. const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
  575. static inline __u16 sctp_chunk_stream_no(struct sctp_chunk *ch)
  576. {
  577. return ntohs(ch->subh.data_hdr->stream);
  578. }
  579. enum {
  580. SCTP_ADDR_NEW, /* new address added to assoc/ep */
  581. SCTP_ADDR_SRC, /* address can be used as source */
  582. SCTP_ADDR_DEL, /* address about to be deleted */
  583. };
  584. /* This is a structure for holding either an IPv6 or an IPv4 address. */
  585. struct sctp_sockaddr_entry {
  586. struct list_head list;
  587. struct rcu_head rcu;
  588. union sctp_addr a;
  589. __u8 state;
  590. __u8 valid;
  591. };
  592. #define SCTP_ADDRESS_TICK_DELAY 500
  593. /* This structure holds lists of chunks as we are assembling for
  594. * transmission.
  595. */
  596. struct sctp_packet {
  597. /* These are the SCTP header values (host order) for the packet. */
  598. __u16 source_port;
  599. __u16 destination_port;
  600. __u32 vtag;
  601. /* This contains the payload chunks. */
  602. struct list_head chunk_list;
  603. /* This is the overhead of the sctp and ip headers. */
  604. size_t overhead;
  605. /* This is the total size of all chunks INCLUDING padding. */
  606. size_t size;
  607. /* This is the maximum size this packet may have */
  608. size_t max_size;
  609. /* The packet is destined for this transport address.
  610. * The function we finally use to pass down to the next lower
  611. * layer lives in the transport structure.
  612. */
  613. struct sctp_transport *transport;
  614. /* pointer to the auth chunk for this packet */
  615. struct sctp_chunk *auth;
  616. u8 has_cookie_echo:1, /* This packet contains a COOKIE-ECHO chunk. */
  617. has_sack:1, /* This packet contains a SACK chunk. */
  618. has_auth:1, /* This packet contains an AUTH chunk */
  619. has_data:1, /* This packet contains at least 1 DATA chunk */
  620. ipfragok:1; /* So let ip fragment this packet */
  621. };
  622. void sctp_packet_init(struct sctp_packet *, struct sctp_transport *,
  623. __u16 sport, __u16 dport);
  624. void sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
  625. enum sctp_xmit sctp_packet_transmit_chunk(struct sctp_packet *packet,
  626. struct sctp_chunk *chunk,
  627. int one_packet, gfp_t gfp);
  628. enum sctp_xmit sctp_packet_append_chunk(struct sctp_packet *packet,
  629. struct sctp_chunk *chunk);
  630. int sctp_packet_transmit(struct sctp_packet *, gfp_t);
  631. void sctp_packet_free(struct sctp_packet *);
  632. static inline int sctp_packet_empty(struct sctp_packet *packet)
  633. {
  634. return packet->size == packet->overhead;
  635. }
  636. /* This represents a remote transport address.
  637. * For local transport addresses, we just use union sctp_addr.
  638. *
  639. * RFC2960 Section 1.4 Key Terms
  640. *
  641. * o Transport address: A Transport Address is traditionally defined
  642. * by Network Layer address, Transport Layer protocol and Transport
  643. * Layer port number. In the case of SCTP running over IP, a
  644. * transport address is defined by the combination of an IP address
  645. * and an SCTP port number (where SCTP is the Transport protocol).
  646. *
  647. * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
  648. *
  649. * o The sender keeps a separate congestion control parameter set for
  650. * each of the destination addresses it can send to (not each
  651. * source-destination pair but for each destination). The parameters
  652. * should decay if the address is not used for a long enough time
  653. * period.
  654. *
  655. */
  656. struct sctp_transport {
  657. /* A list of transports. */
  658. struct list_head transports;
  659. struct rhlist_head node;
  660. /* Reference counting. */
  661. refcount_t refcnt;
  662. __u32 dead:1,
  663. /* RTO-Pending : A flag used to track if one of the DATA
  664. * chunks sent to this address is currently being
  665. * used to compute a RTT. If this flag is 0,
  666. * the next DATA chunk sent to this destination
  667. * should be used to compute a RTT and this flag
  668. * should be set. Every time the RTT
  669. * calculation completes (i.e. the DATA chunk
  670. * is SACK'd) clear this flag.
  671. */
  672. rto_pending:1,
  673. /*
  674. * hb_sent : a flag that signals that we have a pending
  675. * heartbeat.
  676. */
  677. hb_sent:1,
  678. /* Is the Path MTU update pending on this transport */
  679. pmtu_pending:1,
  680. dst_pending_confirm:1, /* need to confirm neighbour */
  681. /* Has this transport moved the ctsn since we last sacked */
  682. sack_generation:1;
  683. u32 dst_cookie;
  684. struct flowi fl;
  685. /* This is the peer's IP address and port. */
  686. union sctp_addr ipaddr;
  687. /* These are the functions we call to handle LLP stuff. */
  688. struct sctp_af *af_specific;
  689. /* Which association do we belong to? */
  690. struct sctp_association *asoc;
  691. /* RFC2960
  692. *
  693. * 12.3 Per Transport Address Data
  694. *
  695. * For each destination transport address in the peer's
  696. * address list derived from the INIT or INIT ACK chunk, a
  697. * number of data elements needs to be maintained including:
  698. */
  699. /* RTO : The current retransmission timeout value. */
  700. unsigned long rto;
  701. __u32 rtt; /* This is the most recent RTT. */
  702. /* RTTVAR : The current RTT variation. */
  703. __u32 rttvar;
  704. /* SRTT : The current smoothed round trip time. */
  705. __u32 srtt;
  706. /*
  707. * These are the congestion stats.
  708. */
  709. /* cwnd : The current congestion window. */
  710. __u32 cwnd; /* This is the actual cwnd. */
  711. /* ssthresh : The current slow start threshold value. */
  712. __u32 ssthresh;
  713. /* partial : The tracking method for increase of cwnd when in
  714. * bytes acked : congestion avoidance mode (see Section 6.2.2)
  715. */
  716. __u32 partial_bytes_acked;
  717. /* Data that has been sent, but not acknowledged. */
  718. __u32 flight_size;
  719. __u32 burst_limited; /* Holds old cwnd when max.burst is applied */
  720. /* Destination */
  721. struct dst_entry *dst;
  722. /* Source address. */
  723. union sctp_addr saddr;
  724. /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
  725. * the destination address every heartbeat interval.
  726. */
  727. unsigned long hbinterval;
  728. unsigned long probe_interval;
  729. /* SACK delay timeout */
  730. unsigned long sackdelay;
  731. __u32 sackfreq;
  732. atomic_t mtu_info;
  733. /* When was the last time that we heard from this transport? We use
  734. * this to pick new active and retran paths.
  735. */
  736. ktime_t last_time_heard;
  737. /* When was the last time that we sent a chunk using this
  738. * transport? We use this to check for idle transports
  739. */
  740. unsigned long last_time_sent;
  741. /* Last time(in jiffies) when cwnd is reduced due to the congestion
  742. * indication based on ECNE chunk.
  743. */
  744. unsigned long last_time_ecne_reduced;
  745. __be16 encap_port;
  746. /* This is the max_retrans value for the transport and will
  747. * be initialized from the assocs value. This can be changed
  748. * using the SCTP_SET_PEER_ADDR_PARAMS socket option.
  749. */
  750. __u16 pathmaxrxt;
  751. __u32 flowlabel;
  752. __u8 dscp;
  753. /* This is the partially failed retrans value for the transport
  754. * and will be initialized from the assocs value. This can be changed
  755. * using the SCTP_PEER_ADDR_THLDS socket option
  756. */
  757. __u16 pf_retrans;
  758. /* Used for primary path switchover. */
  759. __u16 ps_retrans;
  760. /* PMTU : The current known path MTU. */
  761. __u32 pathmtu;
  762. /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
  763. __u32 param_flags;
  764. /* The number of times INIT has been sent on this transport. */
  765. int init_sent_count;
  766. /* state : The current state of this destination,
  767. * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKNOWN.
  768. */
  769. int state;
  770. /* These are the error stats for this destination. */
  771. /* Error count : The current error count for this destination. */
  772. unsigned short error_count;
  773. /* Per : A timer used by each destination.
  774. * Destination :
  775. * Timer :
  776. *
  777. * [Everywhere else in the text this is called T3-rtx. -ed]
  778. */
  779. struct timer_list T3_rtx_timer;
  780. /* Heartbeat timer is per destination. */
  781. struct timer_list hb_timer;
  782. /* Timer to handle ICMP proto unreachable envets */
  783. struct timer_list proto_unreach_timer;
  784. /* Timer to handler reconf chunk rtx */
  785. struct timer_list reconf_timer;
  786. /* Timer to send a probe HB packet for PLPMTUD */
  787. struct timer_list probe_timer;
  788. /* Since we're using per-destination retransmission timers
  789. * (see above), we're also using per-destination "transmitted"
  790. * queues. This probably ought to be a private struct
  791. * accessible only within the outqueue, but it's not, yet.
  792. */
  793. struct list_head transmitted;
  794. /* We build bundle-able packets for this transport here. */
  795. struct sctp_packet packet;
  796. /* This is the list of transports that have chunks to send. */
  797. struct list_head send_ready;
  798. /* State information saved for SFR_CACC algorithm. The key
  799. * idea in SFR_CACC is to maintain state at the sender on a
  800. * per-destination basis when a changeover happens.
  801. * char changeover_active;
  802. * char cycling_changeover;
  803. * __u32 next_tsn_at_change;
  804. * char cacc_saw_newack;
  805. */
  806. struct {
  807. /* An unsigned integer, which stores the next TSN to be
  808. * used by the sender, at the moment of changeover.
  809. */
  810. __u32 next_tsn_at_change;
  811. /* A flag which indicates the occurrence of a changeover */
  812. char changeover_active;
  813. /* A flag which indicates whether the change of primary is
  814. * the first switch to this destination address during an
  815. * active switch.
  816. */
  817. char cycling_changeover;
  818. /* A temporary flag, which is used during the processing of
  819. * a SACK to estimate the causative TSN(s)'s group.
  820. */
  821. char cacc_saw_newack;
  822. } cacc;
  823. struct {
  824. __u16 pmtu;
  825. __u16 probe_size;
  826. __u16 probe_high;
  827. __u8 probe_count;
  828. __u8 state;
  829. } pl; /* plpmtud related */
  830. /* 64-bit random number sent with heartbeat. */
  831. __u64 hb_nonce;
  832. struct rcu_head rcu;
  833. };
  834. struct sctp_transport *sctp_transport_new(struct net *, const union sctp_addr *,
  835. gfp_t);
  836. void sctp_transport_set_owner(struct sctp_transport *,
  837. struct sctp_association *);
  838. void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
  839. struct sctp_sock *);
  840. void sctp_transport_pmtu(struct sctp_transport *, struct sock *sk);
  841. void sctp_transport_free(struct sctp_transport *);
  842. void sctp_transport_reset_t3_rtx(struct sctp_transport *);
  843. void sctp_transport_reset_hb_timer(struct sctp_transport *);
  844. void sctp_transport_reset_reconf_timer(struct sctp_transport *transport);
  845. void sctp_transport_reset_probe_timer(struct sctp_transport *transport);
  846. void sctp_transport_reset_raise_timer(struct sctp_transport *transport);
  847. int sctp_transport_hold(struct sctp_transport *);
  848. void sctp_transport_put(struct sctp_transport *);
  849. void sctp_transport_update_rto(struct sctp_transport *, __u32);
  850. void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
  851. void sctp_transport_lower_cwnd(struct sctp_transport *t,
  852. enum sctp_lower_cwnd reason);
  853. void sctp_transport_burst_limited(struct sctp_transport *);
  854. void sctp_transport_burst_reset(struct sctp_transport *);
  855. unsigned long sctp_transport_timeout(struct sctp_transport *);
  856. void sctp_transport_reset(struct sctp_transport *t);
  857. bool sctp_transport_update_pmtu(struct sctp_transport *t, u32 pmtu);
  858. void sctp_transport_immediate_rtx(struct sctp_transport *);
  859. void sctp_transport_dst_release(struct sctp_transport *t);
  860. void sctp_transport_dst_confirm(struct sctp_transport *t);
  861. void sctp_transport_pl_send(struct sctp_transport *t);
  862. bool sctp_transport_pl_recv(struct sctp_transport *t);
  863. /* This is the structure we use to queue packets as they come into
  864. * SCTP. We write packets to it and read chunks from it.
  865. */
  866. struct sctp_inq {
  867. /* This is actually a queue of sctp_chunk each
  868. * containing a partially decoded packet.
  869. */
  870. struct list_head in_chunk_list;
  871. /* This is the packet which is currently off the in queue and is
  872. * being worked on through the inbound chunk processing.
  873. */
  874. struct sctp_chunk *in_progress;
  875. /* This is the delayed task to finish delivering inbound
  876. * messages.
  877. */
  878. struct work_struct immediate;
  879. };
  880. void sctp_inq_init(struct sctp_inq *);
  881. void sctp_inq_free(struct sctp_inq *);
  882. void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
  883. struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
  884. struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
  885. void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
  886. /* This is the structure we use to hold outbound chunks. You push
  887. * chunks in and they automatically pop out the other end as bundled
  888. * packets (it calls (*output_handler)()).
  889. *
  890. * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
  891. * and 8.2 of the v13 draft.
  892. *
  893. * It handles retransmissions. The connection to the timeout portion
  894. * of the state machine is through sctp_..._timeout() and timeout_handler.
  895. *
  896. * If you feed it SACKs, it will eat them.
  897. *
  898. * If you give it big chunks, it will fragment them.
  899. *
  900. * It assigns TSN's to data chunks. This happens at the last possible
  901. * instant before transmission.
  902. *
  903. * When free()'d, it empties itself out via output_handler().
  904. */
  905. struct sctp_outq {
  906. struct sctp_association *asoc;
  907. /* Data pending that has never been transmitted. */
  908. struct list_head out_chunk_list;
  909. /* Stream scheduler being used */
  910. struct sctp_sched_ops *sched;
  911. unsigned int out_qlen; /* Total length of queued data chunks. */
  912. /* Error of send failed, may used in SCTP_SEND_FAILED event. */
  913. unsigned int error;
  914. /* These are control chunks we want to send. */
  915. struct list_head control_chunk_list;
  916. /* These are chunks that have been sacked but are above the
  917. * CTSN, or cumulative tsn ack point.
  918. */
  919. struct list_head sacked;
  920. /* Put chunks on this list to schedule them for
  921. * retransmission.
  922. */
  923. struct list_head retransmit;
  924. /* Put chunks on this list to save them for FWD TSN processing as
  925. * they were abandoned.
  926. */
  927. struct list_head abandoned;
  928. /* How many unackd bytes do we have in-flight? */
  929. __u32 outstanding_bytes;
  930. /* Are we doing fast-rtx on this queue */
  931. char fast_rtx;
  932. /* Corked? */
  933. char cork;
  934. };
  935. void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
  936. void sctp_outq_teardown(struct sctp_outq *);
  937. void sctp_outq_free(struct sctp_outq*);
  938. void sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk, gfp_t);
  939. int sctp_outq_sack(struct sctp_outq *, struct sctp_chunk *);
  940. int sctp_outq_is_empty(const struct sctp_outq *);
  941. void sctp_retransmit(struct sctp_outq *q, struct sctp_transport *transport,
  942. enum sctp_retransmit_reason reason);
  943. void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
  944. void sctp_outq_uncork(struct sctp_outq *, gfp_t gfp);
  945. void sctp_prsctp_prune(struct sctp_association *asoc,
  946. struct sctp_sndrcvinfo *sinfo, int msg_len);
  947. void sctp_generate_fwdtsn(struct sctp_outq *q, __u32 sack_ctsn);
  948. /* Uncork and flush an outqueue. */
  949. static inline void sctp_outq_cork(struct sctp_outq *q)
  950. {
  951. q->cork = 1;
  952. }
  953. /* SCTP skb control block.
  954. * sctp_input_cb is currently used on rx and sock rx queue
  955. */
  956. struct sctp_input_cb {
  957. union {
  958. struct inet_skb_parm h4;
  959. #if IS_ENABLED(CONFIG_IPV6)
  960. struct inet6_skb_parm h6;
  961. #endif
  962. } header;
  963. struct sctp_chunk *chunk;
  964. struct sctp_af *af;
  965. __be16 encap_port;
  966. };
  967. #define SCTP_INPUT_CB(__skb) ((struct sctp_input_cb *)&((__skb)->cb[0]))
  968. struct sctp_output_cb {
  969. struct sk_buff *last;
  970. };
  971. #define SCTP_OUTPUT_CB(__skb) ((struct sctp_output_cb *)&((__skb)->cb[0]))
  972. static inline const struct sk_buff *sctp_gso_headskb(const struct sk_buff *skb)
  973. {
  974. const struct sctp_chunk *chunk = SCTP_INPUT_CB(skb)->chunk;
  975. return chunk->head_skb ? : skb;
  976. }
  977. /* These bind address data fields common between endpoints and associations */
  978. struct sctp_bind_addr {
  979. /* RFC 2960 12.1 Parameters necessary for the SCTP instance
  980. *
  981. * SCTP Port: The local SCTP port number the endpoint is
  982. * bound to.
  983. */
  984. __u16 port;
  985. /* RFC 2960 12.1 Parameters necessary for the SCTP instance
  986. *
  987. * Address List: The list of IP addresses that this instance
  988. * has bound. This information is passed to one's
  989. * peer(s) in INIT and INIT ACK chunks.
  990. */
  991. struct list_head address_list;
  992. };
  993. void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
  994. void sctp_bind_addr_free(struct sctp_bind_addr *);
  995. int sctp_bind_addr_copy(struct net *net, struct sctp_bind_addr *dest,
  996. const struct sctp_bind_addr *src,
  997. enum sctp_scope scope, gfp_t gfp,
  998. int flags);
  999. int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
  1000. const struct sctp_bind_addr *src,
  1001. gfp_t gfp);
  1002. int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
  1003. int new_size, __u8 addr_state, gfp_t gfp);
  1004. int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
  1005. int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
  1006. struct sctp_sock *);
  1007. int sctp_bind_addr_conflict(struct sctp_bind_addr *, const union sctp_addr *,
  1008. struct sctp_sock *, struct sctp_sock *);
  1009. int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
  1010. const union sctp_addr *addr);
  1011. int sctp_bind_addrs_check(struct sctp_sock *sp,
  1012. struct sctp_sock *sp2, int cnt2);
  1013. union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
  1014. const union sctp_addr *addrs,
  1015. int addrcnt,
  1016. struct sctp_sock *opt);
  1017. union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
  1018. int *addrs_len,
  1019. gfp_t gfp);
  1020. int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
  1021. __u16 port, gfp_t gfp);
  1022. enum sctp_scope sctp_scope(const union sctp_addr *addr);
  1023. int sctp_in_scope(struct net *net, const union sctp_addr *addr,
  1024. const enum sctp_scope scope);
  1025. int sctp_is_any(struct sock *sk, const union sctp_addr *addr);
  1026. int sctp_is_ep_boundall(struct sock *sk);
  1027. /* What type of endpoint? */
  1028. enum sctp_endpoint_type {
  1029. SCTP_EP_TYPE_SOCKET,
  1030. SCTP_EP_TYPE_ASSOCIATION,
  1031. };
  1032. /*
  1033. * A common base class to bridge the implementation view of a
  1034. * socket (usually listening) endpoint versus an association's
  1035. * local endpoint.
  1036. * This common structure is useful for several purposes:
  1037. * 1) Common interface for lookup routines.
  1038. * a) Subfunctions work for either endpoint or association
  1039. * b) Single interface to lookup allows hiding the lookup lock rather
  1040. * than acquiring it externally.
  1041. * 2) Common interface for the inbound chunk handling/state machine.
  1042. * 3) Common object handling routines for reference counting, etc.
  1043. * 4) Disentangle association lookup from endpoint lookup, where we
  1044. * do not have to find our endpoint to find our association.
  1045. *
  1046. */
  1047. struct sctp_ep_common {
  1048. /* Runtime type information. What kind of endpoint is this? */
  1049. enum sctp_endpoint_type type;
  1050. /* Some fields to help us manage this object.
  1051. * refcnt - Reference count access to this object.
  1052. * dead - Do not attempt to use this object.
  1053. */
  1054. refcount_t refcnt;
  1055. bool dead;
  1056. /* What socket does this endpoint belong to? */
  1057. struct sock *sk;
  1058. /* Cache netns and it won't change once set */
  1059. struct net *net;
  1060. /* This is where we receive inbound chunks. */
  1061. struct sctp_inq inqueue;
  1062. /* This substructure includes the defining parameters of the
  1063. * endpoint:
  1064. * bind_addr.port is our shared port number.
  1065. * bind_addr.address_list is our set of local IP addresses.
  1066. */
  1067. struct sctp_bind_addr bind_addr;
  1068. };
  1069. /* RFC Section 1.4 Key Terms
  1070. *
  1071. * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
  1072. * multi-homed host, an SCTP endpoint is represented to its peers as a
  1073. * combination of a set of eligible destination transport addresses to
  1074. * which SCTP packets can be sent and a set of eligible source
  1075. * transport addresses from which SCTP packets can be received.
  1076. * All transport addresses used by an SCTP endpoint must use the
  1077. * same port number, but can use multiple IP addresses. A transport
  1078. * address used by an SCTP endpoint must not be used by another
  1079. * SCTP endpoint. In other words, a transport address is unique
  1080. * to an SCTP endpoint.
  1081. *
  1082. * From an implementation perspective, each socket has one of these.
  1083. * A TCP-style socket will have exactly one association on one of
  1084. * these. An UDP-style socket will have multiple associations hanging
  1085. * off one of these.
  1086. */
  1087. struct sctp_endpoint {
  1088. /* Common substructure for endpoint and association. */
  1089. struct sctp_ep_common base;
  1090. /* Fields to help us manage our entries in the hash tables. */
  1091. struct hlist_node node;
  1092. int hashent;
  1093. /* Associations: A list of current associations and mappings
  1094. * to the data consumers for each association. This
  1095. * may be in the form of a hash table or other
  1096. * implementation dependent structure. The data
  1097. * consumers may be process identification
  1098. * information such as file descriptors, named pipe
  1099. * pointer, or table pointers dependent on how SCTP
  1100. * is implemented.
  1101. */
  1102. /* This is really a list of struct sctp_association entries. */
  1103. struct list_head asocs;
  1104. /* Secret Key: A secret key used by this endpoint to compute
  1105. * the MAC. This SHOULD be a cryptographic quality
  1106. * random number with a sufficient length.
  1107. * Discussion in [RFC1750] can be helpful in
  1108. * selection of the key.
  1109. */
  1110. __u8 secret_key[SCTP_SECRET_SIZE];
  1111. /* digest: This is a digest of the sctp cookie. This field is
  1112. * only used on the receive path when we try to validate
  1113. * that the cookie has not been tampered with. We put
  1114. * this here so we pre-allocate this once and can re-use
  1115. * on every receive.
  1116. */
  1117. __u8 *digest;
  1118. /* sendbuf acct. policy. */
  1119. __u32 sndbuf_policy;
  1120. /* rcvbuf acct. policy. */
  1121. __u32 rcvbuf_policy;
  1122. /* SCTP AUTH: array of the HMACs that will be allocated
  1123. * we need this per association so that we don't serialize
  1124. */
  1125. struct crypto_shash **auth_hmacs;
  1126. /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
  1127. struct sctp_hmac_algo_param *auth_hmacs_list;
  1128. /* SCTP-AUTH: chunks to authenticate encoded into parameter */
  1129. struct sctp_chunks_param *auth_chunk_list;
  1130. /* SCTP-AUTH: endpoint shared keys */
  1131. struct list_head endpoint_shared_keys;
  1132. __u16 active_key_id;
  1133. __u8 ecn_enable:1,
  1134. auth_enable:1,
  1135. intl_enable:1,
  1136. prsctp_enable:1,
  1137. asconf_enable:1,
  1138. reconf_enable:1;
  1139. __u8 strreset_enable;
  1140. struct rcu_head rcu;
  1141. };
  1142. /* Recover the outer endpoint structure. */
  1143. static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
  1144. {
  1145. struct sctp_endpoint *ep;
  1146. ep = container_of(base, struct sctp_endpoint, base);
  1147. return ep;
  1148. }
  1149. /* These are function signatures for manipulating endpoints. */
  1150. struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
  1151. void sctp_endpoint_free(struct sctp_endpoint *);
  1152. void sctp_endpoint_put(struct sctp_endpoint *);
  1153. int sctp_endpoint_hold(struct sctp_endpoint *ep);
  1154. void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
  1155. struct sctp_association *sctp_endpoint_lookup_assoc(
  1156. const struct sctp_endpoint *ep,
  1157. const union sctp_addr *paddr,
  1158. struct sctp_transport **);
  1159. bool sctp_endpoint_is_peeled_off(struct sctp_endpoint *ep,
  1160. const union sctp_addr *paddr);
  1161. struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *ep,
  1162. struct net *net,
  1163. const union sctp_addr *laddr,
  1164. int dif, int sdif);
  1165. bool sctp_has_association(struct net *net, const union sctp_addr *laddr,
  1166. const union sctp_addr *paddr, int dif, int sdif);
  1167. int sctp_verify_init(struct net *net, const struct sctp_endpoint *ep,
  1168. const struct sctp_association *asoc,
  1169. enum sctp_cid cid, struct sctp_init_chunk *peer_init,
  1170. struct sctp_chunk *chunk, struct sctp_chunk **err_chunk);
  1171. int sctp_process_init(struct sctp_association *, struct sctp_chunk *chunk,
  1172. const union sctp_addr *peer,
  1173. struct sctp_init_chunk *init, gfp_t gfp);
  1174. __u32 sctp_generate_tag(const struct sctp_endpoint *);
  1175. __u32 sctp_generate_tsn(const struct sctp_endpoint *);
  1176. struct sctp_inithdr_host {
  1177. __u32 init_tag;
  1178. __u32 a_rwnd;
  1179. __u16 num_outbound_streams;
  1180. __u16 num_inbound_streams;
  1181. __u32 initial_tsn;
  1182. };
  1183. struct sctp_stream_priorities {
  1184. /* List of priorities scheduled */
  1185. struct list_head prio_sched;
  1186. /* List of streams scheduled */
  1187. struct list_head active;
  1188. /* The next stream in line */
  1189. struct sctp_stream_out_ext *next;
  1190. __u16 prio;
  1191. __u16 users;
  1192. };
  1193. struct sctp_stream_out_ext {
  1194. __u64 abandoned_unsent[SCTP_PR_INDEX(MAX) + 1];
  1195. __u64 abandoned_sent[SCTP_PR_INDEX(MAX) + 1];
  1196. struct list_head outq; /* chunks enqueued by this stream */
  1197. union {
  1198. struct {
  1199. /* Scheduled streams list */
  1200. struct list_head prio_list;
  1201. struct sctp_stream_priorities *prio_head;
  1202. };
  1203. /* Fields used by RR scheduler */
  1204. struct {
  1205. struct list_head rr_list;
  1206. };
  1207. struct {
  1208. struct list_head fc_list;
  1209. __u32 fc_length;
  1210. __u16 fc_weight;
  1211. };
  1212. };
  1213. };
  1214. struct sctp_stream_out {
  1215. union {
  1216. __u32 mid;
  1217. __u16 ssn;
  1218. };
  1219. __u32 mid_uo;
  1220. struct sctp_stream_out_ext *ext;
  1221. __u8 state;
  1222. };
  1223. struct sctp_stream_in {
  1224. union {
  1225. __u32 mid;
  1226. __u16 ssn;
  1227. };
  1228. __u32 mid_uo;
  1229. __u32 fsn;
  1230. __u32 fsn_uo;
  1231. char pd_mode;
  1232. char pd_mode_uo;
  1233. };
  1234. struct sctp_stream {
  1235. GENRADIX(struct sctp_stream_out) out;
  1236. GENRADIX(struct sctp_stream_in) in;
  1237. __u16 outcnt;
  1238. __u16 incnt;
  1239. /* Current stream being sent, if any */
  1240. struct sctp_stream_out *out_curr;
  1241. union {
  1242. /* Fields used by priority scheduler */
  1243. struct {
  1244. /* List of priorities scheduled */
  1245. struct list_head prio_list;
  1246. };
  1247. /* Fields used by RR scheduler */
  1248. struct {
  1249. /* List of streams scheduled */
  1250. struct list_head rr_list;
  1251. /* The next stream in line */
  1252. struct sctp_stream_out_ext *rr_next;
  1253. };
  1254. struct {
  1255. struct list_head fc_list;
  1256. };
  1257. };
  1258. struct sctp_stream_interleave *si;
  1259. };
  1260. static inline struct sctp_stream_out *sctp_stream_out(
  1261. struct sctp_stream *stream,
  1262. __u16 sid)
  1263. {
  1264. return genradix_ptr(&stream->out, sid);
  1265. }
  1266. static inline struct sctp_stream_in *sctp_stream_in(
  1267. struct sctp_stream *stream,
  1268. __u16 sid)
  1269. {
  1270. return genradix_ptr(&stream->in, sid);
  1271. }
  1272. #define SCTP_SO(s, i) sctp_stream_out((s), (i))
  1273. #define SCTP_SI(s, i) sctp_stream_in((s), (i))
  1274. #define SCTP_STREAM_CLOSED 0x00
  1275. #define SCTP_STREAM_OPEN 0x01
  1276. static inline __u16 sctp_datachk_len(const struct sctp_stream *stream)
  1277. {
  1278. return stream->si->data_chunk_len;
  1279. }
  1280. static inline __u16 sctp_datahdr_len(const struct sctp_stream *stream)
  1281. {
  1282. return stream->si->data_chunk_len - sizeof(struct sctp_chunkhdr);
  1283. }
  1284. static inline __u16 sctp_ftsnchk_len(const struct sctp_stream *stream)
  1285. {
  1286. return stream->si->ftsn_chunk_len;
  1287. }
  1288. static inline __u16 sctp_ftsnhdr_len(const struct sctp_stream *stream)
  1289. {
  1290. return stream->si->ftsn_chunk_len - sizeof(struct sctp_chunkhdr);
  1291. }
  1292. /* SCTP_GET_ASSOC_STATS counters */
  1293. struct sctp_priv_assoc_stats {
  1294. /* Maximum observed rto in the association during subsequent
  1295. * observations. Value is set to 0 if no RTO measurement took place
  1296. * The transport where the max_rto was observed is returned in
  1297. * obs_rto_ipaddr
  1298. */
  1299. struct sockaddr_storage obs_rto_ipaddr;
  1300. __u64 max_obs_rto;
  1301. /* Total In and Out SACKs received and sent */
  1302. __u64 isacks;
  1303. __u64 osacks;
  1304. /* Total In and Out packets received and sent */
  1305. __u64 opackets;
  1306. __u64 ipackets;
  1307. /* Total retransmitted chunks */
  1308. __u64 rtxchunks;
  1309. /* TSN received > next expected */
  1310. __u64 outofseqtsns;
  1311. /* Duplicate Chunks received */
  1312. __u64 idupchunks;
  1313. /* Gap Ack Blocks received */
  1314. __u64 gapcnt;
  1315. /* Unordered data chunks sent and received */
  1316. __u64 ouodchunks;
  1317. __u64 iuodchunks;
  1318. /* Ordered data chunks sent and received */
  1319. __u64 oodchunks;
  1320. __u64 iodchunks;
  1321. /* Control chunks sent and received */
  1322. __u64 octrlchunks;
  1323. __u64 ictrlchunks;
  1324. };
  1325. /* RFC2960
  1326. *
  1327. * 12. Recommended Transmission Control Block (TCB) Parameters
  1328. *
  1329. * This section details a recommended set of parameters that should
  1330. * be contained within the TCB for an implementation. This section is
  1331. * for illustrative purposes and should not be deemed as requirements
  1332. * on an implementation or as an exhaustive list of all parameters
  1333. * inside an SCTP TCB. Each implementation may need its own additional
  1334. * parameters for optimization.
  1335. */
  1336. /* Here we have information about each individual association. */
  1337. struct sctp_association {
  1338. /* A base structure common to endpoint and association.
  1339. * In this context, it represents the associations's view
  1340. * of the local endpoint of the association.
  1341. */
  1342. struct sctp_ep_common base;
  1343. /* Associations on the same socket. */
  1344. struct list_head asocs;
  1345. /* association id. */
  1346. sctp_assoc_t assoc_id;
  1347. /* This is our parent endpoint. */
  1348. struct sctp_endpoint *ep;
  1349. /* These are those association elements needed in the cookie. */
  1350. struct sctp_cookie c;
  1351. /* This is all information about our peer. */
  1352. struct {
  1353. /* transport_addr_list
  1354. *
  1355. * Peer : A list of SCTP transport addresses that the
  1356. * Transport : peer is bound to. This information is derived
  1357. * Address : from the INIT or INIT ACK and is used to
  1358. * List : associate an inbound packet with a given
  1359. * : association. Normally this information is
  1360. * : hashed or keyed for quick lookup and access
  1361. * : of the TCB.
  1362. * : The list is also initialized with the list
  1363. * : of addresses passed with the sctp_connectx()
  1364. * : call.
  1365. *
  1366. * It is a list of SCTP_transport's.
  1367. */
  1368. struct list_head transport_addr_list;
  1369. /* rwnd
  1370. *
  1371. * Peer Rwnd : Current calculated value of the peer's rwnd.
  1372. */
  1373. __u32 rwnd;
  1374. /* transport_count
  1375. *
  1376. * Peer : A count of the number of peer addresses
  1377. * Transport : in the Peer Transport Address List.
  1378. * Address :
  1379. * Count :
  1380. */
  1381. __u16 transport_count;
  1382. /* port
  1383. * The transport layer port number.
  1384. */
  1385. __u16 port;
  1386. /* primary_path
  1387. *
  1388. * Primary : This is the current primary destination
  1389. * Path : transport address of the peer endpoint. It
  1390. * : may also specify a source transport address
  1391. * : on this endpoint.
  1392. *
  1393. * All of these paths live on transport_addr_list.
  1394. *
  1395. * At the bakeoffs, we discovered that the intent of
  1396. * primaryPath is that it only changes when the ULP
  1397. * asks to have it changed. We add the activePath to
  1398. * designate the connection we are currently using to
  1399. * transmit new data and most control chunks.
  1400. */
  1401. struct sctp_transport *primary_path;
  1402. /* Cache the primary path address here, when we
  1403. * need a an address for msg_name.
  1404. */
  1405. union sctp_addr primary_addr;
  1406. /* active_path
  1407. * The path that we are currently using to
  1408. * transmit new data and most control chunks.
  1409. */
  1410. struct sctp_transport *active_path;
  1411. /* retran_path
  1412. *
  1413. * RFC2960 6.4 Multi-homed SCTP Endpoints
  1414. * ...
  1415. * Furthermore, when its peer is multi-homed, an
  1416. * endpoint SHOULD try to retransmit a chunk to an
  1417. * active destination transport address that is
  1418. * different from the last destination address to
  1419. * which the DATA chunk was sent.
  1420. */
  1421. struct sctp_transport *retran_path;
  1422. /* Pointer to last transport I have sent on. */
  1423. struct sctp_transport *last_sent_to;
  1424. /* This is the last transport I have received DATA on. */
  1425. struct sctp_transport *last_data_from;
  1426. /*
  1427. * Mapping An array of bits or bytes indicating which out of
  1428. * Array order TSN's have been received (relative to the
  1429. * Last Rcvd TSN). If no gaps exist, i.e. no out of
  1430. * order packets have been received, this array
  1431. * will be set to all zero. This structure may be
  1432. * in the form of a circular buffer or bit array.
  1433. *
  1434. * Last Rcvd : This is the last TSN received in
  1435. * TSN : sequence. This value is set initially by
  1436. * : taking the peer's Initial TSN, received in
  1437. * : the INIT or INIT ACK chunk, and subtracting
  1438. * : one from it.
  1439. *
  1440. * Throughout most of the specification this is called the
  1441. * "Cumulative TSN ACK Point". In this case, we
  1442. * ignore the advice in 12.2 in favour of the term
  1443. * used in the bulk of the text. This value is hidden
  1444. * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
  1445. */
  1446. struct sctp_tsnmap tsn_map;
  1447. /* This mask is used to disable sending the ASCONF chunk
  1448. * with specified parameter to peer.
  1449. */
  1450. __be16 addip_disabled_mask;
  1451. /* These are capabilities which our peer advertised. */
  1452. __u16 ecn_capable:1, /* Can peer do ECN? */
  1453. ipv4_address:1, /* Peer understands IPv4 addresses? */
  1454. ipv6_address:1, /* Peer understands IPv6 addresses? */
  1455. asconf_capable:1, /* Does peer support ADDIP? */
  1456. prsctp_capable:1, /* Can peer do PR-SCTP? */
  1457. reconf_capable:1, /* Can peer do RE-CONFIG? */
  1458. intl_capable:1, /* Can peer do INTERLEAVE */
  1459. auth_capable:1, /* Is peer doing SCTP-AUTH? */
  1460. /* sack_needed:
  1461. * This flag indicates if the next received
  1462. * packet is to be responded to with a
  1463. * SACK. This is initialized to 0. When a packet
  1464. * is received sack_cnt is incremented. If this value
  1465. * reaches 2 or more, a SACK is sent and the
  1466. * value is reset to 0. Note: This is used only
  1467. * when no DATA chunks are received out of
  1468. * order. When DATA chunks are out of order,
  1469. * SACK's are not delayed (see Section 6).
  1470. */
  1471. sack_needed:1, /* Do we need to sack the peer? */
  1472. sack_generation:1,
  1473. zero_window_announced:1;
  1474. __u32 sack_cnt;
  1475. __u32 adaptation_ind; /* Adaptation Code point. */
  1476. struct sctp_inithdr_host i;
  1477. void *cookie;
  1478. int cookie_len;
  1479. /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
  1480. * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
  1481. * Initial TSN Value minus 1
  1482. */
  1483. __u32 addip_serial;
  1484. /* SCTP-AUTH: We need to know pears random number, hmac list
  1485. * and authenticated chunk list. All that is part of the
  1486. * cookie and these are just pointers to those locations
  1487. */
  1488. struct sctp_random_param *peer_random;
  1489. struct sctp_chunks_param *peer_chunks;
  1490. struct sctp_hmac_algo_param *peer_hmacs;
  1491. } peer;
  1492. /* State : A state variable indicating what state the
  1493. * : association is in, i.e. COOKIE-WAIT,
  1494. * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
  1495. * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
  1496. *
  1497. * Note: No "CLOSED" state is illustrated since if a
  1498. * association is "CLOSED" its TCB SHOULD be removed.
  1499. *
  1500. * In this implementation we DO have a CLOSED
  1501. * state which is used during initiation and shutdown.
  1502. *
  1503. * State takes values from SCTP_STATE_*.
  1504. */
  1505. enum sctp_state state;
  1506. /* Overall : The overall association error count.
  1507. * Error Count : [Clear this any time I get something.]
  1508. */
  1509. int overall_error_count;
  1510. /* The cookie life I award for any cookie. */
  1511. ktime_t cookie_life;
  1512. /* These are the association's initial, max, and min RTO values.
  1513. * These values will be initialized by system defaults, but can
  1514. * be modified via the SCTP_RTOINFO socket option.
  1515. */
  1516. unsigned long rto_initial;
  1517. unsigned long rto_max;
  1518. unsigned long rto_min;
  1519. /* Maximum number of new data packets that can be sent in a burst. */
  1520. int max_burst;
  1521. /* This is the max_retrans value for the association. This value will
  1522. * be initialized from system defaults, but can be
  1523. * modified by the SCTP_ASSOCINFO socket option.
  1524. */
  1525. int max_retrans;
  1526. /* This is the partially failed retrans value for the transport
  1527. * and will be initialized from the assocs value. This can be
  1528. * changed using the SCTP_PEER_ADDR_THLDS socket option
  1529. */
  1530. __u16 pf_retrans;
  1531. /* Used for primary path switchover. */
  1532. __u16 ps_retrans;
  1533. /* Maximum number of times the endpoint will retransmit INIT */
  1534. __u16 max_init_attempts;
  1535. /* How many times have we resent an INIT? */
  1536. __u16 init_retries;
  1537. /* The largest timeout or RTO value to use in attempting an INIT */
  1538. unsigned long max_init_timeo;
  1539. /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
  1540. * the destination address every heartbeat interval. This value
  1541. * will be inherited by all new transports.
  1542. */
  1543. unsigned long hbinterval;
  1544. unsigned long probe_interval;
  1545. __be16 encap_port;
  1546. /* This is the max_retrans value for new transports in the
  1547. * association.
  1548. */
  1549. __u16 pathmaxrxt;
  1550. __u32 flowlabel;
  1551. __u8 dscp;
  1552. /* Flag that path mtu update is pending */
  1553. __u8 pmtu_pending;
  1554. /* Association : The smallest PMTU discovered for all of the
  1555. * PMTU : peer's transport addresses.
  1556. */
  1557. __u32 pathmtu;
  1558. /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
  1559. __u32 param_flags;
  1560. __u32 sackfreq;
  1561. /* SACK delay timeout */
  1562. unsigned long sackdelay;
  1563. unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
  1564. struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
  1565. /* Transport to which SHUTDOWN chunk was last sent. */
  1566. struct sctp_transport *shutdown_last_sent_to;
  1567. /* Transport to which INIT chunk was last sent. */
  1568. struct sctp_transport *init_last_sent_to;
  1569. /* How many times have we resent a SHUTDOWN */
  1570. int shutdown_retries;
  1571. /* Next TSN : The next TSN number to be assigned to a new
  1572. * : DATA chunk. This is sent in the INIT or INIT
  1573. * : ACK chunk to the peer and incremented each
  1574. * : time a DATA chunk is assigned a TSN
  1575. * : (normally just prior to transmit or during
  1576. * : fragmentation).
  1577. */
  1578. __u32 next_tsn;
  1579. /*
  1580. * Last Rcvd : This is the last TSN received in sequence. This value
  1581. * TSN : is set initially by taking the peer's Initial TSN,
  1582. * : received in the INIT or INIT ACK chunk, and
  1583. * : subtracting one from it.
  1584. *
  1585. * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
  1586. */
  1587. __u32 ctsn_ack_point;
  1588. /* PR-SCTP Advanced.Peer.Ack.Point */
  1589. __u32 adv_peer_ack_point;
  1590. /* Highest TSN that is acknowledged by incoming SACKs. */
  1591. __u32 highest_sacked;
  1592. /* TSN marking the fast recovery exit point */
  1593. __u32 fast_recovery_exit;
  1594. /* Flag to track the current fast recovery state */
  1595. __u8 fast_recovery;
  1596. /* The number of unacknowledged data chunks. Reported through
  1597. * the SCTP_STATUS sockopt.
  1598. */
  1599. __u16 unack_data;
  1600. /* The total number of data chunks that we've had to retransmit
  1601. * as the result of a T3 timer expiration
  1602. */
  1603. __u32 rtx_data_chunks;
  1604. /* This is the association's receive buffer space. This value is used
  1605. * to set a_rwnd field in an INIT or a SACK chunk.
  1606. */
  1607. __u32 rwnd;
  1608. /* This is the last advertised value of rwnd over a SACK chunk. */
  1609. __u32 a_rwnd;
  1610. /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
  1611. * to slop over a maximum of the association's frag_point.
  1612. */
  1613. __u32 rwnd_over;
  1614. /* Keeps treack of rwnd pressure. This happens when we have
  1615. * a window, but not receive buffer (i.e small packets). This one
  1616. * is releases slowly (1 PMTU at a time ).
  1617. */
  1618. __u32 rwnd_press;
  1619. /* This is the sndbuf size in use for the association.
  1620. * This corresponds to the sndbuf size for the association,
  1621. * as specified in the sk->sndbuf.
  1622. */
  1623. int sndbuf_used;
  1624. /* This is the amount of memory that this association has allocated
  1625. * in the receive path at any given time.
  1626. */
  1627. atomic_t rmem_alloc;
  1628. /* This is the wait queue head for send requests waiting on
  1629. * the association sndbuf space.
  1630. */
  1631. wait_queue_head_t wait;
  1632. /* The message size at which SCTP fragmentation will occur. */
  1633. __u32 frag_point;
  1634. __u32 user_frag;
  1635. /* Counter used to count INIT errors. */
  1636. int init_err_counter;
  1637. /* Count the number of INIT cycles (for doubling timeout). */
  1638. int init_cycle;
  1639. /* Default send parameters. */
  1640. __u16 default_stream;
  1641. __u16 default_flags;
  1642. __u32 default_ppid;
  1643. __u32 default_context;
  1644. __u32 default_timetolive;
  1645. /* Default receive parameters */
  1646. __u32 default_rcv_context;
  1647. /* Stream arrays */
  1648. struct sctp_stream stream;
  1649. /* All outbound chunks go through this structure. */
  1650. struct sctp_outq outqueue;
  1651. /* A smart pipe that will handle reordering and fragmentation,
  1652. * as well as handle passing events up to the ULP.
  1653. */
  1654. struct sctp_ulpq ulpq;
  1655. /* Last TSN that caused an ECNE Chunk to be sent. */
  1656. __u32 last_ecne_tsn;
  1657. /* Last TSN that caused a CWR Chunk to be sent. */
  1658. __u32 last_cwr_tsn;
  1659. /* How many duplicated TSNs have we seen? */
  1660. int numduptsns;
  1661. /* These are to support
  1662. * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
  1663. * and Enforcement of Flow and Message Limits"
  1664. * <draft-ietf-tsvwg-addip-sctp-02.txt>
  1665. * or "ADDIP" for short.
  1666. */
  1667. /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
  1668. *
  1669. * R1) One and only one ASCONF Chunk MAY be in transit and
  1670. * unacknowledged at any one time. If a sender, after sending
  1671. * an ASCONF chunk, decides it needs to transfer another
  1672. * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
  1673. * returns from the previous ASCONF Chunk before sending a
  1674. * subsequent ASCONF. Note this restriction binds each side,
  1675. * so at any time two ASCONF may be in-transit on any given
  1676. * association (one sent from each endpoint).
  1677. *
  1678. * [This is our one-and-only-one ASCONF in flight. If we do
  1679. * not have an ASCONF in flight, this is NULL.]
  1680. */
  1681. struct sctp_chunk *addip_last_asconf;
  1682. /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
  1683. *
  1684. * This is needed to implement items E1 - E4 of the updated
  1685. * spec. Here is the justification:
  1686. *
  1687. * Since the peer may bundle multiple ASCONF chunks toward us,
  1688. * we now need the ability to cache multiple ACKs. The section
  1689. * describes in detail how they are cached and cleaned up.
  1690. */
  1691. struct list_head asconf_ack_list;
  1692. /* These ASCONF chunks are waiting to be sent.
  1693. *
  1694. * These chunks can't be pushed to outqueue until receiving
  1695. * ASCONF_ACK for the previous ASCONF indicated by
  1696. * addip_last_asconf, so as to guarantee that only one ASCONF
  1697. * is in flight at any time.
  1698. *
  1699. * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
  1700. *
  1701. * In defining the ASCONF Chunk transfer procedures, it is
  1702. * essential that these transfers MUST NOT cause congestion
  1703. * within the network. To achieve this, we place these
  1704. * restrictions on the transfer of ASCONF Chunks:
  1705. *
  1706. * R1) One and only one ASCONF Chunk MAY be in transit and
  1707. * unacknowledged at any one time. If a sender, after sending
  1708. * an ASCONF chunk, decides it needs to transfer another
  1709. * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
  1710. * returns from the previous ASCONF Chunk before sending a
  1711. * subsequent ASCONF. Note this restriction binds each side,
  1712. * so at any time two ASCONF may be in-transit on any given
  1713. * association (one sent from each endpoint).
  1714. *
  1715. *
  1716. * [I really think this is EXACTLY the sort of intelligence
  1717. * which already resides in sctp_outq. Please move this
  1718. * queue and its supporting logic down there. --piggy]
  1719. */
  1720. struct list_head addip_chunk_list;
  1721. /* ADDIP Section 4.1 ASCONF Chunk Procedures
  1722. *
  1723. * A2) A serial number should be assigned to the Chunk. The
  1724. * serial number SHOULD be a monotonically increasing
  1725. * number. The serial number SHOULD be initialized at
  1726. * the start of the association to the same value as the
  1727. * Initial TSN and every time a new ASCONF chunk is created
  1728. * it is incremented by one after assigning the serial number
  1729. * to the newly created chunk.
  1730. *
  1731. * ADDIP
  1732. * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
  1733. *
  1734. * Serial Number : 32 bits (unsigned integer)
  1735. *
  1736. * This value represents a Serial Number for the ASCONF
  1737. * Chunk. The valid range of Serial Number is from 0 to
  1738. * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
  1739. * after reaching 4294967295.
  1740. */
  1741. __u32 addip_serial;
  1742. int src_out_of_asoc_ok;
  1743. union sctp_addr *asconf_addr_del_pending;
  1744. struct sctp_transport *new_transport;
  1745. /* SCTP AUTH: list of the endpoint shared keys. These
  1746. * keys are provided out of band by the user application
  1747. * and can't change during the lifetime of the association
  1748. */
  1749. struct list_head endpoint_shared_keys;
  1750. /* SCTP AUTH:
  1751. * The current generated association shared key (secret)
  1752. */
  1753. struct sctp_auth_bytes *asoc_shared_key;
  1754. struct sctp_shared_key *shkey;
  1755. /* SCTP AUTH: hmac id of the first peer requested algorithm
  1756. * that we support.
  1757. */
  1758. __u16 default_hmac_id;
  1759. __u16 active_key_id;
  1760. __u8 need_ecne:1, /* Need to send an ECNE Chunk? */
  1761. temp:1, /* Is it a temporary association? */
  1762. pf_expose:2, /* Expose pf state? */
  1763. force_delay:1;
  1764. __u8 strreset_enable;
  1765. __u8 strreset_outstanding; /* request param count on the fly */
  1766. __u32 strreset_outseq; /* Update after receiving response */
  1767. __u32 strreset_inseq; /* Update after receiving request */
  1768. __u32 strreset_result[2]; /* save the results of last 2 responses */
  1769. struct sctp_chunk *strreset_chunk; /* save request chunk */
  1770. struct sctp_priv_assoc_stats stats;
  1771. int sent_cnt_removable;
  1772. __u16 subscribe;
  1773. __u64 abandoned_unsent[SCTP_PR_INDEX(MAX) + 1];
  1774. __u64 abandoned_sent[SCTP_PR_INDEX(MAX) + 1];
  1775. /* Security identifiers from incoming (INIT). These are set by
  1776. * security_sctp_assoc_request(). These will only be used by
  1777. * SCTP TCP type sockets and peeled off connections as they
  1778. * cause a new socket to be generated. security_sctp_sk_clone()
  1779. * will then plug these into the new socket.
  1780. */
  1781. u32 secid;
  1782. u32 peer_secid;
  1783. struct rcu_head rcu;
  1784. };
  1785. /* An eyecatcher for determining if we are really looking at an
  1786. * association data structure.
  1787. */
  1788. enum {
  1789. SCTP_ASSOC_EYECATCHER = 0xa550c123,
  1790. };
  1791. /* Recover the outer association structure. */
  1792. static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
  1793. {
  1794. struct sctp_association *asoc;
  1795. asoc = container_of(base, struct sctp_association, base);
  1796. return asoc;
  1797. }
  1798. /* These are function signatures for manipulating associations. */
  1799. struct sctp_association *
  1800. sctp_association_new(const struct sctp_endpoint *ep, const struct sock *sk,
  1801. enum sctp_scope scope, gfp_t gfp);
  1802. void sctp_association_free(struct sctp_association *);
  1803. void sctp_association_put(struct sctp_association *);
  1804. void sctp_association_hold(struct sctp_association *);
  1805. struct sctp_transport *sctp_assoc_choose_alter_transport(
  1806. struct sctp_association *, struct sctp_transport *);
  1807. void sctp_assoc_update_retran_path(struct sctp_association *);
  1808. struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
  1809. const union sctp_addr *);
  1810. int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
  1811. const union sctp_addr *laddr);
  1812. struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
  1813. const union sctp_addr *address,
  1814. const gfp_t gfp,
  1815. const int peer_state);
  1816. void sctp_assoc_del_peer(struct sctp_association *asoc,
  1817. const union sctp_addr *addr);
  1818. void sctp_assoc_rm_peer(struct sctp_association *asoc,
  1819. struct sctp_transport *peer);
  1820. void sctp_assoc_control_transport(struct sctp_association *asoc,
  1821. struct sctp_transport *transport,
  1822. enum sctp_transport_cmd command,
  1823. sctp_sn_error_t error);
  1824. struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
  1825. void sctp_assoc_migrate(struct sctp_association *, struct sock *);
  1826. int sctp_assoc_update(struct sctp_association *old,
  1827. struct sctp_association *new);
  1828. __u32 sctp_association_get_next_tsn(struct sctp_association *);
  1829. void sctp_assoc_update_frag_point(struct sctp_association *asoc);
  1830. void sctp_assoc_set_pmtu(struct sctp_association *asoc, __u32 pmtu);
  1831. void sctp_assoc_sync_pmtu(struct sctp_association *asoc);
  1832. void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned int);
  1833. void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned int);
  1834. void sctp_assoc_set_primary(struct sctp_association *,
  1835. struct sctp_transport *);
  1836. void sctp_assoc_del_nonprimary_peers(struct sctp_association *,
  1837. struct sctp_transport *);
  1838. int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *asoc,
  1839. enum sctp_scope scope, gfp_t gfp);
  1840. int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
  1841. struct sctp_cookie*,
  1842. gfp_t gfp);
  1843. int sctp_assoc_set_id(struct sctp_association *, gfp_t);
  1844. void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc);
  1845. struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
  1846. const struct sctp_association *asoc,
  1847. __be32 serial);
  1848. void sctp_asconf_queue_teardown(struct sctp_association *asoc);
  1849. int sctp_cmp_addr_exact(const union sctp_addr *ss1,
  1850. const union sctp_addr *ss2);
  1851. struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
  1852. /* A convenience structure to parse out SCTP specific CMSGs. */
  1853. struct sctp_cmsgs {
  1854. struct sctp_initmsg *init;
  1855. struct sctp_sndrcvinfo *srinfo;
  1856. struct sctp_sndinfo *sinfo;
  1857. struct sctp_prinfo *prinfo;
  1858. struct sctp_authinfo *authinfo;
  1859. struct msghdr *addrs_msg;
  1860. };
  1861. /* Structure for tracking memory objects */
  1862. struct sctp_dbg_objcnt_entry {
  1863. char *label;
  1864. atomic_t *counter;
  1865. };
  1866. #endif /* __sctp_structs_h__ */