1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
//! The server side API
use std::fmt::Debug;
use std::sync::Arc;
use std::time::Duration;
use anyhow::{Context, Result};
use bao_tree::io::fsm::{encode_ranges_validated, Outboard};
use futures::future::BoxFuture;
use iroh_io::stats::{
SliceReaderStats, StreamWriterStats, TrackingSliceReader, TrackingStreamWriter,
};
use iroh_io::{AsyncStreamWriter, TokioStreamWriter};
use serde::{Deserialize, Serialize};
use tracing::{debug, debug_span, info, trace, warn};
use tracing_futures::Instrument;
use crate::hashseq::parse_hash_seq;
use crate::protocol::{GetRequest, RangeSpec, Request, RequestToken};
use crate::store::*;
use crate::util::{BlobFormat, RpcError, Tag};
use crate::Hash;
/// Events emitted by the provider informing about the current status.
#[derive(Debug, Clone)]
pub enum Event {
/// A new collection or tagged blob has been added
TaggedBlobAdded {
/// The hash of the added data
hash: Hash,
/// The format of the added data
format: BlobFormat,
/// The tag of the added data
tag: Tag,
},
/// A new client connected to the node.
ClientConnected {
/// An unique connection id.
connection_id: u64,
},
/// A request was received from a client.
GetRequestReceived {
/// An unique connection id.
connection_id: u64,
/// An identifier uniquely identifying this transfer request.
request_id: u64,
/// Token requester gve for this request, if any
token: Option<RequestToken>,
/// The hash for which the client wants to receive data.
hash: Hash,
},
/// A request was received from a client.
CustomGetRequestReceived {
/// An unique connection id.
connection_id: u64,
/// An identifier uniquely identifying this transfer request.
request_id: u64,
/// Token requester gve for this request, if any
token: Option<RequestToken>,
/// The size of the custom get request.
len: usize,
},
/// A sequence of hashes has been found and is being transferred.
TransferHashSeqStarted {
/// An unique connection id.
connection_id: u64,
/// An identifier uniquely identifying this transfer request.
request_id: u64,
/// The number of blobs in the sequence.
num_blobs: u64,
},
/// A blob in a sequence was transferred.
TransferBlobCompleted {
/// An unique connection id.
connection_id: u64,
/// An identifier uniquely identifying this transfer request.
request_id: u64,
/// The hash of the blob
hash: Hash,
/// The index of the blob in the sequence.
index: u64,
/// The size of the blob transferred.
size: u64,
},
/// A request was completed and the data was sent to the client.
TransferCompleted {
/// An unique connection id.
connection_id: u64,
/// An identifier uniquely identifying this transfer request.
request_id: u64,
/// statistics about the transfer
stats: Box<TransferStats>,
},
/// A request was aborted because the client disconnected.
TransferAborted {
/// The quic connection id.
connection_id: u64,
/// An identifier uniquely identifying this request.
request_id: u64,
/// statistics about the transfer. This is None if the transfer
/// was aborted before any data was sent.
stats: Option<Box<TransferStats>>,
},
}
/// The stats for a transfer of a collection or blob.
#[derive(Debug, Clone, Copy, Default)]
pub struct TransferStats {
/// Stats for sending to the client.
pub send: StreamWriterStats,
/// Stats for reading from disk.
pub read: SliceReaderStats,
/// The total duration of the transfer.
pub duration: Duration,
}
/// Progress updates for the add operation.
#[derive(Debug, Serialize, Deserialize)]
pub enum AddProgress {
/// An item was found with name `name`, from now on referred to via `id`
Found {
/// A new unique id for this entry.
id: u64,
/// The name of the entry.
name: String,
/// The size of the entry in bytes.
size: u64,
},
/// We got progress ingesting item `id`.
Progress {
/// The unique id of the entry.
id: u64,
/// The offset of the progress, in bytes.
offset: u64,
},
/// We are done with `id`, and the hash is `hash`.
Done {
/// The unique id of the entry.
id: u64,
/// The hash of the entry.
hash: Hash,
},
/// We are done with the whole operation.
AllDone {
/// The hash of the created data.
hash: Hash,
/// The format of the added data.
format: BlobFormat,
/// The tag of the added data.
tag: Tag,
},
/// We got an error and need to abort.
///
/// This will be the last message in the stream.
Abort(RpcError),
}
/// Progress updates for the get operation.
#[derive(Debug, Serialize, Deserialize)]
pub enum DownloadProgress {
/// A new connection was established.
Connected,
/// An item was found with hash `hash`, from now on referred to via `id`.
Found {
/// A new unique id for this entry.
id: u64,
/// child offset
child: u64,
/// The name of the entry.
hash: Hash,
/// The size of the entry in bytes.
size: u64,
},
/// An item was found with hash `hash`, from now on referred to via `id`.
FoundHashSeq {
/// The name of the entry.
hash: Hash,
/// Number of children in the collection, if known.
children: u64,
},
/// We got progress ingesting item `id`.
Progress {
/// The unique id of the entry.
id: u64,
/// The offset of the progress, in bytes.
offset: u64,
},
/// We are done with `id`, and the hash is `hash`.
Done {
/// The unique id of the entry.
id: u64,
},
/// We are done with the network part - all data is local.
NetworkDone {
/// The number of bytes written.
bytes_written: u64,
/// The number of bytes read.
bytes_read: u64,
/// The time it took to transfer the data.
elapsed: Duration,
},
/// The download part is done for this id, we are now exporting the data
/// to the specified out path.
Export {
/// Unique id of the entry.
id: u64,
/// The hash of the entry.
hash: Hash,
/// The size of the entry in bytes.
size: u64,
/// The path to the file where the data is exported.
target: String,
},
/// We have made progress exporting the data.
///
/// This is only sent for large blobs.
ExportProgress {
/// Unique id of the entry that is being exported.
id: u64,
/// The offset of the progress, in bytes.
offset: u64,
},
/// We got an error and need to abort.
Abort(RpcError),
/// We are done with the whole operation.
AllDone,
}
/// hook into the request handling to process authorization by examining
/// the request and any given token. Any error returned will abort the request,
/// and the error will be sent to the requester.
pub trait RequestAuthorizationHandler: Send + Sync + Debug + 'static {
/// Handle the authorization request, given an opaque data blob from the requester.
fn authorize(
&self,
token: Option<RequestToken>,
request: &Request,
) -> BoxFuture<'static, anyhow::Result<()>>;
}
/// Read the request from the getter.
///
/// Will fail if there is an error while reading, if the reader
/// contains more data than the Request, or if no valid request is sent.
///
/// When successful, the buffer is empty after this function call.
pub async fn read_request(mut reader: quinn::RecvStream) -> Result<Request> {
let payload = reader
.read_to_end(crate::protocol::MAX_MESSAGE_SIZE)
.await?;
let request: Request = postcard::from_bytes(&payload)?;
Ok(request)
}
/// Transfers the collection & blob data.
///
/// First, it transfers the collection data & its associated outboard encoding data. Then it sequentially transfers each individual blob data & its associated outboard
/// encoding data.
///
/// Will fail if there is an error writing to the getter or reading from
/// the database.
///
/// If a blob from the collection cannot be found in the database, the transfer will gracefully
/// close the writer, and return with `Ok(SentStatus::NotFound)`.
///
/// If the transfer does _not_ end in error, the buffer will be empty and the writer is gracefully closed.
pub async fn transfer_collection<D: Map, E: EventSender>(
request: GetRequest,
// Store from which to fetch blobs.
db: &D,
// Response writer, containing the quinn stream.
writer: &mut ResponseWriter<E>,
// the collection to transfer
mut outboard: D::Outboard,
mut data: D::DataReader,
stats: &mut TransferStats,
) -> Result<SentStatus> {
let hash = request.hash;
// if the request is just for the root, we don't need to deserialize the collection
let just_root = matches!(request.ranges.as_single(), Some((0, _)));
let mut c = if !just_root {
// parse the hash seq
let (stream, num_blobs) = parse_hash_seq(&mut data).await?;
writer
.events
.send(Event::TransferHashSeqStarted {
connection_id: writer.connection_id(),
request_id: writer.request_id(),
num_blobs,
})
.await;
Some(stream)
} else {
None
};
let mut prev = 0;
for (offset, ranges) in request.ranges.iter_non_empty() {
// create a tracking writer so we can get some stats for writing
let mut tw = writer.tracking_writer();
if offset == 0 {
debug!("writing ranges '{:?}' of sequence {}", ranges, hash);
// wrap the data reader in a tracking reader so we can get some stats for reading
let mut tracking_reader = TrackingSliceReader::new(&mut data);
// send the root
encode_ranges_validated(
&mut tracking_reader,
&mut outboard,
&ranges.to_chunk_ranges(),
&mut tw,
)
.await?;
stats.read += tracking_reader.stats();
stats.send += tw.stats();
debug!(
"finished writing ranges '{:?}' of collection {}",
ranges, hash
);
} else {
let c = c.as_mut().context("collection parser not available")?;
debug!("wrtiting ranges '{:?}' of child {}", ranges, offset);
// skip to the next blob if there is a gap
if prev < offset - 1 {
c.skip(offset - prev - 1).await?;
}
if let Some(hash) = c.next().await? {
tokio::task::yield_now().await;
let (status, size, blob_read_stats) = send_blob(db, hash, ranges, &mut tw).await?;
stats.send += tw.stats();
stats.read += blob_read_stats;
if SentStatus::NotFound == status {
writer.inner.finish().await?;
return Ok(status);
}
writer
.events
.send(Event::TransferBlobCompleted {
connection_id: writer.connection_id(),
request_id: writer.request_id(),
hash,
index: offset - 1,
size,
})
.await;
} else {
// nothing more we can send
break;
}
prev = offset;
}
}
debug!("done writing");
Ok(SentStatus::Sent)
}
/// Trait for sending events.
pub trait EventSender: Clone + Sync + Send + 'static {
/// Send an event.
fn send(&self, event: Event) -> BoxFuture<()>;
}
/// Handle a single connection.
pub async fn handle_connection<D: Map, E: EventSender>(
connecting: quinn::Connecting,
db: D,
events: E,
authorization_handler: Arc<dyn RequestAuthorizationHandler>,
rt: crate::util::runtime::Handle,
) {
let remote_addr = connecting.remote_address();
let connection = match connecting.await {
Ok(conn) => conn,
Err(err) => {
warn!(%remote_addr, "Error connecting: {err:#}");
return;
}
};
let connection_id = connection.stable_id() as u64;
let span = debug_span!("connection", connection_id, %remote_addr);
async move {
while let Ok((writer, reader)) = connection.accept_bi().await {
// The stream ID index is used to identify this request. Requests only arrive in
// bi-directional RecvStreams initiated by the client, so this uniquely identifies them.
let request_id = reader.id().index();
let span = debug_span!("stream", stream_id = %request_id);
let writer = ResponseWriter {
connection_id,
events: events.clone(),
inner: writer,
};
events.send(Event::ClientConnected { connection_id }).await;
let db = db.clone();
let authorization_handler = authorization_handler.clone();
rt.local_pool().spawn_pinned(|| {
async move {
if let Err(err) = handle_stream(db, reader, writer, authorization_handler).await
{
warn!("error: {err:#?}",);
}
}
.instrument(span)
});
}
}
.instrument(span)
.await
}
async fn handle_stream<D: Map, E: EventSender>(
db: D,
reader: quinn::RecvStream,
writer: ResponseWriter<E>,
authorization_handler: Arc<dyn RequestAuthorizationHandler>,
) -> Result<()> {
// 1. Decode the request.
debug!("reading request");
let request = match read_request(reader).await {
Ok(r) => r,
Err(e) => {
writer.notify_transfer_aborted(None).await;
return Err(e);
}
};
// 2. Authorize the request (may be a no-op)
debug!("authorizing request");
if let Err(e) = authorization_handler
.authorize(request.token().cloned(), &request)
.await
{
writer.notify_transfer_aborted(None).await;
return Err(e);
}
match request {
Request::Get(request) => handle_get(db, request, writer).await,
}
}
/// Handle a single standard get request.
pub async fn handle_get<D: Map, E: EventSender>(
db: D,
request: GetRequest,
mut writer: ResponseWriter<E>,
) -> Result<()> {
let hash = request.hash;
debug!(%hash, "received request");
writer
.events
.send(Event::GetRequestReceived {
hash,
connection_id: writer.connection_id(),
request_id: writer.request_id(),
token: request.token().cloned(),
})
.await;
// 4. Attempt to find hash
match db.get(&hash) {
// Collection or blob request
Some(entry) => {
let mut stats = Box::<TransferStats>::default();
let t0 = std::time::Instant::now();
// 5. Transfer data!
let res = transfer_collection(
request,
&db,
&mut writer,
entry.outboard().await?,
entry.data_reader().await?,
&mut stats,
)
.await;
stats.duration = t0.elapsed();
match res {
Ok(SentStatus::Sent) => {
writer.notify_transfer_completed(&hash, stats).await;
}
Ok(SentStatus::NotFound) => {
writer.notify_transfer_aborted(Some(stats)).await;
}
Err(e) => {
writer.notify_transfer_aborted(Some(stats)).await;
return Err(e);
}
}
debug!("finished response");
}
None => {
debug!("not found {}", hash);
writer.notify_transfer_aborted(None).await;
writer.inner.finish().await?;
}
};
Ok(())
}
/// A helper struct that combines a quinn::SendStream with auxiliary information
#[derive(Debug)]
pub struct ResponseWriter<E> {
inner: quinn::SendStream,
events: E,
connection_id: u64,
}
impl<E: EventSender> ResponseWriter<E> {
fn tracking_writer(
&mut self,
) -> TrackingStreamWriter<TokioStreamWriter<&mut quinn::SendStream>> {
TrackingStreamWriter::new(TokioStreamWriter(&mut self.inner))
}
fn connection_id(&self) -> u64 {
self.connection_id
}
fn request_id(&self) -> u64 {
self.inner.id().index()
}
fn print_stats(stats: &TransferStats) {
let send = stats.send.total();
let read = stats.read.total();
let total_sent_bytes = send.size;
let send_duration = send.stats.duration;
let read_duration = read.stats.duration;
let total_duration = stats.duration;
let other_duration = total_duration
.saturating_sub(send_duration)
.saturating_sub(read_duration);
let avg_send_size = total_sent_bytes.checked_div(send.stats.count).unwrap_or(0);
info!(
"sent {} bytes in {}s",
total_sent_bytes,
total_duration.as_secs_f64()
);
debug!(
"{}s sending, {}s reading, {}s other",
send_duration.as_secs_f64(),
read_duration.as_secs_f64(),
other_duration.as_secs_f64()
);
trace!(
"send_count: {} avg_send_size {}",
send.stats.count,
avg_send_size,
)
}
async fn notify_transfer_completed(&self, hash: &Hash, stats: Box<TransferStats>) {
info!("trasnfer completed for {}", hash);
Self::print_stats(&stats);
self.events
.send(Event::TransferCompleted {
connection_id: self.connection_id(),
request_id: self.request_id(),
stats,
})
.await;
}
async fn notify_transfer_aborted(&self, stats: Option<Box<TransferStats>>) {
if let Some(stats) = &stats {
Self::print_stats(stats);
};
self.events
.send(Event::TransferAborted {
connection_id: self.connection_id(),
request_id: self.request_id(),
stats,
})
.await;
}
}
/// Status of a send operation
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum SentStatus {
/// The requested data was sent
Sent,
/// The requested data was not found
NotFound,
}
/// Send a
pub async fn send_blob<D: Map, W: AsyncStreamWriter>(
db: &D,
name: Hash,
ranges: &RangeSpec,
writer: W,
) -> Result<(SentStatus, u64, SliceReaderStats)> {
match db.get(&name) {
Some(entry) => {
let outboard = entry.outboard().await?;
let size = outboard.tree().size().0;
let mut file_reader = TrackingSliceReader::new(entry.data_reader().await?);
let res = encode_ranges_validated(
&mut file_reader,
outboard,
&ranges.to_chunk_ranges(),
writer,
)
.await;
debug!("done sending blob {} {:?}", name, res);
res?;
Ok((SentStatus::Sent, size, file_reader.stats()))
}
_ => {
debug!("blob not found {}", hex::encode(name));
Ok((SentStatus::NotFound, 0, SliceReaderStats::default()))
}
}
}