iPXE
peerblk.c
Go to the documentation of this file.
1/*
2 * Copyright (C) 2015 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 (at your option) 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
24FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25FILE_SECBOOT ( PERMITTED );
26
27#include <stdlib.h>
28#include <stdio.h>
29#include <string.h>
30#include <errno.h>
31#include <ipxe/http.h>
32#include <ipxe/iobuf.h>
33#include <ipxe/xfer.h>
34#include <ipxe/uri.h>
35#include <ipxe/timer.h>
36#include <ipxe/profile.h>
37#include <ipxe/fault.h>
38#include <ipxe/pccrr.h>
39#include <ipxe/peerblk.h>
40
41/** @file
42 *
43 * Peer Content Caching and Retrieval (PeerDist) protocol block downloads
44 *
45 */
46
47/** PeerDist decryption chunksize
48 *
49 * This is a policy decision.
50 */
51#define PEERBLK_DECRYPT_CHUNKSIZE 2048
52
53/** PeerDist maximum number of concurrent raw block downloads
54 *
55 * Raw block downloads are expensive if the origin server uses HTTPS,
56 * since each concurrent download will require local TLS resources
57 * (including potentially large received encrypted data buffers).
58 *
59 * Raw block downloads may also be prohibitively slow to initiate when
60 * the origin server is using HTTPS and client certificates. Origin
61 * servers for PeerDist downloads are likely to be running IIS, which
62 * has a bug that breaks session resumption and requires each
63 * connection to go through the full client certificate verification.
64 *
65 * Limit the total number of concurrent raw block downloads to
66 * ameliorate these problems.
67 *
68 * This is a policy decision.
69 */
70#define PEERBLK_RAW_MAX 2
71
72/** PeerDist raw block download attempt initial progress timeout
73 *
74 * This is a policy decision.
75 */
76#define PEERBLK_RAW_OPEN_TIMEOUT ( 10 * TICKS_PER_SEC )
77
78/** PeerDist raw block download attempt ongoing progress timeout
79 *
80 * This is a policy decision.
81 */
82#define PEERBLK_RAW_RX_TIMEOUT ( 15 * TICKS_PER_SEC )
83
84/** PeerDist retrieval protocol block download attempt initial progress timeout
85 *
86 * This is a policy decision.
87 */
88#define PEERBLK_RETRIEVAL_OPEN_TIMEOUT ( 3 * TICKS_PER_SEC )
89
90/** PeerDist retrieval protocol block download attempt ongoing progress timeout
91 *
92 * This is a policy decision.
93 */
94#define PEERBLK_RETRIEVAL_RX_TIMEOUT ( 5 * TICKS_PER_SEC )
95
96/** PeerDist maximum number of full download attempt cycles
97 *
98 * This is the maximum number of times that we will try a full cycle
99 * of download attempts (i.e. a retrieval protocol download attempt
100 * from each discovered peer plus a raw download attempt from the
101 * origin server).
102 *
103 * This is a policy decision.
104 */
105#define PEERBLK_MAX_ATTEMPT_CYCLES 4
106
107/** PeerDist block download profiler */
108static struct profiler peerblk_download_profiler __profiler =
109 { .name = "peerblk.download" };
110
111/** PeerDist block download attempt success profiler */
112static struct profiler peerblk_attempt_success_profiler __profiler =
113 { .name = "peerblk.attempt.success" };
114
115/** PeerDist block download attempt failure profiler */
116static struct profiler peerblk_attempt_failure_profiler __profiler =
117 { .name = "peerblk.attempt.failure" };
118
119/** PeerDist block download attempt timeout profiler */
120static struct profiler peerblk_attempt_timeout_profiler __profiler =
121 { .name = "peerblk.attempt.timeout" };
122
123/** PeerDist block download discovery success profiler */
124static struct profiler peerblk_discovery_success_profiler __profiler =
125 { .name = "peerblk.discovery.success" };
126
127/** PeerDist block download discovery timeout profiler */
128static struct profiler peerblk_discovery_timeout_profiler __profiler =
129 { .name = "peerblk.discovery.timeout" };
130
131static void peerblk_dequeue ( struct peerdist_block *peerblk );
132
133/**
134 * Get profiling timestamp
135 *
136 * @ret timestamp Timestamp
137 */
138static inline __attribute__ (( always_inline )) unsigned long
140
141 if ( PROFILING ) {
142 return currticks();
143 } else {
144 return 0;
145 }
146}
147
148/**
149 * Free PeerDist block download
150 *
151 * @v refcnt Reference count
152 */
153static void peerblk_free ( struct refcnt *refcnt ) {
154 struct peerdist_block *peerblk =
156
157 uri_put ( peerblk->uri );
158 free ( peerblk->cipherctx );
159 free ( peerblk );
160}
161
162/**
163 * Reset PeerDist block download attempt
164 *
165 * @v peerblk PeerDist block download
166 * @v rc Reason for reset
167 */
168static void peerblk_reset ( struct peerdist_block *peerblk, int rc ) {
169
170 /* Stop decryption process */
171 process_del ( &peerblk->process );
172
173 /* Stop timer */
174 stop_timer ( &peerblk->timer );
175
176 /* Abort any current download attempt */
177 intf_restart ( &peerblk->raw, rc );
178 intf_restart ( &peerblk->retrieval, rc );
179
180 /* Remove from download queue, if applicable */
181 if ( peerblk->queue )
182 peerblk_dequeue ( peerblk );
183
184 /* Empty received data buffer */
185 xferbuf_free ( &peerblk->buffer );
186 peerblk->pos = 0;
187
188 /* Reset digest and free cipher context */
189 digest_init ( peerblk->digest, peerblk->digestctx );
190 free ( peerblk->cipherctx );
191 peerblk->cipherctx = NULL;
192 peerblk->cipher = NULL;
193
194 /* Reset trim thresholds */
195 peerblk->start = ( peerblk->trim.start - peerblk->range.start );
196 peerblk->end = ( peerblk->trim.end - peerblk->range.start );
197 assert ( peerblk->start <= peerblk->end );
198}
199
200/**
201 * Close PeerDist block download
202 *
203 * @v peerblk PeerDist block download
204 * @v rc Reason for close
205 */
206static void peerblk_close ( struct peerdist_block *peerblk, int rc ) {
207 unsigned long now = peerblk_timestamp();
208
209 /* Profile overall block download */
210 profile_custom ( &peerblk_download_profiler,
211 ( now - peerblk->started ) );
212
213 /* Reset download attempt */
214 peerblk_reset ( peerblk, rc );
215
216 /* Close discovery */
217 peerdisc_close ( &peerblk->discovery );
218
219 /* Shut down all interfaces */
220 intf_shutdown ( &peerblk->retrieval, rc );
221 intf_shutdown ( &peerblk->raw, rc );
222 intf_shutdown ( &peerblk->xfer, rc );
223}
224
225/**
226 * Calculate offset within overall download
227 *
228 * @v peerblk PeerDist block download
229 * @v pos Position within incoming data stream
230 * @ret offset Offset within overall download
231 */
232static inline __attribute__ (( always_inline )) size_t
233peerblk_offset ( struct peerdist_block *peerblk, size_t pos ) {
234
235 return ( ( pos - peerblk->start ) + peerblk->offset );
236}
237
238/**
239 * Deliver download attempt data block
240 *
241 * @v peerblk PeerDist block download
242 * @v iobuf I/O buffer
243 * @v meta Original data transfer metadata
244 * @v pos Position within incoming data stream
245 * @ret rc Return status code
246 */
247static int peerblk_deliver ( struct peerdist_block *peerblk,
248 struct io_buffer *iobuf,
249 struct xfer_metadata *meta, size_t pos ) {
250 struct xfer_metadata xfer_meta;
251 size_t len = iob_len ( iobuf );
252 size_t start = pos;
253 size_t end = ( pos + len );
254 int rc;
255
256 /* Discard zero-length packets and packets which lie entirely
257 * outside the trimmed range.
258 */
259 if ( ( start >= peerblk->end ) || ( end <= peerblk->start ) ||
260 ( len == 0 ) ) {
261 free_iob ( iobuf );
262 return 0;
263 }
264
265 /* Truncate data to within trimmed range */
267 iob_pull ( iobuf, ( peerblk->start - start ) );
268 start = peerblk->start;
269 }
270 if ( end > peerblk->end ) {
271 iob_unput ( iobuf, ( end - peerblk->end ) );
272 end = peerblk->end;
273 }
274
275 /* Construct metadata */
276 memcpy ( &xfer_meta, meta, sizeof ( xfer_meta ) );
277 xfer_meta.flags |= XFER_FL_ABS_OFFSET;
278 xfer_meta.offset = peerblk_offset ( peerblk, start );
279
280 /* Deliver data */
281 if ( ( rc = xfer_deliver ( &peerblk->xfer, iob_disown ( iobuf ),
282 &xfer_meta ) ) != 0 ) {
283 DBGC ( peerblk, "PEERBLK %p %d.%d could not deliver data: %s\n",
284 peerblk, peerblk->segment, peerblk->block,
285 strerror ( rc ) );
286 return rc;
287 }
288
289 return 0;
290}
291
292/**
293 * Finish PeerDist block download attempt
294 *
295 * @v peerblk PeerDist block download
296 * @v rc Reason for close
297 */
298static void peerblk_done ( struct peerdist_block *peerblk, int rc ) {
299 struct digest_algorithm *digest = peerblk->digest;
300 struct peerdisc_segment *segment = peerblk->discovery.segment;
301 struct peerdisc_peer *head;
302 struct peerdisc_peer *peer;
303 uint8_t hash[digest->digestsize];
304 unsigned long now = peerblk_timestamp();
305
306 /* Check for errors on completion */
307 if ( rc != 0 ) {
308 DBGC ( peerblk, "PEERBLK %p %d.%d attempt failed: %s\n",
309 peerblk, peerblk->segment, peerblk->block,
310 strerror ( rc ) );
311 goto err;
312 }
313
314 /* Check digest */
315 digest_final ( digest, peerblk->digestctx, hash );
316 if ( memcmp ( hash, peerblk->hash, peerblk->digestsize ) != 0 ) {
317 DBGC ( peerblk, "PEERBLK %p %d.%d digest mismatch:\n",
318 peerblk, peerblk->segment, peerblk->block );
319 DBGC_HDA ( peerblk, 0, hash, peerblk->digestsize );
320 DBGC_HDA ( peerblk, 0, peerblk->hash, peerblk->digestsize );
321 rc = -EIO;
322 goto err;
323 }
324
325 /* Profile successful attempt */
326 profile_custom ( &peerblk_attempt_success_profiler,
327 ( now - peerblk->attempted ) );
328
329 /* Report peer statistics */
330 head = list_entry ( &segment->peers, struct peerdisc_peer, list );
331 peer = ( ( peerblk->peer == head ) ? NULL : peerblk->peer );
332 peerdisc_stat ( &peerblk->xfer, peer, &segment->peers );
333
334 /* Close download */
335 peerblk_close ( peerblk, 0 );
336 return;
337
338 err:
339 /* Record failure reason and schedule a retry attempt */
340 profile_custom ( &peerblk_attempt_failure_profiler,
341 ( now - peerblk->attempted ) );
342 peerblk_reset ( peerblk, rc );
343 peerblk->rc = rc;
344 start_timer_nodelay ( &peerblk->timer );
345}
346
347/******************************************************************************
348 *
349 * Raw block download attempts (using an HTTP range request)
350 *
351 ******************************************************************************
352 */
353
354/**
355 * Open PeerDist raw block download attempt
356 *
357 * @v peerblk PeerDist block download
358 * @ret rc Return status code
359 */
360static int peerblk_raw_open ( struct peerdist_block *peerblk ) {
362 int rc;
363
364 DBGC2 ( peerblk, "PEERBLK %p %d.%d attempting raw range request\n",
365 peerblk, peerblk->segment, peerblk->block );
366
367 /* Construct HTTP range */
368 memset ( &range, 0, sizeof ( range ) );
369 range.start = peerblk->range.start;
370 range.len = ( peerblk->range.end - peerblk->range.start );
371
372 /* Initiate range request to retrieve block */
373 if ( ( rc = http_open ( &peerblk->raw, &http_get, peerblk->uri,
374 &range, NULL ) ) != 0 ) {
375 DBGC ( peerblk, "PEERBLK %p %d.%d could not create range "
376 "request: %s\n", peerblk, peerblk->segment,
377 peerblk->block, strerror ( rc ) );
378 return rc;
379 }
380
381 /* Annul HTTP connection (for testing) if applicable. Do not
382 * report as an immediate error, in order to test our ability
383 * to recover from a totally unresponsive HTTP server.
384 */
385 if ( inject_fault ( PEERBLK_ANNUL_RATE ) )
386 intf_restart ( &peerblk->raw, 0 );
387
388 /* Start download attempt timer */
389 peerblk->rc = -ETIMEDOUT;
391
392 return 0;
393}
394
395/**
396 * Receive PeerDist raw data
397 *
398 * @v peerblk PeerDist block download
399 * @v iobuf I/O buffer
400 * @v meta Data transfer metadata
401 * @ret rc Return status code
402 */
403static int peerblk_raw_rx ( struct peerdist_block *peerblk,
404 struct io_buffer *iobuf,
405 struct xfer_metadata *meta ) {
406 size_t len = iob_len ( iobuf );
407 size_t pos = peerblk->pos;
408 size_t mid = ( ( peerblk->range.end - peerblk->range.start ) / 2 );
409 int rc;
410
411 /* Corrupt received data (for testing) if applicable */
412 inject_corruption ( PEERBLK_CORRUPT_RATE, iobuf->data, len );
413
414 /* Fail if data is delivered out of order, since the streaming
415 * digest requires strict ordering.
416 */
417 if ( ( rc = xfer_check_order ( meta, &peerblk->pos, len ) ) != 0 )
418 goto err;
419
420 /* Add data to digest */
421 digest_update ( peerblk->digest, peerblk->digestctx, iobuf->data, len );
422
423 /* Deliver data */
424 if ( ( rc = peerblk_deliver ( peerblk, iob_disown ( iobuf ), meta,
425 pos ) ) != 0 )
426 goto err;
427
428 /* Extend download attempt timer */
430
431 /* Stall download attempt (for testing) if applicable */
432 if ( ( pos < mid ) && ( ( pos + len ) >= mid ) &&
433 ( ( rc = inject_fault ( PEERBLK_STALL_RATE ) ) != 0 ) ) {
434 intf_restart ( &peerblk->raw, rc );
435 }
436
437 return 0;
438
439 err:
440 free_iob ( iobuf );
441 peerblk_done ( peerblk, rc );
442 return rc;
443}
444
445/**
446 * Close PeerDist raw block download attempt
447 *
448 * @v peerblk PeerDist block download
449 * @v rc Reason for close
450 */
451static void peerblk_raw_close ( struct peerdist_block *peerblk, int rc ) {
452
453 /* Restart interface */
454 intf_restart ( &peerblk->raw, rc );
455
456 /* Fail immediately if we have an error */
457 if ( rc != 0 )
458 goto done;
459
460 /* Abort download attempt (for testing) if applicable */
461 if ( ( rc = inject_fault ( PEERBLK_ABORT_RATE ) ) != 0 )
462 goto done;
463
464 done:
465 /* Complete download attempt */
466 peerblk_done ( peerblk, rc );
467}
468
469/******************************************************************************
470 *
471 * Block download queue
472 *
473 ******************************************************************************
474 */
475
476/**
477 * PeerDist block download queue process
478 *
479 * @v queue Block download queue
480 */
481static void peerblk_step ( struct peerdist_block_queue *queue ) {
482 struct peerdist_block *peerblk;
483 int rc;
484
485 /* Do nothing yet if we have too many open block downloads */
486 if ( queue->count >= queue->max )
487 return;
488
489 /* Do nothing unless there are queued block downloads */
490 peerblk = list_first_entry ( &queue->list, struct peerdist_block,
491 queued );
492 if ( ! peerblk )
493 return;
494
495 /* Reschedule queue process */
496 process_add ( &queue->process );
497
498 /* Remove block from queue */
499 list_del ( &peerblk->queued );
500 INIT_LIST_HEAD ( &peerblk->queued );
501
502 /* Attempt download */
503 if ( ( rc = queue->open ( peerblk ) ) != 0 ) {
504 peerblk_close ( peerblk, rc );
505 return;
506 }
507
508 /* Increment open block download count */
509 queue->count++;
510}
511
512/**
513 * Add block to download queue
514 *
515 * @v peerblk PeerDist block download
516 * @v queue Block download queue
517 */
518static void peerblk_enqueue ( struct peerdist_block *peerblk,
519 struct peerdist_block_queue *queue ) {
520
521 /* Sanity checks */
522 assert ( peerblk->queue == NULL );
523 assert ( list_empty ( &peerblk->queued ) );
524
525 /* Add block to queue */
526 peerblk->queue = queue;
527 list_add_tail ( &peerblk->queued, &queue->list );
528
529 /* Schedule queue process */
530 process_add ( &queue->process );
531}
532
533/**
534 * Remove block from download queue
535 *
536 * @v peerblk PeerDist block download
537 */
538static void peerblk_dequeue ( struct peerdist_block *peerblk ) {
539 struct peerdist_block_queue *queue = peerblk->queue;
540
541 /* Sanity checks */
542 assert ( queue != NULL );
543
544 /* Remove block from queue */
545 peerblk->queue = NULL;
546 if ( list_empty ( &peerblk->queued ) ) {
547
548 /* Open download: decrement count and reschedule queue */
549 queue->count--;
550 process_add ( &queue->process );
551
552 } else {
553
554 /* Queued download: remove from queue */
555 list_del ( &peerblk->queued );
556 INIT_LIST_HEAD ( &peerblk->queued );
557 }
558}
559
560/** PeerDist block download queue process descriptor */
563
564/** Raw block download queue */
566 .process = PROC_INIT ( peerblk_raw_queue.process, &peerblk_queue_desc ),
567 .list = LIST_HEAD_INIT ( peerblk_raw_queue.list ),
568 .max = PEERBLK_RAW_MAX,
569 .open = peerblk_raw_open,
570};
571
572/******************************************************************************
573 *
574 * Retrieval protocol block download attempts
575 *
576 ******************************************************************************
577 */
578
579/**
580 * Open PeerDist retrieval protocol block download attempt
581 *
582 * @v peerblk PeerDist block download
583 * @v retrieval Retrieval protocol
584 * @v location Peer location
585 * @ret rc Return status code
586 */
587static int peerblk_retrieval_open ( struct peerdist_block *peerblk,
588 struct peerdist_retrieval *retrieval,
589 const char *location ) {
590 size_t digestsize = peerblk->digestsize;
591 peerblk_msg_blk_t ( digestsize, 0, 0, 0 ) *rsp;
592 int rc;
593
594 DBGC2 ( peerblk, "PEERBLK %p %d.%d attempting %s retrieval from %s\n",
595 peerblk, peerblk->segment, peerblk->block, retrieval->name,
596 location );
597
598 /* Open connection */
599 if ( ( rc = retrieval->open ( &peerblk->retrieval, location,
600 digestsize, peerblk->id,
601 peerblk->block ) ) != 0 ) {
602 DBGC ( peerblk, "PEERBLK %p %d.%d could not create %s "
603 "retrieval request: %s\n", peerblk, peerblk->segment,
604 peerblk->block, retrieval->name, strerror ( rc ) );
605 return rc;
606 }
607
608 /* Update trim thresholds for retrieval protocol format */
609 peerblk->start += offsetof ( typeof ( *rsp ), msg.vrf );
610 peerblk->end += offsetof ( typeof ( *rsp ), msg.vrf );
611
612 /* Annul connection (for testing) if applicable. Do not
613 * report as an immediate error, in order to test our ability
614 * to recover from a totally unresponsive HTTP server.
615 */
616 if ( inject_fault ( PEERBLK_ANNUL_RATE ) )
617 intf_restart ( &peerblk->retrieval, 0 );
618
619 /* Start download attempt timer */
620 peerblk->rc = -ETIMEDOUT;
622
623 return 0;
624}
625
626/**
627 * Receive PeerDist retrieval protocol data
628 *
629 * @v peerblk PeerDist block download
630 * @v iobuf I/O buffer
631 * @v meta Data transfer metadata
632 * @ret rc Return status code
633 */
634static int peerblk_retrieval_rx ( struct peerdist_block *peerblk,
635 struct io_buffer *iobuf,
636 struct xfer_metadata *meta ) {
637 size_t len = iob_len ( iobuf );
638 size_t start;
639 size_t end;
640 size_t before;
641 size_t after;
642 size_t cut;
643 int rc;
644
645 /* Some genius at Microsoft thought it would be a great idea
646 * to place the AES-CBC initialisation vector *after* the
647 * encrypted data, thereby making it logically impossible to
648 * decrypt each packet as it arrives.
649 *
650 * To work around this mindless stupidity, we deliver the
651 * ciphertext as-is and later use xfer_buffer() to obtain
652 * access to the underlying data transfer buffer in order to
653 * perform the decryption.
654 *
655 * There will be some data both before and after the bytes
656 * corresponding to the trimmed plaintext: a MSG_BLK
657 * header/footer, some block padding for the AES-CBC cipher,
658 * and a possibly large quantity of unwanted ciphertext which
659 * is excluded from the trimmed content range. We store this
660 * data in a local data transfer buffer. If the amount of
661 * data to be stored is too large, we will fail allocation and
662 * so eventually fall back to using a range request (which
663 * does not require this kind of temporary storage
664 * allocation).
665 */
666
667 /* Corrupt received data (for testing) if applicable */
668 inject_corruption ( PEERBLK_CORRUPT_RATE, iobuf->data, len );
669
670 /* Calculate start and end positions of this buffer */
671 start = peerblk->pos;
672 if ( meta->flags & XFER_FL_ABS_OFFSET )
673 start = 0;
674 start += meta->offset;
675 end = ( start + len );
676
677 /* Buffer any data before the trimmed content */
678 if ( ( start < peerblk->start ) && ( len > 0 ) ) {
679
680 /* Calculate length of data before the trimmed content */
681 before = ( peerblk->start - start );
682 if ( before > len )
683 before = len;
684
685 /* Buffer data before the trimmed content */
686 if ( ( rc = xferbuf_write ( &peerblk->buffer, start,
687 iobuf->data, before ) ) != 0 ) {
688 DBGC ( peerblk, "PEERBLK %p %d.%d could not buffer "
689 "data: %s\n", peerblk, peerblk->segment,
690 peerblk->block, strerror ( rc ) );
691 goto err;
692 }
693 }
694
695 /* Buffer any data after the trimmed content */
696 if ( ( end > peerblk->end ) && ( len > 0 ) ) {
697
698 /* Calculate length of data after the trimmed content */
699 after = ( end - peerblk->end );
700 if ( after > len )
701 after = len;
702
703 /* Buffer data after the trimmed content */
704 cut = ( peerblk->end - peerblk->start );
705 if ( ( rc = xferbuf_write ( &peerblk->buffer,
706 ( end - after - cut ),
707 ( iobuf->data + len - after ),
708 after ) ) != 0 ) {
709 DBGC ( peerblk, "PEERBLK %p %d.%d could not buffer "
710 "data: %s\n", peerblk, peerblk->segment,
711 peerblk->block, strerror ( rc ) );
712 goto err;
713 }
714 }
715
716 /* Deliver any remaining data */
717 if ( ( rc = peerblk_deliver ( peerblk, iob_disown ( iobuf ), meta,
718 start ) ) != 0 )
719 goto err;
720
721 /* Update position */
722 peerblk->pos = end;
723
724 /* Extend download attempt timer */
726
727 /* Stall download attempt (for testing) if applicable */
728 if ( ( start < peerblk->end ) && ( end >= peerblk->end ) &&
729 ( ( rc = inject_fault ( PEERBLK_STALL_RATE ) ) != 0 ) ) {
730 intf_restart ( &peerblk->retrieval, rc );
731 }
732
733 return 0;
734
735 err:
736 free_iob ( iobuf );
737 peerblk_done ( peerblk, rc );
738 return rc;
739}
740
741/**
742 * Parse retrieval protocol message header
743 *
744 * @v peerblk PeerDist block download
745 * @ret rc Return status code
746 */
747static int peerblk_parse_header ( struct peerdist_block *peerblk ) {
748 struct {
751 } __attribute__ (( packed )) *msg = peerblk->buffer.data;
752 struct cipher_algorithm *cipher;
753 size_t len = peerblk->buffer.len;
754 size_t keylen = 0;
755 int rc;
756
757 /* Check message length */
758 if ( len < sizeof ( *msg ) ) {
759 DBGC ( peerblk, "PEERBLK %p %d.%d message too short for header "
760 "(%zd bytes)\n", peerblk, peerblk->segment,
761 peerblk->block, len );
762 return -ERANGE;
763 }
764
765 /* Check message type */
766 if ( msg->msg.type != htonl ( PEERDIST_MSG_BLK_TYPE ) ) {
767 DBGC ( peerblk, "PEERBLK %p %d.%d unexpected message type "
768 "%#08x\n", peerblk, peerblk->segment, peerblk->block,
769 ntohl ( msg->msg.type ) );
770 return -EPROTO;
771 }
772
773 /* Determine cipher algorithm and key length */
774 cipher = &aes_cbc_algorithm;
775 switch ( msg->msg.algorithm ) {
777 cipher = NULL;
778 break;
780 keylen = ( 128 / 8 );
781 break;
783 keylen = ( 192 / 8 );
784 break;
786 keylen = ( 256 / 8 );
787 break;
788 default:
789 DBGC ( peerblk, "PEERBLK %p %d.%d unrecognised algorithm "
790 "%#08x\n", peerblk, peerblk->segment, peerblk->block,
791 ntohl ( msg->msg.algorithm ) );
792 return -ENOTSUP;
793 }
794 DBGC2 ( peerblk, "PEERBLK %p %d.%d using %s with %zd-bit key\n",
795 peerblk, peerblk->segment, peerblk->block,
796 ( cipher ? cipher->name : "plaintext" ), ( 8 * keylen ) );
797
798 /* Sanity check key length against maximum secret length */
799 if ( keylen > peerblk->digestsize ) {
800 DBGC ( peerblk, "PEERBLK %p %d.%d %zd-byte secret too short "
801 "for %zd-bit key\n", peerblk, peerblk->segment,
802 peerblk->block, peerblk->digestsize, ( 8 * keylen ) );
803 return -EPROTO;
804 }
805
806 /* Allocate cipher context, if applicable. Freeing the cipher
807 * context (on error or otherwise) is handled by peerblk_reset().
808 */
809 peerblk->cipher = cipher;
810 assert ( peerblk->cipherctx == NULL );
811 if ( cipher ) {
812 peerblk->cipherctx = malloc ( cipher->ctxsize );
813 if ( ! peerblk->cipherctx )
814 return -ENOMEM;
815 }
816
817 /* Initialise cipher, if applicable */
818 if ( cipher &&
819 ( rc = cipher_setkey ( cipher, peerblk->cipherctx, peerblk->secret,
820 keylen ) ) != 0 ) {
821 DBGC ( peerblk, "PEERBLK %p %d.%d could not set key: %s\n",
822 peerblk, peerblk->segment, peerblk->block,
823 strerror ( rc ) );
824 return rc;
825 }
826
827 return 0;
828}
829
830/**
831 * Parse retrieval protocol message segment and block details
832 *
833 * @v peerblk PeerDist block download
834 * @v buf_len Length of buffered data to fill in
835 * @ret rc Return status code
836 */
837static int peerblk_parse_block ( struct peerdist_block *peerblk,
838 size_t *buf_len ) {
839 size_t digestsize = peerblk->digestsize;
840 peerblk_msg_blk_t ( digestsize, 0, 0, 0 ) *msg = peerblk->buffer.data;
841 size_t len = peerblk->buffer.len;
842 size_t data_len;
843 size_t total;
844
845 /* Check message length */
846 if ( len < offsetof ( typeof ( *msg ), msg.block.data ) ) {
847 DBGC ( peerblk, "PEERBLK %p %d.%d message too short for "
848 "zero-length data (%zd bytes)\n", peerblk,
849 peerblk->segment, peerblk->block, len );
850 return -ERANGE;
851 }
852
853 /* Check digest size */
854 if ( ntohl ( msg->msg.segment.segment.digestsize ) != digestsize ) {
855 DBGC ( peerblk, "PEERBLK %p %d.%d incorrect digest size %d\n",
856 peerblk, peerblk->segment, peerblk->block,
857 ntohl ( msg->msg.segment.segment.digestsize ) );
858 return -EPROTO;
859 }
860
861 /* Check segment ID */
862 if ( memcmp ( msg->msg.segment.id, peerblk->id, digestsize ) != 0 ) {
863 DBGC ( peerblk, "PEERBLK %p %d.%d segment ID mismatch\n",
864 peerblk, peerblk->segment, peerblk->block );
865 return -EPROTO;
866 }
867
868 /* Check block ID */
869 if ( ntohl ( msg->msg.index ) != peerblk->block ) {
870 DBGC ( peerblk, "PEERBLK %p %d.%d block ID mismatch (got %d)\n",
871 peerblk, peerblk->segment, peerblk->block,
872 ntohl ( msg->msg.index ) );
873 return -EPROTO;
874 }
875
876 /* Check for missing blocks */
877 data_len = be32_to_cpu ( msg->msg.block.block.len );
878 if ( ! data_len ) {
879 DBGC ( peerblk, "PEERBLK %p %d.%d block not found\n",
880 peerblk, peerblk->segment, peerblk->block );
881 return -ENOENT;
882 }
883
884 /* Check for underlength blocks */
885 if ( data_len < ( peerblk->range.end - peerblk->range.start ) ) {
886 DBGC ( peerblk, "PEERBLK %p %d.%d underlength block (%zd "
887 "bytes)\n", peerblk, peerblk->segment, peerblk->block,
888 data_len );
889 return -ERANGE;
890 }
891
892 /* Calculate buffered data length (i.e. excluding data which
893 * was delivered to the final data transfer buffer).
894 */
895 *buf_len = ( data_len - ( peerblk->end - peerblk->start ) );
896
897 /* Describe data before the trimmed content */
898 peerblk->decrypt[PEERBLK_BEFORE].xferbuf = &peerblk->buffer;
899 peerblk->decrypt[PEERBLK_BEFORE].offset =
900 offsetof ( typeof ( *msg ), msg.block.data );
901 peerblk->decrypt[PEERBLK_BEFORE].len =
902 ( peerblk->start -
903 offsetof ( typeof ( *msg ), msg.block.data ) );
904 total = peerblk->decrypt[PEERBLK_BEFORE].len;
905
906 /* Describe data within the trimmed content */
907 peerblk->decrypt[PEERBLK_DURING].offset =
908 peerblk_offset ( peerblk, peerblk->start );
909 peerblk->decrypt[PEERBLK_DURING].len =
910 ( peerblk->end - peerblk->start );
911 total += peerblk->decrypt[PEERBLK_DURING].len;
912
913 /* Describe data after the trimmed content */
914 peerblk->decrypt[PEERBLK_AFTER].xferbuf = &peerblk->buffer;
915 peerblk->decrypt[PEERBLK_AFTER].offset = peerblk->start;
916 peerblk->decrypt[PEERBLK_AFTER].len =
917 ( offsetof ( typeof ( *msg ), msg.block.data )
918 + *buf_len - peerblk->start );
919 total += peerblk->decrypt[PEERBLK_AFTER].len;
920
921 /* Sanity check */
922 assert ( total == be32_to_cpu ( msg->msg.block.block.len ) );
923
924 /* Initialise cipher and digest lengths */
925 peerblk->cipher_remaining = total;
926 peerblk->digest_remaining =
927 ( peerblk->range.end - peerblk->range.start );
928 assert ( peerblk->cipher_remaining >= peerblk->digest_remaining );
929
930 return 0;
931}
932
933/**
934 * Parse retrieval protocol message useless details
935 *
936 * @v peerblk PeerDist block download
937 * @v buf_len Length of buffered data
938 * @v vrf_len Length of uselessness to fill in
939 * @ret rc Return status code
940 */
941static int peerblk_parse_useless ( struct peerdist_block *peerblk,
942 size_t buf_len, size_t *vrf_len ) {
943 size_t digestsize = peerblk->digestsize;
944 peerblk_msg_blk_t ( digestsize, buf_len, 0, 0 ) *msg =
945 peerblk->buffer.data;
946 size_t len = peerblk->buffer.len;
947
948 /* Check message length */
949 if ( len < offsetof ( typeof ( *msg ), msg.vrf.data ) ) {
950 DBGC ( peerblk, "PEERBLK %p %d.%d message too short for "
951 "zero-length uselessness (%zd bytes)\n", peerblk,
952 peerblk->segment, peerblk->block, len );
953 return -ERANGE;
954 }
955
956 /* Extract length of uselessness */
957 *vrf_len = be32_to_cpu ( msg->msg.vrf.vrf.len );
958
959 return 0;
960}
961
962/**
963 * Parse retrieval protocol message initialisation vector details
964 *
965 * @v peerblk PeerDist block download
966 * @v buf_len Length of buffered data
967 * @v vrf_len Length of uselessness
968 * @ret rc Return status code
969 */
970static int peerblk_parse_iv ( struct peerdist_block *peerblk, size_t buf_len,
971 size_t vrf_len ) {
972 size_t digestsize = peerblk->digestsize;
973 size_t blksize = peerblk->cipher->blocksize;
974 peerblk_msg_blk_t ( digestsize, buf_len, vrf_len, blksize ) *msg =
975 peerblk->buffer.data;
976 size_t len = peerblk->buffer.len;
977 size_t ivlen;
978 int rc;
979
980 /* Check message length */
981 if ( len < sizeof ( *msg ) ) {
982 DBGC ( peerblk, "PEERBLK %p %d.%d message too short for "
983 "initialisation vector (%zd bytes)\n", peerblk,
984 peerblk->segment, peerblk->block, len );
985 return -ERANGE;
986 }
987 ivlen = ntohl ( msg->msg.iv.iv.blksize );
988
989 /* Set initialisation vector */
990 if ( ( rc = cipher_setiv ( peerblk->cipher, peerblk->cipherctx,
991 msg->msg.iv.data, ivlen ) ) != 0 ) {
992 DBGC ( peerblk, "PEERBLK %p %d.%d could not set IV: %s\n",
993 peerblk, peerblk->segment, peerblk->block,
994 strerror ( rc ) );
995 return rc;
996 }
997
998 return 0;
999}
1000
1001/**
1002 * Read from decryption buffers
1003 *
1004 * @v peerblk PeerDist block download
1005 * @v data Data buffer
1006 * @v len Length to read
1007 * @ret rc Return status code
1008 */
1009static int peerblk_decrypt_read ( struct peerdist_block *peerblk,
1010 void *data, size_t len ) {
1011 struct peerdist_block_decrypt *decrypt = peerblk->decrypt;
1012 size_t frag_len;
1013 int rc;
1014
1015 /* Read from each decryption buffer in turn */
1016 for ( ; len ; decrypt++, data += frag_len, len -= frag_len ) {
1017
1018 /* Calculate length to use from this buffer */
1019 frag_len = decrypt->len;
1020 if ( frag_len > len )
1021 frag_len = len;
1022 if ( ! frag_len )
1023 continue;
1024
1025 /* Read from this buffer */
1026 if ( ( rc = xferbuf_read ( decrypt->xferbuf, decrypt->offset,
1027 data, frag_len ) ) != 0 )
1028 return rc;
1029 }
1030
1031 return 0;
1032}
1033
1034/**
1035 * Write to decryption buffers and update offsets and lengths
1036 *
1037 * @v peerblk PeerDist block download
1038 * @v data Data buffer
1039 * @v len Length to read
1040 * @ret rc Return status code
1041 */
1042static int peerblk_decrypt_write ( struct peerdist_block *peerblk,
1043 const void *data, size_t len ) {
1044 struct peerdist_block_decrypt *decrypt = peerblk->decrypt;
1045 size_t frag_len;
1046 int rc;
1047
1048 /* Write to each decryption buffer in turn */
1049 for ( ; len ; decrypt++, data += frag_len, len -= frag_len ) {
1050
1051 /* Calculate length to use from this buffer */
1052 frag_len = decrypt->len;
1053 if ( frag_len > len )
1054 frag_len = len;
1055 if ( ! frag_len )
1056 continue;
1057
1058 /* Write to this buffer */
1059 if ( ( rc = xferbuf_write ( decrypt->xferbuf, decrypt->offset,
1060 data, frag_len ) ) != 0 )
1061 return rc;
1062
1063 /* Update offset and length */
1064 decrypt->offset += frag_len;
1065 decrypt->len -= frag_len;
1066 }
1067
1068 return 0;
1069}
1070
1071/**
1072 * Decrypt one chunk of PeerDist retrieval protocol data
1073 *
1074 * @v peerblk PeerDist block download
1075 */
1076static void peerblk_decrypt ( struct peerdist_block *peerblk ) {
1077 struct cipher_algorithm *cipher = peerblk->cipher;
1078 struct digest_algorithm *digest = peerblk->digest;
1079 struct xfer_buffer *xferbuf;
1080 size_t cipher_len;
1081 size_t digest_len;
1082 void *data;
1083 int rc;
1084
1085 /* Sanity checks */
1086 assert ( ( PEERBLK_DECRYPT_CHUNKSIZE % cipher->blocksize ) == 0 );
1087 if ( peerblk->cipher_remaining & ( cipher->blocksize - 1 ) ) {
1088 DBGC ( peerblk, "PEERBLK %p %d.%d has invalid length %zd\n",
1089 peerblk, peerblk->segment, peerblk->block,
1090 peerblk->cipher_remaining );
1091 rc = -EINVAL;
1092 goto err_blocksize;
1093 }
1094
1095 /* Get the underlying data transfer buffer */
1096 xferbuf = xfer_buffer ( &peerblk->xfer );
1097 if ( ! xferbuf ) {
1098 DBGC ( peerblk, "PEERBLK %p %d.%d has no underlying data "
1099 "transfer buffer\n", peerblk, peerblk->segment,
1100 peerblk->block );
1101 rc = -ENOTSUP;
1102 goto err_xfer_buffer;
1103 }
1104 peerblk->decrypt[PEERBLK_DURING].xferbuf = xferbuf;
1105
1106 /* Calculate cipher and digest lengths */
1107 cipher_len = PEERBLK_DECRYPT_CHUNKSIZE;
1108 if ( cipher_len > peerblk->cipher_remaining )
1109 cipher_len = peerblk->cipher_remaining;
1110 digest_len = cipher_len;
1111 if ( digest_len > peerblk->digest_remaining )
1112 digest_len = peerblk->digest_remaining;
1113 assert ( ( cipher_len & ( cipher->blocksize - 1 ) ) == 0 );
1114
1115 /* Allocate temporary data buffer */
1116 data = malloc ( cipher_len );
1117 if ( ! data ) {
1118 rc = -ENOMEM;
1119 goto err_alloc_data;
1120 }
1121
1122 /* Read ciphertext */
1123 if ( ( rc = peerblk_decrypt_read ( peerblk, data, cipher_len ) ) != 0 ){
1124 DBGC ( peerblk, "PEERBLK %p %d.%d could not read ciphertext: "
1125 "%s\n", peerblk, peerblk->segment, peerblk->block,
1126 strerror ( rc ) );
1127 goto err_read;
1128 }
1129
1130 /* Decrypt data */
1131 cipher_decrypt ( cipher, peerblk->cipherctx, data, data, cipher_len );
1132
1133 /* Add data to digest */
1134 digest_update ( digest, peerblk->digestctx, data, digest_len );
1135
1136 /* Write plaintext */
1137 if ( ( rc = peerblk_decrypt_write ( peerblk, data, cipher_len ) ) != 0){
1138 DBGC ( peerblk, "PEERBLK %p %d.%d could not write plaintext: "
1139 "%s\n", peerblk, peerblk->segment, peerblk->block,
1140 strerror ( rc ) );
1141 goto err_write;
1142 }
1143
1144 /* Consume input */
1145 peerblk->cipher_remaining -= cipher_len;
1146 peerblk->digest_remaining -= digest_len;
1147
1148 /* Free temporary data buffer */
1149 free ( data );
1150
1151 /* Continue processing until all input is consumed */
1152 if ( peerblk->cipher_remaining )
1153 return;
1154
1155 /* Complete download attempt */
1156 peerblk_done ( peerblk, 0 );
1157 return;
1158
1159 err_write:
1160 err_read:
1161 free ( data );
1162 err_alloc_data:
1163 err_xfer_buffer:
1164 err_blocksize:
1165 peerblk_done ( peerblk, rc );
1166}
1167
1168/**
1169 * Close PeerDist retrieval protocol block download attempt
1170 *
1171 * @v peerblk PeerDist block download
1172 * @v rc Reason for close
1173 */
1174static void peerblk_retrieval_close ( struct peerdist_block *peerblk, int rc ) {
1175 size_t buf_len;
1176 size_t vrf_len;
1177
1178 /* Restart interface */
1179 intf_restart ( &peerblk->retrieval, rc );
1180
1181 /* Fail immediately if we have an error */
1182 if ( rc != 0 )
1183 goto done;
1184
1185 /* Abort download attempt (for testing) if applicable */
1186 if ( ( rc = inject_fault ( PEERBLK_ABORT_RATE ) ) != 0 )
1187 goto done;
1188
1189 /* Parse message header */
1190 if ( ( rc = peerblk_parse_header ( peerblk ) ) != 0 )
1191 goto done;
1192
1193 /* Parse message segment and block details */
1194 if ( ( rc = peerblk_parse_block ( peerblk, &buf_len ) ) != 0 )
1195 goto done;
1196
1197 /* If the block was plaintext, then there is nothing more to do */
1198 if ( ! peerblk->cipher )
1199 goto done;
1200
1201 /* Parse message useless details */
1202 if ( ( rc = peerblk_parse_useless ( peerblk, buf_len, &vrf_len ) ) != 0)
1203 goto done;
1204
1205 /* Parse message initialisation vector details */
1206 if ( ( rc = peerblk_parse_iv ( peerblk, buf_len, vrf_len ) ) != 0 )
1207 goto done;
1208
1209 /* Fail if decryption length is not aligned to the cipher block size */
1210 if ( peerblk->cipher_remaining & ( peerblk->cipher->blocksize - 1 ) ) {
1211 DBGC ( peerblk, "PEERBLK %p %d.%d unaligned data length %zd\n",
1212 peerblk, peerblk->segment, peerblk->block,
1213 peerblk->cipher_remaining );
1214 rc = -EPROTO;
1215 goto done;
1216 }
1217
1218 /* Stop the download attempt timer: there is no point in
1219 * timing out while decrypting.
1220 */
1221 stop_timer ( &peerblk->timer );
1222
1223 /* Start decryption process */
1224 process_add ( &peerblk->process );
1225 return;
1226
1227 done:
1228 /* Complete download attempt */
1229 peerblk_done ( peerblk, rc );
1230}
1231
1232/******************************************************************************
1233 *
1234 * Retry policy
1235 *
1236 ******************************************************************************
1237 */
1238
1239/**
1240 * Handle PeerDist retry timer expiry
1241 *
1242 * @v timer Retry timer
1243 * @v over Failure indicator
1244 */
1245static void peerblk_expired ( struct retry_timer *timer, int over __unused ) {
1246 struct peerdist_block *peerblk =
1248 struct peerdisc_segment *segment = peerblk->discovery.segment;
1249 struct peerdisc_peer *head;
1250 unsigned long now = peerblk_timestamp();
1251 struct peerdist_retrieval *retrieval;
1252 const char *location;
1253 int rc;
1254
1255 /* Profile discovery timeout, if applicable */
1256 if ( ( peerblk->peer == NULL ) && ( timer->timeout != 0 ) ) {
1257 profile_custom ( &peerblk_discovery_timeout_profiler,
1258 ( now - peerblk->started ) );
1259 DBGC ( peerblk, "PEERBLK %p %d.%d discovery timed out after "
1260 "%ld ticks\n", peerblk, peerblk->segment,
1261 peerblk->block, timer->timeout );
1262 }
1263
1264 /* Profile download timeout, if applicable */
1265 if ( ( peerblk->peer != NULL ) && ( timer->timeout != 0 ) ) {
1266 profile_custom ( &peerblk_attempt_timeout_profiler,
1267 ( now - peerblk->attempted ) );
1268 DBGC ( peerblk, "PEERBLK %p %d.%d timed out after %ld ticks\n",
1269 peerblk, peerblk->segment, peerblk->block,
1270 timer->timeout );
1271 }
1272
1273 /* Abort any current download attempt */
1274 peerblk_reset ( peerblk, -ETIMEDOUT );
1275
1276 /* Record attempt start time */
1277 peerblk->attempted = now;
1278
1279 /* If we have exceeded our maximum number of attempt cycles
1280 * (each cycle comprising a retrieval protocol download from
1281 * each peer in the list followed by a raw download from the
1282 * origin server), then abort the overall download.
1283 */
1284 head = list_entry ( &segment->peers, struct peerdisc_peer, list );
1285 if ( ( peerblk->peer == head ) &&
1286 ( ++peerblk->cycles >= PEERBLK_MAX_ATTEMPT_CYCLES ) ) {
1287 rc = peerblk->rc;
1288 assert ( rc != 0 );
1289 goto err;
1290 }
1291
1292 /* If we have not yet made any download attempts, then move to
1293 * the start of the peer list.
1294 */
1295 if ( peerblk->peer == NULL )
1296 peerblk->peer = head;
1297
1298 /* Attempt retrieval protocol download from next usable peer */
1299 list_for_each_entry_continue ( peerblk->peer, &segment->peers, list ) {
1300
1301 /* Attempt retrieval protocol download from this peer */
1302 retrieval = peerblk->peer->retrieval;
1303 location = peerblk->peer->location;
1304 if ( ( rc = peerblk_retrieval_open ( peerblk, retrieval,
1305 location ) ) != 0 ) {
1306 /* Non-fatal: continue to try next peer */
1307 continue;
1308 }
1309
1310 /* Peer download started */
1311 return;
1312 }
1313
1314 /* Add to raw download queue */
1315 peerblk_enqueue ( peerblk, &peerblk_raw_queue );
1316
1317 return;
1318
1319 err:
1320 peerblk_close ( peerblk, rc );
1321}
1322
1323/**
1324 * Handle PeerDist peer discovery
1325 *
1326 * @v discovery PeerDist discovery client
1327 */
1328static void peerblk_discovered ( struct peerdisc_client *discovery ) {
1329 struct peerdist_block *peerblk =
1331 unsigned long now = peerblk_timestamp();
1332
1333 /* Do nothing unless we are still waiting for the initial
1334 * discovery timeout.
1335 */
1336 if ( ( peerblk->peer != NULL ) || ( peerblk->timer.timeout == 0 ) )
1337 return;
1338
1339 /* Schedule an immediate retry */
1340 start_timer_nodelay ( &peerblk->timer );
1341
1342 /* Profile discovery success */
1343 profile_custom ( &peerblk_discovery_success_profiler,
1344 ( now - peerblk->started ) );
1345}
1346
1347/******************************************************************************
1348 *
1349 * Opener
1350 *
1351 ******************************************************************************
1352 */
1353
1354/** PeerDist block download data transfer interface operations */
1358
1359/** PeerDist block download data transfer interface descriptor */
1362
1363/** PeerDist block download raw data interface operations */
1368
1369/** PeerDist block download raw data interface descriptor */
1372
1373/** PeerDist block download retrieval protocol interface operations */
1378
1379/** PeerDist block download retrieval protocol interface descriptor */
1381 INTF_DESC ( struct peerdist_block, retrieval,
1383
1384/** PeerDist block download decryption process descriptor */
1387
1388/** PeerDist block download discovery operations */
1392
1393/**
1394 * Open PeerDist block download
1395 *
1396 * @v xfer Data transfer interface
1397 * @v uri Original URI
1398 * @v info Content information block
1399 * @ret rc Return status code
1400 */
1401int peerblk_open ( struct interface *xfer, struct uri *uri,
1402 struct peerdist_info_block *block ) {
1403 const struct peerdist_info_segment *segment = block->segment;
1404 const struct peerdist_info *info = segment->info;
1405 struct digest_algorithm *digest = info->digest;
1406 struct peerdist_block *peerblk;
1407 unsigned long timeout;
1408 size_t digestsize;
1409 int rc;
1410
1411 /* Allocate and initialise structure */
1412 peerblk = zalloc ( sizeof ( *peerblk ) + digest->ctxsize );
1413 if ( ! peerblk ) {
1414 rc = -ENOMEM;
1415 goto err_alloc;
1416 }
1417 ref_init ( &peerblk->refcnt, peerblk_free );
1418 intf_init ( &peerblk->xfer, &peerblk_xfer_desc, &peerblk->refcnt );
1419 intf_init ( &peerblk->raw, &peerblk_raw_desc, &peerblk->refcnt );
1421 &peerblk->refcnt );
1422 peerblk->uri = uri_get ( uri );
1423 memcpy ( &peerblk->range, &block->range, sizeof ( peerblk->range ) );
1424 memcpy ( &peerblk->trim, &block->trim, sizeof ( peerblk->trim ) );
1425 peerblk->offset = ( block->trim.start - info->trim.start );
1426 peerblk->digest = info->digest;
1427 peerblk->digestsize = digestsize = info->digestsize;
1428 peerblk->digestctx = ( ( ( void * ) peerblk ) + sizeof ( *peerblk ) );
1429 peerblk->segment = segment->index;
1430 memcpy ( peerblk->id, segment->id, sizeof ( peerblk->id ) );
1431 memcpy ( peerblk->secret, segment->secret, sizeof ( peerblk->secret ) );
1432 peerblk->block = block->index;
1433 memcpy ( peerblk->hash, block->hash, sizeof ( peerblk->hash ) );
1434 xferbuf_malloc_init ( &peerblk->buffer );
1436 &peerblk->refcnt );
1438 INIT_LIST_HEAD ( &peerblk->queued );
1439 timer_init ( &peerblk->timer, peerblk_expired, &peerblk->refcnt );
1440 DBGC2 ( peerblk, "PEERBLK %p %d.%d id %02x%02x%02x%02x%02x..."
1441 "%02x%02x%02x [%08zx,%08zx)", peerblk, peerblk->segment,
1442 peerblk->block, peerblk->id[0], peerblk->id[1], peerblk->id[2],
1443 peerblk->id[3], peerblk->id[4], peerblk->id[ digestsize - 3 ],
1444 peerblk->id[ digestsize - 2 ], peerblk->id[ digestsize - 1 ],
1445 peerblk->range.start, peerblk->range.end );
1446 if ( ( peerblk->trim.start != peerblk->range.start ) ||
1447 ( peerblk->trim.end != peerblk->range.end ) ) {
1448 DBGC2 ( peerblk, " covers [%08zx,%08zx)",
1449 peerblk->trim.start, peerblk->trim.end );
1450 }
1451 DBGC2 ( peerblk, "\n" );
1452
1453 /* Open discovery */
1454 if ( ( rc = peerdisc_open ( &peerblk->discovery, peerblk->id,
1455 peerblk->digestsize ) ) != 0 )
1456 goto err_open_discovery;
1457
1458 /* Schedule a retry attempt either immediately (if we already
1459 * have some peers) or after the discovery timeout.
1460 */
1461 timeout = ( list_empty ( &peerblk->discovery.segment->peers ) ?
1463 start_timer_fixed ( &peerblk->timer, timeout );
1464
1465 /* Record start time */
1466 peerblk->started = peerblk_timestamp();
1467
1468 /* Attach to parent interface, mortalise self, and return */
1469 intf_plug_plug ( xfer, &peerblk->xfer );
1470 ref_put ( &peerblk->refcnt );
1471 return 0;
1472
1473 err_open_discovery:
1474 peerblk_close ( peerblk, rc );
1475 err_alloc:
1476 return rc;
1477}
#define NULL
NULL pointer (VOID *).
Definition Base.h:321
__be32 raw[7]
Definition CIB_PRM.h:0
struct golan_inbox_hdr hdr
Message header.
Definition CIB_PRM.h:0
typeof(acpi_finder=acpi_find)
ACPI table finder.
Definition acpi.c:48
u32 info
Definition ar9003_mac.h:0
struct arbelprm_rc_send_wqe rc
Definition arbel.h:3
pseudo_bit_t hash[0x00010]
Definition arbel.h:2
unsigned char uint8_t
Definition stdint.h:10
#define assert(condition)
Assert a condition at run-time.
Definition assert.h:61
struct bofm_section_header done
Definition bofm_test.c:46
#define PEERBLK_STALL_RATE
Definition fault.h:28
#define PEERBLK_ABORT_RATE
Definition fault.h:31
#define PEERBLK_ANNUL_RATE
Definition fault.h:25
#define PEERBLK_CORRUPT_RATE
Definition fault.h:34
void timeout(int)
ring len
Length.
Definition dwmac.h:226
uint8_t data[48]
Additional event data.
Definition ena.h:11
uint16_t queue
Queue ID.
Definition ena.h:11
uint8_t meta
Metadata flags.
Definition ena.h:3
Error codes.
#define __unused
Declare a variable or data structure as unused.
Definition compiler.h:598
#define DBGC2(...)
Definition compiler.h:547
#define DBGC(...)
Definition compiler.h:530
#define DBGC_HDA(...)
Definition compiler.h:531
uint32_t start
Starting offset.
Definition netvsc.h:1
uint8_t head
Head number.
Definition int13.h:23
#define FILE_LICENCE(_licence)
Declare a particular licence as applying to a file.
Definition compiler.h:921
#define ENOENT
No such file or directory.
Definition errno.h:558
#define EINVAL
Invalid argument.
Definition errno.h:472
#define ETIMEDOUT
Connection timed out.
Definition errno.h:713
#define EPROTO
Protocol error.
Definition errno.h:668
#define ENOMEM
Not enough space.
Definition errno.h:578
#define EIO
Input/output error.
Definition errno.h:477
#define ENOTSUP
Operation not supported.
Definition errno.h:633
#define ERANGE
Result too large.
Definition errno.h:683
#define FILE_SECBOOT(_status)
Declare a file's UEFI Secure Boot permission status.
Definition compiler.h:951
Hyper Text Transport Protocol.
int http_open(struct interface *xfer, struct http_method *method, struct uri *uri, struct http_request_range *range, struct http_request_content *content)
Open HTTP transaction.
Definition httpcore.c:665
#define be32_to_cpu(value)
Definition byteswap.h:117
#define ntohl(value)
Definition byteswap.h:135
#define htonl(value)
Definition byteswap.h:134
#define __attribute__(x)
Definition compiler.h:10
struct cipher_algorithm aes_cbc_algorithm
static void digest_init(struct digest_algorithm *digest, void *ctx)
Definition crypto.h:294
static int cipher_setkey(struct cipher_algorithm *cipher, void *ctx, const void *key, size_t keylen)
Definition crypto.h:310
static void digest_final(struct digest_algorithm *digest, void *ctx, void *out)
Definition crypto.h:305
static int cipher_setiv(struct cipher_algorithm *cipher, void *ctx, const void *iv, size_t ivlen)
Definition crypto.h:316
static void digest_update(struct digest_algorithm *digest, void *ctx, const void *data, size_t len)
Definition crypto.h:299
#define cipher_decrypt(cipher, ctx, src, dst, len)
Definition crypto.h:336
Fault injection.
Profiling.
#define __profiler
Declare a profiler.
Definition profile.h:61
static void profile_custom(struct profiler *profiler, unsigned long sample)
Record profiling sample in custom units.
Definition profile.h:201
#define PROFILING
Definition profile.h:20
iPXE timers
#define TICKS_PER_SEC
Number of ticks per second.
Definition timer.h:16
String functions.
void * memcpy(void *dest, const void *src, size_t len) __nonnull
void * memset(void *dest, int character, size_t len) __nonnull
void intf_close(struct interface *intf, int rc)
Close an object interface.
Definition interface.c:250
void intf_plug_plug(struct interface *a, struct interface *b)
Plug two object interfaces together.
Definition interface.c:108
void intf_shutdown(struct interface *intf, int rc)
Shut down an object interface.
Definition interface.c:279
void intf_restart(struct interface *intf, int rc)
Shut down and restart an object interface.
Definition interface.c:344
#define INTF_DESC(object_type, intf, operations)
Define an object interface descriptor.
Definition interface.h:81
static void intf_init(struct interface *intf, struct interface_descriptor *desc, struct refcnt *refcnt)
Initialise an object interface.
Definition interface.h:204
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition interface.h:33
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition iobuf.c:153
I/O buffers.
#define iob_disown(iobuf)
Disown an I/O buffer.
Definition iobuf.h:277
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition iobuf.h:220
#define iob_pull(iobuf, len)
Definition iobuf.h:167
#define iob_unput(iobuf, len)
Definition iobuf.h:200
uint64_t rsp
Definition librm.h:18
uint16_t segment
Code segment.
Definition librm.h:3
uint16_t mid
Middle 16 bits of address.
Definition librm.h:9
#define list_first_entry(list, type, member)
Get the container of the first entry in a list.
Definition list.h:334
#define list_entry(list, type, member)
Get the container of a list entry.
Definition list.h:322
#define LIST_HEAD_INIT(list)
Initialise a static list head.
Definition list.h:31
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition list.h:94
#define list_for_each_entry_continue(pos, head, member)
Iterate over entries in a list, starting after current position.
Definition list.h:474
#define list_del(list)
Delete an entry from a list.
Definition list.h:120
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition list.h:46
#define list_empty(list)
Test whether a list is empty.
Definition list.h:137
void * zalloc(size_t size)
Allocate cleared memory.
Definition malloc.c:718
void * malloc(size_t size)
Allocate memory.
Definition malloc.c:677
void msg(unsigned int row, const char *fmt,...)
Print message centred on specified row.
Definition message.c:62
struct mschapv2_challenge peer
Peer challenge.
Definition mschapv2.h:1
uint8_t block[3][8]
DES-encrypted blocks.
Definition mschapv2.h:1
uint32_t end
Ending offset.
Definition netvsc.h:7
Peer Content Caching and Retrieval: Retrieval Protocol [MS-PCCRR].
#define PEERDIST_MSG_BLK_TYPE
Retrieval protocol block fetch response type.
Definition pccrr.h:353
@ PEERDIST_MSG_AES_192_CBC
AES-192 in CBC mode.
Definition pccrr.h:176
@ PEERDIST_MSG_AES_128_CBC
AES-128 in CBC mode.
Definition pccrr.h:174
@ PEERDIST_MSG_PLAINTEXT
No encryption.
Definition pccrr.h:172
@ PEERDIST_MSG_AES_256_CBC
AES-256 in CBC mode.
Definition pccrr.h:178
uint32_t blksize
Cipher block size.
Definition pccrr.h:1
uint32_t digestsize
Digest size (i.e.
Definition pccrr.h:1
struct pci_range range
PCI bus:dev.fn address range.
Definition pcicloud.c:40
static int peerblk_raw_open(struct peerdist_block *peerblk)
Open PeerDist raw block download attempt.
Definition peerblk.c:360
static struct process_descriptor peerblk_queue_desc
PeerDist block download queue process descriptor.
Definition peerblk.c:561
static void peerblk_enqueue(struct peerdist_block *peerblk, struct peerdist_block_queue *queue)
Add block to download queue.
Definition peerblk.c:518
static struct interface_operation peerblk_retrieval_operations[]
PeerDist block download retrieval protocol interface operations.
Definition peerblk.c:1374
static void peerblk_step(struct peerdist_block_queue *queue)
PeerDist block download queue process.
Definition peerblk.c:481
static int peerblk_parse_useless(struct peerdist_block *peerblk, size_t buf_len, size_t *vrf_len)
Parse retrieval protocol message useless details.
Definition peerblk.c:941
static struct interface_operation peerblk_raw_operations[]
PeerDist block download raw data interface operations.
Definition peerblk.c:1364
static int peerblk_deliver(struct peerdist_block *peerblk, struct io_buffer *iobuf, struct xfer_metadata *meta, size_t pos)
Deliver download attempt data block.
Definition peerblk.c:247
static void peerblk_reset(struct peerdist_block *peerblk, int rc)
Reset PeerDist block download attempt.
Definition peerblk.c:168
static int peerblk_parse_block(struct peerdist_block *peerblk, size_t *buf_len)
Parse retrieval protocol message segment and block details.
Definition peerblk.c:837
static int peerblk_decrypt_read(struct peerdist_block *peerblk, void *data, size_t len)
Read from decryption buffers.
Definition peerblk.c:1009
static void peerblk_raw_close(struct peerdist_block *peerblk, int rc)
Close PeerDist raw block download attempt.
Definition peerblk.c:451
static int peerblk_retrieval_open(struct peerdist_block *peerblk, struct peerdist_retrieval *retrieval, const char *location)
Open PeerDist retrieval protocol block download attempt.
Definition peerblk.c:587
static int peerblk_parse_header(struct peerdist_block *peerblk)
Parse retrieval protocol message header.
Definition peerblk.c:747
static int peerblk_parse_iv(struct peerdist_block *peerblk, size_t buf_len, size_t vrf_len)
Parse retrieval protocol message initialisation vector details.
Definition peerblk.c:970
#define PEERBLK_DECRYPT_CHUNKSIZE
PeerDist decryption chunksize.
Definition peerblk.c:51
#define PEERBLK_RETRIEVAL_OPEN_TIMEOUT
PeerDist retrieval protocol block download attempt initial progress timeout.
Definition peerblk.c:88
#define PEERBLK_RETRIEVAL_RX_TIMEOUT
PeerDist retrieval protocol block download attempt ongoing progress timeout.
Definition peerblk.c:94
#define PEERBLK_RAW_OPEN_TIMEOUT
PeerDist raw block download attempt initial progress timeout.
Definition peerblk.c:76
static struct peerdisc_client_operations peerblk_discovery_operations
PeerDist block download discovery operations.
Definition peerblk.c:1389
static struct interface_descriptor peerblk_xfer_desc
PeerDist block download data transfer interface descriptor.
Definition peerblk.c:1360
#define PEERBLK_RAW_MAX
PeerDist maximum number of concurrent raw block downloads.
Definition peerblk.c:70
static void peerblk_discovered(struct peerdisc_client *discovery)
Handle PeerDist peer discovery.
Definition peerblk.c:1328
static struct interface_operation peerblk_xfer_operations[]
PeerDist block download data transfer interface operations.
Definition peerblk.c:1355
static size_t peerblk_offset(struct peerdist_block *peerblk, size_t pos)
Calculate offset within overall download.
Definition peerblk.c:233
static void peerblk_dequeue(struct peerdist_block *peerblk)
Remove block from download queue.
Definition peerblk.c:538
static struct process_descriptor peerblk_process_desc
PeerDist block download decryption process descriptor.
Definition peerblk.c:1385
static void peerblk_done(struct peerdist_block *peerblk, int rc)
Finish PeerDist block download attempt.
Definition peerblk.c:298
static unsigned long peerblk_timestamp(void)
Get profiling timestamp.
Definition peerblk.c:139
static void peerblk_decrypt(struct peerdist_block *peerblk)
Decrypt one chunk of PeerDist retrieval protocol data.
Definition peerblk.c:1076
static struct interface_descriptor peerblk_retrieval_desc
PeerDist block download retrieval protocol interface descriptor.
Definition peerblk.c:1380
static struct peerdist_block_queue peerblk_raw_queue
Raw block download queue.
Definition peerblk.c:565
#define PEERBLK_MAX_ATTEMPT_CYCLES
PeerDist maximum number of full download attempt cycles.
Definition peerblk.c:105
#define PEERBLK_RAW_RX_TIMEOUT
PeerDist raw block download attempt ongoing progress timeout.
Definition peerblk.c:82
static void peerblk_close(struct peerdist_block *peerblk, int rc)
Close PeerDist block download.
Definition peerblk.c:206
static struct interface_descriptor peerblk_raw_desc
PeerDist block download raw data interface descriptor.
Definition peerblk.c:1370
static int peerblk_retrieval_rx(struct peerdist_block *peerblk, struct io_buffer *iobuf, struct xfer_metadata *meta)
Receive PeerDist retrieval protocol data.
Definition peerblk.c:634
static void peerblk_retrieval_close(struct peerdist_block *peerblk, int rc)
Close PeerDist retrieval protocol block download attempt.
Definition peerblk.c:1174
int peerblk_open(struct interface *xfer, struct uri *uri, struct peerdist_info_block *block)
Open PeerDist block download.
Definition peerblk.c:1401
static int peerblk_raw_rx(struct peerdist_block *peerblk, struct io_buffer *iobuf, struct xfer_metadata *meta)
Receive PeerDist raw data.
Definition peerblk.c:403
static int peerblk_decrypt_write(struct peerdist_block *peerblk, const void *data, size_t len)
Write to decryption buffers and update offsets and lengths.
Definition peerblk.c:1042
static void peerblk_expired(struct retry_timer *timer, int over __unused)
Handle PeerDist retry timer expiry.
Definition peerblk.c:1245
static void peerblk_free(struct refcnt *refcnt)
Free PeerDist block download.
Definition peerblk.c:153
Peer Content Caching and Retrieval (PeerDist) protocol block downloads.
@ PEERBLK_AFTER
Data after the trimmed content.
Definition peerblk.h:41
@ PEERBLK_BEFORE
Data before the trimmed content.
Definition peerblk.h:37
@ PEERBLK_DURING
Data within the trimmed content.
Definition peerblk.h:39
#define peerblk_msg_blk_t(digestsize, len, vrf_len, blksize)
Retrieval protocol block fetch response (including transport header).
Definition peerblk.h:159
void peerdisc_stat(struct interface *intf, struct peerdisc_peer *peer, struct list_head *peers)
Report peer discovery statistics.
Definition peerdisc.c:106
int peerdisc_open(struct peerdisc_client *peerdisc, const void *id, size_t len)
Open PeerDist discovery client.
Definition peerdisc.c:580
void peerdisc_close(struct peerdisc_client *peerdisc)
Close PeerDist discovery client.
Definition peerdisc.c:618
unsigned int peerdisc_timeout_secs
Recommended discovery timeout (in seconds).
Definition peerdisc.c:76
static void peerdisc_init(struct peerdisc_client *peerdisc, struct peerdisc_client_operations *op)
Initialise PeerDist discovery.
Definition peerdisc.h:107
void process_del(struct process *process)
Remove process from process list.
Definition process.c:80
void process_add(struct process *process)
Add process to process list.
Definition process.c:60
#define PROC_DESC_ONCE(object_type, process, _step)
Define a process descriptor for a process that runs only once.
Definition process.h:98
static void process_init_stopped(struct process *process, struct process_descriptor *desc, struct refcnt *refcnt)
Initialise process without adding to process list.
Definition process.h:146
#define PROC_INIT(_process, _desc)
Initialise a static process.
Definition process.h:132
#define PROC_DESC(object_type, process, _step)
Define a process descriptor.
Definition process.h:83
static void(* free)(struct refcnt *refcnt))
Definition refcnt.h:55
#define ref_put(refcnt)
Drop reference to object.
Definition refcnt.h:107
#define ref_init(refcnt, free)
Initialise a reference counter.
Definition refcnt.h:65
void start_timer_fixed(struct retry_timer *timer, unsigned long timeout)
Start timer with a specified timeout.
Definition retry.c:65
void stop_timer(struct retry_timer *timer)
Stop timer.
Definition retry.c:118
static void start_timer_nodelay(struct retry_timer *timer)
Start timer with no delay.
Definition retry.h:100
#define offsetof(type, field)
Get offset of a field within a structure.
Definition stddef.h:25
#define container_of(ptr, type, field)
Get containing structure.
Definition stddef.h:36
char * strerror(int errno)
Retrieve string representation of error number.
Definition strerror.c:79
int memcmp(const void *first, const void *second, size_t len)
Compare memory regions.
Definition string.c:115
A cipher algorithm.
Definition crypto.h:58
const char * name
Algorithm name.
Definition crypto.h:60
size_t blocksize
Block size.
Definition crypto.h:68
size_t ctxsize
Context size.
Definition crypto.h:62
A message digest algorithm.
Definition crypto.h:19
size_t digestsize
Digest size.
Definition crypto.h:27
size_t ctxsize
Context size.
Definition crypto.h:23
HTTP request range descriptor.
Definition http.h:143
An object interface descriptor.
Definition interface.h:56
An object interface operation.
Definition interface.h:18
An object interface.
Definition interface.h:125
A persistent I/O buffer.
Definition iobuf.h:98
void * data
Start of data.
Definition iobuf.h:113
PeerDist discovery client operations.
Definition peerdisc.h:92
A PeerDist discovery client.
Definition peerdisc.h:82
struct peerdisc_segment * segment
Discovery segment.
Definition peerdisc.h:84
A PeerDist discovery peer.
Definition peerdisc.h:72
struct peerdist_retrieval * retrieval
Retrieval protocol.
Definition peerdisc.h:76
struct list_head list
List of peers.
Definition peerdisc.h:74
char location[0]
Peer location.
Definition peerdisc.h:78
A PeerDist discovery segment.
Definition peerdisc.h:43
struct list_head peers
List of discovered peers.
Definition peerdisc.h:64
A PeerDist retrieval protocol decryption buffer descriptor.
Definition peerblk.h:25
struct xfer_buffer * xferbuf
Data transfer buffer.
Definition peerblk.h:27
size_t offset
Offset within data transfer buffer.
Definition peerblk.h:29
size_t len
Length to use from data transfer buffer.
Definition peerblk.h:31
PeerDist block download queue.
Definition peerblk.h:133
A PeerDist block download.
Definition peerblk.h:47
unsigned int segment
Segment index.
Definition peerblk.h:83
struct retry_timer timer
Retry timer.
Definition peerblk.h:120
struct interface raw
Raw data interface.
Definition peerblk.h:53
size_t end
End of trimmed content (relative to incoming data stream).
Definition peerblk.h:98
struct uri * uri
Original URI.
Definition peerblk.h:58
struct cipher_algorithm * cipher
Cipher algorithm.
Definition peerblk.h:78
struct peerdist_block_decrypt decrypt[PEERBLK_NUM_BUFFERS]
Decryption data buffer descriptors.
Definition peerblk.h:105
void * digestctx
Digest context (statically allocated at instantiation time).
Definition peerblk.h:75
size_t start
Start of trimmed content (relative to incoming data stream).
Definition peerblk.h:96
unsigned long started
Time at which block download was started.
Definition peerblk.h:127
struct peerdist_block_queue * queue
Block download queue.
Definition peerblk.h:116
struct digest_algorithm * digest
Digest algorithm.
Definition peerblk.h:67
unsigned int cycles
Number of full attempt cycles completed.
Definition peerblk.h:122
struct peerdist_range range
Content range of this block.
Definition peerblk.h:60
struct xfer_buffer buffer
Data buffer.
Definition peerblk.h:100
size_t digestsize
Digest size.
Definition peerblk.h:73
size_t offset
Offset of first byte in trimmed range within overall download.
Definition peerblk.h:64
uint8_t secret[PEERDIST_DIGEST_MAX_SIZE]
Segment secret.
Definition peerblk.h:87
struct peerdisc_client discovery
Discovery client.
Definition peerblk.h:112
size_t pos
Current position (relative to incoming data stream).
Definition peerblk.h:94
struct interface xfer
Data transfer interface.
Definition peerblk.h:51
struct process process
Decryption process.
Definition peerblk.h:103
void * cipherctx
Cipher context (dynamically allocated as needed).
Definition peerblk.h:80
unsigned long attempted
Time at which most recent attempt was started.
Definition peerblk.h:129
struct peerdist_range trim
Trimmed range of this block.
Definition peerblk.h:62
uint8_t hash[PEERDIST_DIGEST_MAX_SIZE]
Block hash.
Definition peerblk.h:91
size_t cipher_remaining
Remaining decryption length.
Definition peerblk.h:107
unsigned int block
Block index.
Definition peerblk.h:89
struct refcnt refcnt
Reference count.
Definition peerblk.h:49
struct list_head queued
List of queued block downloads.
Definition peerblk.h:118
struct peerdisc_peer * peer
Current position in discovered peer list.
Definition peerblk.h:114
size_t digest_remaining
Remaining digest length (excluding AES padding bytes).
Definition peerblk.h:109
uint8_t id[PEERDIST_DIGEST_MAX_SIZE]
Segment identifier.
Definition peerblk.h:85
struct interface retrieval
Retrieval protocol interface.
Definition peerblk.h:55
int rc
Most recent attempt failure.
Definition peerblk.h:124
A content information block.
Definition pccrc.h:396
A content information segment.
Definition pccrc.h:347
Content information.
Definition pccrc.h:317
Retrieval protocol message header.
Definition pccrr.h:154
Retrieval protocol transport response header.
Definition pccrr.h:182
size_t start
Start offset.
Definition pccrc.h:311
size_t end
End offset.
Definition pccrc.h:313
A retrieval protocol mechanism.
Definition pccrr.h:356
const char * name
Name.
Definition pccrr.h:358
int(* open)(struct interface *xfer, const char *location, size_t digestsize, const uint8_t *id, unsigned int block)
Open retrieval protocol connection.
Definition pccrr.h:369
A process descriptor.
Definition process.h:32
A process.
Definition process.h:18
A data structure for storing profiling information.
Definition profile.h:27
A reference counter.
Definition refcnt.h:27
A retry timer.
Definition retry.h:22
unsigned long timeout
Timeout value (in ticks).
Definition retry.h:28
A timer.
Definition timer.h:29
A Uniform Resource Identifier.
Definition uri.h:65
A data transfer buffer.
Definition xferbuf.h:21
size_t len
Size of data.
Definition xferbuf.h:25
void * data
Data.
Definition xferbuf.h:23
Data transfer metadata.
Definition xfer.h:23
unsigned int flags
Flags.
Definition xfer.h:29
off_t offset
Offset of data within stream.
Definition xfer.h:38
unsigned long currticks(void)
Get current system time in ticks.
Definition timer.c:43
uint32_t data_len
Microcode data size (or 0 to indicate 2000 bytes).
Definition ucode.h:15
int32_t after
Final microcode version.
Definition ucode.h:7
int32_t before
Initial microcode version.
Definition ucode.h:5
Uniform Resource Identifiers.
static struct uri * uri_get(struct uri *uri)
Increment URI reference count.
Definition uri.h:195
static void uri_put(struct uri *uri)
Decrement URI reference count.
Definition uri.h:206
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition xfer.c:195
int xfer_check_order(struct xfer_metadata *meta, size_t *pos, size_t len)
Check that data is delivered strictly in order.
Definition xfer.c:378
Data transfer interfaces.
#define XFER_FL_ABS_OFFSET
Offset is absolute.
Definition xfer.h:48
struct xfer_buffer * xfer_buffer(struct interface *intf)
Get underlying data transfer buffer.
Definition xferbuf.c:380
int xferbuf_read(struct xfer_buffer *xferbuf, size_t offset, void *data, size_t len)
Read from data transfer buffer.
Definition xferbuf.c:166
int xferbuf_write(struct xfer_buffer *xferbuf, size_t offset, const void *data, size_t len)
Write to data transfer buffer.
Definition xferbuf.c:133
void xferbuf_free(struct xfer_buffer *xferbuf)
Free data transfer buffer.
Definition xferbuf.c:88
static void xferbuf_malloc_init(struct xfer_buffer *xferbuf)
Initialise malloc()-based data transfer buffer.
Definition xferbuf.h:66