Files
FastDeploy/tests/cache_manager/v1/test_transfer_manager.py
T
kevin 7707be8384 [Feature][KVCache] Implement Cache Manager V1 with GPU + CPU Cache Support (1/n) (#7097)
* [Feature][KVCache] Support cache manager v1 architecture

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Update cache manager and related modules

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: update cache_manager and related modules

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: add node to evictable set in complete_swap_to_device

When a node transitions from SWAP_TO_DEVICE to DEVICE via
complete_swap_to_device, it was not being added to the
_evictable_device set. This caused nodes with ref_count=0 to
become "orphaned" - not appearing in any evictable set despite
having cache_status=DEVICE.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* feat: update cache manager v1 and related modules

- Add new cache_manager.py with cache management functionality
- Add radix_tree.py for prefix caching
- Update block_pool.py and metadata.py
- Update request.py and resource_manager_v1.py for scheduling
- Update gpu_model_runner.py for GPU model execution

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* feat(cache): add cache controller v1 implementation

- Add CacheController class for cache management
- Update config.py with cache related configurations
- Refactor gpu_model_runner.py for improved cache handling

* feat(cache_manager): update cache manager v1

* fix(cache_manager): 修复 swap_cache H2D/D2H 方向的 block_ids 逻辑并清理 ForwardMeta

## Motivation

修复 swap_cache_optimized.cu 中 H2D 方向时 src/dst block_ids 使用错误的问题,
并清理 ForwardMeta 中已废弃的 cache_controller 字段。

## Modifications

- fix: swap_cache_optimized.cu 中根据 D2H 模板参数正确选取 src/dst block_ids,
  修复 H2D 方向 src/dst 倒置 bug(同时修复 SwapCachePerLayerImpl 和 SwapCacheAllLayersBatchImpl)
- refactor: cache_manager/v1/__init__.py 将 LayerSwapTimeoutError 导入从
  cache_controller 改为 cache_utils(正确来源)
- refactor: ForwardMeta 移除废弃的 cache_controller 字段
- refactor: gpu_model_runner.py 移除对应的 cache_controller 赋值语句
- test: 新增 tests/cache_manager/v1/test_swap_cache_ops.py 单元测试

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat(cache_manager): refactor cache manager v1 and optimize swap ops

## Motivation

对 cache manager v1 进行重构和优化,精简代码结构,提升可维护性。

## Modifications

- 重构 transfer_manager.py,大幅精简代码逻辑
- 优化 swap_cache_optimized.cu GPU 算子实现
- 调整 cache_manager.py、cache_controller.py 逻辑,修复 free_device_blocks 方法缺失问题
- 更新 block_pool.py、cache_utils.py、metadata.py、radix_tree.py
- 精简 gpu_model_runner.py、forward_meta.py、attention.py 中相关调用
- 更新对应单元测试(test_cache_controller、test_swap_cache_ops、test_transfer_manager)
- 调整 config.py 中相关配置项

* [KVCache][MTP] 支持 cache_manager_v1 下的 MTP KV Cache 初始化及多模态 hash

## Motivation

在 enable_cache_manager_v1 路径下,MTP(speculative decode)的 KV Cache 需要由
CacheController 统一管理,以复用 swap/transfer 能力,同时修复多模态场景下 block
hash 未携带 multimodal extra_keys 的问题。

## Modifications

- `cache_controller.py`
  - 新增 `initialize_mtp_kv_cache`:通过 CacheController 初始化 MTP KV Cache,
    并将其注册到 cache_kvs_map,使 transfer_manager 自动覆盖 MTP 层
  - `initialize_host_cache` 中的 num_layers 改为包含 MTP 额外 cache 层数,保证
    Host Cache 也为 MTP 分配足够空间
  - `_free_gpu_cache` 改名为 `free_gpu_cache`(对外可调用)

- `cache_utils.py`
  - 新增 `get_block_hash_extra_keys`:提取单个 block 内的多模态 hash 信息,
    对齐 PrefixCacheManager 的 multimodal extra_keys 逻辑
  - `get_request_block_hasher` 中在 hash_block_tokens 时携带 extra_keys,
    修复多模态场景 prefix cache 命中率不准的问题

- `spec_decode/mtp.py`
  - `update_mtp_block_num` 新增 `skip_cache_init` 参数,避免 v1 cache manager
    路径下重复初始化 MTP KV Cache

- `gpu_model_runner.py`
  - `initialize_kv_cache(v1)` 路径:在主模型 cache 初始化后,调用
    `cache_controller.initialize_mtp_kv_cache` 完成 MTP cache 创建
  - `clear_cache` / `wakeup` / `reset` 等路径:respect `enable_cache_manager_v1`
    标志,跳过重复的 proposer.initialize_kv_cache 调用

## Usage or Command

```bash
# 启动支持 MTP + cache_manager_v1 的推理服务(示例)
bash run.sh
```

* fix(cache_manager): multi-GPU fix, mm hash boundary fix, and remove batch ops

1. Fix CuPy stream/event creation for multi-GPU: wrap all stream operations
   with cp.cuda.Device(device_id) context to ensure streams/events are bound
   to the correct device, preventing cross-device errors in multi-GPU setups.

2. Remove cudaSetDevice from SwapCacheAllLayers (handled by cupy context now).

3. Remove swap_cache_all_layers_batch op: simplified the implementation by
   removing the batch upload variant; all-layer transfers now use the standard
   swap_cache_all_layers with cupy device context.

4. Fix mm hash boundary comparison in get_block_hash_extra_keys: change
   strict less-than (<) to less-than-or-equal (<=) so that multimodal items
   ending exactly at block start are correctly excluded.

5. Extract config fields to KVCacheBase: model_config, cache_config,
   quant_config, parallel_config are now set in the base class __init__ to
   avoid duplication in CacheController and CacheManager subclasses.

6. Translate metadata.py docstrings from Chinese to English for broader
   contributor accessibility.

7. Add test_cache_utils.py: comprehensive unit tests for
   get_block_hash_extra_keys covering all boundary and overlap scenarios.

8. Expand test suite: test_request.py cache fields tests, test_radix_tree.py
   backup candidate tests, test_transfer_manager.py and test_cache_manager.py
   multi-GPU and concurrent operation tests.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] fix List import and move write_policy normalization to CacheManager

