]>
Commit | Line | Data |
---|---|---|
606ce64b DM |
1 | use failure::*; |
2 | ||
22968600 | 3 | use crate::tools; |
7bc1d727 | 4 | use super::IndexFile; |
7e336555 | 5 | use super::chunk_stat::*; |
606ce64b DM |
6 | use super::chunk_store::*; |
7 | ||
150f1bd8 | 8 | use std::sync::Arc; |
4818c8b6 | 9 | use std::io::{Read, Write}; |
10eea49d | 10 | use std::fs::File; |
606ce64b DM |
11 | use std::path::{Path, PathBuf}; |
12 | use std::os::unix::io::AsRawFd; | |
d13e3745 | 13 | use uuid::Uuid; |
4818c8b6 | 14 | use chrono::{Local, TimeZone}; |
606ce64b | 15 | |
8e39232a | 16 | /// Header format definition for fixed index files (`.fidx`) |
d13e3745 | 17 | #[repr(C)] |
91a905b6 | 18 | pub struct FixedIndexHeader { |
e5064ba6 | 19 | /// The string `PROXMOX-FIDX` |
d13e3745 DM |
20 | pub magic: [u8; 12], |
21 | pub version: u32, | |
22 | pub uuid: [u8; 16], | |
5e5b7f1c | 23 | pub ctime: u64, |
d13e3745 | 24 | pub size: u64, |
4818c8b6 | 25 | pub chunk_size: u64, |
44b3f62b | 26 | reserved: [u8; 4040], // overall size is one page (4096 bytes) |
d13e3745 | 27 | } |
606ce64b DM |
28 | |
29 | // split image into fixed size chunks | |
30 | ||
91a905b6 | 31 | pub struct FixedIndexReader { |
150f1bd8 | 32 | store: Arc<ChunkStore>, |
10eea49d | 33 | _file: File, |
4818c8b6 DM |
34 | filename: PathBuf, |
35 | chunk_size: usize, | |
9f49fe1d | 36 | pub size: usize, |
4818c8b6 | 37 | index: *mut u8, |
9f49fe1d DM |
38 | pub uuid: [u8; 16], |
39 | pub ctime: u64, | |
4818c8b6 DM |
40 | } |
41 | ||
5be4065b WB |
42 | // `index` is mmap()ed which cannot be thread-local so should be sendable |
43 | unsafe impl Send for FixedIndexReader {} | |
44 | ||
91a905b6 | 45 | impl Drop for FixedIndexReader { |
4818c8b6 DM |
46 | |
47 | fn drop(&mut self) { | |
48 | if let Err(err) = self.unmap() { | |
49 | eprintln!("Unable to unmap file {:?} - {}", self.filename, err); | |
50 | } | |
51 | } | |
52 | } | |
53 | ||
91a905b6 | 54 | impl FixedIndexReader { |
4818c8b6 | 55 | |
150f1bd8 | 56 | pub fn open(store: Arc<ChunkStore>, path: &Path) -> Result<Self, Error> { |
4818c8b6 DM |
57 | |
58 | let full_path = store.relative_path(path); | |
59 | ||
10eea49d | 60 | let mut file = File::open(&full_path)?; |
4818c8b6 | 61 | |
c597a92c DM |
62 | if let Err(err) = nix::fcntl::flock(file.as_raw_fd(), nix::fcntl::FlockArg::LockSharedNonblock) { |
63 | bail!("unable to get shared lock on {:?} - {}", full_path, err); | |
64 | } | |
65 | ||
91a905b6 | 66 | let header_size = std::mem::size_of::<FixedIndexHeader>(); |
4818c8b6 DM |
67 | |
68 | // todo: use static assertion when available in rust | |
a360f6fa | 69 | if header_size != 4096 { bail!("got unexpected header size for {:?}", path); } |
4818c8b6 DM |
70 | |
71 | let mut buffer = vec![0u8; header_size]; | |
72 | file.read_exact(&mut buffer)?; | |
73 | ||
91a905b6 | 74 | let header = unsafe { &mut * (buffer.as_ptr() as *mut FixedIndexHeader) }; |
4818c8b6 | 75 | |
91a905b6 | 76 | if header.magic != *b"PROXMOX-FIDX" { |
a360f6fa DM |
77 | bail!("got unknown magic number for {:?}", path); |
78 | } | |
79 | ||
48d0d356 | 80 | let version = u32::from_le(header.version); |
a360f6fa DM |
81 | if version != 1 { |
82 | bail!("got unsupported version number ({})", version); | |
83 | } | |
84 | ||
48d0d356 DM |
85 | let size = u64::from_le(header.size) as usize; |
86 | let ctime = u64::from_le(header.ctime); | |
87 | let chunk_size = u64::from_le(header.chunk_size) as usize; | |
4818c8b6 DM |
88 | |
89 | let index_size = ((size + chunk_size - 1)/chunk_size)*32; | |
90 | ||
0b8e75ed DM |
91 | let rawfd = file.as_raw_fd(); |
92 | ||
93 | let stat = match nix::sys::stat::fstat(rawfd) { | |
94 | Ok(stat) => stat, | |
95 | Err(err) => bail!("fstat {:?} failed - {}", path, err), | |
96 | }; | |
97 | ||
ddbdf80d | 98 | let expected_index_size = (stat.st_size as usize) - header_size; |
0b8e75ed DM |
99 | if index_size != expected_index_size { |
100 | bail!("got unexpected file size for {:?} ({} != {})", | |
101 | path, index_size, expected_index_size); | |
102 | } | |
4818c8b6 DM |
103 | |
104 | let data = unsafe { nix::sys::mman::mmap( | |
105 | std::ptr::null_mut(), | |
106 | index_size, | |
107 | nix::sys::mman::ProtFlags::PROT_READ, | |
108 | nix::sys::mman::MapFlags::MAP_PRIVATE, | |
109 | file.as_raw_fd(), | |
110 | header_size as i64) }? as *mut u8; | |
111 | ||
112 | Ok(Self { | |
113 | store, | |
114 | filename: full_path, | |
10eea49d | 115 | _file: file, |
4818c8b6 DM |
116 | chunk_size, |
117 | size, | |
118 | index: data, | |
119 | ctime, | |
120 | uuid: header.uuid, | |
121 | }) | |
122 | } | |
123 | ||
124 | fn unmap(&mut self) -> Result<(), Error> { | |
125 | ||
126 | if self.index == std::ptr::null_mut() { return Ok(()); } | |
127 | ||
128 | let index_size = ((self.size + self.chunk_size - 1)/self.chunk_size)*32; | |
129 | ||
130 | if let Err(err) = unsafe { nix::sys::mman::munmap(self.index as *mut std::ffi::c_void, index_size) } { | |
131 | bail!("unmap file {:?} failed - {}", self.filename, err); | |
132 | } | |
133 | ||
134 | self.index = std::ptr::null_mut(); | |
135 | ||
136 | Ok(()) | |
137 | } | |
138 | ||
64e53b28 | 139 | pub fn mark_used_chunks(&self, status: &mut GarbageCollectionStatus) -> Result<(), Error> { |
3d5c11e5 DM |
140 | |
141 | if self.index == std::ptr::null_mut() { bail!("detected closed index file."); } | |
142 | ||
7bc1d727 | 143 | let index_count = self.index_count(); |
3d5c11e5 | 144 | |
64e53b28 DM |
145 | status.used_bytes += index_count * self.chunk_size; |
146 | status.used_chunks += index_count; | |
147 | ||
3d5c11e5 DM |
148 | for pos in 0..index_count { |
149 | ||
92da93b2 DM |
150 | tools::fail_on_shutdown()?; |
151 | ||
7bc1d727 | 152 | let digest = self.index_digest(pos).unwrap(); |
3d5c11e5 DM |
153 | if let Err(err) = self.store.touch_chunk(digest) { |
154 | bail!("unable to access chunk {}, required by {:?} - {}", | |
22968600 | 155 | tools::digest_to_hex(digest), self.filename, err); |
3d5c11e5 DM |
156 | } |
157 | } | |
158 | ||
159 | Ok(()) | |
160 | } | |
161 | ||
4818c8b6 DM |
162 | pub fn print_info(&self) { |
163 | println!("Filename: {:?}", self.filename); | |
164 | println!("Size: {}", self.size); | |
165 | println!("ChunkSize: {}", self.chunk_size); | |
166 | println!("CTime: {}", Local.timestamp(self.ctime as i64, 0).format("%c")); | |
167 | println!("UUID: {:?}", self.uuid); | |
168 | } | |
169 | } | |
170 | ||
7bc1d727 WB |
171 | impl IndexFile for FixedIndexReader { |
172 | fn index_count(&self) -> usize { | |
173 | (self.size + self.chunk_size - 1)/self.chunk_size | |
174 | } | |
175 | ||
176 | fn index_digest(&self, pos: usize) -> Option<&[u8; 32]> { | |
177 | if pos >= self.index_count() { | |
178 | None | |
179 | } else { | |
180 | Some(unsafe { std::mem::transmute(self.index.add(pos*32)) }) | |
181 | } | |
182 | } | |
183 | } | |
184 | ||
91a905b6 | 185 | pub struct FixedIndexWriter { |
150f1bd8 | 186 | store: Arc<ChunkStore>, |
43b13033 | 187 | _lock: tools::ProcessLockSharedGuard, |
4fbb72a8 DM |
188 | filename: PathBuf, |
189 | tmp_filename: PathBuf, | |
606ce64b | 190 | chunk_size: usize, |
7e336555 DM |
191 | |
192 | stat: ChunkStat, | |
193 | ||
606ce64b DM |
194 | size: usize, |
195 | index: *mut u8, | |
9f49fe1d DM |
196 | pub uuid: [u8; 16], |
197 | pub ctime: u64, | |
606ce64b DM |
198 | } |
199 | ||
c3bb97e5 WB |
200 | // `index` is mmap()ed which cannot be thread-local so should be sendable |
201 | unsafe impl Send for FixedIndexWriter {} | |
202 | ||
91a905b6 | 203 | impl Drop for FixedIndexWriter { |
4fbb72a8 DM |
204 | |
205 | fn drop(&mut self) { | |
206 | let _ = std::fs::remove_file(&self.tmp_filename); // ignore errors | |
207 | if let Err(err) = self.unmap() { | |
0cd9d420 | 208 | eprintln!("Unable to unmap file {:?} - {}", self.tmp_filename, err); |
4fbb72a8 DM |
209 | } |
210 | } | |
211 | } | |
212 | ||
91a905b6 | 213 | impl FixedIndexWriter { |
606ce64b | 214 | |
150f1bd8 | 215 | pub fn create(store: Arc<ChunkStore>, path: &Path, size: usize, chunk_size: usize) -> Result<Self, Error> { |
606ce64b | 216 | |
43b13033 DM |
217 | let shared_lock = store.try_shared_lock()?; |
218 | ||
606ce64b | 219 | let full_path = store.relative_path(path); |
4fbb72a8 | 220 | let mut tmp_path = full_path.clone(); |
91a905b6 | 221 | tmp_path.set_extension("tmp_fidx"); |
606ce64b DM |
222 | |
223 | let mut file = std::fs::OpenOptions::new() | |
d13e3745 | 224 | .create(true).truncate(true) |
606ce64b DM |
225 | .read(true) |
226 | .write(true) | |
4fbb72a8 | 227 | .open(&tmp_path)?; |
606ce64b | 228 | |
91a905b6 | 229 | let header_size = std::mem::size_of::<FixedIndexHeader>(); |
d13e3745 DM |
230 | |
231 | // todo: use static assertion when available in rust | |
232 | if header_size != 4096 { panic!("got unexpected header size"); } | |
233 | ||
234 | let ctime = std::time::SystemTime::now().duration_since( | |
5e5b7f1c | 235 | std::time::SystemTime::UNIX_EPOCH)?.as_secs(); |
d13e3745 DM |
236 | |
237 | let uuid = Uuid::new_v4(); | |
238 | ||
0cd9d420 | 239 | let buffer = vec![0u8; header_size]; |
91a905b6 | 240 | let header = unsafe { &mut * (buffer.as_ptr() as *mut FixedIndexHeader) }; |
d13e3745 | 241 | |
91a905b6 | 242 | header.magic = *b"PROXMOX-FIDX"; |
48d0d356 DM |
243 | header.version = u32::to_le(1); |
244 | header.ctime = u64::to_le(ctime); | |
245 | header.size = u64::to_le(size as u64); | |
246 | header.chunk_size = u64::to_le(chunk_size as u64); | |
d13e3745 DM |
247 | header.uuid = *uuid.as_bytes(); |
248 | ||
5e5b7f1c | 249 | file.write_all(&buffer)?; |
d13e3745 | 250 | |
606ce64b | 251 | let index_size = ((size + chunk_size - 1)/chunk_size)*32; |
d13e3745 DM |
252 | nix::unistd::ftruncate(file.as_raw_fd(), (header_size + index_size) as i64)?; |
253 | ||
606ce64b DM |
254 | let data = unsafe { nix::sys::mman::mmap( |
255 | std::ptr::null_mut(), | |
256 | index_size, | |
257 | nix::sys::mman::ProtFlags::PROT_READ | nix::sys::mman::ProtFlags::PROT_WRITE, | |
258 | nix::sys::mman::MapFlags::MAP_SHARED, | |
259 | file.as_raw_fd(), | |
d13e3745 DM |
260 | header_size as i64) }? as *mut u8; |
261 | ||
606ce64b DM |
262 | |
263 | Ok(Self { | |
264 | store, | |
43b13033 | 265 | _lock: shared_lock, |
4fbb72a8 DM |
266 | filename: full_path, |
267 | tmp_filename: tmp_path, | |
606ce64b DM |
268 | chunk_size, |
269 | size, | |
7e336555 | 270 | stat: ChunkStat::new(size as u64), |
606ce64b | 271 | index: data, |
d13e3745 DM |
272 | ctime, |
273 | uuid: *uuid.as_bytes(), | |
606ce64b DM |
274 | }) |
275 | } | |
276 | ||
4fbb72a8 DM |
277 | fn unmap(&mut self) -> Result<(), Error> { |
278 | ||
279 | if self.index == std::ptr::null_mut() { return Ok(()); } | |
280 | ||
281 | let index_size = ((self.size + self.chunk_size - 1)/self.chunk_size)*32; | |
282 | ||
283 | if let Err(err) = unsafe { nix::sys::mman::munmap(self.index as *mut std::ffi::c_void, index_size) } { | |
0cd9d420 | 284 | bail!("unmap file {:?} failed - {}", self.tmp_filename, err); |
4fbb72a8 DM |
285 | } |
286 | ||
287 | self.index = std::ptr::null_mut(); | |
288 | ||
7e336555 | 289 | self.stat.disk_size += index_size as u64; |
798f7fa0 | 290 | |
7e336555 | 291 | println!("STAT: {:?}", self.stat); |
580dc84b | 292 | |
4fbb72a8 DM |
293 | Ok(()) |
294 | } | |
295 | ||
296 | pub fn close(&mut self) -> Result<(), Error> { | |
297 | ||
298 | if self.index == std::ptr::null_mut() { bail!("cannot close already closed index file."); } | |
299 | ||
300 | self.unmap()?; | |
301 | ||
302 | if let Err(err) = std::fs::rename(&self.tmp_filename, &self.filename) { | |
303 | bail!("Atomic rename file {:?} failed - {}", self.filename, err); | |
304 | } | |
305 | ||
306 | Ok(()) | |
307 | } | |
308 | ||
7e336555 DM |
309 | pub fn stat(&self) -> &ChunkStat { |
310 | &self.stat | |
311 | } | |
312 | ||
606ce64b DM |
313 | // Note: We want to add data out of order, so do not assume and order here. |
314 | pub fn add_chunk(&mut self, pos: usize, chunk: &[u8]) -> Result<(), Error> { | |
315 | ||
4fbb72a8 DM |
316 | if self.index == std::ptr::null_mut() { bail!("cannot write to closed index file."); } |
317 | ||
606ce64b DM |
318 | let end = pos + chunk.len(); |
319 | ||
320 | if end > self.size { | |
321 | bail!("write chunk data exceeds size ({} >= {})", end, self.size); | |
322 | } | |
323 | ||
324 | // last chunk can be smaller | |
325 | if ((end != self.size) && (chunk.len() != self.chunk_size)) || | |
326 | (chunk.len() > self.chunk_size) || (chunk.len() == 0) { | |
327 | bail!("got chunk with wrong length ({} != {}", chunk.len(), self.chunk_size); | |
328 | } | |
329 | ||
330 | if pos >= self.size { bail!("add chunk after end ({} >= {})", pos, self.size); } | |
331 | ||
332 | if pos & (self.chunk_size-1) != 0 { bail!("add unaligned chunk (pos = {})", pos); } | |
333 | ||
334 | ||
798f7fa0 DM |
335 | let (is_duplicate, digest, compressed_size) = self.store.insert_chunk(chunk)?; |
336 | ||
7e336555 DM |
337 | self.stat.chunk_count += 1; |
338 | self.stat.compressed_size += compressed_size; | |
606ce64b | 339 | |
798f7fa0 DM |
340 | println!("ADD CHUNK {} {} {}% {} {}", pos, chunk.len(), |
341 | (compressed_size*100)/(chunk.len() as u64), is_duplicate, tools::digest_to_hex(&digest)); | |
342 | ||
343 | if is_duplicate { | |
7e336555 | 344 | self.stat.duplicate_chunks += 1; |
798f7fa0 | 345 | } else { |
7e336555 | 346 | self.stat.disk_size += compressed_size; |
798f7fa0 | 347 | } |
606ce64b | 348 | |
e3062f87 WB |
349 | self.add_digest(pos / self.chunk_size, &digest) |
350 | } | |
351 | ||
352 | pub fn add_digest(&mut self, index: usize, digest: &[u8; 32]) -> Result<(), Error> { | |
353 | ||
354 | let index_pos = index*32; | |
606ce64b DM |
355 | unsafe { |
356 | let dst = self.index.add(index_pos); | |
357 | dst.copy_from_nonoverlapping(digest.as_ptr(), 32); | |
358 | } | |
359 | ||
360 | Ok(()) | |
361 | } | |
362 | } |