sm_sideeffect.c 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752
  1. /* SCTP kernel implementation
  2. * (C) Copyright IBM Corp. 2001, 2004
  3. * Copyright (c) 1999 Cisco, Inc.
  4. * Copyright (c) 1999-2001 Motorola, Inc.
  5. *
  6. * This file is part of the SCTP kernel implementation
  7. *
  8. * These functions work with the state functions in sctp_sm_statefuns.c
  9. * to implement that state operations. These functions implement the
  10. * steps which require modifying existing data structures.
  11. *
  12. * This SCTP implementation is free software;
  13. * you can redistribute it and/or modify it under the terms of
  14. * the GNU General Public License as published by
  15. * the Free Software Foundation; either version 2, or (at your option)
  16. * any later version.
  17. *
  18. * This SCTP implementation is distributed in the hope that it
  19. * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  20. * ************************
  21. * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  22. * See the GNU General Public License for more details.
  23. *
  24. * You should have received a copy of the GNU General Public License
  25. * along with GNU CC; see the file COPYING. If not, write to
  26. * the Free Software Foundation, 59 Temple Place - Suite 330,
  27. * Boston, MA 02111-1307, USA.
  28. *
  29. * Please send any bug reports or fixes you make to the
  30. * email address(es):
  31. * lksctp developers <lksctp-developers@lists.sourceforge.net>
  32. *
  33. * Or submit a bug report through the following website:
  34. * http://www.sf.net/projects/lksctp
  35. *
  36. * Written or modified by:
  37. * La Monte H.P. Yarroll <piggy@acm.org>
  38. * Karl Knutson <karl@athena.chicago.il.us>
  39. * Jon Grimm <jgrimm@austin.ibm.com>
  40. * Hui Huang <hui.huang@nokia.com>
  41. * Dajiang Zhang <dajiang.zhang@nokia.com>
  42. * Daisy Chang <daisyc@us.ibm.com>
  43. * Sridhar Samudrala <sri@us.ibm.com>
  44. * Ardelle Fan <ardelle.fan@intel.com>
  45. *
  46. * Any bugs reported given to us we will try to fix... any fixes shared will
  47. * be incorporated into the next SCTP release.
  48. */
  49. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  50. #include <linux/skbuff.h>
  51. #include <linux/types.h>
  52. #include <linux/socket.h>
  53. #include <linux/ip.h>
  54. #include <linux/gfp.h>
  55. #include <net/sock.h>
  56. #include <net/sctp/sctp.h>
  57. #include <net/sctp/sm.h>
  58. static int sctp_cmd_interpreter(sctp_event_t event_type,
  59. sctp_subtype_t subtype,
  60. sctp_state_t state,
  61. struct sctp_endpoint *ep,
  62. struct sctp_association *asoc,
  63. void *event_arg,
  64. sctp_disposition_t status,
  65. sctp_cmd_seq_t *commands,
  66. gfp_t gfp);
  67. static int sctp_side_effects(sctp_event_t event_type, sctp_subtype_t subtype,
  68. sctp_state_t state,
  69. struct sctp_endpoint *ep,
  70. struct sctp_association *asoc,
  71. void *event_arg,
  72. sctp_disposition_t status,
  73. sctp_cmd_seq_t *commands,
  74. gfp_t gfp);
  75. static void sctp_cmd_hb_timer_update(sctp_cmd_seq_t *cmds,
  76. struct sctp_transport *t);
  77. /********************************************************************
  78. * Helper functions
  79. ********************************************************************/
  80. /* A helper function for delayed processing of INET ECN CE bit. */
  81. static void sctp_do_ecn_ce_work(struct sctp_association *asoc,
  82. __u32 lowest_tsn)
  83. {
  84. /* Save the TSN away for comparison when we receive CWR */
  85. asoc->last_ecne_tsn = lowest_tsn;
  86. asoc->need_ecne = 1;
  87. }
  88. /* Helper function for delayed processing of SCTP ECNE chunk. */
  89. /* RFC 2960 Appendix A
  90. *
  91. * RFC 2481 details a specific bit for a sender to send in
  92. * the header of its next outbound TCP segment to indicate to
  93. * its peer that it has reduced its congestion window. This
  94. * is termed the CWR bit. For SCTP the same indication is made
  95. * by including the CWR chunk. This chunk contains one data
  96. * element, i.e. the TSN number that was sent in the ECNE chunk.
  97. * This element represents the lowest TSN number in the datagram
  98. * that was originally marked with the CE bit.
  99. */
  100. static struct sctp_chunk *sctp_do_ecn_ecne_work(struct sctp_association *asoc,
  101. __u32 lowest_tsn,
  102. struct sctp_chunk *chunk)
  103. {
  104. struct sctp_chunk *repl;
  105. /* Our previously transmitted packet ran into some congestion
  106. * so we should take action by reducing cwnd and ssthresh
  107. * and then ACK our peer that we we've done so by
  108. * sending a CWR.
  109. */
  110. /* First, try to determine if we want to actually lower
  111. * our cwnd variables. Only lower them if the ECNE looks more
  112. * recent than the last response.
  113. */
  114. if (TSN_lt(asoc->last_cwr_tsn, lowest_tsn)) {
  115. struct sctp_transport *transport;
  116. /* Find which transport's congestion variables
  117. * need to be adjusted.
  118. */
  119. transport = sctp_assoc_lookup_tsn(asoc, lowest_tsn);
  120. /* Update the congestion variables. */
  121. if (transport)
  122. sctp_transport_lower_cwnd(transport,
  123. SCTP_LOWER_CWND_ECNE);
  124. asoc->last_cwr_tsn = lowest_tsn;
  125. }
  126. /* Always try to quiet the other end. In case of lost CWR,
  127. * resend last_cwr_tsn.
  128. */
  129. repl = sctp_make_cwr(asoc, asoc->last_cwr_tsn, chunk);
  130. /* If we run out of memory, it will look like a lost CWR. We'll
  131. * get back in sync eventually.
  132. */
  133. return repl;
  134. }
  135. /* Helper function to do delayed processing of ECN CWR chunk. */
  136. static void sctp_do_ecn_cwr_work(struct sctp_association *asoc,
  137. __u32 lowest_tsn)
  138. {
  139. /* Turn off ECNE getting auto-prepended to every outgoing
  140. * packet
  141. */
  142. asoc->need_ecne = 0;
  143. }
  144. /* Generate SACK if necessary. We call this at the end of a packet. */
  145. static int sctp_gen_sack(struct sctp_association *asoc, int force,
  146. sctp_cmd_seq_t *commands)
  147. {
  148. __u32 ctsn, max_tsn_seen;
  149. struct sctp_chunk *sack;
  150. struct sctp_transport *trans = asoc->peer.last_data_from;
  151. int error = 0;
  152. if (force ||
  153. (!trans && (asoc->param_flags & SPP_SACKDELAY_DISABLE)) ||
  154. (trans && (trans->param_flags & SPP_SACKDELAY_DISABLE)))
  155. asoc->peer.sack_needed = 1;
  156. ctsn = sctp_tsnmap_get_ctsn(&asoc->peer.tsn_map);
  157. max_tsn_seen = sctp_tsnmap_get_max_tsn_seen(&asoc->peer.tsn_map);
  158. /* From 12.2 Parameters necessary per association (i.e. the TCB):
  159. *
  160. * Ack State : This flag indicates if the next received packet
  161. * : is to be responded to with a SACK. ...
  162. * : When DATA chunks are out of order, SACK's
  163. * : are not delayed (see Section 6).
  164. *
  165. * [This is actually not mentioned in Section 6, but we
  166. * implement it here anyway. --piggy]
  167. */
  168. if (max_tsn_seen != ctsn)
  169. asoc->peer.sack_needed = 1;
  170. /* From 6.2 Acknowledgement on Reception of DATA Chunks:
  171. *
  172. * Section 4.2 of [RFC2581] SHOULD be followed. Specifically,
  173. * an acknowledgement SHOULD be generated for at least every
  174. * second packet (not every second DATA chunk) received, and
  175. * SHOULD be generated within 200 ms of the arrival of any
  176. * unacknowledged DATA chunk. ...
  177. */
  178. if (!asoc->peer.sack_needed) {
  179. asoc->peer.sack_cnt++;
  180. /* Set the SACK delay timeout based on the
  181. * SACK delay for the last transport
  182. * data was received from, or the default
  183. * for the association.
  184. */
  185. if (trans) {
  186. /* We will need a SACK for the next packet. */
  187. if (asoc->peer.sack_cnt >= trans->sackfreq - 1)
  188. asoc->peer.sack_needed = 1;
  189. asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] =
  190. trans->sackdelay;
  191. } else {
  192. /* We will need a SACK for the next packet. */
  193. if (asoc->peer.sack_cnt >= asoc->sackfreq - 1)
  194. asoc->peer.sack_needed = 1;
  195. asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] =
  196. asoc->sackdelay;
  197. }
  198. /* Restart the SACK timer. */
  199. sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
  200. SCTP_TO(SCTP_EVENT_TIMEOUT_SACK));
  201. } else {
  202. asoc->a_rwnd = asoc->rwnd;
  203. sack = sctp_make_sack(asoc);
  204. if (!sack)
  205. goto nomem;
  206. asoc->peer.sack_needed = 0;
  207. asoc->peer.sack_cnt = 0;
  208. sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(sack));
  209. /* Stop the SACK timer. */
  210. sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
  211. SCTP_TO(SCTP_EVENT_TIMEOUT_SACK));
  212. }
  213. return error;
  214. nomem:
  215. error = -ENOMEM;
  216. return error;
  217. }
  218. /* When the T3-RTX timer expires, it calls this function to create the
  219. * relevant state machine event.
  220. */
  221. void sctp_generate_t3_rtx_event(unsigned long peer)
  222. {
  223. int error;
  224. struct sctp_transport *transport = (struct sctp_transport *) peer;
  225. struct sctp_association *asoc = transport->asoc;
  226. /* Check whether a task is in the sock. */
  227. sctp_bh_lock_sock(asoc->base.sk);
  228. if (sock_owned_by_user(asoc->base.sk)) {
  229. SCTP_DEBUG_PRINTK("%s:Sock is busy.\n", __func__);
  230. /* Try again later. */
  231. if (!mod_timer(&transport->T3_rtx_timer, jiffies + (HZ/20)))
  232. sctp_transport_hold(transport);
  233. goto out_unlock;
  234. }
  235. /* Is this transport really dead and just waiting around for
  236. * the timer to let go of the reference?
  237. */
  238. if (transport->dead)
  239. goto out_unlock;
  240. /* Run through the state machine. */
  241. error = sctp_do_sm(SCTP_EVENT_T_TIMEOUT,
  242. SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_T3_RTX),
  243. asoc->state,
  244. asoc->ep, asoc,
  245. transport, GFP_ATOMIC);
  246. if (error)
  247. asoc->base.sk->sk_err = -error;
  248. out_unlock:
  249. sctp_bh_unlock_sock(asoc->base.sk);
  250. sctp_transport_put(transport);
  251. }
  252. /* This is a sa interface for producing timeout events. It works
  253. * for timeouts which use the association as their parameter.
  254. */
  255. static void sctp_generate_timeout_event(struct sctp_association *asoc,
  256. sctp_event_timeout_t timeout_type)
  257. {
  258. int error = 0;
  259. sctp_bh_lock_sock(asoc->base.sk);
  260. if (sock_owned_by_user(asoc->base.sk)) {
  261. SCTP_DEBUG_PRINTK("%s:Sock is busy: timer %d\n",
  262. __func__,
  263. timeout_type);
  264. /* Try again later. */
  265. if (!mod_timer(&asoc->timers[timeout_type], jiffies + (HZ/20)))
  266. sctp_association_hold(asoc);
  267. goto out_unlock;
  268. }
  269. /* Is this association really dead and just waiting around for
  270. * the timer to let go of the reference?
  271. */
  272. if (asoc->base.dead)
  273. goto out_unlock;
  274. /* Run through the state machine. */
  275. error = sctp_do_sm(SCTP_EVENT_T_TIMEOUT,
  276. SCTP_ST_TIMEOUT(timeout_type),
  277. asoc->state, asoc->ep, asoc,
  278. (void *)timeout_type, GFP_ATOMIC);
  279. if (error)
  280. asoc->base.sk->sk_err = -error;
  281. out_unlock:
  282. sctp_bh_unlock_sock(asoc->base.sk);
  283. sctp_association_put(asoc);
  284. }
  285. static void sctp_generate_t1_cookie_event(unsigned long data)
  286. {
  287. struct sctp_association *asoc = (struct sctp_association *) data;
  288. sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T1_COOKIE);
  289. }
  290. static void sctp_generate_t1_init_event(unsigned long data)
  291. {
  292. struct sctp_association *asoc = (struct sctp_association *) data;
  293. sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T1_INIT);
  294. }
  295. static void sctp_generate_t2_shutdown_event(unsigned long data)
  296. {
  297. struct sctp_association *asoc = (struct sctp_association *) data;
  298. sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T2_SHUTDOWN);
  299. }
  300. static void sctp_generate_t4_rto_event(unsigned long data)
  301. {
  302. struct sctp_association *asoc = (struct sctp_association *) data;
  303. sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T4_RTO);
  304. }
  305. static void sctp_generate_t5_shutdown_guard_event(unsigned long data)
  306. {
  307. struct sctp_association *asoc = (struct sctp_association *)data;
  308. sctp_generate_timeout_event(asoc,
  309. SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD);
  310. } /* sctp_generate_t5_shutdown_guard_event() */
  311. static void sctp_generate_autoclose_event(unsigned long data)
  312. {
  313. struct sctp_association *asoc = (struct sctp_association *) data;
  314. sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_AUTOCLOSE);
  315. }
  316. /* Generate a heart beat event. If the sock is busy, reschedule. Make
  317. * sure that the transport is still valid.
  318. */
  319. void sctp_generate_heartbeat_event(unsigned long data)
  320. {
  321. int error = 0;
  322. struct sctp_transport *transport = (struct sctp_transport *) data;
  323. struct sctp_association *asoc = transport->asoc;
  324. sctp_bh_lock_sock(asoc->base.sk);
  325. if (sock_owned_by_user(asoc->base.sk)) {
  326. SCTP_DEBUG_PRINTK("%s:Sock is busy.\n", __func__);
  327. /* Try again later. */
  328. if (!mod_timer(&transport->hb_timer, jiffies + (HZ/20)))
  329. sctp_transport_hold(transport);
  330. goto out_unlock;
  331. }
  332. /* Is this structure just waiting around for us to actually
  333. * get destroyed?
  334. */
  335. if (transport->dead)
  336. goto out_unlock;
  337. error = sctp_do_sm(SCTP_EVENT_T_TIMEOUT,
  338. SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_HEARTBEAT),
  339. asoc->state, asoc->ep, asoc,
  340. transport, GFP_ATOMIC);
  341. if (error)
  342. asoc->base.sk->sk_err = -error;
  343. out_unlock:
  344. sctp_bh_unlock_sock(asoc->base.sk);
  345. sctp_transport_put(transport);
  346. }
  347. /* Handle the timeout of the ICMP protocol unreachable timer. Trigger
  348. * the correct state machine transition that will close the association.
  349. */
  350. void sctp_generate_proto_unreach_event(unsigned long data)
  351. {
  352. struct sctp_transport *transport = (struct sctp_transport *) data;
  353. struct sctp_association *asoc = transport->asoc;
  354. sctp_bh_lock_sock(asoc->base.sk);
  355. if (sock_owned_by_user(asoc->base.sk)) {
  356. SCTP_DEBUG_PRINTK("%s:Sock is busy.\n", __func__);
  357. /* Try again later. */
  358. if (!mod_timer(&transport->proto_unreach_timer,
  359. jiffies + (HZ/20)))
  360. sctp_association_hold(asoc);
  361. goto out_unlock;
  362. }
  363. /* Is this structure just waiting around for us to actually
  364. * get destroyed?
  365. */
  366. if (asoc->base.dead)
  367. goto out_unlock;
  368. sctp_do_sm(SCTP_EVENT_T_OTHER,
  369. SCTP_ST_OTHER(SCTP_EVENT_ICMP_PROTO_UNREACH),
  370. asoc->state, asoc->ep, asoc, transport, GFP_ATOMIC);
  371. out_unlock:
  372. sctp_bh_unlock_sock(asoc->base.sk);
  373. sctp_association_put(asoc);
  374. }
  375. /* Inject a SACK Timeout event into the state machine. */
  376. static void sctp_generate_sack_event(unsigned long data)
  377. {
  378. struct sctp_association *asoc = (struct sctp_association *) data;
  379. sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_SACK);
  380. }
  381. sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES] = {
  382. NULL,
  383. sctp_generate_t1_cookie_event,
  384. sctp_generate_t1_init_event,
  385. sctp_generate_t2_shutdown_event,
  386. NULL,
  387. sctp_generate_t4_rto_event,
  388. sctp_generate_t5_shutdown_guard_event,
  389. NULL,
  390. sctp_generate_sack_event,
  391. sctp_generate_autoclose_event,
  392. };
  393. /* RFC 2960 8.2 Path Failure Detection
  394. *
  395. * When its peer endpoint is multi-homed, an endpoint should keep a
  396. * error counter for each of the destination transport addresses of the
  397. * peer endpoint.
  398. *
  399. * Each time the T3-rtx timer expires on any address, or when a
  400. * HEARTBEAT sent to an idle address is not acknowledged within a RTO,
  401. * the error counter of that destination address will be incremented.
  402. * When the value in the error counter exceeds the protocol parameter
  403. * 'Path.Max.Retrans' of that destination address, the endpoint should
  404. * mark the destination transport address as inactive, and a
  405. * notification SHOULD be sent to the upper layer.
  406. *
  407. */
  408. static void sctp_do_8_2_transport_strike(sctp_cmd_seq_t *commands,
  409. struct sctp_association *asoc,
  410. struct sctp_transport *transport,
  411. int is_hb)
  412. {
  413. /* The check for association's overall error counter exceeding the
  414. * threshold is done in the state function.
  415. */
  416. /* We are here due to a timer expiration. If the timer was
  417. * not a HEARTBEAT, then normal error tracking is done.
  418. * If the timer was a heartbeat, we only increment error counts
  419. * when we already have an outstanding HEARTBEAT that has not
  420. * been acknowledged.
  421. * Additionally, some tranport states inhibit error increments.
  422. */
  423. if (!is_hb) {
  424. asoc->overall_error_count++;
  425. if (transport->state != SCTP_INACTIVE)
  426. transport->error_count++;
  427. } else if (transport->hb_sent) {
  428. if (transport->state != SCTP_UNCONFIRMED)
  429. asoc->overall_error_count++;
  430. if (transport->state != SCTP_INACTIVE)
  431. transport->error_count++;
  432. }
  433. /* If the transport error count is greater than the pf_retrans
  434. * threshold, and less than pathmaxrtx, then mark this transport
  435. * as Partially Failed, ee SCTP Quick Failover Draft, secon 5.1,
  436. * point 1
  437. */
  438. if ((transport->state != SCTP_PF) &&
  439. (asoc->pf_retrans < transport->pathmaxrxt) &&
  440. (transport->error_count > asoc->pf_retrans)) {
  441. sctp_assoc_control_transport(asoc, transport,
  442. SCTP_TRANSPORT_PF,
  443. 0);
  444. /* Update the hb timer to resend a heartbeat every rto */
  445. sctp_cmd_hb_timer_update(commands, transport);
  446. }
  447. if (transport->state != SCTP_INACTIVE &&
  448. (transport->error_count > transport->pathmaxrxt)) {
  449. SCTP_DEBUG_PRINTK_IPADDR("transport_strike:association %p",
  450. " transport IP: port:%d failed.\n",
  451. asoc,
  452. (&transport->ipaddr),
  453. ntohs(transport->ipaddr.v4.sin_port));
  454. sctp_assoc_control_transport(asoc, transport,
  455. SCTP_TRANSPORT_DOWN,
  456. SCTP_FAILED_THRESHOLD);
  457. }
  458. /* E2) For the destination address for which the timer
  459. * expires, set RTO <- RTO * 2 ("back off the timer"). The
  460. * maximum value discussed in rule C7 above (RTO.max) may be
  461. * used to provide an upper bound to this doubling operation.
  462. *
  463. * Special Case: the first HB doesn't trigger exponential backoff.
  464. * The first unacknowledged HB triggers it. We do this with a flag
  465. * that indicates that we have an outstanding HB.
  466. */
  467. if (!is_hb || transport->hb_sent) {
  468. transport->rto = min((transport->rto * 2), transport->asoc->rto_max);
  469. }
  470. }
  471. /* Worker routine to handle INIT command failure. */
  472. static void sctp_cmd_init_failed(sctp_cmd_seq_t *commands,
  473. struct sctp_association *asoc,
  474. unsigned int error)
  475. {
  476. struct sctp_ulpevent *event;
  477. event = sctp_ulpevent_make_assoc_change(asoc,0, SCTP_CANT_STR_ASSOC,
  478. (__u16)error, 0, 0, NULL,
  479. GFP_ATOMIC);
  480. if (event)
  481. sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
  482. SCTP_ULPEVENT(event));
  483. sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
  484. SCTP_STATE(SCTP_STATE_CLOSED));
  485. /* SEND_FAILED sent later when cleaning up the association. */
  486. asoc->outqueue.error = error;
  487. sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
  488. }
  489. /* Worker routine to handle SCTP_CMD_ASSOC_FAILED. */
  490. static void sctp_cmd_assoc_failed(sctp_cmd_seq_t *commands,
  491. struct sctp_association *asoc,
  492. sctp_event_t event_type,
  493. sctp_subtype_t subtype,
  494. struct sctp_chunk *chunk,
  495. unsigned int error)
  496. {
  497. struct sctp_ulpevent *event;
  498. /* Cancel any partial delivery in progress. */
  499. sctp_ulpq_abort_pd(&asoc->ulpq, GFP_ATOMIC);
  500. if (event_type == SCTP_EVENT_T_CHUNK && subtype.chunk == SCTP_CID_ABORT)
  501. event = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_COMM_LOST,
  502. (__u16)error, 0, 0, chunk,
  503. GFP_ATOMIC);
  504. else
  505. event = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_COMM_LOST,
  506. (__u16)error, 0, 0, NULL,
  507. GFP_ATOMIC);
  508. if (event)
  509. sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
  510. SCTP_ULPEVENT(event));
  511. sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
  512. SCTP_STATE(SCTP_STATE_CLOSED));
  513. /* SEND_FAILED sent later when cleaning up the association. */
  514. asoc->outqueue.error = error;
  515. sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
  516. }
  517. /* Process an init chunk (may be real INIT/INIT-ACK or an embedded INIT
  518. * inside the cookie. In reality, this is only used for INIT-ACK processing
  519. * since all other cases use "temporary" associations and can do all
  520. * their work in statefuns directly.
  521. */
  522. static int sctp_cmd_process_init(sctp_cmd_seq_t *commands,
  523. struct sctp_association *asoc,
  524. struct sctp_chunk *chunk,
  525. sctp_init_chunk_t *peer_init,
  526. gfp_t gfp)
  527. {
  528. int error;
  529. /* We only process the init as a sideeffect in a single
  530. * case. This is when we process the INIT-ACK. If we
  531. * fail during INIT processing (due to malloc problems),
  532. * just return the error and stop processing the stack.
  533. */
  534. if (!sctp_process_init(asoc, chunk, sctp_source(chunk), peer_init, gfp))
  535. error = -ENOMEM;
  536. else
  537. error = 0;
  538. return error;
  539. }
  540. /* Helper function to break out starting up of heartbeat timers. */
  541. static void sctp_cmd_hb_timers_start(sctp_cmd_seq_t *cmds,
  542. struct sctp_association *asoc)
  543. {
  544. struct sctp_transport *t;
  545. /* Start a heartbeat timer for each transport on the association.
  546. * hold a reference on the transport to make sure none of
  547. * the needed data structures go away.
  548. */
  549. list_for_each_entry(t, &asoc->peer.transport_addr_list, transports) {
  550. if (!mod_timer(&t->hb_timer, sctp_transport_timeout(t)))
  551. sctp_transport_hold(t);
  552. }
  553. }
  554. static void sctp_cmd_hb_timers_stop(sctp_cmd_seq_t *cmds,
  555. struct sctp_association *asoc)
  556. {
  557. struct sctp_transport *t;
  558. /* Stop all heartbeat timers. */
  559. list_for_each_entry(t, &asoc->peer.transport_addr_list,
  560. transports) {
  561. if (del_timer(&t->hb_timer))
  562. sctp_transport_put(t);
  563. }
  564. }
  565. /* Helper function to stop any pending T3-RTX timers */
  566. static void sctp_cmd_t3_rtx_timers_stop(sctp_cmd_seq_t *cmds,
  567. struct sctp_association *asoc)
  568. {
  569. struct sctp_transport *t;
  570. list_for_each_entry(t, &asoc->peer.transport_addr_list,
  571. transports) {
  572. if (timer_pending(&t->T3_rtx_timer) &&
  573. del_timer(&t->T3_rtx_timer)) {
  574. sctp_transport_put(t);
  575. }
  576. }
  577. }
  578. /* Helper function to update the heartbeat timer. */
  579. static void sctp_cmd_hb_timer_update(sctp_cmd_seq_t *cmds,
  580. struct sctp_transport *t)
  581. {
  582. /* Update the heartbeat timer. */
  583. if (!mod_timer(&t->hb_timer, sctp_transport_timeout(t)))
  584. sctp_transport_hold(t);
  585. }
  586. /* Helper function to handle the reception of an HEARTBEAT ACK. */
  587. static void sctp_cmd_transport_on(sctp_cmd_seq_t *cmds,
  588. struct sctp_association *asoc,
  589. struct sctp_transport *t,
  590. struct sctp_chunk *chunk)
  591. {
  592. sctp_sender_hb_info_t *hbinfo;
  593. int was_unconfirmed = 0;
  594. /* 8.3 Upon the receipt of the HEARTBEAT ACK, the sender of the
  595. * HEARTBEAT should clear the error counter of the destination
  596. * transport address to which the HEARTBEAT was sent.
  597. */
  598. t->error_count = 0;
  599. /*
  600. * Although RFC4960 specifies that the overall error count must
  601. * be cleared when a HEARTBEAT ACK is received, we make an
  602. * exception while in SHUTDOWN PENDING. If the peer keeps its
  603. * window shut forever, we may never be able to transmit our
  604. * outstanding data and rely on the retransmission limit be reached
  605. * to shutdown the association.
  606. */
  607. if (t->asoc->state != SCTP_STATE_SHUTDOWN_PENDING)
  608. t->asoc->overall_error_count = 0;
  609. /* Clear the hb_sent flag to signal that we had a good
  610. * acknowledgement.
  611. */
  612. t->hb_sent = 0;
  613. /* Mark the destination transport address as active if it is not so
  614. * marked.
  615. */
  616. if ((t->state == SCTP_INACTIVE) || (t->state == SCTP_UNCONFIRMED)) {
  617. was_unconfirmed = 1;
  618. sctp_assoc_control_transport(asoc, t, SCTP_TRANSPORT_UP,
  619. SCTP_HEARTBEAT_SUCCESS);
  620. }
  621. if (t->state == SCTP_PF)
  622. sctp_assoc_control_transport(asoc, t, SCTP_TRANSPORT_UP,
  623. SCTP_HEARTBEAT_SUCCESS);
  624. /* The receiver of the HEARTBEAT ACK should also perform an
  625. * RTT measurement for that destination transport address
  626. * using the time value carried in the HEARTBEAT ACK chunk.
  627. * If the transport's rto_pending variable has been cleared,
  628. * it was most likely due to a retransmit. However, we want
  629. * to re-enable it to properly update the rto.
  630. */
  631. if (t->rto_pending == 0)
  632. t->rto_pending = 1;
  633. hbinfo = (sctp_sender_hb_info_t *) chunk->skb->data;
  634. sctp_transport_update_rto(t, (jiffies - hbinfo->sent_at));
  635. /* Update the heartbeat timer. */
  636. if (!mod_timer(&t->hb_timer, sctp_transport_timeout(t)))
  637. sctp_transport_hold(t);
  638. if (was_unconfirmed && asoc->peer.transport_count == 1)
  639. sctp_transport_immediate_rtx(t);
  640. }
  641. /* Helper function to process the process SACK command. */
  642. static int sctp_cmd_process_sack(sctp_cmd_seq_t *cmds,
  643. struct sctp_association *asoc,
  644. struct sctp_sackhdr *sackh)
  645. {
  646. int err = 0;
  647. if (sctp_outq_sack(&asoc->outqueue, sackh)) {
  648. /* There are no more TSNs awaiting SACK. */
  649. err = sctp_do_sm(SCTP_EVENT_T_OTHER,
  650. SCTP_ST_OTHER(SCTP_EVENT_NO_PENDING_TSN),
  651. asoc->state, asoc->ep, asoc, NULL,
  652. GFP_ATOMIC);
  653. }
  654. return err;
  655. }
  656. /* Helper function to set the timeout value for T2-SHUTDOWN timer and to set
  657. * the transport for a shutdown chunk.
  658. */
  659. static void sctp_cmd_setup_t2(sctp_cmd_seq_t *cmds,
  660. struct sctp_association *asoc,
  661. struct sctp_chunk *chunk)
  662. {
  663. struct sctp_transport *t;
  664. if (chunk->transport)
  665. t = chunk->transport;
  666. else {
  667. t = sctp_assoc_choose_alter_transport(asoc,
  668. asoc->shutdown_last_sent_to);
  669. chunk->transport = t;
  670. }
  671. asoc->shutdown_last_sent_to = t;
  672. asoc->timeouts[SCTP_EVENT_TIMEOUT_T2_SHUTDOWN] = t->rto;
  673. }
  674. /* Helper function to change the state of an association. */
  675. static void sctp_cmd_new_state(sctp_cmd_seq_t *cmds,
  676. struct sctp_association *asoc,
  677. sctp_state_t state)
  678. {
  679. struct sock *sk = asoc->base.sk;
  680. asoc->state = state;
  681. SCTP_DEBUG_PRINTK("sctp_cmd_new_state: asoc %p[%s]\n",
  682. asoc, sctp_state_tbl[state]);
  683. if (sctp_style(sk, TCP)) {
  684. /* Change the sk->sk_state of a TCP-style socket that has
  685. * successfully completed a connect() call.
  686. */
  687. if (sctp_state(asoc, ESTABLISHED) && sctp_sstate(sk, CLOSED))
  688. sk->sk_state = SCTP_SS_ESTABLISHED;
  689. /* Set the RCV_SHUTDOWN flag when a SHUTDOWN is received. */
  690. if (sctp_state(asoc, SHUTDOWN_RECEIVED) &&
  691. sctp_sstate(sk, ESTABLISHED))
  692. sk->sk_shutdown |= RCV_SHUTDOWN;
  693. }
  694. if (sctp_state(asoc, COOKIE_WAIT)) {
  695. /* Reset init timeouts since they may have been
  696. * increased due to timer expirations.
  697. */
  698. asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] =
  699. asoc->rto_initial;
  700. asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] =
  701. asoc->rto_initial;
  702. }
  703. if (sctp_state(asoc, ESTABLISHED) ||
  704. sctp_state(asoc, CLOSED) ||
  705. sctp_state(asoc, SHUTDOWN_RECEIVED)) {
  706. /* Wake up any processes waiting in the asoc's wait queue in
  707. * sctp_wait_for_connect() or sctp_wait_for_sndbuf().
  708. */
  709. if (waitqueue_active(&asoc->wait))
  710. wake_up_interruptible(&asoc->wait);
  711. /* Wake up any processes waiting in the sk's sleep queue of
  712. * a TCP-style or UDP-style peeled-off socket in
  713. * sctp_wait_for_accept() or sctp_wait_for_packet().
  714. * For a UDP-style socket, the waiters are woken up by the
  715. * notifications.
  716. */
  717. if (!sctp_style(sk, UDP))
  718. sk->sk_state_change(sk);
  719. }
  720. }
  721. /* Helper function to delete an association. */
  722. static void sctp_cmd_delete_tcb(sctp_cmd_seq_t *cmds,
  723. struct sctp_association *asoc)
  724. {
  725. struct sock *sk = asoc->base.sk;
  726. /* If it is a non-temporary association belonging to a TCP-style
  727. * listening socket that is not closed, do not free it so that accept()
  728. * can pick it up later.
  729. */
  730. if (sctp_style(sk, TCP) && sctp_sstate(sk, LISTENING) &&
  731. (!asoc->temp) && (sk->sk_shutdown != SHUTDOWN_MASK))
  732. return;
  733. sctp_unhash_established(asoc);
  734. sctp_association_free(asoc);
  735. }
  736. /*
  737. * ADDIP Section 4.1 ASCONF Chunk Procedures
  738. * A4) Start a T-4 RTO timer, using the RTO value of the selected
  739. * destination address (we use active path instead of primary path just
  740. * because primary path may be inactive.
  741. */
  742. static void sctp_cmd_setup_t4(sctp_cmd_seq_t *cmds,
  743. struct sctp_association *asoc,
  744. struct sctp_chunk *chunk)
  745. {
  746. struct sctp_transport *t;
  747. t = sctp_assoc_choose_alter_transport(asoc, chunk->transport);
  748. asoc->timeouts[SCTP_EVENT_TIMEOUT_T4_RTO] = t->rto;
  749. chunk->transport = t;
  750. }
  751. /* Process an incoming Operation Error Chunk. */
  752. static void sctp_cmd_process_operr(sctp_cmd_seq_t *cmds,
  753. struct sctp_association *asoc,
  754. struct sctp_chunk *chunk)
  755. {
  756. struct sctp_errhdr *err_hdr;
  757. struct sctp_ulpevent *ev;
  758. while (chunk->chunk_end > chunk->skb->data) {
  759. err_hdr = (struct sctp_errhdr *)(chunk->skb->data);
  760. ev = sctp_ulpevent_make_remote_error(asoc, chunk, 0,
  761. GFP_ATOMIC);
  762. if (!ev)
  763. return;
  764. sctp_ulpq_tail_event(&asoc->ulpq, ev);
  765. switch (err_hdr->cause) {
  766. case SCTP_ERROR_UNKNOWN_CHUNK:
  767. {
  768. sctp_chunkhdr_t *unk_chunk_hdr;
  769. unk_chunk_hdr = (sctp_chunkhdr_t *)err_hdr->variable;
  770. switch (unk_chunk_hdr->type) {
  771. /* ADDIP 4.1 A9) If the peer responds to an ASCONF with
  772. * an ERROR chunk reporting that it did not recognized
  773. * the ASCONF chunk type, the sender of the ASCONF MUST
  774. * NOT send any further ASCONF chunks and MUST stop its
  775. * T-4 timer.
  776. */
  777. case SCTP_CID_ASCONF:
  778. if (asoc->peer.asconf_capable == 0)
  779. break;
  780. asoc->peer.asconf_capable = 0;
  781. sctp_add_cmd_sf(cmds, SCTP_CMD_TIMER_STOP,
  782. SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
  783. break;
  784. default:
  785. break;
  786. }
  787. break;
  788. }
  789. default:
  790. break;
  791. }
  792. }
  793. }
  794. /* Process variable FWDTSN chunk information. */
  795. static void sctp_cmd_process_fwdtsn(struct sctp_ulpq *ulpq,
  796. struct sctp_chunk *chunk)
  797. {
  798. struct sctp_fwdtsn_skip *skip;
  799. /* Walk through all the skipped SSNs */
  800. sctp_walk_fwdtsn(skip, chunk) {
  801. sctp_ulpq_skip(ulpq, ntohs(skip->stream), ntohs(skip->ssn));
  802. }
  803. }
  804. /* Helper function to remove the association non-primary peer
  805. * transports.
  806. */
  807. static void sctp_cmd_del_non_primary(struct sctp_association *asoc)
  808. {
  809. struct sctp_transport *t;
  810. struct list_head *pos;
  811. struct list_head *temp;
  812. list_for_each_safe(pos, temp, &asoc->peer.transport_addr_list) {
  813. t = list_entry(pos, struct sctp_transport, transports);
  814. if (!sctp_cmp_addr_exact(&t->ipaddr,
  815. &asoc->peer.primary_addr)) {
  816. sctp_assoc_del_peer(asoc, &t->ipaddr);
  817. }
  818. }
  819. }
  820. /* Helper function to set sk_err on a 1-1 style socket. */
  821. static void sctp_cmd_set_sk_err(struct sctp_association *asoc, int error)
  822. {
  823. struct sock *sk = asoc->base.sk;
  824. if (!sctp_style(sk, UDP))
  825. sk->sk_err = error;
  826. }
  827. /* Helper function to generate an association change event */
  828. static void sctp_cmd_assoc_change(sctp_cmd_seq_t *commands,
  829. struct sctp_association *asoc,
  830. u8 state)
  831. {
  832. struct sctp_ulpevent *ev;
  833. ev = sctp_ulpevent_make_assoc_change(asoc, 0, state, 0,
  834. asoc->c.sinit_num_ostreams,
  835. asoc->c.sinit_max_instreams,
  836. NULL, GFP_ATOMIC);
  837. if (ev)
  838. sctp_ulpq_tail_event(&asoc->ulpq, ev);
  839. }
  840. /* Helper function to generate an adaptation indication event */
  841. static void sctp_cmd_adaptation_ind(sctp_cmd_seq_t *commands,
  842. struct sctp_association *asoc)
  843. {
  844. struct sctp_ulpevent *ev;
  845. ev = sctp_ulpevent_make_adaptation_indication(asoc, GFP_ATOMIC);
  846. if (ev)
  847. sctp_ulpq_tail_event(&asoc->ulpq, ev);
  848. }
  849. static void sctp_cmd_t1_timer_update(struct sctp_association *asoc,
  850. sctp_event_timeout_t timer,
  851. char *name)
  852. {
  853. struct sctp_transport *t;
  854. t = asoc->init_last_sent_to;
  855. asoc->init_err_counter++;
  856. if (t->init_sent_count > (asoc->init_cycle + 1)) {
  857. asoc->timeouts[timer] *= 2;
  858. if (asoc->timeouts[timer] > asoc->max_init_timeo) {
  859. asoc->timeouts[timer] = asoc->max_init_timeo;
  860. }
  861. asoc->init_cycle++;
  862. SCTP_DEBUG_PRINTK(
  863. "T1 %s Timeout adjustment"
  864. " init_err_counter: %d"
  865. " cycle: %d"
  866. " timeout: %ld\n",
  867. name,
  868. asoc->init_err_counter,
  869. asoc->init_cycle,
  870. asoc->timeouts[timer]);
  871. }
  872. }
  873. /* Send the whole message, chunk by chunk, to the outqueue.
  874. * This way the whole message is queued up and bundling if
  875. * encouraged for small fragments.
  876. */
  877. static int sctp_cmd_send_msg(struct sctp_association *asoc,
  878. struct sctp_datamsg *msg)
  879. {
  880. struct sctp_chunk *chunk;
  881. int error = 0;
  882. list_for_each_entry(chunk, &msg->chunks, frag_list) {
  883. error = sctp_outq_tail(&asoc->outqueue, chunk);
  884. if (error)
  885. break;
  886. }
  887. return error;
  888. }
  889. /* Sent the next ASCONF packet currently stored in the association.
  890. * This happens after the ASCONF_ACK was succeffully processed.
  891. */
  892. static void sctp_cmd_send_asconf(struct sctp_association *asoc)
  893. {
  894. /* Send the next asconf chunk from the addip chunk
  895. * queue.
  896. */
  897. if (!list_empty(&asoc->addip_chunk_list)) {
  898. struct list_head *entry = asoc->addip_chunk_list.next;
  899. struct sctp_chunk *asconf = list_entry(entry,
  900. struct sctp_chunk, list);
  901. list_del_init(entry);
  902. /* Hold the chunk until an ASCONF_ACK is received. */
  903. sctp_chunk_hold(asconf);
  904. if (sctp_primitive_ASCONF(asoc, asconf))
  905. sctp_chunk_free(asconf);
  906. else
  907. asoc->addip_last_asconf = asconf;
  908. }
  909. }
  910. /* These three macros allow us to pull the debugging code out of the
  911. * main flow of sctp_do_sm() to keep attention focused on the real
  912. * functionality there.
  913. */
  914. #define DEBUG_PRE \
  915. SCTP_DEBUG_PRINTK("sctp_do_sm prefn: " \
  916. "ep %p, %s, %s, asoc %p[%s], %s\n", \
  917. ep, sctp_evttype_tbl[event_type], \
  918. (*debug_fn)(subtype), asoc, \
  919. sctp_state_tbl[state], state_fn->name)
  920. #define DEBUG_POST \
  921. SCTP_DEBUG_PRINTK("sctp_do_sm postfn: " \
  922. "asoc %p, status: %s\n", \
  923. asoc, sctp_status_tbl[status])
  924. #define DEBUG_POST_SFX \
  925. SCTP_DEBUG_PRINTK("sctp_do_sm post sfx: error %d, asoc %p[%s]\n", \
  926. error, asoc, \
  927. sctp_state_tbl[(asoc && sctp_id2assoc(ep->base.sk, \
  928. sctp_assoc2id(asoc)))?asoc->state:SCTP_STATE_CLOSED])
  929. /*
  930. * This is the master state machine processing function.
  931. *
  932. * If you want to understand all of lksctp, this is a
  933. * good place to start.
  934. */
  935. int sctp_do_sm(sctp_event_t event_type, sctp_subtype_t subtype,
  936. sctp_state_t state,
  937. struct sctp_endpoint *ep,
  938. struct sctp_association *asoc,
  939. void *event_arg,
  940. gfp_t gfp)
  941. {
  942. sctp_cmd_seq_t commands;
  943. const sctp_sm_table_entry_t *state_fn;
  944. sctp_disposition_t status;
  945. int error = 0;
  946. typedef const char *(printfn_t)(sctp_subtype_t);
  947. static printfn_t *table[] = {
  948. NULL, sctp_cname, sctp_tname, sctp_oname, sctp_pname,
  949. };
  950. printfn_t *debug_fn __attribute__ ((unused)) = table[event_type];
  951. /* Look up the state function, run it, and then process the
  952. * side effects. These three steps are the heart of lksctp.
  953. */
  954. state_fn = sctp_sm_lookup_event(event_type, state, subtype);
  955. sctp_init_cmd_seq(&commands);
  956. DEBUG_PRE;
  957. status = (*state_fn->fn)(ep, asoc, subtype, event_arg, &commands);
  958. DEBUG_POST;
  959. error = sctp_side_effects(event_type, subtype, state,
  960. ep, asoc, event_arg, status,
  961. &commands, gfp);
  962. DEBUG_POST_SFX;
  963. return error;
  964. }
  965. #undef DEBUG_PRE
  966. #undef DEBUG_POST
  967. /*****************************************************************
  968. * This the master state function side effect processing function.
  969. *****************************************************************/
  970. static int sctp_side_effects(sctp_event_t event_type, sctp_subtype_t subtype,
  971. sctp_state_t state,
  972. struct sctp_endpoint *ep,
  973. struct sctp_association *asoc,
  974. void *event_arg,
  975. sctp_disposition_t status,
  976. sctp_cmd_seq_t *commands,
  977. gfp_t gfp)
  978. {
  979. int error;
  980. /* FIXME - Most of the dispositions left today would be categorized
  981. * as "exceptional" dispositions. For those dispositions, it
  982. * may not be proper to run through any of the commands at all.
  983. * For example, the command interpreter might be run only with
  984. * disposition SCTP_DISPOSITION_CONSUME.
  985. */
  986. if (0 != (error = sctp_cmd_interpreter(event_type, subtype, state,
  987. ep, asoc,
  988. event_arg, status,
  989. commands, gfp)))
  990. goto bail;
  991. switch (status) {
  992. case SCTP_DISPOSITION_DISCARD:
  993. SCTP_DEBUG_PRINTK("Ignored sctp protocol event - state %d, "
  994. "event_type %d, event_id %d\n",
  995. state, event_type, subtype.chunk);
  996. break;
  997. case SCTP_DISPOSITION_NOMEM:
  998. /* We ran out of memory, so we need to discard this
  999. * packet.
  1000. */
  1001. /* BUG--we should now recover some memory, probably by
  1002. * reneging...
  1003. */
  1004. error = -ENOMEM;
  1005. break;
  1006. case SCTP_DISPOSITION_DELETE_TCB:
  1007. /* This should now be a command. */
  1008. break;
  1009. case SCTP_DISPOSITION_CONSUME:
  1010. case SCTP_DISPOSITION_ABORT:
  1011. /*
  1012. * We should no longer have much work to do here as the
  1013. * real work has been done as explicit commands above.
  1014. */
  1015. break;
  1016. case SCTP_DISPOSITION_VIOLATION:
  1017. net_err_ratelimited("protocol violation state %d chunkid %d\n",
  1018. state, subtype.chunk);
  1019. break;
  1020. case SCTP_DISPOSITION_NOT_IMPL:
  1021. pr_warn("unimplemented feature in state %d, event_type %d, event_id %d\n",
  1022. state, event_type, subtype.chunk);
  1023. break;
  1024. case SCTP_DISPOSITION_BUG:
  1025. pr_err("bug in state %d, event_type %d, event_id %d\n",
  1026. state, event_type, subtype.chunk);
  1027. BUG();
  1028. break;
  1029. default:
  1030. pr_err("impossible disposition %d in state %d, event_type %d, event_id %d\n",
  1031. status, state, event_type, subtype.chunk);
  1032. BUG();
  1033. break;
  1034. }
  1035. bail:
  1036. return error;
  1037. }
  1038. /********************************************************************
  1039. * 2nd Level Abstractions
  1040. ********************************************************************/
  1041. /* This is the side-effect interpreter. */
  1042. static int sctp_cmd_interpreter(sctp_event_t event_type,
  1043. sctp_subtype_t subtype,
  1044. sctp_state_t state,
  1045. struct sctp_endpoint *ep,
  1046. struct sctp_association *asoc,
  1047. void *event_arg,
  1048. sctp_disposition_t status,
  1049. sctp_cmd_seq_t *commands,
  1050. gfp_t gfp)
  1051. {
  1052. int error = 0;
  1053. int force;
  1054. sctp_cmd_t *cmd;
  1055. struct sctp_chunk *new_obj;
  1056. struct sctp_chunk *chunk = NULL;
  1057. struct sctp_packet *packet;
  1058. struct timer_list *timer;
  1059. unsigned long timeout;
  1060. struct sctp_transport *t;
  1061. struct sctp_sackhdr sackh;
  1062. int local_cork = 0;
  1063. if (SCTP_EVENT_T_TIMEOUT != event_type)
  1064. chunk = event_arg;
  1065. /* Note: This whole file is a huge candidate for rework.
  1066. * For example, each command could either have its own handler, so
  1067. * the loop would look like:
  1068. * while (cmds)
  1069. * cmd->handle(x, y, z)
  1070. * --jgrimm
  1071. */
  1072. while (NULL != (cmd = sctp_next_cmd(commands))) {
  1073. switch (cmd->verb) {
  1074. case SCTP_CMD_NOP:
  1075. /* Do nothing. */
  1076. break;
  1077. case SCTP_CMD_NEW_ASOC:
  1078. /* Register a new association. */
  1079. if (local_cork) {
  1080. sctp_outq_uncork(&asoc->outqueue);
  1081. local_cork = 0;
  1082. }
  1083. asoc = cmd->obj.ptr;
  1084. /* Register with the endpoint. */
  1085. sctp_endpoint_add_asoc(ep, asoc);
  1086. sctp_hash_established(asoc);
  1087. break;
  1088. case SCTP_CMD_UPDATE_ASSOC:
  1089. sctp_assoc_update(asoc, cmd->obj.ptr);
  1090. break;
  1091. case SCTP_CMD_PURGE_OUTQUEUE:
  1092. sctp_outq_teardown(&asoc->outqueue);
  1093. break;
  1094. case SCTP_CMD_DELETE_TCB:
  1095. if (local_cork) {
  1096. sctp_outq_uncork(&asoc->outqueue);
  1097. local_cork = 0;
  1098. }
  1099. /* Delete the current association. */
  1100. sctp_cmd_delete_tcb(commands, asoc);
  1101. asoc = NULL;
  1102. break;
  1103. case SCTP_CMD_NEW_STATE:
  1104. /* Enter a new state. */
  1105. sctp_cmd_new_state(commands, asoc, cmd->obj.state);
  1106. break;
  1107. case SCTP_CMD_REPORT_TSN:
  1108. /* Record the arrival of a TSN. */
  1109. error = sctp_tsnmap_mark(&asoc->peer.tsn_map,
  1110. cmd->obj.u32, NULL);
  1111. break;
  1112. case SCTP_CMD_REPORT_FWDTSN:
  1113. /* Move the Cumulattive TSN Ack ahead. */
  1114. sctp_tsnmap_skip(&asoc->peer.tsn_map, cmd->obj.u32);
  1115. /* purge the fragmentation queue */
  1116. sctp_ulpq_reasm_flushtsn(&asoc->ulpq, cmd->obj.u32);
  1117. /* Abort any in progress partial delivery. */
  1118. sctp_ulpq_abort_pd(&asoc->ulpq, GFP_ATOMIC);
  1119. break;
  1120. case SCTP_CMD_PROCESS_FWDTSN:
  1121. sctp_cmd_process_fwdtsn(&asoc->ulpq, cmd->obj.ptr);
  1122. break;
  1123. case SCTP_CMD_GEN_SACK:
  1124. /* Generate a Selective ACK.
  1125. * The argument tells us whether to just count
  1126. * the packet and MAYBE generate a SACK, or
  1127. * force a SACK out.
  1128. */
  1129. force = cmd->obj.i32;
  1130. error = sctp_gen_sack(asoc, force, commands);
  1131. break;
  1132. case SCTP_CMD_PROCESS_SACK:
  1133. /* Process an inbound SACK. */
  1134. error = sctp_cmd_process_sack(commands, asoc,
  1135. cmd->obj.ptr);
  1136. break;
  1137. case SCTP_CMD_GEN_INIT_ACK:
  1138. /* Generate an INIT ACK chunk. */
  1139. new_obj = sctp_make_init_ack(asoc, chunk, GFP_ATOMIC,
  1140. 0);
  1141. if (!new_obj)
  1142. goto nomem;
  1143. sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
  1144. SCTP_CHUNK(new_obj));
  1145. break;
  1146. case SCTP_CMD_PEER_INIT:
  1147. /* Process a unified INIT from the peer.
  1148. * Note: Only used during INIT-ACK processing. If
  1149. * there is an error just return to the outter
  1150. * layer which will bail.
  1151. */
  1152. error = sctp_cmd_process_init(commands, asoc, chunk,
  1153. cmd->obj.ptr, gfp);
  1154. break;
  1155. case SCTP_CMD_GEN_COOKIE_ECHO:
  1156. /* Generate a COOKIE ECHO chunk. */
  1157. new_obj = sctp_make_cookie_echo(asoc, chunk);
  1158. if (!new_obj) {
  1159. if (cmd->obj.ptr)
  1160. sctp_chunk_free(cmd->obj.ptr);
  1161. goto nomem;
  1162. }
  1163. sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
  1164. SCTP_CHUNK(new_obj));
  1165. /* If there is an ERROR chunk to be sent along with
  1166. * the COOKIE_ECHO, send it, too.
  1167. */
  1168. if (cmd->obj.ptr)
  1169. sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
  1170. SCTP_CHUNK(cmd->obj.ptr));
  1171. if (new_obj->transport) {
  1172. new_obj->transport->init_sent_count++;
  1173. asoc->init_last_sent_to = new_obj->transport;
  1174. }
  1175. /* FIXME - Eventually come up with a cleaner way to
  1176. * enabling COOKIE-ECHO + DATA bundling during
  1177. * multihoming stale cookie scenarios, the following
  1178. * command plays with asoc->peer.retran_path to
  1179. * avoid the problem of sending the COOKIE-ECHO and
  1180. * DATA in different paths, which could result
  1181. * in the association being ABORTed if the DATA chunk
  1182. * is processed first by the server. Checking the
  1183. * init error counter simply causes this command
  1184. * to be executed only during failed attempts of
  1185. * association establishment.
  1186. */
  1187. if ((asoc->peer.retran_path !=
  1188. asoc->peer.primary_path) &&
  1189. (asoc->init_err_counter > 0)) {
  1190. sctp_add_cmd_sf(commands,
  1191. SCTP_CMD_FORCE_PRIM_RETRAN,
  1192. SCTP_NULL());
  1193. }
  1194. break;
  1195. case SCTP_CMD_GEN_SHUTDOWN:
  1196. /* Generate SHUTDOWN when in SHUTDOWN_SENT state.
  1197. * Reset error counts.
  1198. */
  1199. asoc->overall_error_count = 0;
  1200. /* Generate a SHUTDOWN chunk. */
  1201. new_obj = sctp_make_shutdown(asoc, chunk);
  1202. if (!new_obj)
  1203. goto nomem;
  1204. sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
  1205. SCTP_CHUNK(new_obj));
  1206. break;
  1207. case SCTP_CMD_CHUNK_ULP:
  1208. /* Send a chunk to the sockets layer. */
  1209. SCTP_DEBUG_PRINTK("sm_sideff: %s %p, %s %p.\n",
  1210. "chunk_up:", cmd->obj.ptr,
  1211. "ulpq:", &asoc->ulpq);
  1212. sctp_ulpq_tail_data(&asoc->ulpq, cmd->obj.ptr,
  1213. GFP_ATOMIC);
  1214. break;
  1215. case SCTP_CMD_EVENT_ULP:
  1216. /* Send a notification to the sockets layer. */
  1217. SCTP_DEBUG_PRINTK("sm_sideff: %s %p, %s %p.\n",
  1218. "event_up:",cmd->obj.ptr,
  1219. "ulpq:",&asoc->ulpq);
  1220. sctp_ulpq_tail_event(&asoc->ulpq, cmd->obj.ptr);
  1221. break;
  1222. case SCTP_CMD_REPLY:
  1223. /* If an caller has not already corked, do cork. */
  1224. if (!asoc->outqueue.cork) {
  1225. sctp_outq_cork(&asoc->outqueue);
  1226. local_cork = 1;
  1227. }
  1228. /* Send a chunk to our peer. */
  1229. error = sctp_outq_tail(&asoc->outqueue, cmd->obj.ptr);
  1230. break;
  1231. case SCTP_CMD_SEND_PKT:
  1232. /* Send a full packet to our peer. */
  1233. packet = cmd->obj.ptr;
  1234. sctp_packet_transmit(packet);
  1235. sctp_ootb_pkt_free(packet);
  1236. break;
  1237. case SCTP_CMD_T1_RETRAN:
  1238. /* Mark a transport for retransmission. */
  1239. sctp_retransmit(&asoc->outqueue, cmd->obj.transport,
  1240. SCTP_RTXR_T1_RTX);
  1241. break;
  1242. case SCTP_CMD_RETRAN:
  1243. /* Mark a transport for retransmission. */
  1244. sctp_retransmit(&asoc->outqueue, cmd->obj.transport,
  1245. SCTP_RTXR_T3_RTX);
  1246. break;
  1247. case SCTP_CMD_ECN_CE:
  1248. /* Do delayed CE processing. */
  1249. sctp_do_ecn_ce_work(asoc, cmd->obj.u32);
  1250. break;
  1251. case SCTP_CMD_ECN_ECNE:
  1252. /* Do delayed ECNE processing. */
  1253. new_obj = sctp_do_ecn_ecne_work(asoc, cmd->obj.u32,
  1254. chunk);
  1255. if (new_obj)
  1256. sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
  1257. SCTP_CHUNK(new_obj));
  1258. break;
  1259. case SCTP_CMD_ECN_CWR:
  1260. /* Do delayed CWR processing. */
  1261. sctp_do_ecn_cwr_work(asoc, cmd->obj.u32);
  1262. break;
  1263. case SCTP_CMD_SETUP_T2:
  1264. sctp_cmd_setup_t2(commands, asoc, cmd->obj.ptr);
  1265. break;
  1266. case SCTP_CMD_TIMER_START_ONCE:
  1267. timer = &asoc->timers[cmd->obj.to];
  1268. if (timer_pending(timer))
  1269. break;
  1270. /* fall through */
  1271. case SCTP_CMD_TIMER_START:
  1272. timer = &asoc->timers[cmd->obj.to];
  1273. timeout = asoc->timeouts[cmd->obj.to];
  1274. BUG_ON(!timeout);
  1275. timer->expires = jiffies + timeout;
  1276. sctp_association_hold(asoc);
  1277. add_timer(timer);
  1278. break;
  1279. case SCTP_CMD_TIMER_RESTART:
  1280. timer = &asoc->timers[cmd->obj.to];
  1281. timeout = asoc->timeouts[cmd->obj.to];
  1282. if (!mod_timer(timer, jiffies + timeout))
  1283. sctp_association_hold(asoc);
  1284. break;
  1285. case SCTP_CMD_TIMER_STOP:
  1286. timer = &asoc->timers[cmd->obj.to];
  1287. if (timer_pending(timer) && del_timer(timer))
  1288. sctp_association_put(asoc);
  1289. break;
  1290. case SCTP_CMD_INIT_CHOOSE_TRANSPORT:
  1291. chunk = cmd->obj.ptr;
  1292. t = sctp_assoc_choose_alter_transport(asoc,
  1293. asoc->init_last_sent_to);
  1294. asoc->init_last_sent_to = t;
  1295. chunk->transport = t;
  1296. t->init_sent_count++;
  1297. /* Set the new transport as primary */
  1298. sctp_assoc_set_primary(asoc, t);
  1299. break;
  1300. case SCTP_CMD_INIT_RESTART:
  1301. /* Do the needed accounting and updates
  1302. * associated with restarting an initialization
  1303. * timer. Only multiply the timeout by two if
  1304. * all transports have been tried at the current
  1305. * timeout.
  1306. */
  1307. sctp_cmd_t1_timer_update(asoc,
  1308. SCTP_EVENT_TIMEOUT_T1_INIT,
  1309. "INIT");
  1310. sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
  1311. SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
  1312. break;
  1313. case SCTP_CMD_COOKIEECHO_RESTART:
  1314. /* Do the needed accounting and updates
  1315. * associated with restarting an initialization
  1316. * timer. Only multiply the timeout by two if
  1317. * all transports have been tried at the current
  1318. * timeout.
  1319. */
  1320. sctp_cmd_t1_timer_update(asoc,
  1321. SCTP_EVENT_TIMEOUT_T1_COOKIE,
  1322. "COOKIE");
  1323. /* If we've sent any data bundled with
  1324. * COOKIE-ECHO we need to resend.
  1325. */
  1326. list_for_each_entry(t, &asoc->peer.transport_addr_list,
  1327. transports) {
  1328. sctp_retransmit_mark(&asoc->outqueue, t,
  1329. SCTP_RTXR_T1_RTX);
  1330. }
  1331. sctp_add_cmd_sf(commands,
  1332. SCTP_CMD_TIMER_RESTART,
  1333. SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
  1334. break;
  1335. case SCTP_CMD_INIT_FAILED:
  1336. sctp_cmd_init_failed(commands, asoc, cmd->obj.err);
  1337. break;
  1338. case SCTP_CMD_ASSOC_FAILED:
  1339. sctp_cmd_assoc_failed(commands, asoc, event_type,
  1340. subtype, chunk, cmd->obj.err);
  1341. break;
  1342. case SCTP_CMD_INIT_COUNTER_INC:
  1343. asoc->init_err_counter++;
  1344. break;
  1345. case SCTP_CMD_INIT_COUNTER_RESET:
  1346. asoc->init_err_counter = 0;
  1347. asoc->init_cycle = 0;
  1348. list_for_each_entry(t, &asoc->peer.transport_addr_list,
  1349. transports) {
  1350. t->init_sent_count = 0;
  1351. }
  1352. break;
  1353. case SCTP_CMD_REPORT_DUP:
  1354. sctp_tsnmap_mark_dup(&asoc->peer.tsn_map,
  1355. cmd->obj.u32);
  1356. break;
  1357. case SCTP_CMD_REPORT_BAD_TAG:
  1358. SCTP_DEBUG_PRINTK("vtag mismatch!\n");
  1359. break;
  1360. case SCTP_CMD_STRIKE:
  1361. /* Mark one strike against a transport. */
  1362. sctp_do_8_2_transport_strike(commands, asoc,
  1363. cmd->obj.transport, 0);
  1364. break;
  1365. case SCTP_CMD_TRANSPORT_IDLE:
  1366. t = cmd->obj.transport;
  1367. sctp_transport_lower_cwnd(t, SCTP_LOWER_CWND_INACTIVE);
  1368. break;
  1369. case SCTP_CMD_TRANSPORT_HB_SENT:
  1370. t = cmd->obj.transport;
  1371. sctp_do_8_2_transport_strike(commands, asoc,
  1372. t, 1);
  1373. t->hb_sent = 1;
  1374. break;
  1375. case SCTP_CMD_TRANSPORT_ON:
  1376. t = cmd->obj.transport;
  1377. sctp_cmd_transport_on(commands, asoc, t, chunk);
  1378. break;
  1379. case SCTP_CMD_HB_TIMERS_START:
  1380. sctp_cmd_hb_timers_start(commands, asoc);
  1381. break;
  1382. case SCTP_CMD_HB_TIMER_UPDATE:
  1383. t = cmd->obj.transport;
  1384. sctp_cmd_hb_timer_update(commands, t);
  1385. break;
  1386. case SCTP_CMD_HB_TIMERS_STOP:
  1387. sctp_cmd_hb_timers_stop(commands, asoc);
  1388. break;
  1389. case SCTP_CMD_REPORT_ERROR:
  1390. error = cmd->obj.error;
  1391. break;
  1392. case SCTP_CMD_PROCESS_CTSN:
  1393. /* Dummy up a SACK for processing. */
  1394. sackh.cum_tsn_ack = cmd->obj.be32;
  1395. sackh.a_rwnd = asoc->peer.rwnd +
  1396. asoc->outqueue.outstanding_bytes;
  1397. sackh.num_gap_ack_blocks = 0;
  1398. sackh.num_dup_tsns = 0;
  1399. sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_SACK,
  1400. SCTP_SACKH(&sackh));
  1401. break;
  1402. case SCTP_CMD_DISCARD_PACKET:
  1403. /* We need to discard the whole packet.
  1404. * Uncork the queue since there might be
  1405. * responses pending
  1406. */
  1407. chunk->pdiscard = 1;
  1408. if (asoc) {
  1409. sctp_outq_uncork(&asoc->outqueue);
  1410. local_cork = 0;
  1411. }
  1412. break;
  1413. case SCTP_CMD_RTO_PENDING:
  1414. t = cmd->obj.transport;
  1415. t->rto_pending = 1;
  1416. break;
  1417. case SCTP_CMD_PART_DELIVER:
  1418. sctp_ulpq_partial_delivery(&asoc->ulpq, cmd->obj.ptr,
  1419. GFP_ATOMIC);
  1420. break;
  1421. case SCTP_CMD_RENEGE:
  1422. sctp_ulpq_renege(&asoc->ulpq, cmd->obj.ptr,
  1423. GFP_ATOMIC);
  1424. break;
  1425. case SCTP_CMD_SETUP_T4:
  1426. sctp_cmd_setup_t4(commands, asoc, cmd->obj.ptr);
  1427. break;
  1428. case SCTP_CMD_PROCESS_OPERR:
  1429. sctp_cmd_process_operr(commands, asoc, chunk);
  1430. break;
  1431. case SCTP_CMD_CLEAR_INIT_TAG:
  1432. asoc->peer.i.init_tag = 0;
  1433. break;
  1434. case SCTP_CMD_DEL_NON_PRIMARY:
  1435. sctp_cmd_del_non_primary(asoc);
  1436. break;
  1437. case SCTP_CMD_T3_RTX_TIMERS_STOP:
  1438. sctp_cmd_t3_rtx_timers_stop(commands, asoc);
  1439. break;
  1440. case SCTP_CMD_FORCE_PRIM_RETRAN:
  1441. t = asoc->peer.retran_path;
  1442. asoc->peer.retran_path = asoc->peer.primary_path;
  1443. error = sctp_outq_uncork(&asoc->outqueue);
  1444. local_cork = 0;
  1445. asoc->peer.retran_path = t;
  1446. break;
  1447. case SCTP_CMD_SET_SK_ERR:
  1448. sctp_cmd_set_sk_err(asoc, cmd->obj.error);
  1449. break;
  1450. case SCTP_CMD_ASSOC_CHANGE:
  1451. sctp_cmd_assoc_change(commands, asoc,
  1452. cmd->obj.u8);
  1453. break;
  1454. case SCTP_CMD_ADAPTATION_IND:
  1455. sctp_cmd_adaptation_ind(commands, asoc);
  1456. break;
  1457. case SCTP_CMD_ASSOC_SHKEY:
  1458. error = sctp_auth_asoc_init_active_key(asoc,
  1459. GFP_ATOMIC);
  1460. break;
  1461. case SCTP_CMD_UPDATE_INITTAG:
  1462. asoc->peer.i.init_tag = cmd->obj.u32;
  1463. break;
  1464. case SCTP_CMD_SEND_MSG:
  1465. if (!asoc->outqueue.cork) {
  1466. sctp_outq_cork(&asoc->outqueue);
  1467. local_cork = 1;
  1468. }
  1469. error = sctp_cmd_send_msg(asoc, cmd->obj.msg);
  1470. break;
  1471. case SCTP_CMD_SEND_NEXT_ASCONF:
  1472. sctp_cmd_send_asconf(asoc);
  1473. break;
  1474. case SCTP_CMD_PURGE_ASCONF_QUEUE:
  1475. sctp_asconf_queue_teardown(asoc);
  1476. break;
  1477. case SCTP_CMD_SET_ASOC:
  1478. asoc = cmd->obj.asoc;
  1479. break;
  1480. default:
  1481. pr_warn("Impossible command: %u, %p\n",
  1482. cmd->verb, cmd->obj.ptr);
  1483. break;
  1484. }
  1485. if (error)
  1486. break;
  1487. }
  1488. out:
  1489. /* If this is in response to a received chunk, wait until
  1490. * we are done with the packet to open the queue so that we don't
  1491. * send multiple packets in response to a single request.
  1492. */
  1493. if (asoc && SCTP_EVENT_T_CHUNK == event_type && chunk) {
  1494. if (chunk->end_of_packet || chunk->singleton)
  1495. error = sctp_outq_uncork(&asoc->outqueue);
  1496. } else if (local_cork)
  1497. error = sctp_outq_uncork(&asoc->outqueue);
  1498. return error;
  1499. nomem:
  1500. error = -ENOMEM;
  1501. goto out;
  1502. }