risingwave_common/transaction/
transaction_id.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
// Copyright 2024 RisingWave Labs
//
// 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.

use std::sync::atomic::{AtomicU32, Ordering};

use crate::util::worker_util::WorkerNodeId;

const WORKER_ID_SHIFT_BITS: u8 = 32;

/// `TxnIdGenerator` generates unique transaction ids as following format:
///
/// | worker id | sequence |
/// |-----------|----------|
/// |  32 bits  | 32 bits  |
///
/// Currently, we just need to guarantee the transaction ids are unique at runtime.
/// It doesn't matter, even if the sequence starts from zero after recovery.
#[derive(Debug)]
pub struct TxnIdGenerator {
    worker_id: u32,
    sequence: AtomicU32,
}

pub type TxnId = u64;

impl TxnIdGenerator {
    pub fn new(worker_id: WorkerNodeId) -> Self {
        Self {
            worker_id,
            sequence: AtomicU32::new(0),
        }
    }

    pub fn gen_txn_id(&self) -> TxnId {
        let sequence = self.sequence.fetch_add(1, Ordering::Relaxed);
        (self.worker_id as u64) << WORKER_ID_SHIFT_BITS | sequence as u64
    }
}