"docs/kubernetes/deployment/create_deployment.md" did not exist on "6675bfc81c2ef1f8318e0737c3d98a5ed0847140"
offload.rs 59.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

16
17
18
19
20
//! # Offload Manager
//! The offload manager is responsible for handling all block transfers between different cache levels.
//!
//! ## Offloading
//! Offloading is the process of moving blocks to a cache level further away from the device.
Ryan Olson's avatar
Ryan Olson committed
21
//! When blocks are registered (via [`ManagedBlockPool::register_blocks`]), they are automatically sent to the offload manager.
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
//! Due to limited bandwidth, the offload manager must prioritize which offloads to perform.
//! This is indicated by the `priority` parameter to [`OffloadManager::offload`].
//! When a offload request is received, the offload manager will enqueue it into a priority queue.
//! This priority queue is keyed by the `priority` parameter, where blocks with lower priority values are processed first.
//! Within the same priority, blocks that were sent to the offload manager earlier are processed first.
//!
//! ## Onboarding
//! Onboarding is the process of moving blocks to a cache level closer to the device.
//! All onboardings are manually triggered through the [`OffloadManager::onboard`] method.
//!
//! ## Transfer Managers
//! The offload manager uses two transfer managers to handle the offloading and onboarding of blocks.
//!
//! The [`CudaTransferManager`] is responsible for transfers between the device and host.
//! The [`DiskTransferManager`] is responsible for transfers from host to disk and disk to device.
//!
//! ## Worker Threads
//! The offload manager uses two kinds of worker threads to handle the offloading and onboarding of blocks.
//!
//! The [`OffloadManager::offload_worker`] is responsible for offloading blocks.
//! The [`OffloadManager::onboard_worker`] is responsible for onboarding blocks.
//!
//! The kind of offloads/onboards they perform is dictated by the source and target arguments
45
//! of the [`OffloadManager::offload_worker`] and [`OffloadManager::onboard_worker`] methods.
46

Ryan Olson's avatar
Ryan Olson committed
47
use super::block::{
48
49
    BlockError, BlockMetadata, BlockState, ImmutableBlock, MutableBlock,
    locality::LocalityProvider, transfer::TransferContext,
Ryan Olson's avatar
Ryan Olson committed
50
};
51
use super::metrics::{BlockManagerMetrics, PoolMetrics};
Ryan Olson's avatar
Ryan Olson committed
52
use super::pool::{BlockPool, BlockPoolError};
53
use super::storage::{Cuda, Storage};
Ryan Olson's avatar
Ryan Olson committed
54
use super::{DeviceStorage, DiskStorage, PinnedStorage};
55
56
57
58
use nixl_sys::Agent as NixlAgent;
use std::sync::Arc;
use tokio::runtime::Handle;
use tokio::sync::{
59
    Mutex,
60
    mpsc::{self, error::TryRecvError},
61
    oneshot,
62
};
63
use tokio_util::sync::CancellationToken;
64
65
66
67
68
69
70

use anyhow::Result;
use std::any::Any;

use std::collections::BTreeSet;

mod pending;
71
pub mod request;
72

Ryan Olson's avatar
Ryan Olson committed
73
use pending::{LocalTransferManager, PendingTransfer, TransferBatcher, TransferManager};
74
use request::{BlockResult, OffloadRequest, OffloadRequestKey, OnboardRequest};
75

76
77
use dynamo_runtime::utils::task::CriticalTaskExecutionHandle;

78
79
const MAX_CONCURRENT_TRANSFERS: usize = 4;
const MAX_TRANSFER_BATCH_SIZE: usize = 16;
80
81

/// The offload manager handles all block transfers between different cache levels.
Ryan Olson's avatar
Ryan Olson committed
82
pub struct OffloadManager<Locality: LocalityProvider, Metadata: BlockMetadata> {
83
    // Handles to the device, host, and disk pools.
Ryan Olson's avatar
Ryan Olson committed
84
85
86
    disk: Option<Arc<dyn BlockPool<DiskStorage, Locality, Metadata>>>,
    host: Option<Arc<dyn BlockPool<PinnedStorage, Locality, Metadata>>>,
    device: Option<Arc<dyn BlockPool<DeviceStorage, Locality, Metadata>>>,
87

88
    /// Queue of offloading requests.
Ryan Olson's avatar
Ryan Olson committed
89
90
    device_offload_tx: mpsc::UnboundedSender<OffloadRequest<DeviceStorage, Locality, Metadata>>,
    host_offload_tx: mpsc::UnboundedSender<OffloadRequest<PinnedStorage, Locality, Metadata>>,
91
92

    /// Queue of pending onboarding requests.
Ryan Olson's avatar
Ryan Olson committed
93
94
95
96
    host_onboard_tx:
        mpsc::UnboundedSender<OnboardRequest<PinnedStorage, DeviceStorage, Locality, Metadata>>,
    disk_onboard_tx:
        mpsc::UnboundedSender<OnboardRequest<DiskStorage, DeviceStorage, Locality, Metadata>>,
97
98
99

    /// An incrementing counter for offloaded blocks. Within the same priority, blocks with lower tick values are processed first.
    tick: Arc<Mutex<u64>>,
100
101
}