## Motivation

修复两处问题:
1. `fastdeploy/engine/request.py` 中 `List` 未导入导致 pre-commit F821 报错
2. `write_policy` 归一化逻辑(`write_through` → `write_through_selective`)不应放在 `FDConfig`,移至 `CacheManager.__init__` 中,使其只影响 Cache Manager V1 的内部逻辑

## Modifications

- `fastdeploy/engine/request.py`: 在 `typing` 导入中补充 `List`,删除重复的 `CacheSwapMetadata` TYPE_CHECKING 导入,修复 F821/F811
- `fastdeploy/config.py`: 删除 `write_policy` 归一化逻辑
- `fastdeploy/cache_manager/v1/cache_manager.py`: 将归一化逻辑移入 `CacheManager.__init__`

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] fix pre-commit code style issues

## Motivation

修复 CI pre-commit 代码风格检查失败问题。

## Modifications

- `fastdeploy/engine/common_engine.py`: black 格式化
- `fastdeploy/worker/worker_process.py`: black 格式化 + isort 修复
- `fastdeploy/cache_manager/v1/storage/__init__.py`: isort 修复
- `fastdeploy/worker/gpu_worker.py`: isort 修复

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [Feature][KVCache] update cache_manager_v1 modules

## Motivation

更新 Cache Manager V1 相关模块,完善版权信息、改进模块结构与可维护性。

## Modifications

- `fastdeploy/cache_manager/v1/` 系列模块:补充版权 header,优化代码结构
- `fastdeploy/config.py`:配置项更新
- `fastdeploy/engine/sched/resource_manager_v1.py`:调度相关更新

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [Feature][KVCache] add BatchRequest.from_tasks and refactor worker task parsing

## Motivation

将 worker_process 中重复的 task 解析逻辑收敛到 BatchRequest,减少代码冗余,提升可维护性。

## Modifications

- `fastdeploy/engine/request.py`:新增 `BatchRequest.from_tasks()` 类方法,统一将 task_queue 任务分类为推理请求和控制请求
- `fastdeploy/worker/worker_process.py`:使用 `BatchRequest.from_tasks()` 替代内联解析逻辑,并修复重复的 control_reqs 处理块

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [Feature][KVCache] add NUMA affinity for host cache and skip swap cache tests

## Motivation

优化 Host cache 内存分配的 NUMA 亲和性,减少跨 NUMA 访问延迟;
同时跳过 swap cache ops 测试(当前环境不支持)。

## Modifications

- `fastdeploy/cache_manager/v1/cache_controller.py`:
  - 新增 `_get_numa_node_for_gpu()` 方法,通过 nvidia-smi 或 sysfs 获取 GPU 对应的 NUMA 节点
  - 新增 `_bind_to_closest_numa_node()` 方法,绑定当前线程到 GPU 最近的 NUMA 节点
  - 在 `initialize_host_cache()` 中调用 NUMA 绑定,优化 H2D 传输性能
- `tests/cache_manager/v1/test_swap_cache_ops.py`:跳过所有测试类(`TestSwapCacheAllLayersCorrectness`、`TestSwapCacheAllLayersPerformance`、`TestSwapCacheRandomBlockIndices`)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] fix unittest failures for cache_manager_v1

三个单测因接口变更或 Mock 方式问题导致失败,需修复。

- tests/distributed/chunked_moe.py:`setup_model_runner` 使用 `__new__` 跳过 `__init__`,补加 `enable_cache_manager_v1 = False`,修复 `AttributeError`
- tests/engine/test_resource_manager.py:`PrefixCacheManager` 为局部导入,`patch` 路径改为定义位置 `fastdeploy.cache_manager.prefix_cache_manager.PrefixCacheManager`
- tests/v1/test_resource_manager_v1.py:`_trigger_preempt` 第四参数已由 `list` 改为 `BatchRequest`,更新测试传参和断言

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] remove debug logging code

## Modifications

- fastdeploy/engine/request.py:删除调试用 logger 及 prompt_hashes 中的 debug 日志
- fastdeploy/worker/worker_process.py:删除 __main__ 中的调试 import 和 print 语句

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] fix cupy device id caching and pickle for _match_result

## Motivation

修复两个 bug:
1. `transfer_manager.py` 中每次调用 `cp.cuda.runtime.getDevice()` 存在隐患,应在初始化时缓存为实例变量,保证后续操作使用一致的设备 ID。
2. `request.py` 的 `__getstate__` 未跳过 `_match_result`,该字段包含 BlockNode 树的父子循环引用,pickle 时会触发 `RecursionError`;同时补充 `__setstate__` 确保 unpickle 后字段恢复为安全默认值。

## Modifications

- `transfer_manager.py`:初始化时调用 `cp.cuda.runtime.getDevice()` 并缓存到 `self._cupy_device_id`,后续 `with cp.cuda.Device(...)` 和日志均使用该缓存值。
- `request.py`:
  - `__getstate__` 中将 `_match_result` 加入跳过集合 `_SKIP_KEYS`,避免循环引用导致 pickle 失败。
  - 新增 `__setstate__`,unpickle 后将 `_block_hasher` 和 `_match_result` 恢复为 `None`。

