Line data Source code
1 : use std::path::{Path, PathBuf};
2 :
3 : use anyhow::Result;
4 : use camino::{Utf8Path, Utf8PathBuf};
5 : use clap::Subcommand;
6 : use pageserver::context::{DownloadBehavior, RequestContext};
7 : use pageserver::task_mgr::TaskKind;
8 : use pageserver::tenant::block_io::BlockCursor;
9 : use pageserver::tenant::disk_btree::DiskBtreeReader;
10 : use pageserver::tenant::storage_layer::delta_layer::{BlobRef, Summary};
11 : use pageserver::tenant::storage_layer::{delta_layer, image_layer};
12 : use pageserver::tenant::storage_layer::{DeltaLayer, ImageLayer};
13 : use pageserver::tenant::{TENANTS_SEGMENT_NAME, TIMELINES_SEGMENT_NAME};
14 : use pageserver::{page_cache, virtual_file};
15 : use pageserver::{
16 : repository::{Key, KEY_SIZE},
17 : tenant::{
18 : block_io::FileBlockReader, disk_btree::VisitDirection,
19 : storage_layer::delta_layer::DELTA_KEY_SIZE,
20 : },
21 : virtual_file::VirtualFile,
22 : };
23 : use std::fs;
24 : use utils::bin_ser::BeSer;
25 : use utils::id::{TenantId, TimelineId};
26 :
27 : use crate::layer_map_analyzer::parse_filename;
28 :
29 6 : #[derive(Subcommand)]
30 : pub(crate) enum LayerCmd {
31 : /// List all tenants and timelines under the pageserver path
32 : ///
33 : /// Example: `cargo run --bin pagectl layer list .neon/`
34 0 : List { path: PathBuf },
35 : /// List all layers of a given tenant and timeline
36 : ///
37 : /// Example: `cargo run --bin pagectl layer list .neon/`
38 : ListLayer {
39 0 : path: PathBuf,
40 0 : tenant: String,
41 0 : timeline: String,
42 : },
43 : /// Dump all information of a layer file
44 : DumpLayer {
45 0 : path: PathBuf,
46 0 : tenant: String,
47 0 : timeline: String,
48 : /// The id from list-layer command
49 0 : id: usize,
50 : },
51 : RewriteSummary {
52 0 : layer_file_path: Utf8PathBuf,
53 : #[clap(long)]
54 : new_tenant_id: Option<TenantId>,
55 : #[clap(long)]
56 : new_timeline_id: Option<TimelineId>,
57 : },
58 : }
59 :
60 0 : async fn read_delta_file(path: impl AsRef<Path>, ctx: &RequestContext) -> Result<()> {
61 0 : let path = Utf8Path::from_path(path.as_ref()).expect("non-Unicode path");
62 0 : virtual_file::init(10, virtual_file::IoEngineKind::StdFs);
63 0 : page_cache::init(100);
64 0 : let file = FileBlockReader::new(VirtualFile::open(path).await?);
65 0 : let summary_blk = file.read_blk(0, ctx).await?;
66 0 : let actual_summary = Summary::des_prefix(summary_blk.as_ref())?;
67 0 : let tree_reader = DiskBtreeReader::<_, DELTA_KEY_SIZE>::new(
68 0 : actual_summary.index_start_blk,
69 0 : actual_summary.index_root_blk,
70 0 : &file,
71 0 : );
72 0 : // TODO(chi): dedup w/ `delta_layer.rs` by exposing the API.
73 0 : let mut all = vec![];
74 0 : tree_reader
75 0 : .visit(
76 0 : &[0u8; DELTA_KEY_SIZE],
77 0 : VisitDirection::Forwards,
78 0 : |key, value_offset| {
79 0 : let curr = Key::from_slice(&key[..KEY_SIZE]);
80 0 : all.push((curr, BlobRef(value_offset)));
81 0 : true
82 0 : },
83 0 : ctx,
84 0 : )
85 0 : .await?;
86 0 : let cursor = BlockCursor::new_fileblockreader(&file);
87 0 : for (k, v) in all {
88 0 : let value = cursor.read_blob(v.pos(), ctx).await?;
89 0 : println!("key:{} value_len:{}", k, value.len());
90 : }
91 : // TODO(chi): special handling for last key?
92 0 : Ok(())
93 0 : }
94 :
95 0 : pub(crate) async fn main(cmd: &LayerCmd) -> Result<()> {
96 0 : let ctx = RequestContext::new(TaskKind::DebugTool, DownloadBehavior::Error);
97 0 : match cmd {
98 0 : LayerCmd::List { path } => {
99 0 : for tenant in fs::read_dir(path.join(TENANTS_SEGMENT_NAME))? {
100 0 : let tenant = tenant?;
101 0 : if !tenant.file_type()?.is_dir() {
102 0 : continue;
103 0 : }
104 0 : println!("tenant {}", tenant.file_name().to_string_lossy());
105 0 : for timeline in fs::read_dir(tenant.path().join(TIMELINES_SEGMENT_NAME))? {
106 0 : let timeline = timeline?;
107 0 : if !timeline.file_type()?.is_dir() {
108 0 : continue;
109 0 : }
110 0 : println!("- timeline {}", timeline.file_name().to_string_lossy());
111 : }
112 : }
113 0 : Ok(())
114 : }
115 : LayerCmd::ListLayer {
116 0 : path,
117 0 : tenant,
118 0 : timeline,
119 0 : } => {
120 0 : let timeline_path = path
121 0 : .join(TENANTS_SEGMENT_NAME)
122 0 : .join(tenant)
123 0 : .join(TIMELINES_SEGMENT_NAME)
124 0 : .join(timeline);
125 0 : let mut idx = 0;
126 0 : for layer in fs::read_dir(timeline_path)? {
127 0 : let layer = layer?;
128 0 : if let Some(layer_file) = parse_filename(&layer.file_name().into_string().unwrap())
129 0 : {
130 0 : println!(
131 0 : "[{:3}] key:{}-{}\n lsn:{}-{}\n delta:{}",
132 0 : idx,
133 0 : layer_file.key_range.start,
134 0 : layer_file.key_range.end,
135 0 : layer_file.lsn_range.start,
136 0 : layer_file.lsn_range.end,
137 0 : layer_file.is_delta,
138 0 : );
139 0 : idx += 1;
140 0 : }
141 : }
142 0 : Ok(())
143 : }
144 : LayerCmd::DumpLayer {
145 0 : path,
146 0 : tenant,
147 0 : timeline,
148 0 : id,
149 0 : } => {
150 0 : let timeline_path = path
151 0 : .join("tenants")
152 0 : .join(tenant)
153 0 : .join("timelines")
154 0 : .join(timeline);
155 0 : let mut idx = 0;
156 0 : for layer in fs::read_dir(timeline_path)? {
157 0 : let layer = layer?;
158 0 : if let Some(layer_file) = parse_filename(&layer.file_name().into_string().unwrap())
159 : {
160 0 : if *id == idx {
161 : // TODO(chi): dedup code
162 0 : println!(
163 0 : "[{:3}] key:{}-{}\n lsn:{}-{}\n delta:{}",
164 0 : idx,
165 0 : layer_file.key_range.start,
166 0 : layer_file.key_range.end,
167 0 : layer_file.lsn_range.start,
168 0 : layer_file.lsn_range.end,
169 0 : layer_file.is_delta,
170 0 : );
171 0 :
172 0 : if layer_file.is_delta {
173 0 : read_delta_file(layer.path(), &ctx).await?;
174 : } else {
175 0 : anyhow::bail!("not supported yet :(");
176 : }
177 :
178 0 : break;
179 0 : }
180 0 : idx += 1;
181 0 : }
182 : }
183 0 : Ok(())
184 : }
185 : LayerCmd::RewriteSummary {
186 0 : layer_file_path,
187 0 : new_tenant_id,
188 0 : new_timeline_id,
189 0 : } => {
190 0 : pageserver::virtual_file::init(10, virtual_file::IoEngineKind::StdFs);
191 0 : pageserver::page_cache::init(100);
192 0 :
193 0 : let ctx = RequestContext::new(TaskKind::DebugTool, DownloadBehavior::Error);
194 :
195 : macro_rules! rewrite_closure {
196 : ($($summary_ty:tt)*) => {{
197 : |summary| $($summary_ty)* {
198 : tenant_id: new_tenant_id.unwrap_or(summary.tenant_id),
199 : timeline_id: new_timeline_id.unwrap_or(summary.timeline_id),
200 : ..summary
201 : }
202 : }};
203 : }
204 :
205 0 : let res = ImageLayer::rewrite_summary(
206 0 : layer_file_path,
207 0 : rewrite_closure!(image_layer::Summary),
208 0 : &ctx,
209 0 : )
210 0 : .await;
211 0 : match res {
212 : Ok(()) => {
213 0 : println!("Successfully rewrote summary of image layer {layer_file_path}");
214 0 : return Ok(());
215 : }
216 0 : Err(image_layer::RewriteSummaryError::MagicMismatch) => (), // fallthrough
217 0 : Err(image_layer::RewriteSummaryError::Other(e)) => {
218 0 : return Err(e);
219 : }
220 : }
221 :
222 0 : let res = DeltaLayer::rewrite_summary(
223 0 : layer_file_path,
224 0 : rewrite_closure!(delta_layer::Summary),
225 0 : &ctx,
226 0 : )
227 0 : .await;
228 0 : match res {
229 : Ok(()) => {
230 0 : println!("Successfully rewrote summary of delta layer {layer_file_path}");
231 0 : return Ok(());
232 : }
233 0 : Err(delta_layer::RewriteSummaryError::MagicMismatch) => (), // fallthrough
234 0 : Err(delta_layer::RewriteSummaryError::Other(e)) => {
235 0 : return Err(e);
236 : }
237 : }
238 :
239 0 : anyhow::bail!("not an image or delta layer: {layer_file_path}");
240 : }
241 : }
242 0 : }
|