Ryan Olson's avatar
Ryan Olson committed
102
103
104
impl<Locality: LocalityProvider + 'static, Metadata: BlockMetadata>
    OffloadManager<Locality, Metadata>
{
105
    pub fn new(
Ryan Olson's avatar
Ryan Olson committed
106
107
108
        disk: Option<Arc<dyn BlockPool<DiskStorage, Locality, Metadata>>>,
        host: Option<Arc<dyn BlockPool<PinnedStorage, Locality, Metadata>>>,
        device: Option<Arc<dyn BlockPool<DeviceStorage, Locality, Metadata>>>,
109
110
        nixl_agent: Arc<Option<NixlAgent>>,
        async_rt_handle: Handle,
111
        metrics: Arc<BlockManagerMetrics>,
112
        cancellation_token: CancellationToken,
113
    ) -> Result<Arc<Self>> {
114
115
116
117
118
        let (device_offload_tx, device_offload_rx) = mpsc::unbounded_channel();
        let (host_offload_tx, host_offload_rx) = mpsc::unbounded_channel();

        let (host_onboard_tx, host_onboard_rx) = mpsc::unbounded_channel();
        let (disk_onboard_tx, disk_onboard_rx) = mpsc::unbounded_channel();
119
120

        let this = Arc::new(Self {
121
            disk,
122
            host,
123
124
125
126
127
            device,
            device_offload_tx,
            host_offload_tx,
            host_onboard_tx,
            disk_onboard_tx,
128
129
130
            tick: Arc::new(Mutex::new(0)),
        });

131
        let cuda_ctx = Cuda::device_or_create(0)?;
132

133
134
135
136
        // We want cuda offloads to happen in parallel with host onboards, so we need to use a different stream.
        let device_offload_transfer_ctx = Arc::new(TransferContext::new(
            nixl_agent.clone(),
            cuda_ctx.new_stream()?,
137
            async_rt_handle.clone(),
138
        ));
139

Ryan Olson's avatar
Ryan Olson committed
140
141
142
143
        let device_metrics = metrics.pool("device");
        let host_metrics = metrics.pool("host");
        let disk_metrics = metrics.pool("disk");

144
        // Device -> Host offload
145
146
147
148
149
        let device_to_host_task = OffloadManager::offload_worker(
            this.device.clone(),
            this.host.clone(),
            device_offload_rx,
            Arc::new(TransferBatcher::new(
Ryan Olson's avatar
Ryan Olson committed
150
                LocalTransferManager::new(
151
152
                    device_offload_transfer_ctx,
                    MAX_CONCURRENT_TRANSFERS,
153
                    &async_rt_handle,
154
                    cancellation_token.clone(),
Ryan Olson's avatar
Ryan Olson committed
155
156
                    device_metrics.clone(),
                    "offload_bw".to_string(),
157
                )?,
158
159
160
161
                MAX_TRANSFER_BATCH_SIZE,
                &async_rt_handle,
                cancellation_token.clone(),
            )),
Ryan Olson's avatar
Ryan Olson committed
162
            device_metrics.clone(),
163
164
165
166
167
168
169
170
171
            cancellation_token.clone(),
        );
        CriticalTaskExecutionHandle::new_with_runtime(
            |_| device_to_host_task,
            cancellation_token.clone(),
            "Device -> Host offload worker",
            &async_rt_handle,
        )?
        .detach();
172

173
174
175
        let transfer_ctx = Arc::new(TransferContext::new(
            nixl_agent.clone(),
            cuda_ctx.new_stream()?,
176
            async_rt_handle.clone(),
177
        ));
178

179
        // Host -> Disk offload
180
181
182
183
184
        let host_to_disk_task = OffloadManager::offload_worker(
            this.host.clone(),
            this.disk.clone(),
            host_offload_rx,
            Arc::new(TransferBatcher::new(
Ryan Olson's avatar
Ryan Olson committed
185
                LocalTransferManager::new(
186
187
188
189
                    transfer_ctx.clone(),
                    MAX_CONCURRENT_TRANSFERS,
                    &async_rt_handle,
                    cancellation_token.clone(),
Ryan Olson's avatar
Ryan Olson committed
190
191
                    host_metrics.clone(),
                    "offload_bw".to_string(),
192
                )?,
193
194
195
196
                MAX_TRANSFER_BATCH_SIZE,
                &async_rt_handle,
                cancellation_token.clone(),
            )),
Ryan Olson's avatar
Ryan Olson committed
197
            host_metrics.clone(),
198
199
200
201
202
203
204
205
206
            cancellation_token.clone(),
        );
        CriticalTaskExecutionHandle::new_with_runtime(
            |_| host_to_disk_task,
            cancellation_token.clone(),
            "Host -> Disk offload worker",
            &async_rt_handle,
        )?
        .detach();
207

208
        // Host -> Device onboarding
209
210
211
212
213
        let host_to_device_task = OffloadManager::onboard_worker(
            this.host.clone(),
            this.device.clone(),
            host_onboard_rx,
            Arc::new(TransferBatcher::new(
Ryan Olson's avatar
Ryan Olson committed
214
                LocalTransferManager::new(
215
216
                    transfer_ctx.clone(),
                    MAX_CONCURRENT_TRANSFERS,
217
                    &async_rt_handle,
218
                    cancellation_token.clone(),
Ryan Olson's avatar
Ryan Olson committed
219
220
                    host_metrics.clone(),
                    "onboard_bw".to_string(),
221
                )?,
222
223
224
225
                MAX_TRANSFER_BATCH_SIZE,
                &async_rt_handle,
                cancellation_token.clone(),
            )),
Ryan Olson's avatar
Ryan Olson committed
226
            host_metrics.clone(),
227
228
229
230
231
232
233
234
235
            cancellation_token.clone(),
        );
        CriticalTaskExecutionHandle::new_with_runtime(
            |_| host_to_device_task,
            cancellation_token.clone(),
            "Host -> Device onboarding worker",
            &async_rt_handle,
        )?
        .detach();
236

237
        // Disk -> Device onboarding
238
239
240
241
242
        let disk_to_device_task = OffloadManager::onboard_worker(
            this.disk.clone(),
            this.device.clone(),
            disk_onboard_rx,
            Arc::new(TransferBatcher::new(
Ryan Olson's avatar
Ryan Olson committed
243
                LocalTransferManager::new(
244
245
246
247
                    transfer_ctx.clone(),
                    MAX_CONCURRENT_TRANSFERS,
                    &async_rt_handle,
                    cancellation_token.clone(),
Ryan Olson's avatar
Ryan Olson committed
248
249
                    disk_metrics.clone(),
                    "onboard_bw".to_string(),
250
                )?,
251
252
253
254
                MAX_TRANSFER_BATCH_SIZE,
                &async_rt_handle,
                cancellation_token.clone(),
            )),
Ryan Olson's avatar
Ryan Olson committed
255
            disk_metrics.clone(),
256
257
258
259
260
261
262
263
264
            cancellation_token.clone(),
        );
        CriticalTaskExecutionHandle::new_with_runtime(
            |_| disk_to_device_task,
            cancellation_token.clone(),
            "Disk -> Device onboarding worker",
            &async_rt_handle,
        )?
        .detach();
265

266
        Ok(this)
267
    }
268

269
    async fn offload_worker<Source: Storage, Target: Storage>(
Ryan Olson's avatar
Ryan Olson committed
270
271
272
273
        source_pool: Option<Arc<dyn BlockPool<Source, Locality, Metadata>>>,
        target_pool: Option<Arc<dyn BlockPool<Target, Locality, Metadata>>>,
        mut offload_rx: mpsc::UnboundedReceiver<OffloadRequest<Source, Locality, Metadata>>,
        transfer_manager: Arc<dyn TransferManager<Source, Target, Locality, Metadata>>,
274
        pool_metrics: Arc<PoolMetrics>,
275
        cancellation_token: CancellationToken,
276
    ) -> Result<()> {
277
        if source_pool.is_none() || target_pool.is_none() {
278
279
280
            return Ok(());
        }

281
282
        let source_pool = source_pool.as_ref().unwrap();
        let target_pool = target_pool.as_ref().unwrap();
283

284
        let mut queue = BTreeSet::new();
285
286

        loop {
287
288
289
290
            if cancellation_token.is_cancelled() {
                return Ok(());
            }

291
            // Try to check the offload queue.
292
293
294
295
            loop {
                match offload_rx.try_recv() {
                    Ok(request) => {
                        queue.insert(request);
296
                        pool_metrics.gauge("offload_queue_size").inc();
297
298
299
300
                    }
                    Err(TryRecvError::Empty) => {
                        break;
                    }
301
                    Err(e) => return Err(e.into()),
302
303
                }
            }
304
305

            // If there is a request, process it.
306
            if let Some(request) = queue.pop_first() {
307
                pool_metrics.gauge("offload_queue_size").dec();
308
309
                // Try to upgrade the block to a strong reference.
                let block = match request.block.upgrade() {
Ryan Olson's avatar
Ryan Olson committed
310
                    Some(block) => Some(ImmutableBlock::new(block)),
311
                    // If unable to upgrade, the block may have been moved to the inactive pool.
312
                    None => source_pool
313
314
                        .match_sequence_hashes(vec![request.sequence_hash].as_slice())
                        .await?
Ryan Olson's avatar
Ryan Olson committed
315
                        .pop(),
316
317
                };

318
                // If we've found the block, offload it.
319
                if let Some(block) = block {
320
321
                    // If the block is already in the target, don't offload it.
                    if let Ok(blocks) = target_pool
Ryan Olson's avatar
Ryan Olson committed
322
323
                        .match_sequence_hashes(vec![request.sequence_hash].as_slice())
                        .await
324
                        && !blocks.is_empty()
325
                    {
326
                        continue;
327
328
                    }

329
                    let target_block = 'target_block: {
330
331
332
333
                        if let Ok(blocks) = target_pool.allocate_blocks(1).await
                            && let Some(block) = blocks.into_iter().next()
                        {
                            break 'target_block Some(block);
334
                        }
335

336
337
338
                        tracing::warn!(
                            "Target pool full. Skipping offload. This should only ever happen with very small pool sizes."
                        );
339
                        None
340
341
                    };

342
                    if let Some(target_block) = target_block {
343
                        pool_metrics.counter("offload_processed").inc();
Ryan Olson's avatar
Ryan Olson committed
344
345
346
347
                        tracing::debug!(
                            "Offloading block with sequence hash {} to target pool.",
                            request.sequence_hash
                        );
348
                        transfer_manager
349
                            .enqueue_transfer(PendingTransfer::new(
350
                                vec![block],
351
                                vec![target_block],
352
                                None,
353
                                target_pool.clone(),
354
355
356
357
358
                            ))
                            .await?;
                    }
                }
            } else {
359
                // Await the next request.
360
361
362
363
                tokio::select! {
                    _ = cancellation_token.cancelled() => return Ok(()),
                    Some(request) = offload_rx.recv() => {
                        queue.insert(request);
364
                        pool_metrics.gauge("offload_queue_size").inc();
365
                    }
366
                }
367
368
369
370
            }
        }
    }

