ts_pd/layout/
mod.rs

1// Copyright (c) 2026 LightSeek Foundation
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! Transfer planning over the ranks' cache layouts, ported from the Python
22//! PD planner (`pd/cache_protocol.py`, `pd/transfer_plan.py` and the
23//! Mooncake prefill planning).
24//!
25//! * [`contract`]: a rank's cache transfer contract, as the wire carries it.
26//! * [`manifest`]: one request's blocks per group, read off the scheduler's
27//!   block tables, and the blocks one layerwise chunk makes ready.
28//! * [`route`]: which Prefill ranks serve which Decode rank, with which row
29//!   fragments of which fields, across unequal TP sizes, pipeline stages and
30//!   KVP page sharding.
31//! * [`registration`]: a Decode rank's registration and pre-allocation
32//!   messages, and the route a Prefill rank plans for a registration.
33//! * [`copies`]: the copies one transfer makes, as the transfer engine takes
34//!   them.
35//!
36//! Nothing here holds state or moves bytes; the peers do.
37
38pub mod contract;
39pub mod copies;
40pub mod manifest;
41pub mod registration;
42pub mod route;
43
44/// A layout, manifest, route or message that breaks the cache transfer
45/// contract.
46#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
47#[error("{0}")]
48pub struct LayoutError(pub String);
49
50impl LayoutError {
51    /// An error with `message`.
52    pub fn new(message: impl Into<String>) -> Self {
53        Self(message.into())
54    }
55}
ts_pd/layout/mod.rs

ts_pd/layout/
mod.rs