## Usage or Command

* fix(test): fix unit test errors for _trigger_preempt and wakeup with MTP

- Use BatchRequest instead of list in test_trigger_preempt_records_tasks
- Add missing enable_cache_manager_v1 attr in TestSleepWakeupBehavior._make_runner

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] fix gpu_free_block_list returning wrong block IDs

## Motivation

`gpu_free_block_list` 的兼容 property 中误用了 `list(range(N))`,
将 `available_blocks()` 的返回值当作整数传给 `range()`,
导致返回 `[0, 1, ..., N-1]` 的假列表,而非真实的空闲 block ID。

## Modifications

- `cache_manager/v1/cache_manager.py`:将 `list(range(self._device_pool.available_blocks()))` 改为 `list(self._device_pool.available_blocks())`

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] 修复 gpu_free_block_list 返回 int 导致 TypeError

## Motivation

gpu_free_block_list 属性中调用 BlockPool.available_blocks(),
该方法返回 int(空闲块数量),用 list() 包装 int 会触发
TypeError: 'int' object is not iterable。

## Modifications

将 list(self._device_pool.available_blocks()) 改为
list(self._device_pool._free_blocks),直接返回空闲块索引列表。

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [KVCache][CacheManager] 适配 V1 CacheManager 的 pause/sleep/free_cache 操作

## Motivation

V1 CacheManager 引入了新的 reset_cache() 接口,pause 和 sleep 操作需要适配,
同时 free_cache 需要支持可选的 clear_storage 参数。

## Modifications

- cache_controller.py: free_cache 新增 clear_storage 参数(默认 False),
  仅当 clear_storage=True 时才调用 _clear_storage(),避免不必要的 storage 清空
- common_engine.py: pause 和 sleep 操作中,当 ENABLE_V1_KVCACHE_MANAGER 时
  使用 cache_manager.reset_cache() 替代旧的 reset() 和 pause_transfer 逻辑
- gpu_model_runner.py: sleep 时仅在非 V1 cache manager 下执行 MTP cache 清除

## Usage or Command

# 启动服务(V1 CacheManager)
python -m fastdeploy.entrypoints.openai.api_server \
  --enable-v1-kvcache-manager \
  ...

* [BugFix][KVCache] fix missing enable_cache_manager_v1 in test mocks and remove unused select_blocks_for_backup

- Remove unused `select_blocks_for_backup` method from radix_tree.py
- Fix `match_prefix` default param `skip_storage=True` and log order in cache_manager.py
- Sync test_gpu_model_runner.py with upstream/develop (add TestInsertTasksV1SplitwiseSuffix)
- Add `enable_cache_manager_v1=False` to all mock runners to fix AttributeError in CI

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [BugFix][KVCache] simplify _free_blocks in ResourceManagerV1 for non-v1 path

Remove redundant prefix_caching branch in else path; always call
recycle_gpu_blocks with full block_tables for non-cache-manager-v1 case.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* [KVCache][Optimization][BugFix] fix and optimize block_pool, cache_manager, transfer_manager, request

## Motivation

修复 cache_manager v1 中若干代码质量问题,提升性能并消除潜在的类型不一致 Bug。

## Modifications

1. **block_pool.py**:`BlockPool.allocate` 将逐个 pop 循环替换为切片 + 批量 set.update,消除 Python 循环开销,O(n) → O(k)(C 层批量操作)
2. **cache_manager.py**:`match_prefix` 在 prefix caching 关闭时提前 return 前写入空 `MatchResult()`,避免调用方解引用 `_match_result=None` 崩溃
3. **transfer_manager.py**:`_build_device_layer_indices` 在 `_cache_kvs_map` 为空时也重置四个层索引列表,防止残留旧 tensor 被 swap 算子使用
4. **request.py**:`BatchRequest.append_swap_metadata` / `append_evict_metadata` 构造 `CacheSwapMetadata` 时将 `src_type`/`dst_type` 从字符串改为 `CacheLevel` 枚举,与字段类型声明一致;补充 `CacheLevel` 导入;`match_result` 属性返回类型标注修正为 `Optional[MatchResult]`
5. **resource_manager_v1.py**:`_allocate_gpu_blocks` 日志从 `INFO` 降级为 `DEBUG`,消除高频调度路径的日志噪音
6. **tests/engine/test_request.py**:同步更新 `src_type`/`dst_type` 断言为 `CacheLevel` 枚举值,补充 `CacheLevel` 导入

## Usage or Command

单元测试:
```bash
source .venv/py310/bin/activate
cd baidu/FastDeploy
python -m pytest tests/cache_manager/v1/test_cache_manager.py -v
python -m pytest tests/cache_manager/v1/test_transfer_manager.py -v
python -m pytest tests/engine/test_request.py -v
```

* [BugFix][KVCache] Fix BlockPool.allocate returns all blocks when num_blocks=0

## Motivation

当 `allocate(num_blocks=0)` 被调用时,Python 负索引陷阱导致严重错误:
`-0 == 0`,所以 `self._free_blocks[-0:]` 等价于 `self._free_blocks[0:]`,
会返回并清空整个空闲块列表,而非返回空列表。

## Modifications

在 `BlockPool.allocate` 中增加对 `num_blocks == 0` 的提前判断,直接返回 `[]`,
避免触发 Python 负索引陷阱。

## Usage or Command

```bash
# 运行相关单元测试验证修复
python -m pytest tests/cache_manager/v1/test_cache_manager.py -vv -s
```