371
    async fn onboard_worker<Source: Storage, Target: Storage>(
Ryan Olson's avatar
Ryan Olson committed
372
373
374
375
        source_pool: Option<Arc<dyn BlockPool<Source, Locality, Metadata>>>,
        target_pool: Option<Arc<dyn BlockPool<Target, Locality, Metadata>>>,
        mut onboard_rx: mpsc::UnboundedReceiver<OnboardRequest<Source, Target, Locality, Metadata>>,
        transfer_manager: Arc<dyn TransferManager<Source, Target, Locality, Metadata>>,
376
        pool_metrics: Arc<PoolMetrics>,
377
        cancellation_token: CancellationToken,
378
    ) -> Result<()> {
379
        if source_pool.is_none() || target_pool.is_none() {
380
381
382
            return Ok(());
        }

383
        let target_pool = target_pool.as_ref().unwrap();
384
385
386
387
        loop {
            tokio::select! {
                _ = cancellation_token.cancelled() => return Ok::<(), anyhow::Error>(()),
                Some(request) = onboard_rx.recv() => {
388
389
390
391
392

                    pool_metrics
                        .gauge("onboard_queue_size")
                        .set(onboard_rx.len() as i64);

393
                    // Try to allocate blocks on the device.
Ryan Olson's avatar
Ryan Olson committed
394
395
396
397
398
399
400
401
402
                    let target_blocks = if let Some(targets) = request.targets {
                        targets
                    } else {
                            match target_pool.allocate_blocks(request.blocks.len()).await {
                            Ok(blocks) => blocks,
                            Err(err) => {
                                let _ = request.response_tx.send(Err(err));
                                continue;
                            }
403
404
                        }
                    };
405

406
407
408
409
                    pool_metrics
                        .counter("onboard_processed")
                        .inc_by(request.blocks.len() as u64);

Ryan Olson's avatar
Ryan Olson committed
410
                    tracing::debug!("Onboarding {} blocks to target pool.", request.blocks.len());
411
412
413

                    transfer_manager
                        .enqueue_transfer(PendingTransfer::new(
Ryan Olson's avatar
Ryan Olson committed
414
                            request.blocks,
415
416
417
418
419
420
421
                            target_blocks,
                            Some(request.response_tx),
                            target_pool.clone(),
                        ))
                        .await?;

                    Ok::<(), anyhow::Error>(())
422
                }
423
            }?;
424
425
426
427
428
        }
    }

    pub async fn offload<S: Storage>(
        &self,
Ryan Olson's avatar
Ryan Olson committed
429
        block: &ImmutableBlock<S, Locality, Metadata>,
430
431
432
        priority: u64,
    ) -> core::result::Result<(), BlockPoolError> {
        match block.state() {
433
            BlockState::Registered(_, _) => {}
434
435
436
437
438
439
            _ => {
                return Err(BlockPoolError::BlockError(BlockError::InvalidState(
                    "Block is not registered.".to_string(),
                )));
            }
        }
440
441
442
443
444
445
446
447
448
449

        let mut tick = self.tick.lock().await;
        let key = OffloadRequestKey {
            priority,
            timestamp: *tick,
        };
        // Increment a counter for each block. Within the same priority, blocks with lower counter values are processed first.
        *tick += 1;
        drop(tick);

450
451
452
453
454
455
        // This can get called by all pools, regardless of whether or not they have a place to offload to.
        // Because of this, we need to check the block type here.
        let any_block = block as &dyn Any;

        // TODO: What's the performance penalty of this runtime type-checking?
        if let Some(device_block) =
Ryan Olson's avatar
Ryan Olson committed
456
            any_block.downcast_ref::<ImmutableBlock<DeviceStorage, Locality, Metadata>>()
457
        {
458
459
460
461
            // The host pool doesn't exist, so we can't offload to it.
            if self.device_offload_tx.is_closed() {
                return Ok(());
            }
462
463
464

            let request = OffloadRequest {
                block: Arc::downgrade(device_block.mutable_block()),
Ryan Olson's avatar
Ryan Olson committed
465
                sequence_hash: device_block.sequence_hash(),
466
467
468
                key,
            };

469
470
            self.device_offload_tx.send(request).unwrap();
        } else if let Some(host_block) =
Ryan Olson's avatar
Ryan Olson committed
471
            any_block.downcast_ref::<ImmutableBlock<PinnedStorage, Locality, Metadata>>()
472
473
474
475
476
477
478
479
        {
            // The disk pool doesn't exist, so we can't offload to it.
            if self.host_offload_tx.is_closed() {
                return Ok(());
            }

            let request = OffloadRequest {
                block: Arc::downgrade(host_block.mutable_block()),
Ryan Olson's avatar
Ryan Olson committed
480
                sequence_hash: host_block.sequence_hash(),
481
482
483
484
                key,
            };

            self.host_offload_tx.send(request).unwrap();
485
486
487
488
489
        }

        Ok(())
    }

Ryan Olson's avatar
Ryan Olson committed
490
    pub fn onboard<S: Storage>(
491
        &self,
Ryan Olson's avatar
Ryan Olson committed
492
493
494
495
        blocks: Vec<ImmutableBlock<S, Locality, Metadata>>,
        targets: Option<Vec<MutableBlock<DeviceStorage, Locality, Metadata>>>,
    ) -> oneshot::Receiver<BlockResult<DeviceStorage, Locality, Metadata>> {
        let (tx, rx) = oneshot::channel();
496
497
        for block in &blocks {
            match block.state() {
498
                BlockState::Registered(_, _) => {}
499
                _ => {
Ryan Olson's avatar
Ryan Olson committed
500
                    tx.send(Err(BlockPoolError::BlockError(BlockError::InvalidState(
501
                        "Block is not registered.".to_string(),
Ryan Olson's avatar
Ryan Olson committed
502
503
504
                    ))))
                    .unwrap();
                    return rx;
505
506
507
508
                }
            }
        }

509
510
511
512
513
514
515
516
        if let Some(targets) = targets.as_ref()
            && targets.len() != blocks.len()
        {
            tx.send(Err(BlockPoolError::BlockError(BlockError::Other(
                anyhow::anyhow!("Number of targets does not match number of blocks."),
            ))))
            .unwrap();
            return rx;
517
518
        }

Ryan Olson's avatar
Ryan Olson committed
519
520
521
522
        if blocks.is_empty() {
            tx.send(Ok(vec![])).unwrap();
            return rx;
        }
523

524
525
526
527
        let any_block = blocks.first().unwrap() as &dyn Any;

        // TODO: This is really ugly.
        if any_block
Ryan Olson's avatar
Ryan Olson committed
528
            .downcast_ref::<ImmutableBlock<PinnedStorage, Locality, Metadata>>()
529
530
531
532
533
534
            .is_some()
        {
            let host_blocks = blocks
                .iter()
                .map(|b| {
                    (b as &dyn Any)
Ryan Olson's avatar
Ryan Olson committed
535
                        .downcast_ref::<ImmutableBlock<PinnedStorage, Locality, Metadata>>()
536
537
538
539
540
                        .unwrap()
                        .clone()
                })
                .collect();

Ryan Olson's avatar
Ryan Olson committed
541
542
543
544
545
546
547
548
            if let Err(e) = self
                .host_onboard_tx
                .send(OnboardRequest::new(host_blocks, tx, targets))
            {
                e.0.response_tx
                    .send(Err(BlockPoolError::ProgressEngineShutdown))
                    .unwrap();
            }
549
        } else if any_block
Ryan Olson's avatar
Ryan Olson committed
550
            .downcast_ref::<ImmutableBlock<DiskStorage, Locality, Metadata>>()
551
552
553
554
555
556
            .is_some()
        {
            let disk_blocks = blocks
                .iter()
                .map(|b| {
                    (b as &dyn Any)
Ryan Olson's avatar
Ryan Olson committed
557
                        .downcast_ref::<ImmutableBlock<DiskStorage, Locality, Metadata>>()
558
559
560
561
562
                        .unwrap()
                        .clone()
                })
                .collect();

Ryan Olson's avatar
Ryan Olson committed
563
564
565
566
567
568
569
570
            if let Err(e) = self
                .disk_onboard_tx
                .send(OnboardRequest::new(disk_blocks, tx, targets))
            {
                e.0.response_tx
                    .send(Err(BlockPoolError::ProgressEngineShutdown))
                    .unwrap();
            }
571
        } else {
Ryan Olson's avatar
Ryan Olson committed
572
            tx.send(Err(BlockPoolError::BlockError(BlockError::Other(
573
                anyhow::anyhow!("Block type not supported for onboarding."),
Ryan Olson's avatar
Ryan Olson committed
574
575
            ))))
            .unwrap();
576
577
        }

Ryan Olson's avatar
Ryan Olson committed
578
        rx
579
580
581
582
    }
}

