You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

slam.c 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794
  1. /*
  2. * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
  3. *
  4. * This program is free software; you can redistribute it and/or
  5. * modify it under the terms of the GNU General Public License as
  6. * published by the Free Software Foundation; either version 2 of the
  7. * License, or any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful, but
  10. * WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. * General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program; if not, write to the Free Software
  16. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17. */
  18. #include <stdint.h>
  19. #include <stdlib.h>
  20. #include <string.h>
  21. #include <strings.h>
  22. #include <errno.h>
  23. #include <assert.h>
  24. #include <byteswap.h>
  25. #include <gpxe/features.h>
  26. #include <gpxe/iobuf.h>
  27. #include <gpxe/bitmap.h>
  28. #include <gpxe/xfer.h>
  29. #include <gpxe/open.h>
  30. #include <gpxe/uri.h>
  31. #include <gpxe/tcpip.h>
  32. #include <gpxe/retry.h>
  33. /** @file
  34. *
  35. * Scalable Local Area Multicast protocol
  36. *
  37. * The SLAM protocol is supported only by Etherboot; it was designed
  38. * and implemented by Eric Biederman. A server implementation is
  39. * available in contrib/mini-slamd. There does not appear to be any
  40. * documentation beyond a few sparse comments in Etherboot's
  41. * proto_slam.c.
  42. *
  43. * SLAM packets use three types of data field:
  44. *
  45. * Nul : A single NUL (0) byte, used as a list terminator
  46. *
  47. * Raw : A block of raw data
  48. *
  49. * Int : A variable-length integer, in big-endian order. The length
  50. * of the integer is encoded in the most significant three bits.
  51. *
  52. * Packets received by the client have the following layout:
  53. *
  54. * Int : Transaction identifier. This is an opaque value.
  55. *
  56. * Int : Total number of bytes in the transfer.
  57. *
  58. * Int : Block size, in bytes.
  59. *
  60. * Int : Packet sequence number within the transfer (if this packet
  61. * contains data).
  62. *
  63. * Raw : Packet data (if this packet contains data).
  64. *
  65. * Packets transmitted by the client consist of a run-length-encoded
  66. * representation of the received-blocks bitmap, looking something
  67. * like:
  68. *
  69. * Int : Number of consecutive successfully-received packets
  70. * Int : Number of consecutive missing packets
  71. * Int : Number of consecutive successfully-received packets
  72. * Int : Number of consecutive missing packets
  73. * ....
  74. * Nul
  75. *
  76. */
  77. FEATURE ( FEATURE_PROTOCOL, "SLAM", DHCP_EB_FEATURE_SLAM, 1 );
  78. /** Default SLAM server port */
  79. #define SLAM_DEFAULT_PORT 10000
  80. /** Default SLAM multicast IP address */
  81. #define SLAM_DEFAULT_MULTICAST_IP \
  82. ( ( 239 << 24 ) | ( 255 << 16 ) | ( 1 << 8 ) | ( 1 << 0 ) )
  83. /** Default SLAM multicast port */
  84. #define SLAM_DEFAULT_MULTICAST_PORT 10000
  85. /** Maximum SLAM header length */
  86. #define SLAM_MAX_HEADER_LEN ( 8 /* transaction id */ + 8 /* total_bytes */ + \
  87. 8 /* block_size */ )
  88. /** Maximum SLAM NACK length
  89. *
  90. * This is a policy decision. Shorter packets take less time to
  91. * construct and spew out less debug output, and there's a limit to
  92. * how useful it is to send a complete missing-block list anyway; if
  93. * the loss rate is high then we're going to have to retransmit an
  94. * updated missing-block list anyway.
  95. */
  96. #define SLAM_MAX_NACK_LEN 16
  97. /** A SLAM request */
  98. struct slam_request {
  99. /** Reference counter */
  100. struct refcnt refcnt;
  101. /** Data transfer interface */
  102. struct xfer_interface xfer;
  103. /** Unicast socket */
  104. struct xfer_interface socket;
  105. /** Multicast socket */
  106. struct xfer_interface mc_socket;
  107. /** NACK timer */
  108. struct retry_timer timer;
  109. /** Cached header */
  110. uint8_t header[SLAM_MAX_HEADER_LEN];
  111. /** Size of cached header */
  112. size_t header_len;
  113. /** Total number of bytes in transfer */
  114. unsigned long total_bytes;
  115. /** Transfer block size */
  116. unsigned long block_size;
  117. /** Number of blocks in transfer */
  118. unsigned long num_blocks;
  119. /** Block bitmap */
  120. struct bitmap bitmap;
  121. /** NACK sent flag */
  122. int nack_sent;
  123. };
  124. /**
  125. * Free a SLAM request
  126. *
  127. * @v refcnt Reference counter
  128. */
  129. static void slam_free ( struct refcnt *refcnt ) {
  130. struct slam_request *slam =
  131. container_of ( refcnt, struct slam_request, refcnt );
  132. bitmap_free ( &slam->bitmap );
  133. free ( slam );
  134. }
  135. /**
  136. * Mark SLAM request as complete
  137. *
  138. * @v slam SLAM request
  139. * @v rc Return status code
  140. */
  141. static void slam_finished ( struct slam_request *slam, int rc ) {
  142. static const uint8_t slam_disconnect[] = { 0 };
  143. DBGC ( slam, "SLAM %p finished with status code %d (%s)\n",
  144. slam, rc, strerror ( rc ) );
  145. /* Send a disconnect message if we ever sent anything to the
  146. * server.
  147. */
  148. if ( slam->nack_sent ) {
  149. xfer_deliver_raw ( &slam->socket, slam_disconnect,
  150. sizeof ( slam_disconnect ) );
  151. }
  152. /* Stop the retry timer */
  153. stop_timer ( &slam->timer );
  154. /* Close all data transfer interfaces */
  155. xfer_nullify ( &slam->socket );
  156. xfer_close ( &slam->socket, rc );
  157. xfer_nullify ( &slam->mc_socket );
  158. xfer_close ( &slam->mc_socket, rc );
  159. xfer_nullify ( &slam->xfer );
  160. xfer_close ( &slam->xfer, rc );
  161. }
  162. /****************************************************************************
  163. *
  164. * TX datapath
  165. *
  166. */
  167. /**
  168. * Add a variable-length value to a SLAM packet
  169. *
  170. * @v slam SLAM request
  171. * @v iobuf I/O buffer
  172. * @v value Value to add
  173. * @ret rc Return status code
  174. *
  175. * Adds a variable-length value to the end of an I/O buffer. Will
  176. * refuse to use the last byte of the I/O buffer; this is to allow
  177. * space for the terminating NUL.
  178. */
  179. static int slam_put_value ( struct slam_request *slam,
  180. struct io_buffer *iobuf, unsigned long value ) {
  181. uint8_t *data;
  182. size_t len;
  183. unsigned int i;
  184. /* Calculate variable length required to store value. Always
  185. * leave at least one byte in the I/O buffer.
  186. */
  187. len = ( ( flsl ( value ) + 10 ) / 8 );
  188. if ( len >= iob_tailroom ( iobuf ) ) {
  189. DBGC2 ( slam, "SLAM %p cannot add %d-byte value\n",
  190. slam, len );
  191. return -ENOBUFS;
  192. }
  193. /* There is no valid way within the protocol that we can end
  194. * up trying to push a full-sized long (i.e. without space for
  195. * the length encoding).
  196. */
  197. assert ( len <= sizeof ( value ) );
  198. /* Add value */
  199. data = iob_put ( iobuf, len );
  200. for ( i = len ; i-- ; ) {
  201. data[i] = value;
  202. value >>= 8;
  203. }
  204. *data |= ( len << 5 );
  205. assert ( value == 0 );
  206. return 0;
  207. }
  208. /**
  209. * Build SLAM compressed missing-block list
  210. *
  211. * @v slam SLAM request
  212. * @v iobuf I/O buffer
  213. * @ret rc Return status code
  214. */
  215. static int slam_build_block_list ( struct slam_request *slam,
  216. struct io_buffer *iobuf ) {
  217. unsigned int block;
  218. unsigned int block_count;
  219. int block_present;
  220. int last_block_present;
  221. int rc;
  222. DBGC ( slam, "SLAM %p asking for ", slam );
  223. /* Walk bitmap to construct list */
  224. block_count = 0;
  225. last_block_present = ( ! 0 );
  226. for ( block = 0 ; block < slam->num_blocks ; block++ ) {
  227. block_present = ( !! bitmap_test ( &slam->bitmap, block ) );
  228. if ( block_present != last_block_present ) {
  229. if ( ( rc = slam_put_value ( slam, iobuf,
  230. block_count ) ) != 0 ) {
  231. DBGC ( slam, "...\n" );
  232. return rc;
  233. }
  234. DBGC ( slam, "%c%d",
  235. ( last_block_present ? ' ' : '-' ),
  236. ( last_block_present ? block : block - 1 ) );
  237. block_count = 0;
  238. last_block_present = block_present;
  239. }
  240. block_count++;
  241. }
  242. if ( ( rc = slam_put_value ( slam, iobuf, block_count ) ) != 0 ) {
  243. DBGC ( slam, "...\n" );
  244. return rc;
  245. }
  246. DBGC ( slam, "%c%d\n", ( last_block_present ? ' ' : '-' ),
  247. ( last_block_present ? block : block - 1 ) );
  248. return 0;
  249. }
  250. /**
  251. * Send SLAM NACK packet
  252. *
  253. * @v slam SLAM request
  254. * @ret rc Return status code
  255. */
  256. static int slam_tx_nack ( struct slam_request *slam ) {
  257. struct io_buffer *iobuf;
  258. uint8_t *nul;
  259. DBGC ( slam, "SLAM %p transmitting NACK\n", slam );
  260. /* Mark NACK as sent, so that we know we have to disconnect later */
  261. slam->nack_sent = 1;
  262. /* Use the current block size as a good estimate of how much
  263. * data we can fit in a packet. If we overrun, it seems to be
  264. * acceptable to drop information anyway.
  265. */
  266. iobuf = xfer_alloc_iob ( &slam->socket, SLAM_MAX_NACK_LEN );
  267. if ( ! iobuf ) {
  268. DBGC ( slam, "SLAM %p could not allocate I/O buffer\n",
  269. slam );
  270. return -ENOMEM;
  271. }
  272. /* Build block list. (Errors are non-fatal; it just means we
  273. * couldn't fit the compressed list within the packet.)
  274. */
  275. slam_build_block_list ( slam, iobuf );
  276. /* Add NUL terminator */
  277. nul = iob_put ( iobuf, 1 );
  278. *nul = 0;
  279. /* Transmit packet */
  280. return xfer_deliver_iob ( &slam->socket, iobuf );
  281. }
  282. /**
  283. * Handle SLAM retransmission timer expiry
  284. *
  285. * @v timer Retry timer
  286. * @v fail Failure indicator
  287. */
  288. static void slam_timer_expired ( struct retry_timer *timer, int fail ) {
  289. struct slam_request *slam =
  290. container_of ( timer, struct slam_request, timer );
  291. if ( fail ) {
  292. slam_finished ( slam, -ETIMEDOUT );
  293. } else {
  294. start_timer ( timer );
  295. slam_tx_nack ( slam );
  296. }
  297. }
  298. /****************************************************************************
  299. *
  300. * RX datapath
  301. *
  302. */
  303. /**
  304. * Read and strip a variable-length value from a SLAM packet
  305. *
  306. * @v slam SLAM request
  307. * @v iobuf I/O buffer
  308. * @v value Value to fill in, or NULL to ignore value
  309. * @ret rc Return status code
  310. *
  311. * Reads a variable-length value from the start of the I/O buffer.
  312. */
  313. static int slam_pull_value ( struct slam_request *slam,
  314. struct io_buffer *iobuf,
  315. unsigned long *value ) {
  316. uint8_t *data;
  317. size_t len;
  318. /* Sanity check */
  319. if ( iob_len ( iobuf ) == 0 ) {
  320. DBGC ( slam, "SLAM %p empty value\n", slam );
  321. return -EINVAL;
  322. }
  323. /* Read and verify length of value */
  324. data = iobuf->data;
  325. len = ( *data >> 5 );
  326. if ( ( len == 0 ) ||
  327. ( value && ( len > sizeof ( *value ) ) ) ) {
  328. DBGC ( slam, "SLAM %p invalid value length %d bytes\n",
  329. slam, len );
  330. return -EINVAL;
  331. }
  332. if ( len > iob_len ( iobuf ) ) {
  333. DBGC ( slam, "SLAM %p value extends beyond I/O buffer\n",
  334. slam );
  335. return -EINVAL;
  336. }
  337. /* Read value */
  338. iob_pull ( iobuf, len );
  339. *value = ( *data & 0x1f );
  340. while ( --len ) {
  341. *value <<= 8;
  342. *value |= *(++data);
  343. }
  344. return 0;
  345. }
  346. /**
  347. * Read and strip SLAM header
  348. *
  349. * @v slam SLAM request
  350. * @v iobuf I/O buffer
  351. * @ret rc Return status code
  352. */
  353. static int slam_pull_header ( struct slam_request *slam,
  354. struct io_buffer *iobuf ) {
  355. void *header = iobuf->data;
  356. int rc;
  357. /* If header matches cached header, just pull it and return */
  358. if ( ( slam->header_len <= iob_len ( iobuf ) ) &&
  359. ( memcmp ( slam->header, iobuf->data, slam->header_len ) == 0 )){
  360. iob_pull ( iobuf, slam->header_len );
  361. return 0;
  362. }
  363. DBGC ( slam, "SLAM %p detected changed header; resetting\n", slam );
  364. /* Read and strip transaction ID, total number of bytes, and
  365. * block size.
  366. */
  367. if ( ( rc = slam_pull_value ( slam, iobuf, NULL ) ) != 0 )
  368. return rc;
  369. if ( ( rc = slam_pull_value ( slam, iobuf,
  370. &slam->total_bytes ) ) != 0 )
  371. return rc;
  372. if ( ( rc = slam_pull_value ( slam, iobuf,
  373. &slam->block_size ) ) != 0 )
  374. return rc;
  375. /* Update the cached header */
  376. slam->header_len = ( iobuf->data - header );
  377. assert ( slam->header_len <= sizeof ( slam->header ) );
  378. memcpy ( slam->header, header, slam->header_len );
  379. /* Calculate number of blocks */
  380. slam->num_blocks = ( ( slam->total_bytes + slam->block_size - 1 ) /
  381. slam->block_size );
  382. DBGC ( slam, "SLAM %p has total bytes %ld, block size %ld, num "
  383. "blocks %ld\n", slam, slam->total_bytes, slam->block_size,
  384. slam->num_blocks );
  385. /* Discard and reset the bitmap */
  386. bitmap_free ( &slam->bitmap );
  387. memset ( &slam->bitmap, 0, sizeof ( slam->bitmap ) );
  388. /* Allocate a new bitmap */
  389. if ( ( rc = bitmap_resize ( &slam->bitmap,
  390. slam->num_blocks ) ) != 0 ) {
  391. /* Failure to allocate a bitmap is fatal */
  392. DBGC ( slam, "SLAM %p could not allocate bitmap for %ld "
  393. "blocks: %s\n", slam, slam->num_blocks,
  394. strerror ( rc ) );
  395. slam_finished ( slam, rc );
  396. return rc;
  397. }
  398. /* Notify recipient of file size */
  399. xfer_seek ( &slam->xfer, slam->total_bytes, SEEK_SET );
  400. return 0;
  401. }
  402. /**
  403. * Receive SLAM data packet
  404. *
  405. * @v mc_socket SLAM multicast socket
  406. * @v iobuf I/O buffer
  407. * @ret rc Return status code
  408. */
  409. static int slam_mc_socket_deliver ( struct xfer_interface *mc_socket,
  410. struct io_buffer *iobuf,
  411. struct xfer_metadata *rx_meta __unused ) {
  412. struct slam_request *slam =
  413. container_of ( mc_socket, struct slam_request, mc_socket );
  414. struct xfer_metadata meta;
  415. unsigned long packet;
  416. size_t len;
  417. int rc;
  418. /* Hit the timer */
  419. stop_timer ( &slam->timer );
  420. start_timer ( &slam->timer );
  421. /* Read and strip packet header */
  422. if ( ( rc = slam_pull_header ( slam, iobuf ) ) != 0 )
  423. goto err_discard;
  424. /* Read and strip packet number */
  425. if ( ( rc = slam_pull_value ( slam, iobuf, &packet ) ) != 0 )
  426. goto err_discard;
  427. /* Sanity check packet number */
  428. if ( packet >= slam->num_blocks ) {
  429. DBGC ( slam, "SLAM %p received out-of-range packet %ld "
  430. "(num_blocks=%ld)\n", slam, packet, slam->num_blocks );
  431. rc = -EINVAL;
  432. goto err_discard;
  433. }
  434. /* Sanity check length */
  435. len = iob_len ( iobuf );
  436. if ( len > slam->block_size ) {
  437. DBGC ( slam, "SLAM %p received oversize packet of %zd bytes "
  438. "(block_size=%ld)\n", slam, len, slam->block_size );
  439. rc = -EINVAL;
  440. goto err_discard;
  441. }
  442. if ( ( packet != ( slam->num_blocks - 1 ) ) &&
  443. ( len < slam->block_size ) ) {
  444. DBGC ( slam, "SLAM %p received short packet of %zd bytes "
  445. "(block_size=%ld)\n", slam, len, slam->block_size );
  446. rc = -EINVAL;
  447. goto err_discard;
  448. }
  449. /* If we have already seen this packet, discard it */
  450. if ( bitmap_test ( &slam->bitmap, packet ) ) {
  451. goto discard;
  452. }
  453. /* Pass to recipient */
  454. memset ( &meta, 0, sizeof ( meta ) );
  455. meta.whence = SEEK_SET;
  456. meta.offset = ( packet * slam->block_size );
  457. if ( ( rc = xfer_deliver_iob_meta ( &slam->xfer, iobuf,
  458. &meta ) ) != 0 )
  459. goto err;
  460. /* Mark block as received */
  461. bitmap_set ( &slam->bitmap, packet );
  462. /* If we have received all blocks, terminate */
  463. if ( bitmap_full ( &slam->bitmap ) )
  464. slam_finished ( slam, 0 );
  465. return 0;
  466. err_discard:
  467. discard:
  468. free_iob ( iobuf );
  469. err:
  470. return rc;
  471. }
  472. /**
  473. * Receive SLAM non-data packet
  474. *
  475. * @v socket SLAM unicast socket
  476. * @v iobuf I/O buffer
  477. * @ret rc Return status code
  478. */
  479. static int slam_socket_deliver ( struct xfer_interface *socket,
  480. struct io_buffer *iobuf,
  481. struct xfer_metadata *rx_meta __unused ) {
  482. struct slam_request *slam =
  483. container_of ( socket, struct slam_request, socket );
  484. int rc;
  485. /* Hit the timer */
  486. stop_timer ( &slam->timer );
  487. start_timer ( &slam->timer );
  488. /* Read and strip packet header */
  489. if ( ( rc = slam_pull_header ( slam, iobuf ) ) != 0 )
  490. goto discard;
  491. /* Sanity check */
  492. if ( iob_len ( iobuf ) != 0 ) {
  493. DBGC ( slam, "SLAM %p received trailing garbage:\n", slam );
  494. DBGC_HD ( slam, iobuf->data, iob_len ( iobuf ) );
  495. rc = -EINVAL;
  496. goto discard;
  497. }
  498. /* Discard packet */
  499. free_iob ( iobuf );
  500. /* Send NACK in reply */
  501. slam_tx_nack ( slam );
  502. return 0;
  503. discard:
  504. free_iob ( iobuf );
  505. return rc;
  506. }
  507. /**
  508. * Close SLAM unicast socket
  509. *
  510. * @v socket SLAM unicast socket
  511. * @v rc Reason for close
  512. */
  513. static void slam_socket_close ( struct xfer_interface *socket, int rc ) {
  514. struct slam_request *slam =
  515. container_of ( socket, struct slam_request, socket );
  516. DBGC ( slam, "SLAM %p unicast socket closed: %s\n",
  517. slam, strerror ( rc ) );
  518. slam_finished ( slam, rc );
  519. }
  520. /** SLAM unicast socket data transfer operations */
  521. static struct xfer_interface_operations slam_socket_operations = {
  522. .close = slam_socket_close,
  523. .vredirect = xfer_vopen,
  524. .window = unlimited_xfer_window,
  525. .alloc_iob = default_xfer_alloc_iob,
  526. .deliver_iob = slam_socket_deliver,
  527. .deliver_raw = xfer_deliver_as_iob,
  528. };
  529. /**
  530. * Close SLAM multicast socket
  531. *
  532. * @v mc_socket SLAM multicast socket
  533. * @v rc Reason for close
  534. */
  535. static void slam_mc_socket_close ( struct xfer_interface *mc_socket, int rc ){
  536. struct slam_request *slam =
  537. container_of ( mc_socket, struct slam_request, mc_socket );
  538. DBGC ( slam, "SLAM %p multicast socket closed: %s\n",
  539. slam, strerror ( rc ) );
  540. slam_finished ( slam, rc );
  541. }
  542. /** SLAM multicast socket data transfer operations */
  543. static struct xfer_interface_operations slam_mc_socket_operations = {
  544. .close = slam_mc_socket_close,
  545. .vredirect = xfer_vopen,
  546. .window = unlimited_xfer_window,
  547. .alloc_iob = default_xfer_alloc_iob,
  548. .deliver_iob = slam_mc_socket_deliver,
  549. .deliver_raw = xfer_deliver_as_iob,
  550. };
  551. /****************************************************************************
  552. *
  553. * Data transfer interface
  554. *
  555. */
  556. /**
  557. * Close SLAM data transfer interface
  558. *
  559. * @v xfer SLAM data transfer interface
  560. * @v rc Reason for close
  561. */
  562. static void slam_xfer_close ( struct xfer_interface *xfer, int rc ) {
  563. struct slam_request *slam =
  564. container_of ( xfer, struct slam_request, xfer );
  565. DBGC ( slam, "SLAM %p data transfer interface closed: %s\n",
  566. slam, strerror ( rc ) );
  567. slam_finished ( slam, rc );
  568. }
  569. /** SLAM data transfer operations */
  570. static struct xfer_interface_operations slam_xfer_operations = {
  571. .close = slam_xfer_close,
  572. .vredirect = ignore_xfer_vredirect,
  573. .window = unlimited_xfer_window,
  574. .alloc_iob = default_xfer_alloc_iob,
  575. .deliver_iob = xfer_deliver_as_raw,
  576. .deliver_raw = ignore_xfer_deliver_raw,
  577. };
  578. /**
  579. * Parse SLAM URI multicast address
  580. *
  581. * @v slam SLAM request
  582. * @v path Path portion of x-slam:// URI
  583. * @v address Socket address to fill in
  584. * @ret rc Return status code
  585. */
  586. static int slam_parse_multicast_address ( struct slam_request *slam,
  587. const char *path,
  588. struct sockaddr_in *address ) {
  589. char path_dup[ strlen ( path ) /* no +1 */ ];
  590. char *sep;
  591. char *end;
  592. /* Create temporary copy of path, minus the leading '/' */
  593. assert ( *path == '/' );
  594. memcpy ( path_dup, ( path + 1 ) , sizeof ( path_dup ) );
  595. /* Parse port, if present */
  596. sep = strchr ( path_dup, ':' );
  597. if ( sep ) {
  598. *(sep++) = '\0';
  599. address->sin_port = htons ( strtoul ( sep, &end, 0 ) );
  600. if ( *end != '\0' ) {
  601. DBGC ( slam, "SLAM %p invalid multicast port "
  602. "\"%s\"\n", slam, sep );
  603. return -EINVAL;
  604. }
  605. }
  606. /* Parse address */
  607. if ( inet_aton ( path_dup, &address->sin_addr ) == 0 ) {
  608. DBGC ( slam, "SLAM %p invalid multicast address \"%s\"\n",
  609. slam, path_dup );
  610. return -EINVAL;
  611. }
  612. return 0;
  613. }
  614. /**
  615. * Initiate a SLAM request
  616. *
  617. * @v xfer Data transfer interface
  618. * @v uri Uniform Resource Identifier
  619. * @ret rc Return status code
  620. */
  621. static int slam_open ( struct xfer_interface *xfer, struct uri *uri ) {
  622. static const struct sockaddr_in default_multicast = {
  623. .sin_family = AF_INET,
  624. .sin_port = htons ( SLAM_DEFAULT_MULTICAST_PORT ),
  625. .sin_addr = { htonl ( SLAM_DEFAULT_MULTICAST_IP ) },
  626. };
  627. struct slam_request *slam;
  628. struct sockaddr_tcpip server;
  629. struct sockaddr_in multicast;
  630. int rc;
  631. /* Sanity checks */
  632. if ( ! uri->host )
  633. return -EINVAL;
  634. /* Allocate and populate structure */
  635. slam = zalloc ( sizeof ( *slam ) );
  636. if ( ! slam )
  637. return -ENOMEM;
  638. slam->refcnt.free = slam_free;
  639. xfer_init ( &slam->xfer, &slam_xfer_operations, &slam->refcnt );
  640. xfer_init ( &slam->socket, &slam_socket_operations, &slam->refcnt );
  641. xfer_init ( &slam->mc_socket, &slam_mc_socket_operations,
  642. &slam->refcnt );
  643. slam->timer.expired = slam_timer_expired;
  644. /* Fake an invalid cached header of { 0x00, ... } */
  645. slam->header_len = 1;
  646. /* Fake parameters for initial NACK */
  647. slam->num_blocks = 1;
  648. if ( ( rc = bitmap_resize ( &slam->bitmap, 1 ) ) != 0 ) {
  649. DBGC ( slam, "SLAM %p could not allocate initial bitmap: "
  650. "%s\n", slam, strerror ( rc ) );
  651. goto err;
  652. }
  653. /* Open unicast socket */
  654. memset ( &server, 0, sizeof ( server ) );
  655. server.st_port = htons ( uri_port ( uri, SLAM_DEFAULT_PORT ) );
  656. if ( ( rc = xfer_open_named_socket ( &slam->socket, SOCK_DGRAM,
  657. ( struct sockaddr * ) &server,
  658. uri->host, NULL ) ) != 0 ) {
  659. DBGC ( slam, "SLAM %p could not open unicast socket: %s\n",
  660. slam, strerror ( rc ) );
  661. goto err;
  662. }
  663. /* Open multicast socket */
  664. memcpy ( &multicast, &default_multicast, sizeof ( multicast ) );
  665. if ( uri->path &&
  666. ( ( rc = slam_parse_multicast_address ( slam, uri->path,
  667. &multicast ) ) != 0 ) ) {
  668. goto err;
  669. }
  670. if ( ( rc = xfer_open_socket ( &slam->mc_socket, SOCK_DGRAM,
  671. ( struct sockaddr * ) &multicast,
  672. ( struct sockaddr * ) &multicast ) ) != 0 ) {
  673. DBGC ( slam, "SLAM %p could not open multicast socket: %s\n",
  674. slam, strerror ( rc ) );
  675. goto err;
  676. }
  677. /* Start retry timer */
  678. start_timer ( &slam->timer );
  679. /* Attach to parent interface, mortalise self, and return */
  680. xfer_plug_plug ( &slam->xfer, xfer );
  681. ref_put ( &slam->refcnt );
  682. return 0;
  683. err:
  684. slam_finished ( slam, rc );
  685. ref_put ( &slam->refcnt );
  686. return rc;
  687. }
  688. /** SLAM URI opener */
  689. struct uri_opener slam_uri_opener __uri_opener = {
  690. .scheme = "x-slam",
  691. .open = slam_open,
  692. };