structs.h 66 KB

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