#[cfg(all(test, feature = "testing-cuda"))]
Ryan Olson's avatar
Ryan Olson committed
583
mod tests {
584
585
586
    use super::*;

    use crate::block_manager::{
587
        LayoutConfig, NixlRegisterableStorage,
588
        block::{
589
            BasicMetadata, BlockDataExt, BlockDataProvider, Blocks, MutableBlock, locality::Local,
590
        },
591
        layout::{FullyContiguous, LayerSeparate, LayoutType, nixl::NixlLayout},
Ryan Olson's avatar
Ryan Olson committed
592
        pool::{BlockRegistrationDuplicationSetting, ManagedBlockPool},
593
        storage::{
594
            DeviceAllocator, DeviceStorage, DiskAllocator, DiskStorage, PinnedAllocator,
Ryan Olson's avatar
Ryan Olson committed
595
            PinnedStorage, StorageAllocator, StorageType,
596
597
        },
    };
598
    use crate::tokens::{TokenBlockSequence, Tokens};
599
    use nixl_sys::{MemoryRegion, NixlDescriptor};
600

601
    use aligned_vec::avec;
602
    use cudarc::runtime::sys::{cudaMemcpy, cudaMemcpyKind, cudaMemset};
603
    use prometheus::Registry;
Ryan Olson's avatar
Ryan Olson committed
604
    use rstest::*;
605
    use std::fs::File;
606
    use std::io::{Read, Seek, SeekFrom, Write};
607
608
    use std::mem::ManuallyDrop;
    use std::os::unix::io::FromRawFd;
609
610

    const BLOCK_SIZE: usize = 4;
611
    const NUM_LAYERS: usize = 8;
612

Ryan Olson's avatar
Ryan Olson committed
613
614
615
    type DevicePool = Option<Arc<dyn BlockPool<DeviceStorage, Local, BasicMetadata>>>;
    type HostPool = Option<Arc<dyn BlockPool<PinnedStorage, Local, BasicMetadata>>>;
    type DiskPool = Option<Arc<dyn BlockPool<DiskStorage, Local, BasicMetadata>>>;
616
617
618
619
620

    lazy_static::lazy_static! {
        static ref NIXL_AGENT: Arc<Option<NixlAgent>> = {
            let agent = NixlAgent::new("offload-manager").unwrap();
            let (_, ucx_params) = agent.get_plugin_params("UCX").unwrap();
Ryan Olson's avatar
Ryan Olson committed
621
            let (_, gds_mt_params) = agent.get_plugin_params("GDS_MT").unwrap();
622
            let (_, posix_params) = agent.get_plugin_params("POSIX").unwrap();
623
            agent.create_backend("UCX", &ucx_params).unwrap();
Ryan Olson's avatar
Ryan Olson committed
624
            agent.create_backend("GDS_MT", &gds_mt_params).unwrap();
625
            agent.create_backend("POSIX", &posix_params).unwrap();
626
627
628
            Arc::new(Some(agent))
        };
    }
629

Ryan Olson's avatar
Ryan Olson committed
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
    fn build_layout<S: Storage + NixlRegisterableStorage>(
        config: LayoutConfig,
        layout_type: LayoutType,
        agent: &NixlAgent,
        allocator: &dyn StorageAllocator<S>,
        duplication_setting: BlockRegistrationDuplicationSetting,
    ) -> Result<Arc<dyn BlockPool<S, Local, BasicMetadata>>> {
        match layout_type {
            LayoutType::FullyContiguous => {
                let mut pool_layout = FullyContiguous::allocate(config.clone(), allocator)?;
                pool_layout.nixl_register(agent, None)?;
                let blocks = Blocks::new(pool_layout, 42, 0)?.into_blocks()?;
                Ok(Arc::new(
                    ManagedBlockPool::builder()
                        .blocks(blocks)
                        .default_duplication_setting(duplication_setting)
                        .build()?,
                ))
            }
            LayoutType::LayerSeparate { outer_contiguous } => {
                let mut pool_layout =
                    LayerSeparate::allocate(config.clone(), allocator, outer_contiguous)?;
                pool_layout.nixl_register(agent, None)?;
                let blocks = Blocks::new(pool_layout, 42, 0)?.into_blocks()?;
                Ok(Arc::new(
                    ManagedBlockPool::builder()
                        .blocks(blocks)
                        .default_duplication_setting(duplication_setting)
                        .build()?,
                ))
            }
        }
    }

    #[allow(clippy::type_complexity)]
    fn build_pools(
666
667
        device_blocks: usize,
        host_blocks: Option<usize>,
668
        disk_blocks: Option<usize>,
669
        inner_dim: Option<usize>,
670
    ) -> Result<(
Ryan Olson's avatar
Ryan Olson committed
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
        Arc<OffloadManager<Local, BasicMetadata>>,
        DevicePool,
        HostPool,
        DiskPool,
    )> {
        build_pools_with_layout(
            device_blocks,
            host_blocks,
            disk_blocks,
            inner_dim,
            LayoutType::FullyContiguous,
            BlockRegistrationDuplicationSetting::Disabled,
        )
    }

    #[allow(clippy::type_complexity)]
    pub fn build_pools_with_layout(
        device_blocks: usize,
        host_blocks: Option<usize>,
        disk_blocks: Option<usize>,
        inner_dim: Option<usize>,
        layout_type: LayoutType,
        duplication_setting: BlockRegistrationDuplicationSetting,
    ) -> Result<(
        Arc<OffloadManager<Local, BasicMetadata>>,
696
697
698
699
        DevicePool,
        HostPool,
        DiskPool,
    )> {
700
701
        let mut config = LayoutConfig {
            num_blocks: device_blocks,
702
            num_layers: NUM_LAYERS,
703
            outer_dim: 1,
704
            page_size: BLOCK_SIZE,
705
            inner_dim: inner_dim.unwrap_or(1024),
706
            alignment: 1,
Ryan Olson's avatar
Ryan Olson committed
707
            dtype_width_bytes: 2,
708
709
        };

710
711
712
        let agent_arc = NIXL_AGENT.clone();
        let agent = agent_arc.as_ref().as_ref().unwrap();

Ryan Olson's avatar
Ryan Olson committed
713
714
715
716
717
718
719
        let device_pool = Some(build_layout(
            config.clone(),
            layout_type,
            agent,
            &DeviceAllocator::default(),
            duplication_setting,
        )?);
720
721
722

        let host_pool = if let Some(host_blocks) = host_blocks {
            config.num_blocks = host_blocks;
Ryan Olson's avatar
Ryan Olson committed
723
724
725
726
727
728
729
            Some(build_layout(
                config.clone(),
                layout_type,
                agent,
                &PinnedAllocator::default(),
                duplication_setting,
            )?)
730
        } else {
731
            None
732
733
        };

734
735
        let disk_pool = if let Some(disk_blocks) = disk_blocks {
            config.num_blocks = disk_blocks;
Ryan Olson's avatar
Ryan Olson committed
736
737
738
739
740
741
742
            Some(build_layout(
                config,
                layout_type,
                agent,
                &DiskAllocator,
                duplication_setting,
            )?)
743
        } else {
744
            None
745
        };
746

747
748
749
750
751
752
753
754
        let async_rt_handle = Handle::current();

        let manager = OffloadManager::new(
            disk_pool.clone(),
            host_pool.clone(),
            device_pool.clone(),
            agent_arc,
            async_rt_handle,
755
            BlockManagerMetrics::new(&Arc::new(Registry::new()))?,
756
            CancellationToken::new(),
757
758
759
        )?;

        Ok((manager, device_pool, host_pool, disk_pool))
760
761
762
    }

