risingwave_meta/stream/stream_graph/
id.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use crate::controller::id::{
16    IdCategory, IdCategoryType, IdGeneratorManager as SqlIdGeneratorManager,
17};
18
19/// A wrapper to distinguish global ID generated by the [`SqlIdGeneratorManager`] and the local ID from
20/// the frontend.
21#[derive(Clone, Copy, Debug, Hash, Eq, PartialEq, PartialOrd, Ord)]
22pub(super) struct GlobalId<const TYPE: IdCategoryType>(u32);
23
24impl<const TYPE: IdCategoryType> GlobalId<TYPE> {
25    pub const fn new(id: u32) -> Self {
26        Self(id)
27    }
28
29    pub fn as_global_id(&self) -> u32 {
30        self.0
31    }
32}
33
34impl<const TYPE: IdCategoryType> From<u32> for GlobalId<TYPE> {
35    fn from(id: u32) -> Self {
36        Self(id)
37    }
38}
39
40/// Utility for converting local IDs into pre-allocated global IDs by adding an `offset`.
41///
42/// This requires the local IDs exactly a permutation of the range `[0, len)`.
43#[derive(Clone, Copy, Debug)]
44pub(super) struct GlobalIdGen<const TYPE: IdCategoryType> {
45    offset: u32,
46    len: u32,
47}
48
49impl<const TYPE: IdCategoryType> GlobalIdGen<TYPE> {
50    /// Pre-allocate a range of IDs with the given `len` and return the generator.
51    pub fn new(id_gen: &SqlIdGeneratorManager, len: u64) -> Self {
52        let offset = id_gen.generate_interval::<TYPE>(len);
53        Self {
54            offset: offset as u32,
55            len: len as u32,
56        }
57    }
58
59    /// Convert local id to global id. Panics if `id >= len`.
60    pub fn to_global_id(self, local_id: u32) -> GlobalId<TYPE> {
61        assert!(
62            local_id < self.len,
63            "id {} is out of range (len: {})",
64            local_id,
65            self.len
66        );
67        GlobalId(local_id + self.offset)
68    }
69
70    /// Returns the length of this ID generator.
71    pub fn len(&self) -> u32 {
72        self.len
73    }
74}
75
76pub(super) type GlobalFragmentId = GlobalId<{ IdCategory::Fragment }>;
77pub(super) type GlobalFragmentIdGen = GlobalIdGen<{ IdCategory::Fragment }>;
78
79pub(super) type GlobalTableIdGen = GlobalIdGen<{ IdCategory::Table }>;
80
81pub(super) type GlobalActorId = GlobalId<{ IdCategory::Actor }>;
82pub(super) type GlobalActorIdGen = GlobalIdGen<{ IdCategory::Actor }>;
risingwave_meta/stream/stream_graph/id.rs

risingwave_meta/stream/stream_graph/
id.rs
