LCOV - code coverage report
Current view: top level - safekeeper/src - copy_timeline.rs (source / functions) Coverage Total Hit
Test: 727bdccc1d7d53837da843959afb612f56da4e79.info Lines: 0.0 % 170 0
Test Date: 2025-01-30 15:18:43 Functions: 0.0 % 6 0

            Line data    Source code
       1              : use anyhow::{bail, Result};
       2              : use camino::Utf8PathBuf;
       3              : use postgres_ffi::{MAX_SEND_SIZE, WAL_SEGMENT_SIZE};
       4              : use safekeeper_api::membership::Configuration;
       5              : use std::sync::Arc;
       6              : use tokio::{
       7              :     fs::OpenOptions,
       8              :     io::{AsyncSeekExt, AsyncWriteExt},
       9              : };
      10              : use tracing::{info, warn};
      11              : use utils::{id::TenantTimelineId, lsn::Lsn};
      12              : 
      13              : use crate::{
      14              :     control_file::FileStorage,
      15              :     state::TimelinePersistentState,
      16              :     timeline::{TimelineError, WalResidentTimeline},
      17              :     timelines_global_map::{create_temp_timeline_dir, validate_temp_timeline},
      18              :     wal_backup::copy_s3_segments,
      19              :     wal_storage::{wal_file_paths, WalReader},
      20              :     GlobalTimelines,
      21              : };
      22              : 
      23              : // we don't want to have more than 10 segments on disk after copy, because they take space
      24              : const MAX_BACKUP_LAG: u64 = 10 * WAL_SEGMENT_SIZE as u64;
      25              : 
      26              : pub struct Request {
      27              :     pub source_ttid: TenantTimelineId,
      28              :     pub until_lsn: Lsn,
      29              :     pub destination_ttid: TenantTimelineId,
      30              : }
      31              : 
      32            0 : pub async fn handle_request(
      33            0 :     request: Request,
      34            0 :     global_timelines: Arc<GlobalTimelines>,
      35            0 : ) -> Result<()> {
      36            0 :     // TODO: request.until_lsn MUST be a valid LSN, and we cannot check it :(
      37            0 :     //   if LSN will point to the middle of a WAL record, timeline will be in "broken" state
      38            0 : 
      39            0 :     match global_timelines.get(request.destination_ttid) {
      40              :         // timeline already exists. would be good to check that this timeline is the copy
      41              :         // of the source timeline, but it isn't obvious how to do that
      42            0 :         Ok(_) => return Ok(()),
      43              :         // timeline not found, we are going to create it
      44            0 :         Err(TimelineError::NotFound(_)) => {}
      45              :         // error, probably timeline was deleted
      46            0 :         res => {
      47            0 :             res?;
      48              :         }
      49              :     }
      50              : 
      51            0 :     let source = global_timelines.get(request.source_ttid)?;
      52            0 :     let source_tli = source.wal_residence_guard().await?;
      53              : 
      54            0 :     let conf = &global_timelines.get_global_config();
      55            0 :     let ttid = request.destination_ttid;
      56              : 
      57            0 :     let (_tmp_dir, tli_dir_path) = create_temp_timeline_dir(conf, ttid).await?;
      58              : 
      59            0 :     let (mem_state, state) = source_tli.get_state().await;
      60            0 :     let start_lsn = state.timeline_start_lsn;
      61            0 :     if start_lsn == Lsn::INVALID {
      62            0 :         bail!("timeline is not initialized");
      63            0 :     }
      64            0 :     let backup_lsn = mem_state.backup_lsn;
      65            0 : 
      66            0 :     {
      67            0 :         let commit_lsn = mem_state.commit_lsn;
      68            0 :         let flush_lsn = source_tli.get_flush_lsn().await;
      69              : 
      70            0 :         info!(
      71            0 :             "collected info about source timeline: start_lsn={}, backup_lsn={}, commit_lsn={}, flush_lsn={}",
      72              :             start_lsn, backup_lsn, commit_lsn, flush_lsn
      73              :         );
      74              : 
      75            0 :         assert!(backup_lsn >= start_lsn);
      76            0 :         assert!(commit_lsn >= start_lsn);
      77            0 :         assert!(flush_lsn >= start_lsn);
      78              : 
      79            0 :         if request.until_lsn > flush_lsn {
      80            0 :             bail!(format!(
      81            0 :                 "requested LSN {} is beyond the end of the timeline {}",
      82            0 :                 request.until_lsn, flush_lsn
      83            0 :             ));
      84            0 :         }
      85            0 :         if request.until_lsn < start_lsn {
      86            0 :             bail!(format!(
      87            0 :                 "requested LSN {} is before the start of the timeline {}",
      88            0 :                 request.until_lsn, start_lsn
      89            0 :             ));
      90            0 :         }
      91            0 : 
      92            0 :         if request.until_lsn > commit_lsn {
      93            0 :             warn!("copy_timeline WAL is not fully committed");
      94            0 :         }
      95              : 
      96            0 :         if backup_lsn < request.until_lsn && request.until_lsn.0 - backup_lsn.0 > MAX_BACKUP_LAG {
      97              :             // we have a lot of segments that are not backed up. we can try to wait here until
      98              :             // segments will be backed up to remote storage, but it's not clear how long to wait
      99            0 :             bail!("too many segments are not backed up");
     100            0 :         }
     101            0 :     }
     102            0 : 
     103            0 :     let wal_seg_size = state.server.wal_seg_size as usize;
     104            0 :     if wal_seg_size == 0 {
     105            0 :         bail!("wal_seg_size is not set");
     106            0 :     }
     107            0 : 
     108            0 :     let first_segment = start_lsn.segment_number(wal_seg_size);
     109            0 :     let last_segment = request.until_lsn.segment_number(wal_seg_size);
     110              : 
     111            0 :     let new_backup_lsn = {
     112              :         // we can't have new backup_lsn greater than existing backup_lsn or start of the last segment
     113            0 :         let max_backup_lsn = backup_lsn.min(Lsn(last_segment * wal_seg_size as u64));
     114            0 : 
     115            0 :         if max_backup_lsn <= start_lsn {
     116              :             // probably we are starting from the first segment, which was not backed up yet.
     117              :             // note that start_lsn can be in the middle of the segment
     118            0 :             start_lsn
     119              :         } else {
     120              :             // we have some segments backed up, so we will assume all WAL below max_backup_lsn is backed up
     121            0 :             assert!(max_backup_lsn.segment_offset(wal_seg_size) == 0);
     122            0 :             max_backup_lsn
     123              :         }
     124              :     };
     125              : 
     126              :     // all previous segments will be copied inside S3
     127            0 :     let first_ondisk_segment = new_backup_lsn.segment_number(wal_seg_size);
     128            0 :     assert!(first_ondisk_segment <= last_segment);
     129            0 :     assert!(first_ondisk_segment >= first_segment);
     130              : 
     131            0 :     copy_s3_segments(
     132            0 :         wal_seg_size,
     133            0 :         &request.source_ttid,
     134            0 :         &request.destination_ttid,
     135            0 :         first_segment,
     136            0 :         first_ondisk_segment,
     137            0 :     )
     138            0 :     .await?;
     139              : 
     140            0 :     copy_disk_segments(
     141            0 :         &source_tli,
     142            0 :         wal_seg_size,
     143            0 :         new_backup_lsn,
     144            0 :         request.until_lsn,
     145            0 :         &tli_dir_path,
     146            0 :     )
     147            0 :     .await?;
     148              : 
     149            0 :     let mut new_state = TimelinePersistentState::new(
     150            0 :         &request.destination_ttid,
     151            0 :         Configuration::empty(),
     152            0 :         state.server.clone(),
     153            0 :         start_lsn,
     154            0 :         request.until_lsn,
     155            0 :     )?;
     156            0 :     new_state.timeline_start_lsn = start_lsn;
     157            0 :     new_state.peer_horizon_lsn = request.until_lsn;
     158            0 :     new_state.backup_lsn = new_backup_lsn;
     159            0 : 
     160            0 :     FileStorage::create_new(&tli_dir_path, new_state.clone(), conf.no_sync).await?;
     161              : 
     162              :     // now we have a ready timeline in a temp directory
     163            0 :     validate_temp_timeline(conf, request.destination_ttid, &tli_dir_path).await?;
     164            0 :     global_timelines
     165            0 :         .load_temp_timeline(request.destination_ttid, &tli_dir_path, true)
     166            0 :         .await?;
     167              : 
     168            0 :     Ok(())
     169            0 : }
     170              : 
     171            0 : async fn copy_disk_segments(
     172            0 :     tli: &WalResidentTimeline,
     173            0 :     wal_seg_size: usize,
     174            0 :     start_lsn: Lsn,
     175            0 :     end_lsn: Lsn,
     176            0 :     tli_dir_path: &Utf8PathBuf,
     177            0 : ) -> Result<()> {
     178            0 :     let mut wal_reader = tli.get_walreader(start_lsn).await?;
     179              : 
     180            0 :     let mut buf = vec![0u8; MAX_SEND_SIZE];
     181            0 : 
     182            0 :     let first_segment = start_lsn.segment_number(wal_seg_size);
     183            0 :     let last_segment = end_lsn.segment_number(wal_seg_size);
     184              : 
     185            0 :     for segment in first_segment..=last_segment {
     186            0 :         let segment_start = segment * wal_seg_size as u64;
     187            0 :         let segment_end = segment_start + wal_seg_size as u64;
     188            0 : 
     189            0 :         let copy_start = segment_start.max(start_lsn.0);
     190            0 :         let copy_end = segment_end.min(end_lsn.0);
     191            0 : 
     192            0 :         let copy_start = copy_start - segment_start;
     193            0 :         let copy_end = copy_end - segment_start;
     194              : 
     195            0 :         let wal_file_path = {
     196            0 :             let (normal, partial) = wal_file_paths(tli_dir_path, segment, wal_seg_size);
     197            0 : 
     198            0 :             if segment == last_segment {
     199            0 :                 partial
     200              :             } else {
     201            0 :                 normal
     202              :             }
     203              :         };
     204              : 
     205            0 :         write_segment(
     206            0 :             &mut buf,
     207            0 :             &wal_file_path,
     208            0 :             wal_seg_size as u64,
     209            0 :             copy_start,
     210            0 :             copy_end,
     211            0 :             &mut wal_reader,
     212            0 :         )
     213            0 :         .await?;
     214              :     }
     215              : 
     216            0 :     Ok(())
     217            0 : }
     218              : 
     219            0 : async fn write_segment(
     220            0 :     buf: &mut [u8],
     221            0 :     file_path: &Utf8PathBuf,
     222            0 :     wal_seg_size: u64,
     223            0 :     from: u64,
     224            0 :     to: u64,
     225            0 :     reader: &mut WalReader,
     226            0 : ) -> Result<()> {
     227            0 :     assert!(from <= to);
     228            0 :     assert!(to <= wal_seg_size);
     229              : 
     230              :     #[allow(clippy::suspicious_open_options)]
     231            0 :     let mut file = OpenOptions::new()
     232            0 :         .create(true)
     233            0 :         .write(true)
     234            0 :         .open(&file_path)
     235            0 :         .await?;
     236              : 
     237              :     // maybe fill with zeros, as in wal_storage.rs?
     238            0 :     file.set_len(wal_seg_size).await?;
     239            0 :     file.seek(std::io::SeekFrom::Start(from)).await?;
     240              : 
     241            0 :     let mut bytes_left = to - from;
     242            0 :     while bytes_left > 0 {
     243            0 :         let len = bytes_left as usize;
     244            0 :         let len = len.min(buf.len());
     245            0 :         let len = reader.read(&mut buf[..len]).await?;
     246            0 :         file.write_all(&buf[..len]).await?;
     247            0 :         bytes_left -= len as u64;
     248              :     }
     249              : 
     250            0 :     file.flush().await?;
     251            0 :     file.sync_all().await?;
     252            0 :     Ok(())
     253            0 : }
        

Generated by: LCOV version 2.1-beta