    /// Create a block in the 'RESET' state.
Ryan Olson's avatar
Ryan Olson committed
763
    #[expect(dead_code)]
764
    async fn get_block<S: Storage, Metadata: BlockMetadata>(
Ryan Olson's avatar
Ryan Olson committed
765
766
767
768
        pool: &Arc<dyn BlockPool<S, Local, Metadata>>,
    ) -> Result<MutableBlock<S, Local, Metadata>> {
        let mut blocks = pool.allocate_blocks(1).await?;
        Ok(blocks.pop().unwrap())
769
770
771
772
    }

    /// Create a block in the 'COMPLETED' state.
    async fn completed_block<S: Storage, Metadata: BlockMetadata>(
Ryan Olson's avatar
Ryan Olson committed
773
        pool: &Arc<dyn BlockPool<S, Local, Metadata>>,
774
        tokens: [u32; BLOCK_SIZE],
Ryan Olson's avatar
Ryan Olson committed
775
776
777
778
779
780
781
782
    ) -> Result<MutableBlock<S, Local, Metadata>> {
        let mut block = pool
            .allocate_blocks(1)
            .await?
            .into_iter()
            .next()
            .ok_or(anyhow::anyhow!("Failed to allocate block"))?;

783
784
785
786
787
788
789
790
        block.init_sequence(42)?;
        for token in tokens {
            block.add_token(token)?;
        }
        block.commit()?;
        Ok(block)
    }

791
    fn populate_block<S: Storage + NixlDescriptor>(
792
        block: &impl BlockDataProvider<StorageType = S>,
Ryan Olson's avatar
Ryan Olson committed
793
        start_value: u8,
794
    ) -> Result<()> {
Ryan Olson's avatar
Ryan Olson committed
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
        let block_data = block.block_data();

        let mut value = start_value;

        for layer_idx in 0..block_data.num_layers() {
            for outer_idx in 0..block_data.num_outer_dims() {
                let layer_view = block_data.layer_view(layer_idx, outer_idx)?;
                match block_data.storage_type() {
                    StorageType::Device(_) | StorageType::Pinned => unsafe {
                        cudaMemset(
                            layer_view.as_ptr() as *mut std::ffi::c_void,
                            value as i32,
                            layer_view.size(),
                        )
                        .result()?;
                    },
                    StorageType::Disk(_) => {
                        let nixl_desc = layer_view.as_nixl_descriptor();
                        let mut file: ManuallyDrop<File>;
                        let data = avec![[4096] | value; layer_view.size()];

                        unsafe {
                            file =
                                ManuallyDrop::new(File::from_raw_fd(nixl_desc.device_id() as i32));
                            file.seek(SeekFrom::Start(nixl_desc.as_ptr() as u64))?;
                        }
                        file.write_all(&data)?;
                        file.sync_all()?;
                        file.flush()?;
                    }
                    _ => panic!(),
826
827
                }
            }
Ryan Olson's avatar
Ryan Olson committed
828
829

            value += 1;
830
        }
831

832
833
834
        Ok(())
    }

835
836
    fn get_block_contents<S: Storage + NixlDescriptor>(
        block: &impl BlockDataProvider<StorageType = S>,
Ryan Olson's avatar
Ryan Olson committed
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
    ) -> Result<Vec<Vec<u8>>> {
        let block_data = block.block_data();

        let mut contents: Vec<Vec<u8>> = Vec::new();

        for layer_idx in 0..block_data.num_layers() {
            for outer_idx in 0..block_data.num_outer_dims() {
                let layer_view = block_data.layer_view(layer_idx, outer_idx)?;
                match block_data.storage_type() {
                    StorageType::Device(_) => unsafe {
                        let mut buffer = vec![0_u8; layer_view.size()];

                        cudaMemcpy(
                            buffer.as_mut_ptr() as *mut std::ffi::c_void,
                            layer_view.as_ptr() as *const std::ffi::c_void,
                            layer_view.size(),
                            cudaMemcpyKind::cudaMemcpyDeviceToHost,
                        )
                        .result()?;

                        contents.push(buffer);
                    },
                    StorageType::Pinned => unsafe {
                        contents.push(
                            std::slice::from_raw_parts(layer_view.as_ptr(), layer_view.size())
                                .to_vec(),
                        );
                    },
                    StorageType::Disk(_) => {
                        let nixl_desc = layer_view.as_nixl_descriptor();
                        let mut file: ManuallyDrop<File>;
                        let mut aligned = avec![[4096] | 0; layer_view.size()];

                        unsafe {
                            file =
                                ManuallyDrop::new(File::from_raw_fd(nixl_desc.device_id() as i32));
                            file.seek(SeekFrom::Start(nixl_desc.as_ptr() as u64))?;
                        }
                        file.read_exact(&mut aligned)?;
                        contents.push(aligned.to_vec());
                    }
                    _ => anyhow::bail!("Unsupported storage type."),
879
880
                }
            }
881
882
        }

Ryan Olson's avatar
Ryan Olson committed
883
        Ok(contents)
884
885
    }

886
    fn check_block_contents(
887
888
        block1: &impl BlockDataProvider<StorageType = impl Storage + NixlDescriptor>,
        block2: &impl BlockDataProvider<StorageType = impl Storage + NixlDescriptor>,
Ryan Olson's avatar
Ryan Olson committed
889
        start_value: u8,
890
    ) -> Result<()> {
891
892
        let contents1 = get_block_contents(block1)?;
        let contents2 = get_block_contents(block2)?;
893

Ryan Olson's avatar
Ryan Olson committed
894
895
896
897
898
899
900
901
902
        assert_eq!(contents1.len(), contents2.len());

        let mut value = start_value;

        for (layer1_vec, layer2_vec) in contents1.iter().zip(contents2.iter()) {
            for (c1_value, c2_value) in layer1_vec.iter().zip(layer2_vec.iter()) {
                if c1_value != c2_value || c1_value != &value {
                    panic!("{} != {} != {}", c1_value, c2_value, value);
                }
903
            }
Ryan Olson's avatar
Ryan Olson committed
904
            value += 1;
905
        }
906
907
908
909
910
        Ok(())
    }

    #[tokio::test]
    async fn test_offload_invalid_blocks() -> Result<()> {
911
        let (offload_manager, device_pool, _, _) = build_pools(4, Some(4), None, None)?;
912

913
        let device_pool = device_pool.as_ref().unwrap();
914
915
916
917
918
919
920
921
922
923
924
925
926
927

        // Check blocks in the 'COMPLETED' state.
        let immutable_block = ImmutableBlock::new(Arc::new(
            completed_block(device_pool, [0; BLOCK_SIZE]).await?,
        ));
        assert!(matches!(
            offload_manager.offload(&immutable_block, 0).await,
            Err(BlockPoolError::BlockError(BlockError::InvalidState(_)))
        ));

        Ok(())
    }

    #[tokio::test]
Ryan Olson's avatar
Ryan Olson committed
928
929
930
931
932
933
934
935
936
937
938
939
940
    #[rstest]
    #[case(LayoutType::FullyContiguous)]
    #[case(LayoutType::LayerSeparate { outer_contiguous: true })]
    #[case(LayoutType::LayerSeparate { outer_contiguous: false })]
    async fn test_offload_registered_blocks(#[case] layout_type: LayoutType) -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools_with_layout(
            4,
            Some(4),
            None,
            None,
            layout_type,
            BlockRegistrationDuplicationSetting::Disabled,
        )?;
941

942
943
        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
944
945
946
947
948
949
950
951
952
953
954

        // Create a block and register it with the offload manager
        let block = completed_block(device_pool, [0, 1, 2, 3]).await?;

        let immutable_device_block = device_pool
            .register_blocks(vec![block])
            .await?
            .into_iter()
            .next()
            .ok_or(anyhow::anyhow!("Failed to register block"))?;

955
        populate_block(&immutable_device_block, 42)?;
956
957
958
959
960
961
962
963
964
965
966

        // Offloads should only go to G2 (for now)
        offload_manager.offload(&immutable_device_block, 0).await?;

        // Wait for it to be processed.
        // TODO: This is a bit of a hack, and may lead to non-deterministic behavior.
        // In theory, the offload + memcpy should take much less time than this.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // Check that the block exists in the host pool
        let host_blocks = host_pool
Ryan Olson's avatar
Ryan Olson committed
967
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
968
969
970
971
            .await?;

