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

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