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