        assert_eq!(host_blocks.len(), 1);
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
972
973
            host_blocks[0].sequence_hash(),
            immutable_device_block.sequence_hash()
974
975
        );

976
        check_block_contents(&immutable_device_block, &host_blocks[0], 42)?;
977
978
979
980
981
982

        Ok(())
    }

    #[tokio::test]
    async fn test_no_host_blocks_available() -> Result<()> {
983
        let (offload_manager, device_pool, host_pool, _) = build_pools(4, Some(4), None, None)?;
984

985
986
        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005

        let host_blocks = host_pool.allocate_blocks(4).await?;
        assert_eq!(host_blocks.len(), 4);

        let device_block = completed_block(device_pool, [0, 1, 2, 3]).await?;
        let immutable_device_block = device_pool
            .register_blocks(vec![device_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

        offload_manager.offload(&immutable_device_block, 0).await?;

        // Wait for offload to be processed.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // The offload should fail gracefuly due to a lack of host blocks
        let matched_host_blocks = host_pool
Ryan Olson's avatar
Ryan Olson committed
1006
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
            .await?;
        assert_eq!(matched_host_blocks.len(), 0);

        // Wait for blocks to be returned to the pool.
        drop(host_blocks);
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // Try the offload again.
        offload_manager.offload(&immutable_device_block, 0).await?;

        // Wait for offload to be processed.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // This time, the offload should succeed.
        let matched_host_blocks = host_pool
Ryan Olson's avatar
Ryan Olson committed
1022
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1023
1024
1025
1026
1027
1028
1029
            .await?;
        assert_eq!(matched_host_blocks.len(), 1);

        Ok(())
    }

    #[tokio::test]
Ryan Olson's avatar
Ryan Olson committed
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
    #[rstest]
    #[case(LayoutType::FullyContiguous)]
    #[case(LayoutType::LayerSeparate { outer_contiguous: true })]
    #[case(LayoutType::LayerSeparate { outer_contiguous: false })]
    async fn test_onboard(#[case] layout_type: LayoutType) -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools_with_layout(
            4,
            Some(4),
            None,
            None,
            layout_type,
            BlockRegistrationDuplicationSetting::Disabled,
        )?;
1043

1044
1045
        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055

        // Allocate and fill a block on the host.
        let host_block = completed_block(host_pool, [0, 1, 2, 3]).await?;
        let immutable_host_block = host_pool
            .register_blocks(vec![host_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

1056
        populate_block(&immutable_host_block, 42)?;
1057
1058
1059

        // Onboard the block.
        let onboarded_blocks = offload_manager
Ryan Olson's avatar
Ryan Olson committed
1060
1061
            .onboard(vec![immutable_host_block.clone()], None)
            .await??;
1062
1063
1064
1065

        assert_eq!(onboarded_blocks.len(), 1);
        // Check that the sequence hash is the same.
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
1066
1067
            onboarded_blocks[0].sequence_hash(),
            immutable_host_block.sequence_hash()
1068
1069
1070
1071
        );
        // Check that the block is registered.
        assert!(matches!(
            onboarded_blocks[0].state(),
1072
            BlockState::Registered(_, _)
1073
1074
        ));

1075
        check_block_contents(&immutable_host_block, &onboarded_blocks[0], 42)?;
1076
1077
1078
1079

        // Wait for the new value to show up in the device pool.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;
        let device_blocks = device_pool
Ryan Olson's avatar
Ryan Olson committed
1080
            .match_sequence_hashes(vec![onboarded_blocks[0].sequence_hash()].as_slice())
1081
1082
1083
            .await?;
        assert_eq!(device_blocks.len(), 1);
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
1084
1085
            device_blocks[0].sequence_hash(),
            onboarded_blocks[0].sequence_hash()
1086
1087
1088
        );

        // Check that this is the same block.
1089
        check_block_contents(&immutable_host_block, &device_blocks[0], 42)?;
1090
1091
1092
1093
1094

        Ok(())
    }

    #[tokio::test]
Ryan Olson's avatar
Ryan Olson committed
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
    #[rstest]
    #[case(LayoutType::FullyContiguous)]
    #[case(LayoutType::LayerSeparate { outer_contiguous: true })]
    #[case(LayoutType::LayerSeparate { outer_contiguous: false })]
    async fn test_offload_onboard(#[case] layout_type: LayoutType) -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools_with_layout(
            4,
            Some(4),
            None,
            None,
            layout_type,
            BlockRegistrationDuplicationSetting::Disabled,
        )?;
1108

1109
1110
        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
1111
1112
1113
1114
1115
1116
1117
1118
1119

        let device_block = completed_block(device_pool, [0, 1, 2, 3]).await?;
        let immutable_device_block = device_pool
            .register_blocks(vec![device_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

1120
        populate_block(&immutable_device_block, 42)?;
1121
1122
1123
1124
1125
1126
1127
1128
        // Offload the block to the host.
        offload_manager.offload(&immutable_device_block, 0).await?;

        // Wait for the offload to be processed.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // Check that the block exists in the host pool.
        let immutable_host_block = host_pool
Ryan Olson's avatar
Ryan Olson committed
1129
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1130
1131
1132
1133
1134
            .await?
            .into_iter()
            .next()
            .unwrap();

1135
        check_block_contents(&immutable_device_block, &immutable_host_block, 42)?;
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150

        // Remove the device block from the pool by dropping it and allocating more blocks.
        drop(immutable_device_block);

        // Wait for the block to be returned to the pool.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        let device_blocks = device_pool.allocate_blocks(4).await?;
        assert_eq!(device_blocks.len(), 4);

        drop(device_blocks);
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // Check that the block is not in the device pool.
        let device_blocks = device_pool
Ryan Olson's avatar
Ryan Olson committed
1151
            .match_sequence_hashes(vec![immutable_host_block.sequence_hash()].as_slice())
1152
1153
1154
1155
1156
            .await?;
        assert_eq!(device_blocks.len(), 0);

        // Onboard the block back to the device pool.
        let onboarded_blocks = offload_manager
Ryan Olson's avatar
Ryan Olson committed
1157
1158
            .onboard(vec![immutable_host_block.clone()], None)
            .await??;
1159
1160
        assert_eq!(onboarded_blocks.len(), 1);
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
1161
1162
            onboarded_blocks[0].sequence_hash(),
            immutable_host_block.sequence_hash()
1163
1164
1165
        );
        assert!(matches!(
            onboarded_blocks[0].state(),
1166
            BlockState::Registered(_, _)
1167
1168
        ));

1169
        check_block_contents(&immutable_host_block, &onboarded_blocks[0], 42)?;
1170
1171
1172
1173
1174
1175

        Ok(())
    }

    #[tokio::test]
    async fn test_onboard_err_handling() -> Result<()> {
1176
        let (offload_manager, device_pool, host_pool, _) = build_pools(4, Some(4), None, None)?;
1177

1178
1179
        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192

        let host_block = completed_block(host_pool, [0, 1, 2, 3]).await?;
        let immutable_host_block = host_pool
            .register_blocks(vec![host_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

        let device_blocks = device_pool.allocate_blocks(4).await?;
        assert_eq!(device_blocks.len(), 4);

        let res = offload_manager
Ryan Olson's avatar
Ryan Olson committed
1193
1194
            .onboard(vec![immutable_host_block.clone()], None)
            .await?;
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
        assert!(matches!(
            res.err().unwrap(),
            BlockPoolError::NotEnoughBlocksAvailable(_, _)
        ));

        Ok(())
    }

    #[tokio::test]
    async fn test_offload_onboard_no_host_blocks() -> Result<()> {
1205
        let (offload_manager, device_pool, _, _) = build_pools(4, None, None, None)?;
1206

1207
        let device_pool = device_pool.as_ref().unwrap();
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220

        let device_block = completed_block(device_pool, [0, 1, 2, 3]).await?;
        let immutable_device_block = device_pool
            .register_blocks(vec![device_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

        offload_manager.offload(&immutable_device_block, 0).await?;

        Ok(())
    }
1221
1222

    #[tokio::test]
Ryan Olson's avatar
Ryan Olson committed
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
    #[rstest]
    #[case(LayoutType::FullyContiguous)]
    #[case(LayoutType::LayerSeparate { outer_contiguous: true })]
    #[case(LayoutType::LayerSeparate { outer_contiguous: false })]
    async fn test_offload_disk(#[case] layout_type: LayoutType) -> Result<()> {
        let (offload_manager, _, host_pool, disk_pool) = build_pools_with_layout(
            4,
            Some(4),
            Some(4),
            None,
            layout_type,
            BlockRegistrationDuplicationSetting::Disabled,
        )?;
1236

1237
1238
        let host_pool = host_pool.as_ref().unwrap();
        let disk_pool = disk_pool.as_ref().unwrap();
1239
1240
1241
1242
1243
1244
1245
1246
1247

        let host_block = completed_block(host_pool, [0, 1, 2, 3]).await?;
        let immutable_host_block = host_pool
            .register_blocks(vec![host_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

1248
        populate_block(&immutable_host_block, 42)?;
1249
1250
1251
1252
1253
1254

        offload_manager.offload(&immutable_host_block, 0).await?;

        tokio::time::sleep(std::time::Duration::from_millis(500)).await;

        let disk_blocks = disk_pool
Ryan Olson's avatar
Ryan Olson committed
1255
            .match_sequence_hashes(vec![immutable_host_block.sequence_hash()].as_slice())
1256
1257
1258
            .await?;
        assert_eq!(disk_blocks.len(), 1);
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
1259
1260
            disk_blocks[0].sequence_hash(),
            immutable_host_block.sequence_hash()
1261
1262
        );

1263
        check_block_contents(&immutable_host_block, &disk_blocks[0], 42)?;
1264
1265
1266
1267
1268

        Ok(())
    }

    #[tokio::test]
Ryan Olson's avatar
Ryan Olson committed
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
    #[rstest]
    #[case(LayoutType::FullyContiguous)]
    #[case(LayoutType::LayerSeparate { outer_contiguous: true })]
    #[case(LayoutType::LayerSeparate { outer_contiguous: false })]
    async fn test_onboard_disk(#[case] layout_type: LayoutType) -> Result<()> {
        let (offload_manager, device_pool, _, disk_pool) = build_pools_with_layout(
            4,
            None,
            Some(4),
            None,
            layout_type,
            BlockRegistrationDuplicationSetting::Disabled,
        )?;
1282

1283
1284
        let device_pool = device_pool.as_ref().unwrap();
        let disk_pool = disk_pool.as_ref().unwrap();
1285
1286
1287
1288
1289
1290
1291
1292
1293

        let disk_block = completed_block(disk_pool, [0, 1, 2, 3]).await?;
        let immutable_disk_block = disk_pool
            .register_blocks(vec![disk_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

1294
1295
        populate_block(&immutable_disk_block, 42)?;

1296
        let device_block = offload_manager
Ryan Olson's avatar
Ryan Olson committed
1297
1298
            .onboard(vec![immutable_disk_block.clone()], None)
            .await??;
1299

1300
1301
        check_block_contents(&immutable_disk_block, &device_block[0], 42)?;

1302
1303
        assert_eq!(device_block.len(), 1);
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
1304
1305
            device_block[0].sequence_hash(),
            immutable_disk_block.sequence_hash()
1306
1307
1308
        );
        assert_eq!(
            device_pool
Ryan Olson's avatar
Ryan Olson committed
1309
                .match_sequence_hashes(vec![immutable_disk_block.sequence_hash()].as_slice())
1310
1311
1312
1313
1314
1315
1316
1317
1318
                .await?
                .len(),
            1
        );

        Ok(())
    }

    #[tokio::test]
Ryan Olson's avatar
Ryan Olson committed
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
    #[rstest]
    #[case(LayoutType::FullyContiguous)]
    #[case(LayoutType::LayerSeparate { outer_contiguous: true })]
    #[case(LayoutType::LayerSeparate { outer_contiguous: false })]
    async fn test_bulk_transfer_disk(#[case] layout_type: LayoutType) -> Result<()> {
        let (offload_manager, device_pool, host_pool, disk_pool) = build_pools_with_layout(
            8,
            Some(8),
            Some(8),
            None,
            layout_type,
            BlockRegistrationDuplicationSetting::Disabled,
        )?;
1332

1333
1334
1335
        let disk_pool = disk_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
        let device_pool = device_pool.as_ref().unwrap();
1336
1337
1338
1339
1340

        let mut host_blocks = Vec::new();

        for i in 0..8 {
            let block = completed_block(host_pool, [i; 4]).await?;
1341
            populate_block(&block, i as u8)?;
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
            host_blocks.push(block);
        }

        let immutable_host_blocks = host_pool.register_blocks(host_blocks).await?;

        for block in &immutable_host_blocks {
            offload_manager.offload(block, 0).await?;
        }

        tokio::time::sleep(std::time::Duration::from_millis(500)).await;

        let mut disk_blocks = Vec::new();

1355
        for (i, host_block) in immutable_host_blocks.iter().enumerate() {
1356
            let blocks = disk_pool
Ryan Olson's avatar
Ryan Olson committed
1357
                .match_sequence_hashes(vec![host_block.sequence_hash()].as_slice())
1358
1359
                .await?;
            assert_eq!(blocks.len(), 1);
1360
            check_block_contents(host_block, &blocks[0], i as u8)?;
1361
1362
1363
            disk_blocks.push(blocks[0].clone());
        }

Ryan Olson's avatar
Ryan Olson committed
1364
        let device_blocks = offload_manager.onboard(disk_blocks.clone(), None).await??;
1365
1366
        assert_eq!(device_blocks.len(), disk_blocks.len());

1367
        for (i, disk_block) in disk_blocks.iter().enumerate() {
1368
            let blocks = device_pool
Ryan Olson's avatar
Ryan Olson committed
1369
                .match_sequence_hashes(vec![disk_block.sequence_hash()].as_slice())
1370
1371
                .await?;
            assert_eq!(blocks.len(), 1);
1372
            check_block_contents(disk_block, &blocks[0], i as u8)?;
1373
1374
1375
1376
        }

        Ok(())
    }
1377
1378
1379
1380
1381
1382
1383

    #[tokio::test]
    async fn test_transfer_batcher() -> Result<()> {
        let (offload_manager, device_pool, _, disk_pool) = build_pools(
            2 * MAX_TRANSFER_BATCH_SIZE + 1,
            None,
            Some(2 * MAX_TRANSFER_BATCH_SIZE + 1),
1384
            None,
1385
1386
1387
1388
1389
1390
1391
1392
        )?;

        let device_pool = device_pool.as_ref().unwrap();
        let disk_pool = disk_pool.as_ref().unwrap();

        let mut disk_blocks = Vec::new();

        for i in 0..2 * MAX_TRANSFER_BATCH_SIZE + 1 {
1393
1394
1395
            let disk_block = completed_block(disk_pool, [i as u32; 4]).await?;
            populate_block(&disk_block, i as u8)?;
            disk_blocks.push(disk_block);
1396
1397
1398
1399
1400
        }

        let immutable_disk_blocks = disk_pool.register_blocks(disk_blocks).await?;

        let device_blocks = offload_manager
Ryan Olson's avatar
Ryan Olson committed
1401
1402
            .onboard(immutable_disk_blocks.clone(), None)
            .await??;
1403
1404
        assert_eq!(device_blocks.len(), 2 * MAX_TRANSFER_BATCH_SIZE + 1);

1405
        for (i, device_block) in device_blocks.iter().enumerate() {
1406
            let blocks = device_pool
Ryan Olson's avatar
Ryan Olson committed
1407
                .match_sequence_hashes(vec![device_block.sequence_hash()].as_slice())
1408
                .await?;
1409
            check_block_contents(device_block, &blocks[0], i as u8)?;
1410
1411
1412
1413
1414
            assert_eq!(blocks.len(), 1);
        }

        Ok(())
    }
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430

    #[tokio::test]
    async fn test_onboard_unsupported_block_type() -> Result<()> {
        let (offload_manager, device_pool, _, _) = build_pools(1, None, None, None)?;

        let device_pool = device_pool.as_ref().unwrap();

        let block = completed_block(device_pool, [0; 4]).await?;

        let registered_block = device_pool
            .register_blocks(vec![block])
            .await?
            .into_iter()
            .next()
            .unwrap();

Ryan Olson's avatar
Ryan Olson committed
1431
1432
1433
        let onboarded_blocks = offload_manager
            .onboard(vec![registered_block], None)
            .await?;
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
        assert!(matches!(
            onboarded_blocks,
            Err(BlockPoolError::BlockError(BlockError::Other(_)))
        ));

        Ok(())
    }

    #[tokio::test]
    async fn test_offload_transfer_metadata() -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools(4, Some(4), None, None)?;

        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();

        let mut device_block = completed_block(device_pool, [0; 4]).await?;

        populate_block(&device_block, 42)?;

        let new_metadata = device_block.metadata().update_priority(1);
        device_block.update_metadata(new_metadata);

        let immutable_device_block = device_pool
            .register_blocks(vec![device_block])
            .await?
            .into_iter()
            .next()
            .unwrap();
        offload_manager.offload(&immutable_device_block, 0).await?;

        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        let host_blocks = host_pool
Ryan Olson's avatar
Ryan Olson committed
1467
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
            .await?;
        assert_eq!(host_blocks.len(), 1);
        check_block_contents(&immutable_device_block, &host_blocks[0], 42)?;
        assert_eq!(host_blocks[0].metadata().priority(), 1);

        Ok(())
    }

    #[tokio::test]
    async fn test_onboard_duplicate() -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools(4, Some(4), None, None)?;

        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();

        let device_block = completed_block(device_pool, [0; 4]).await?;

        let immutable_device_block = device_pool
            .register_blocks(vec![device_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

        populate_block(&immutable_device_block, 42)?;

        offload_manager.offload(&immutable_device_block, 0).await?;

        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        let host_blocks = host_pool
Ryan Olson's avatar
Ryan Olson committed
1499
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1500
1501
1502
1503
            .await?;
        assert_eq!(host_blocks.len(), 1);

        let onboarded_blocks = offload_manager
Ryan Olson's avatar
Ryan Olson committed
1504
1505
            .onboard(vec![host_blocks[0].clone()], None)
            .await??;
1506
1507
1508
1509
1510
1511
        assert_eq!(onboarded_blocks.len(), 1);
        check_block_contents(&host_blocks[0], &onboarded_blocks[0], 42)?;

        // This should be the same block that we put on the device.
        // The block that was copied should be discarded by the block pool.
        assert_eq!(
Ryan Olson's avatar
Ryan Olson committed
1512
1513
            onboarded_blocks[0].block_id(),
            immutable_device_block.block_id()
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
        );

        Ok(())
    }

    #[tokio::test]
    async fn test_transfer_big_blocks() -> Result<()> {
        // Try a block size of 32 MB.
        let inner_dim = 2_usize.pow(20) * 32 / NUM_LAYERS / BLOCK_SIZE;
        let (offload_manager, device_pool, host_pool, disk_pool) =
            build_pools(2, Some(2), Some(2), Some(inner_dim))?;

        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();
        let disk_pool = disk_pool.as_ref().unwrap();

        let device_block = completed_block(device_pool, [0; 4]).await?;

        populate_block(&device_block, 42)?;

        let immutable_device_block = device_pool
            .register_blocks(vec![device_block])
            .await?
            .into_iter()
            .next()
            .unwrap();

        // Offload to host.
        offload_manager.offload(&immutable_device_block, 0).await?;

        // Wait for the offload to be processed.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        let host_blocks = host_pool
Ryan Olson's avatar
Ryan Olson committed
1548
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
            .await?;
        assert_eq!(host_blocks.len(), 1);
        check_block_contents(&immutable_device_block, &host_blocks[0], 42)?;

        // Offload to disk
        offload_manager.offload(&host_blocks[0], 0).await?;

        // Wait for the offload to be processed.
        tokio::time::sleep(std::time::Duration::from_millis(500)).await;

        let disk_blocks = disk_pool
Ryan Olson's avatar
Ryan Olson committed
1560
            .match_sequence_hashes(vec![immutable_device_block.sequence_hash()].as_slice())
1561
1562
1563
1564
1565
            .await?;
        assert_eq!(disk_blocks.len(), 1);
        check_block_contents(&host_blocks[0], &disk_blocks[0], 42)?;

        // Onboard to device.
Ryan Olson's avatar
Ryan Olson committed
1566
        let device_blocks = offload_manager.onboard(disk_blocks.clone(), None).await??;
1567
1568
1569
1570
1571
        assert_eq!(device_blocks.len(), 1);
        check_block_contents(&disk_blocks[0], &device_blocks[0], 42)?;

        Ok(())
    }
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608

    #[tokio::test]
    async fn test_offload_evict_order() -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools(4, Some(4), None, None)?;

        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();

        let tokens = vec![0_u32; BLOCK_SIZE * 4];
        let token_blocks = TokenBlockSequence::new(Tokens::from(tokens), 4, None);
        assert_eq!(token_blocks.blocks().len(), 4);

        let mut mutable_blocks = Vec::new();
        let mut sequence_hashes = Vec::new();
        for token_block in token_blocks.blocks() {
            let mut mutable_block = device_pool
                .allocate_blocks(1)
                .await?
                .into_iter()
                .next()
                .unwrap();
            mutable_block.apply_token_block(token_block.clone())?;
            sequence_hashes.push(mutable_block.sequence_hash()?);
            mutable_blocks.push(mutable_block);
        }

        let immutable_blocks = device_pool.register_blocks(mutable_blocks).await?;

        for block in &immutable_blocks {
            offload_manager.offload(block, 0).await?;
        }
        // Wait for offloads.
        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        // Allocate 2 blocks on the host.
        let _host_blocks = host_pool.allocate_blocks(2).await?;

Ryan Olson's avatar
Ryan Olson committed
1609
1610
        // The first two blocks should've been evicted.
        // The last two blocks should still be on the host.
1611
1612
1613
1614
1615
        assert_eq!(
            host_pool
                .match_sequence_hashes(sequence_hashes.as_slice())
                .await?
                .len(),
Ryan Olson's avatar
Ryan Olson committed
1616
            0
1617
1618
1619
1620
        );

        assert_eq!(
            host_pool
Ryan Olson's avatar
Ryan Olson committed
1621
                .match_sequence_hashes(&sequence_hashes[2..])
1622
1623
                .await?
                .len(),
Ryan Olson's avatar
Ryan Olson committed
1624
            2
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
        );

        Ok(())
    }

    #[tokio::test]
    async fn test_onboard_evict_order() -> Result<()> {
        let (offload_manager, device_pool, host_pool, _) = build_pools(4, Some(4), None, None)?;

        let device_pool = device_pool.as_ref().unwrap();
        let host_pool = host_pool.as_ref().unwrap();

        let tokens = vec![0_u32; BLOCK_SIZE * 4];
        let token_blocks = TokenBlockSequence::new(Tokens::from(tokens), 4, None);
        assert_eq!(token_blocks.blocks().len(), 4);

        let mut mutable_blocks = Vec::new();
        let mut sequence_hashes = Vec::new();
        for token_block in token_blocks.blocks() {
            let mut block = host_pool
                .allocate_blocks(1)
                .await?
                .into_iter()
                .next()
                .unwrap();
            block.apply_token_block(token_block.clone())?;

            sequence_hashes.push(block.sequence_hash()?);
            mutable_blocks.push(block);
        }

        let immutable_blocks = host_pool.register_blocks(mutable_blocks).await?;

Ryan Olson's avatar
Ryan Olson committed
1658
        let _ = offload_manager.onboard(immutable_blocks, None).await?;
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685

        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        let _device_blocks = device_pool.allocate_blocks(2).await?;

        assert_eq!(
            device_pool
                .match_sequence_hashes(sequence_hashes.as_slice())
                .await?
                .len(),
            2
        );

        tokio::time::sleep(std::time::Duration::from_millis(100)).await;

        let _device_blocks2 = device_pool.allocate_blocks(1).await?;

        assert_eq!(
            device_pool
                .match_sequence_hashes(sequence_hashes.as_slice())
                .await?
                .len(),
            1
        );

        Ok(())
    }
1686
}