* [KVCache][Test] add unit tests for cache_manager v1 modules

## Motivation

补全 cache_manager/v1 各模块的单测覆盖,确保核心方法有完整的测试保障。

## Modifications

新增/补充以下测试文件,全部 326 个用例通过:

- tests/cache_manager/v1/test_block_pool.py(新建)
  覆盖 BlockPool.get_metadata/set_metadata/resize、DeviceBlockPool/HostBlockPool
- tests/cache_manager/v1/test_metadata.py(新建)
  覆盖 BlockNode、RadixTreeStats、MatchResult、CacheSwapMetadata、AsyncTaskHandler
- tests/cache_manager/v1/test_cache_utils.py(补充)
  新增 hash_block_tokens、get_request_block_hasher、LayerDoneCounter 时间追踪及内部辅助方法
- tests/cache_manager/v1/test_radix_tree.py(补充)
  新增 TestCompleteSwapToDevice 专项测试类(6 个用例)
- tests/cache_manager/v1/test_cache_manager.py(补充)
  新增 offload_to_host、load_from_host、pending backup 系列、prepare_prefetch_metadata
- tests/cache_manager/v1/test_transfer_manager.py(补充)
  新增 _swap_single_layer 校验路径、sync_input/output_stream、record_input_stream_event

## Usage or Command

```bash
# 运行所有新增单测
source .venv/py310/bin/activate
python -m pytest tests/cache_manager/v1/test_block_pool.py \
  tests/cache_manager/v1/test_metadata.py \
  tests/cache_manager/v1/test_cache_utils.py \
  tests/cache_manager/v1/test_radix_tree.py \
  tests/cache_manager/v1/test_cache_manager.py \
  tests/cache_manager/v1/test_transfer_manager.py -v
# 期望结果:326 passed
```

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Jiang-Jia-Jun <163579578+Jiang-Jia-Jun@users.noreply.github.com>
2026-04-21 14:39:00 +08:00

785 lines
31 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""
# Copyright (c) 2025 PaddlePaddle Authors. All Rights Reserved.
#
# 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.
Unit tests for CacheTransferManager class.
Tests cover:
- Device cache map sharing (set_device_cache_kvs_map)
- Host cache map sharing (set_host_cache_kvs_map)
- Layer indices building (_build_device_layer_indices, _build_host_layer_indices)
- Metadata properties (num_layers, local_rank, device_id, etc.)
- Layer indexed access methods
- Host<->Device swap methods (evict/load)
- Parameter validation
"""
import unittest
from unittest.mock import Mock, patch
import paddle
from utils import get_default_test_fd_config
def create_transfer_manager(
enable_prefix_caching: bool = True,
num_host_blocks: int = 50,
):
"""Helper to create CacheTransferManager with test config."""
from fastdeploy.cache_manager.v1.transfer_manager import CacheTransferManager
config = get_default_test_fd_config()
config.cache_config.enable_prefix_caching = enable_prefix_caching
config.cache_config.num_cpu_blocks = num_host_blocks
config.cache_config.cache_dtype = "bfloat16"
return CacheTransferManager(config)
def create_mock_device_cache_kvs_map(
num_layers: int = 4,
local_rank: int = 0,
device_id: int = 0,
include_scales: bool = False,
dtype: str = "bfloat16",
num_blocks: int = 100,
num_heads: int = 32,
block_size: int = 64,
head_dim: int = 128,
):
"""
Helper to create mock device cache_kvs_map.
Device cache stores paddle.Tensor objects on GPU.
"""
cache_kvs_map = {}
for layer_idx in range(num_layers):
key_name = f"key_caches_{layer_idx}_rank{local_rank}.device{device_id}"
val_name = f"value_caches_{layer_idx}_rank{local_rank}.device{device_id}"
# Create real tensors on GPU
key_tensor = paddle.zeros([num_blocks, num_heads, block_size, head_dim], dtype=dtype)
val_tensor = paddle.zeros([num_blocks, num_heads, block_size, head_dim], dtype=dtype)
cache_kvs_map[key_name] = key_tensor
cache_kvs_map[val_name] = val_tensor
if include_scales:
key_scale_name = f"key_cache_scales_{layer_idx}_rank{local_rank}.device{device_id}"
val_scale_name = f"value_cache_scales_{layer_idx}_rank{local_rank}.device{device_id}"
key_scale_tensor = paddle.ones([num_blocks, num_heads, block_size], dtype="float32")
val_scale_tensor = paddle.ones([num_blocks, num_heads, block_size], dtype="float32")
cache_kvs_map[key_scale_name] = key_scale_tensor
cache_kvs_map[val_scale_name] = val_scale_tensor
return cache_kvs_map
def create_mock_host_cache_kvs_map(
num_layers: int = 4,
local_rank: int = 0,
device_id: int = 0,
include_scales: bool = False,
base_ptr: int = 1000000,
):
"""
Helper to create mock host cache_kvs_map (with int pointers).
Host cache stores pinned memory pointers (int) on CPU.
"""
cache_kvs_map = {}
for layer_idx in range(num_layers):
key_name = f"key_caches_{layer_idx}_rank{local_rank}.device{device_id}"
val_name = f"value_caches_{layer_idx}_rank{local_rank}.device{device_id}"
# Use int pointers (simulating cuda_host_alloc result)
cache_kvs_map[key_name] = base_ptr + layer_idx * 10000
cache_kvs_map[val_name] = base_ptr + layer_idx * 10000 + 5000
if include_scales:
key_scale_name = f"key_cache_scales_{layer_idx}_rank{local_rank}.device{device_id}"
val_scale_name = f"value_cache_scales_{layer_idx}_rank{local_rank}.device{device_id}"
cache_kvs_map[key_scale_name] = base_ptr + layer_idx * 10000 + 20000
cache_kvs_map[val_scale_name] = base_ptr + layer_idx * 10000 + 25000
return cache_kvs_map
# ============================================================================
# Initialization Tests
# ============================================================================
class TestCacheTransferManagerInit(unittest.TestCase):
"""Test CacheTransferManager initialization."""
def test_init_basic(self):
"""Test basic initialization."""
manager = create_transfer_manager()
self.assertIsNotNone(manager)
# Device cache storage
self.assertEqual(manager._cache_kvs_map, {})
self.assertEqual(manager._device_key_caches, [])
self.assertEqual(manager._device_value_caches, [])
# Host cache storage
self.assertEqual(manager._host_cache_kvs_map, {})
self.assertEqual(manager._host_key_ptrs, [])
self.assertEqual(manager._host_value_ptrs, [])
def test_init_metadata_defaults(self):
"""Test default metadata values from config."""
manager = create_transfer_manager()
# These values are read from config, not defaults
self.assertEqual(manager._local_rank, 0)
self.assertEqual(manager._device_id, 0)
self.assertEqual(manager._cache_dtype, "bfloat16")
self.assertEqual(manager._num_host_blocks, 50) # from create_transfer_manager
# num_layers comes from config, check it's set
self.assertGreater(manager._num_layers, 0)
# ============================================================================
# Device Cache Map Sharing Tests
# ============================================================================
class TestSetDeviceCacheKvsMap(unittest.TestCase):
"""Test set_cache_kvs_map for device cache."""
def test_set_device_cache_kvs_map_basic(self):
"""Test setting device cache_kvs_map."""
manager = create_transfer_manager()
num_layers = manager._num_layers # Use actual num_layers from config
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers)
manager.set_cache_kvs_map(device_cache)
self.assertEqual(manager._cache_kvs_map, device_cache)
def test_set_device_cache_kvs_map_builds_layer_indices(self):
"""Test that device layer indices are built correctly."""
manager = create_transfer_manager()
num_layers = manager._num_layers # Use actual num_layers from config
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers)
manager.set_cache_kvs_map(device_cache)
self.assertEqual(len(manager._device_key_caches), num_layers)
self.assertEqual(len(manager._device_value_caches), num_layers)
# Verify each layer has correct tensor (compare by identity)
for i in range(num_layers):
key_name = f"key_caches_{i}_rank0.device0"
val_name = f"value_caches_{i}_rank0.device0"
self.assertIs(manager._device_key_caches[i], device_cache[key_name])
self.assertIs(manager._device_value_caches[i], device_cache[val_name])
def test_set_device_cache_kvs_map_with_scales(self):
"""Test setting device cache_kvs_map with fp8 scales."""
from fastdeploy.cache_manager.v1.transfer_manager import CacheTransferManager
config = get_default_test_fd_config()
# Enable fp8 quantization to store scales
config.quant_config = Mock()
config.quant_config.kv_cache_quant_type = "block_wise_fp8"
config.cache_config.num_cpu_blocks = 50
config.cache_config.cache_dtype = "bfloat16"
manager = CacheTransferManager(config)
num_layers = manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers, include_scales=True)
manager.set_cache_kvs_map(device_cache)
# Scales should be stored when fp8 quantization is enabled
self.assertEqual(len(manager._device_key_scales), num_layers)
self.assertEqual(len(manager._device_value_scales), num_layers)
def test_set_device_cache_kvs_map_empty(self):
"""Test setting empty cache_kvs_map."""
manager = create_transfer_manager()
num_layers = manager._num_layers # num_layers is still from config
manager.set_cache_kvs_map({})
# num_layers stays the same (from config)
self.assertEqual(manager._num_layers, num_layers)
# layer indices should be empty since no cache provided
self.assertEqual(len(manager._device_key_caches), 0)
def test_set_device_cache_kvs_map_different_rank_device(self):
"""Test setting cache_kvs_map with different rank and device names."""
manager = create_transfer_manager()
num_layers = manager._num_layers
# Create cache with different rank/device names - should not match
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers, local_rank=2, device_id=3)
manager.set_cache_kvs_map(device_cache)
# The layer indices should have None values since names don't match
# (local_rank=0, device_id=0 in manager, but cache has rank=2, device=3)
self.assertTrue(all(c is None for c in manager._device_key_caches))
# ============================================================================
# Host Cache Map Sharing Tests
# ============================================================================
class TestSetHostCacheKvsMap(unittest.TestCase):
"""Test set_host_cache_kvs_map for host cache."""
def test_set_host_cache_kvs_map_basic(self):
"""Test setting host cache_kvs_map."""
manager = create_transfer_manager()
num_layers = manager._num_layers
# First set device cache to initialize layer indices
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers)
manager.set_cache_kvs_map(device_cache)
host_cache = create_mock_host_cache_kvs_map(num_layers=num_layers)
manager.set_host_cache_kvs_map(host_cache)
self.assertEqual(manager._host_cache_kvs_map, host_cache)
def test_set_host_cache_kvs_map_builds_layer_indices(self):
"""Test that host layer indices are built correctly."""
manager = create_transfer_manager()
num_layers = manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers)
manager.set_cache_kvs_map(device_cache)
host_cache = create_mock_host_cache_kvs_map(num_layers=num_layers)
manager.set_host_cache_kvs_map(host_cache)
self.assertEqual(len(manager._host_key_ptrs), num_layers)
self.assertEqual(len(manager._host_value_ptrs), num_layers)
# Verify pointers are integers
for i in range(num_layers):
self.assertIsInstance(manager._host_key_ptrs[i], int)
self.assertIsInstance(manager._host_value_ptrs[i], int)
self.assertGreater(manager._host_key_ptrs[i], 0)
self.assertGreater(manager._host_value_ptrs[i], 0)
def test_set_host_cache_kvs_map_with_scales(self):
"""Test setting host cache_kvs_map with fp8 scales."""
from fastdeploy.cache_manager.v1.transfer_manager import CacheTransferManager
config = get_default_test_fd_config()
# Enable fp8 quantization to store scales
config.quant_config = Mock()
config.quant_config.kv_cache_quant_type = "block_wise_fp8"
config.cache_config.num_cpu_blocks = 50
config.cache_config.cache_dtype = "bfloat16"
manager = CacheTransferManager(config)
num_layers = manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers, include_scales=True)
manager.set_cache_kvs_map(device_cache)
host_cache = create_mock_host_cache_kvs_map(num_layers=num_layers, include_scales=True)
manager.set_host_cache_kvs_map(host_cache)
# Scales should be stored when fp8 quantization is enabled
self.assertEqual(len(manager._host_key_scales_ptrs), num_layers)
self.assertEqual(len(manager._host_value_scales_ptrs), num_layers)
# ============================================================================
# Metadata Properties Tests
# ============================================================================
class TestMetadataProperties(unittest.TestCase):
"""Test metadata properties."""
def setUp(self):
"""Set up test fixtures."""
self.manager = create_transfer_manager()
self.num_layers = self.manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_cache_kvs_map(device_cache)
def test_num_layers_property(self):
"""Test num_layers property."""
self.assertEqual(self.manager.num_layers, self.num_layers)
def test_local_rank_property(self):
"""Test local_rank property."""
self.assertEqual(self.manager.local_rank, 0)
def test_device_id_property(self):
"""Test device_id property."""
self.assertEqual(self.manager.device_id, 0)
def test_cache_dtype_property(self):
"""Test cache_dtype property."""
self.assertEqual(self.manager.cache_dtype, "bfloat16")
def test_has_cache_scale_property_false(self):
"""Test has_cache_scale property when no scales."""
self.assertFalse(self.manager.has_cache_scale)
def test_has_cache_scale_property_true(self):
"""Test has_cache_scale property with fp8 quantization config."""
from fastdeploy.cache_manager.v1.transfer_manager import CacheTransferManager
config = get_default_test_fd_config()
# Mock quant_config to have kv_cache_quant_type
config.quant_config = Mock()
config.quant_config.kv_cache_quant_type = "block_wise_fp8"
manager = CacheTransferManager(config)
self.assertTrue(manager.has_cache_scale)
def test_num_host_blocks_property(self):
"""Test num_host_blocks property."""
# num_host_blocks is set from config (50 in create_transfer_manager)
self.assertEqual(self.manager.num_host_blocks, 50)
# ============================================================================
# Layer Indexed Access Tests
# ============================================================================
class TestLayerIndexedAccess(unittest.TestCase):
"""Test layer-indexed access methods."""
def setUp(self):
"""Set up test fixtures."""
self.manager = create_transfer_manager()
self.num_layers = self.manager._num_layers
self.device_cache = create_mock_device_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_cache_kvs_map(self.device_cache)
self.host_cache = create_mock_host_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_host_cache_kvs_map(self.host_cache)
# --- Device cache access ---
def test_get_device_key_cache_valid(self):
"""Test get_device_key_cache with valid index."""
for i in range(self.num_layers):
cache = self.manager.get_device_key_cache(i)
self.assertIsNotNone(cache)
key_name = f"key_caches_{i}_rank0.device0"
self.assertIs(cache, self.device_cache[key_name])
def test_get_device_key_cache_invalid(self):
"""Test get_device_key_cache with invalid index."""
self.assertIsNone(self.manager.get_device_key_cache(-1))
self.assertIsNone(self.manager.get_device_key_cache(100))
def test_get_device_value_cache_valid(self):
"""Test get_device_value_cache with valid index."""
for i in range(self.num_layers):
cache = self.manager.get_device_value_cache(i)
self.assertIsNotNone(cache)
# --- Host cache access ---
def test_get_host_key_ptr_valid(self):
"""Test get_host_key_ptr with valid index."""
for i in range(self.num_layers):
ptr = self.manager.get_host_key_ptr(i)
self.assertIsInstance(ptr, int)
self.assertGreater(ptr, 0)
def test_get_host_key_ptr_invalid(self):
"""Test get_host_key_ptr with invalid index."""
self.assertEqual(self.manager.get_host_key_ptr(-1), 0)
self.assertEqual(self.manager.get_host_key_ptr(100), 0)
def test_get_host_value_ptr_valid(self):
"""Test get_host_value_ptr with valid index."""
for i in range(self.num_layers):
ptr = self.manager.get_host_value_ptr(i)
self.assertIsInstance(ptr, int)
# ============================================================================
# Swap Parameter Validation Tests
# ============================================================================
class TestValidateSwapParams(unittest.TestCase):
"""Test _swap_all_layers behavior with various parameter conditions."""
def setUp(self):
"""Set up test fixtures."""
self.manager = create_transfer_manager()
self.num_layers = self.manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_cache_kvs_map(device_cache)
host_cache = create_mock_host_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_host_cache_kvs_map(host_cache)
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_returns_false_when_no_host_blocks(self, mock_swap):
"""Test _swap_all_layers returns False when num_host_blocks is 0."""
manager = create_transfer_manager(num_host_blocks=0)
device_cache = create_mock_device_cache_kvs_map(num_layers=manager._num_layers)
manager.set_cache_kvs_map(device_cache)
result = manager._swap_all_layers([0, 1], [10, 11], mode=0)
self.assertFalse(result)
mock_swap.assert_not_called()
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_with_valid_params_calls_operator(self, mock_swap):
"""Test _swap_all_layers calls operator with valid params."""
mock_swap.return_value = None
result = self.manager._swap_all_layers([0, 1, 2], [10, 11, 12], mode=0)
self.assertTrue(result)
self.assertGreaterEqual(mock_swap.call_count, 2) # key + value
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_with_empty_block_ids(self, mock_swap):
"""Test _swap_all_layers with empty block id lists."""
mock_swap.return_value = None
result = self.manager._swap_all_layers([], [], mode=0)
self.assertTrue(result)
# Operator is still called (empty lists are passed through)
self.assertEqual(mock_swap.call_count, 2) # key + value
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_no_device_caches_skipped(self, mock_swap):
"""Test _swap_all_layers returns False when device caches not initialized."""
manager = create_transfer_manager()
# Do NOT set device cache
result = manager._swap_all_layers([0, 1], [10, 11], mode=0)
# With no device caches loaded, num_host_blocks check passes but caches are empty
# The operator receives empty lists for key/value caches
# Actual behavior: returns True since num_host_blocks > 0
# (operator is called with empty layer lists)
self.assertIsInstance(result, bool)
# ============================================================================
# Swap All Layers Tests
# ============================================================================
class TestSwapAllLayers(unittest.TestCase):
"""Test _swap_all_layers and related methods."""
def setUp(self):
"""Set up test fixtures."""
self.manager = create_transfer_manager()
self.num_layers = self.manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_cache_kvs_map(device_cache)
host_cache = create_mock_host_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_host_cache_kvs_map(host_cache)
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_all_layers_evict_device_to_host(self, mock_swap):
"""Test _swap_all_layers in evict mode (Device->Host)."""
mock_swap.return_value = None
result = self.manager._swap_all_layers(
device_block_ids=[0, 1, 2],
host_block_ids=[10, 11, 12],
mode=0, # Device->Host
)
self.assertTrue(result)
# Should be called for key and value caches
self.assertGreaterEqual(mock_swap.call_count, 2)
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_all_layers_load_host_to_device(self, mock_swap):
"""Test _swap_all_layers in load mode (Host->Device)."""
mock_swap.return_value = None
result = self.manager._swap_all_layers(
device_block_ids=[0, 1, 2],
host_block_ids=[10, 11, 12],
mode=1, # Host->Device
)
self.assertTrue(result)
self.assertGreaterEqual(mock_swap.call_count, 2)
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_all_layers_with_fp8_scales(self, mock_swap):
"""Test _swap_all_layers with fp8 scales."""
from fastdeploy.cache_manager.v1.transfer_manager import CacheTransferManager
config = get_default_test_fd_config()
# Mock quant_config to have kv_cache_quant_type for fp8
config.quant_config = Mock()
config.quant_config.kv_cache_quant_type = "block_wise_fp8"
config.cache_config.num_cpu_blocks = 50
manager = CacheTransferManager(config)
num_layers = manager._num_layers
device_cache = create_mock_device_cache_kvs_map(num_layers=num_layers, include_scales=True)
manager.set_cache_kvs_map(device_cache)
host_cache = create_mock_host_cache_kvs_map(num_layers=num_layers, include_scales=True)
manager.set_host_cache_kvs_map(host_cache)
mock_swap.return_value = None
result = manager._swap_all_layers(
device_block_ids=[0, 1],
host_block_ids=[10, 11],
mode=0,
)
self.assertTrue(result)
# 2 for key/value + 2 for scales = 4 calls
self.assertEqual(mock_swap.call_count, 4)
@patch("fastdeploy.cache_manager.v1.transfer_manager.swap_cache_all_layers")
def test_swap_all_layers_invalid_params(self, mock_swap):
"""Test _swap_all_layers with empty params."""
mock_swap.return_value = None
result = self.manager._swap_all_layers(
device_block_ids=[],
host_block_ids=[],
mode=0,
)
# Empty lists should still call the operator and return True
self.assertTrue(result)
self.assertEqual(mock_swap.call_count, 2) # key + value
# ============================================================================
# Cache Map Getters Tests
# ============================================================================
class TestCacheKvsMapGetters(unittest.TestCase):
"""Test cache_kvs_map and host_cache_kvs_map getter properties."""
def setUp(self):
"""Set up test fixtures."""
self.manager = create_transfer_manager()
self.num_layers = self.manager._num_layers
self.device_cache = create_mock_device_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_cache_kvs_map(self.device_cache)
self.host_cache = create_mock_host_cache_kvs_map(num_layers=self.num_layers)
self.manager.set_host_cache_kvs_map(self.host_cache)
def test_device_cache_kvs_map_property(self):
"""Test device cache_kvs_map property returns the set map."""
self.assertEqual(self.manager.cache_kvs_map, self.device_cache)
def test_host_cache_kvs_map_property(self):
"""Test host cache_kvs_map property returns the set map."""
self.assertEqual(self.manager.host_cache_kvs_map, self.host_cache)
def test_device_key_cache_per_layer_accessible(self):
"""Test get_device_key_cache returns correct tensor for each layer."""
for i in range(self.num_layers):
cache = self.manager.get_device_key_cache(i)
expected_name = f"key_caches_{i}_rank0.device0"
self.assertIs(cache, self.device_cache[expected_name])
def test_device_value_cache_per_layer_accessible(self):
"""Test get_device_value_cache returns correct tensor for each layer."""
for i in range(self.num_layers):
cache = self.manager.get_device_value_cache(i)
expected_name = f"value_caches_{i}_rank0.device0"
self.assertIs(cache, self.device_cache[expected_name])
def test_host_key_ptr_per_layer_accessible(self):
"""Test get_host_key_ptr returns correct pointer for each layer."""
for i in range(self.num_layers):
ptr = self.manager.get_host_key_ptr(i)
expected_name = f"key_caches_{i}_rank0.device0"
self.assertEqual(ptr, self.host_cache[expected_name])
def test_host_value_ptr_per_layer_accessible(self):
"""Test get_host_value_ptr returns correct pointer for each layer."""
for i in range(self.num_layers):
ptr = self.manager.get_host_value_ptr(i)
expected_name = f"value_caches_{i}_rank0.device0"
self.assertEqual(ptr, self.host_cache[expected_name])
def test_get_stats_includes_expected_keys(self):
"""Test get_stats returns dict with all expected keys."""
stats = self.manager.get_stats()
self.assertIn("num_layers", stats)
self.assertIn("local_rank", stats)
self.assertIn("device_id", stats)
self.assertIn("cache_dtype", stats)
self.assertIn("num_host_blocks", stats)
self.assertIn("has_device_cache", stats)
self.assertIn("has_host_cache", stats)
self.assertIn("is_fp8", stats)
self.assertTrue(stats["has_device_cache"])
self.assertTrue(stats["has_host_cache"])
# ---------------------------------------------------------------------------
# _swap_single_layer validation paths (no real GPU transfer needed)
# ---------------------------------------------------------------------------
class TestSwapSingleLayer(unittest.TestCase):
"""Tests for CacheTransferManager._swap_single_layer validation paths."""
def setUp(self):
self.tm = create_transfer_manager(enable_prefix_caching=True, num_host_blocks=0)
def test_returns_false_when_no_host_blocks(self):
"""_swap_single_layer returns False when _num_host_blocks <= 0."""
self.assertEqual(self.tm._num_host_blocks, 0)
result = self.tm._swap_single_layer(
layer_idx=0,
device_block_ids=[0, 1],
host_block_ids=[10, 11],
mode=0,
)
self.assertFalse(result)
def test_returns_false_when_empty_device_ids(self):
"""_swap_single_layer returns False when device_block_ids is empty."""
tm = create_transfer_manager(num_host_blocks=50)
result = tm._swap_single_layer(
layer_idx=0,
device_block_ids=[],
host_block_ids=[10],
mode=0,
)
self.assertFalse(result)
def test_returns_false_when_empty_host_ids(self):
"""_swap_single_layer returns False when host_block_ids is empty."""
tm = create_transfer_manager(num_host_blocks=50)
result = tm._swap_single_layer(
layer_idx=0,
device_block_ids=[0],
host_block_ids=[],
mode=0,
)
self.assertFalse(result)
def test_returns_false_when_length_mismatch(self):
"""_swap_single_layer returns False when lists have different lengths."""
tm = create_transfer_manager(num_host_blocks=50)
result = tm._swap_single_layer(
layer_idx=0,
device_block_ids=[0, 1],
host_block_ids=[10],
mode=0,
)
self.assertFalse(result)
def test_returns_false_when_no_device_cache(self):
"""_swap_single_layer returns False when device cache map not set."""
tm = create_transfer_manager(num_host_blocks=50)
# No cache map set → get_device_key_cache returns None
result = tm._swap_single_layer(
layer_idx=0,
device_block_ids=[0],
host_block_ids=[10],
mode=0,
)
self.assertFalse(result)
# ---------------------------------------------------------------------------
# sync_input_stream / sync_output_stream
# ---------------------------------------------------------------------------
class TestSyncStreams(unittest.TestCase):
"""Tests for sync_input_stream and sync_output_stream."""
def test_sync_input_stream_no_stream_does_not_raise(self):
"""When _input_stream is None, sync_input_stream should not raise."""
tm = create_transfer_manager()
tm._input_stream = None
tm.sync_input_stream() # should not raise
def test_sync_output_stream_no_stream_does_not_raise(self):
"""When _output_stream is None, sync_output_stream should not raise."""
tm = create_transfer_manager()
tm._output_stream = None
tm.sync_output_stream() # should not raise
def test_sync_input_stream_with_mock_stream(self):
"""sync_input_stream calls synchronize() on the stream."""
from unittest.mock import MagicMock
tm = create_transfer_manager()
mock_stream = MagicMock()
tm._input_stream = mock_stream
tm.sync_input_stream()
mock_stream.synchronize.assert_called_once()
def test_sync_output_stream_with_mock_stream(self):
"""sync_output_stream calls synchronize() on the stream."""
from unittest.mock import MagicMock
tm = create_transfer_manager()
mock_stream = MagicMock()
tm._output_stream = mock_stream
tm.sync_output_stream()
mock_stream.synchronize.assert_called_once()
# ---------------------------------------------------------------------------
# record_input_stream_event
# ---------------------------------------------------------------------------
class TestRecordInputStreamEvent(unittest.TestCase):
"""Tests for record_input_stream_event."""
def test_returns_none_when_no_cupy(self):
"""When cupy unavailable (_input_stream is None), returns None."""
tm = create_transfer_manager()
tm._input_stream = None
result = tm.record_input_stream_event()
self.assertIsNone(result)
def test_returns_none_when_input_stream_none(self):
"""Explicitly set _input_stream to None → returns None."""
tm = create_transfer_manager()
# Patch _HAS_CUPY via the module, or just verify None path works
tm._input_stream = None
result = tm.record_input_stream_event()
self.assertIsNone(result)
if __name__ == "__main__":
unittest.main()