##// END OF EJS Templates
rust: mostly avoid streaming zstd decompression...
Arseniy Alekseyev -
r51401:39ed7b29 default
parent child Browse files
Show More
@@ -1,730 +1,743 b''
1 1 // Copyright 2018-2023 Georges Racinet <georges.racinet@octobus.net>
2 2 // and Mercurial contributors
3 3 //
4 4 // This software may be used and distributed according to the terms of the
5 5 // GNU General Public License version 2 or any later version.
6 6 //! Mercurial concepts for handling revision history
7 7
8 8 pub mod node;
9 9 pub mod nodemap;
10 10 mod nodemap_docket;
11 11 pub mod path_encode;
12 12 pub use node::{FromHexError, Node, NodePrefix};
13 13 pub mod changelog;
14 14 pub mod filelog;
15 15 pub mod index;
16 16 pub mod manifest;
17 17 pub mod patch;
18 18
19 19 use std::borrow::Cow;
20 20 use std::io::Read;
21 21 use std::ops::Deref;
22 22 use std::path::Path;
23 23
24 24 use flate2::read::ZlibDecoder;
25 25 use sha1::{Digest, Sha1};
26 26 use std::cell::RefCell;
27 27 use zstd;
28 28
29 29 use self::node::{NODE_BYTES_LENGTH, NULL_NODE};
30 30 use self::nodemap_docket::NodeMapDocket;
31 31 use super::index::Index;
32 32 use super::nodemap::{NodeMap, NodeMapError};
33 33 use crate::errors::HgError;
34 34 use crate::vfs::Vfs;
35 35
36 36 /// Mercurial revision numbers
37 37 ///
38 38 /// As noted in revlog.c, revision numbers are actually encoded in
39 39 /// 4 bytes, and are liberally converted to ints, whence the i32
40 40 pub type Revision = i32;
41 41
42 42 /// Marker expressing the absence of a parent
43 43 ///
44 44 /// Independently of the actual representation, `NULL_REVISION` is guaranteed
45 45 /// to be smaller than all existing revisions.
46 46 pub const NULL_REVISION: Revision = -1;
47 47
48 48 /// Same as `mercurial.node.wdirrev`
49 49 ///
50 50 /// This is also equal to `i32::max_value()`, but it's better to spell
51 51 /// it out explicitely, same as in `mercurial.node`
52 52 #[allow(clippy::unreadable_literal)]
53 53 pub const WORKING_DIRECTORY_REVISION: Revision = 0x7fffffff;
54 54
55 55 pub const WORKING_DIRECTORY_HEX: &str =
56 56 "ffffffffffffffffffffffffffffffffffffffff";
57 57
58 58 /// The simplest expression of what we need of Mercurial DAGs.
59 59 pub trait Graph {
60 60 /// Return the two parents of the given `Revision`.
61 61 ///
62 62 /// Each of the parents can be independently `NULL_REVISION`
63 63 fn parents(&self, rev: Revision) -> Result<[Revision; 2], GraphError>;
64 64 }
65 65
66 66 #[derive(Clone, Debug, PartialEq)]
67 67 pub enum GraphError {
68 68 ParentOutOfRange(Revision),
69 69 WorkingDirectoryUnsupported,
70 70 }
71 71
72 72 /// The Mercurial Revlog Index
73 73 ///
74 74 /// This is currently limited to the minimal interface that is needed for
75 75 /// the [`nodemap`](nodemap/index.html) module
76 76 pub trait RevlogIndex {
77 77 /// Total number of Revisions referenced in this index
78 78 fn len(&self) -> usize;
79 79
80 80 fn is_empty(&self) -> bool {
81 81 self.len() == 0
82 82 }
83 83
84 84 /// Return a reference to the Node or `None` if rev is out of bounds
85 85 ///
86 86 /// `NULL_REVISION` is not considered to be out of bounds.
87 87 fn node(&self, rev: Revision) -> Option<&Node>;
88 88 }
89 89
90 90 const REVISION_FLAG_CENSORED: u16 = 1 << 15;
91 91 const REVISION_FLAG_ELLIPSIS: u16 = 1 << 14;
92 92 const REVISION_FLAG_EXTSTORED: u16 = 1 << 13;
93 93 const REVISION_FLAG_HASCOPIESINFO: u16 = 1 << 12;
94 94
95 95 // Keep this in sync with REVIDX_KNOWN_FLAGS in
96 96 // mercurial/revlogutils/flagutil.py
97 97 const REVIDX_KNOWN_FLAGS: u16 = REVISION_FLAG_CENSORED
98 98 | REVISION_FLAG_ELLIPSIS
99 99 | REVISION_FLAG_EXTSTORED
100 100 | REVISION_FLAG_HASCOPIESINFO;
101 101
102 102 const NULL_REVLOG_ENTRY_FLAGS: u16 = 0;
103 103
104 104 #[derive(Debug, derive_more::From)]
105 105 pub enum RevlogError {
106 106 InvalidRevision,
107 107 /// Working directory is not supported
108 108 WDirUnsupported,
109 109 /// Found more than one entry whose ID match the requested prefix
110 110 AmbiguousPrefix,
111 111 #[from]
112 112 Other(HgError),
113 113 }
114 114
115 115 impl From<NodeMapError> for RevlogError {
116 116 fn from(error: NodeMapError) -> Self {
117 117 match error {
118 118 NodeMapError::MultipleResults => RevlogError::AmbiguousPrefix,
119 119 NodeMapError::RevisionNotInIndex(rev) => RevlogError::corrupted(
120 120 format!("nodemap point to revision {} not in index", rev),
121 121 ),
122 122 }
123 123 }
124 124 }
125 125
126 126 fn corrupted<S: AsRef<str>>(context: S) -> HgError {
127 127 HgError::corrupted(format!("corrupted revlog, {}", context.as_ref()))
128 128 }
129 129
130 130 impl RevlogError {
131 131 fn corrupted<S: AsRef<str>>(context: S) -> Self {
132 132 RevlogError::Other(corrupted(context))
133 133 }
134 134 }
135 135
136 136 /// Read only implementation of revlog.
137 137 pub struct Revlog {
138 138 /// When index and data are not interleaved: bytes of the revlog index.
139 139 /// When index and data are interleaved: bytes of the revlog index and
140 140 /// data.
141 141 index: Index,
142 142 /// When index and data are not interleaved: bytes of the revlog data
143 143 data_bytes: Option<Box<dyn Deref<Target = [u8]> + Send>>,
144 144 /// When present on disk: the persistent nodemap for this revlog
145 145 nodemap: Option<nodemap::NodeTree>,
146 146 }
147 147
148 148 impl Revlog {
149 149 /// Open a revlog index file.
150 150 ///
151 151 /// It will also open the associated data file if index and data are not
152 152 /// interleaved.
153 153 pub fn open(
154 154 store_vfs: &Vfs,
155 155 index_path: impl AsRef<Path>,
156 156 data_path: Option<&Path>,
157 157 use_nodemap: bool,
158 158 ) -> Result<Self, HgError> {
159 159 let index_path = index_path.as_ref();
160 160 let index = {
161 161 match store_vfs.mmap_open_opt(&index_path)? {
162 162 None => Index::new(Box::new(vec![])),
163 163 Some(index_mmap) => {
164 164 let index = Index::new(Box::new(index_mmap))?;
165 165 Ok(index)
166 166 }
167 167 }
168 168 }?;
169 169
170 170 let default_data_path = index_path.with_extension("d");
171 171
172 172 // type annotation required
173 173 // won't recognize Mmap as Deref<Target = [u8]>
174 174 let data_bytes: Option<Box<dyn Deref<Target = [u8]> + Send>> =
175 175 if index.is_inline() {
176 176 None
177 177 } else {
178 178 let data_path = data_path.unwrap_or(&default_data_path);
179 179 let data_mmap = store_vfs.mmap_open(data_path)?;
180 180 Some(Box::new(data_mmap))
181 181 };
182 182
183 183 let nodemap = if index.is_inline() || !use_nodemap {
184 184 None
185 185 } else {
186 186 NodeMapDocket::read_from_file(store_vfs, index_path)?.map(
187 187 |(docket, data)| {
188 188 nodemap::NodeTree::load_bytes(
189 189 Box::new(data),
190 190 docket.data_length,
191 191 )
192 192 },
193 193 )
194 194 };
195 195
196 196 Ok(Revlog {
197 197 index,
198 198 data_bytes,
199 199 nodemap,
200 200 })
201 201 }
202 202
203 203 /// Return number of entries of the `Revlog`.
204 204 pub fn len(&self) -> usize {
205 205 self.index.len()
206 206 }
207 207
208 208 /// Returns `true` if the `Revlog` has zero `entries`.
209 209 pub fn is_empty(&self) -> bool {
210 210 self.index.is_empty()
211 211 }
212 212
213 213 /// Returns the node ID for the given revision number, if it exists in this
214 214 /// revlog
215 215 pub fn node_from_rev(&self, rev: Revision) -> Option<&Node> {
216 216 if rev == NULL_REVISION {
217 217 return Some(&NULL_NODE);
218 218 }
219 219 Some(self.index.get_entry(rev)?.hash())
220 220 }
221 221
222 222 /// Return the revision number for the given node ID, if it exists in this
223 223 /// revlog
224 224 pub fn rev_from_node(
225 225 &self,
226 226 node: NodePrefix,
227 227 ) -> Result<Revision, RevlogError> {
228 228 if node.is_prefix_of(&NULL_NODE) {
229 229 return Ok(NULL_REVISION);
230 230 }
231 231
232 232 if let Some(nodemap) = &self.nodemap {
233 233 return nodemap
234 234 .find_bin(&self.index, node)?
235 235 .ok_or(RevlogError::InvalidRevision);
236 236 }
237 237
238 238 // Fallback to linear scan when a persistent nodemap is not present.
239 239 // This happens when the persistent-nodemap experimental feature is not
240 240 // enabled, or for small revlogs.
241 241 //
242 242 // TODO: consider building a non-persistent nodemap in memory to
243 243 // optimize these cases.
244 244 let mut found_by_prefix = None;
245 245 for rev in (0..self.len() as Revision).rev() {
246 246 let index_entry = self.index.get_entry(rev).ok_or_else(|| {
247 247 HgError::corrupted(
248 248 "revlog references a revision not in the index",
249 249 )
250 250 })?;
251 251 if node == *index_entry.hash() {
252 252 return Ok(rev);
253 253 }
254 254 if node.is_prefix_of(index_entry.hash()) {
255 255 if found_by_prefix.is_some() {
256 256 return Err(RevlogError::AmbiguousPrefix);
257 257 }
258 258 found_by_prefix = Some(rev)
259 259 }
260 260 }
261 261 found_by_prefix.ok_or(RevlogError::InvalidRevision)
262 262 }
263 263
264 264 /// Returns whether the given revision exists in this revlog.
265 265 pub fn has_rev(&self, rev: Revision) -> bool {
266 266 self.index.get_entry(rev).is_some()
267 267 }
268 268
269 269 /// Return the full data associated to a revision.
270 270 ///
271 271 /// All entries required to build the final data out of deltas will be
272 272 /// retrieved as needed, and the deltas will be applied to the inital
273 273 /// snapshot to rebuild the final data.
274 274 pub fn get_rev_data(
275 275 &self,
276 276 rev: Revision,
277 277 ) -> Result<Cow<[u8]>, RevlogError> {
278 278 if rev == NULL_REVISION {
279 279 return Ok(Cow::Borrowed(&[]));
280 280 };
281 281 Ok(self.get_entry(rev)?.data()?)
282 282 }
283 283
284 284 /// Check the hash of some given data against the recorded hash.
285 285 pub fn check_hash(
286 286 &self,
287 287 p1: Revision,
288 288 p2: Revision,
289 289 expected: &[u8],
290 290 data: &[u8],
291 291 ) -> bool {
292 292 let e1 = self.index.get_entry(p1);
293 293 let h1 = match e1 {
294 294 Some(ref entry) => entry.hash(),
295 295 None => &NULL_NODE,
296 296 };
297 297 let e2 = self.index.get_entry(p2);
298 298 let h2 = match e2 {
299 299 Some(ref entry) => entry.hash(),
300 300 None => &NULL_NODE,
301 301 };
302 302
303 303 hash(data, h1.as_bytes(), h2.as_bytes()) == expected
304 304 }
305 305
306 306 /// Build the full data of a revision out its snapshot
307 307 /// and its deltas.
308 308 fn build_data_from_deltas(
309 309 snapshot: RevlogEntry,
310 310 deltas: &[RevlogEntry],
311 311 ) -> Result<Vec<u8>, HgError> {
312 312 let snapshot = snapshot.data_chunk()?;
313 313 let deltas = deltas
314 314 .iter()
315 315 .rev()
316 316 .map(RevlogEntry::data_chunk)
317 317 .collect::<Result<Vec<_>, _>>()?;
318 318 let patches: Vec<_> =
319 319 deltas.iter().map(|d| patch::PatchList::new(d)).collect();
320 320 let patch = patch::fold_patch_lists(&patches);
321 321 Ok(patch.apply(&snapshot))
322 322 }
323 323
324 324 /// Return the revlog data.
325 325 fn data(&self) -> &[u8] {
326 326 match &self.data_bytes {
327 327 Some(data_bytes) => data_bytes,
328 328 None => panic!(
329 329 "forgot to load the data or trying to access inline data"
330 330 ),
331 331 }
332 332 }
333 333
334 334 pub fn make_null_entry(&self) -> RevlogEntry {
335 335 RevlogEntry {
336 336 revlog: self,
337 337 rev: NULL_REVISION,
338 338 bytes: b"",
339 339 compressed_len: 0,
340 340 uncompressed_len: 0,
341 341 base_rev_or_base_of_delta_chain: None,
342 342 p1: NULL_REVISION,
343 343 p2: NULL_REVISION,
344 344 flags: NULL_REVLOG_ENTRY_FLAGS,
345 345 hash: NULL_NODE,
346 346 }
347 347 }
348 348
349 349 /// Get an entry of the revlog.
350 350 pub fn get_entry(
351 351 &self,
352 352 rev: Revision,
353 353 ) -> Result<RevlogEntry, RevlogError> {
354 354 if rev == NULL_REVISION {
355 355 return Ok(self.make_null_entry());
356 356 }
357 357 let index_entry = self
358 358 .index
359 359 .get_entry(rev)
360 360 .ok_or(RevlogError::InvalidRevision)?;
361 361 let start = index_entry.offset();
362 362 let end = start + index_entry.compressed_len() as usize;
363 363 let data = if self.index.is_inline() {
364 364 self.index.data(start, end)
365 365 } else {
366 366 &self.data()[start..end]
367 367 };
368 368 let entry = RevlogEntry {
369 369 revlog: self,
370 370 rev,
371 371 bytes: data,
372 372 compressed_len: index_entry.compressed_len(),
373 373 uncompressed_len: index_entry.uncompressed_len(),
374 374 base_rev_or_base_of_delta_chain: if index_entry
375 375 .base_revision_or_base_of_delta_chain()
376 376 == rev
377 377 {
378 378 None
379 379 } else {
380 380 Some(index_entry.base_revision_or_base_of_delta_chain())
381 381 },
382 382 p1: index_entry.p1(),
383 383 p2: index_entry.p2(),
384 384 flags: index_entry.flags(),
385 385 hash: *index_entry.hash(),
386 386 };
387 387 Ok(entry)
388 388 }
389 389
390 390 /// when resolving internal references within revlog, any errors
391 391 /// should be reported as corruption, instead of e.g. "invalid revision"
392 392 fn get_entry_internal(
393 393 &self,
394 394 rev: Revision,
395 395 ) -> Result<RevlogEntry, HgError> {
396 396 self.get_entry(rev)
397 397 .map_err(|_| corrupted(format!("revision {} out of range", rev)))
398 398 }
399 399 }
400 400
401 401 /// The revlog entry's bytes and the necessary informations to extract
402 402 /// the entry's data.
403 403 #[derive(Clone)]
404 404 pub struct RevlogEntry<'revlog> {
405 405 revlog: &'revlog Revlog,
406 406 rev: Revision,
407 407 bytes: &'revlog [u8],
408 408 compressed_len: u32,
409 409 uncompressed_len: i32,
410 410 base_rev_or_base_of_delta_chain: Option<Revision>,
411 411 p1: Revision,
412 412 p2: Revision,
413 413 flags: u16,
414 414 hash: Node,
415 415 }
416 416
417 417 thread_local! {
418 418 // seems fine to [unwrap] here: this can only fail due to memory allocation
419 419 // failing, and it's normal for that to cause panic.
420 420 static ZSTD_DECODER : RefCell<zstd::bulk::Decompressor<'static>> =
421 421 RefCell::new(zstd::bulk::Decompressor::new().ok().unwrap());
422 422 }
423 423
424 424 fn zstd_decompress_to_buffer(
425 425 bytes: &[u8],
426 426 buf: &mut Vec<u8>,
427 427 ) -> Result<usize, std::io::Error> {
428 428 ZSTD_DECODER
429 429 .with(|decoder| decoder.borrow_mut().decompress_to_buffer(bytes, buf))
430 430 }
431 431
432 432 impl<'revlog> RevlogEntry<'revlog> {
433 433 pub fn revision(&self) -> Revision {
434 434 self.rev
435 435 }
436 436
437 437 pub fn node(&self) -> &Node {
438 438 &self.hash
439 439 }
440 440
441 441 pub fn uncompressed_len(&self) -> Option<u32> {
442 442 u32::try_from(self.uncompressed_len).ok()
443 443 }
444 444
445 445 pub fn has_p1(&self) -> bool {
446 446 self.p1 != NULL_REVISION
447 447 }
448 448
449 449 pub fn p1_entry(
450 450 &self,
451 451 ) -> Result<Option<RevlogEntry<'revlog>>, RevlogError> {
452 452 if self.p1 == NULL_REVISION {
453 453 Ok(None)
454 454 } else {
455 455 Ok(Some(self.revlog.get_entry(self.p1)?))
456 456 }
457 457 }
458 458
459 459 pub fn p2_entry(
460 460 &self,
461 461 ) -> Result<Option<RevlogEntry<'revlog>>, RevlogError> {
462 462 if self.p2 == NULL_REVISION {
463 463 Ok(None)
464 464 } else {
465 465 Ok(Some(self.revlog.get_entry(self.p2)?))
466 466 }
467 467 }
468 468
469 469 pub fn p1(&self) -> Option<Revision> {
470 470 if self.p1 == NULL_REVISION {
471 471 None
472 472 } else {
473 473 Some(self.p1)
474 474 }
475 475 }
476 476
477 477 pub fn p2(&self) -> Option<Revision> {
478 478 if self.p2 == NULL_REVISION {
479 479 None
480 480 } else {
481 481 Some(self.p2)
482 482 }
483 483 }
484 484
485 485 pub fn is_censored(&self) -> bool {
486 486 (self.flags & REVISION_FLAG_CENSORED) != 0
487 487 }
488 488
489 489 pub fn has_length_affecting_flag_processor(&self) -> bool {
490 490 // Relevant Python code: revlog.size()
491 491 // note: ELLIPSIS is known to not change the content
492 492 (self.flags & (REVIDX_KNOWN_FLAGS ^ REVISION_FLAG_ELLIPSIS)) != 0
493 493 }
494 494
495 495 /// The data for this entry, after resolving deltas if any.
496 496 pub fn rawdata(&self) -> Result<Cow<'revlog, [u8]>, HgError> {
497 497 let mut entry = self.clone();
498 498 let mut delta_chain = vec![];
499 499
500 500 // The meaning of `base_rev_or_base_of_delta_chain` depends on
501 501 // generaldelta. See the doc on `ENTRY_DELTA_BASE` in
502 502 // `mercurial/revlogutils/constants.py` and the code in
503 503 // [_chaininfo] and in [index_deltachain].
504 504 let uses_generaldelta = self.revlog.index.uses_generaldelta();
505 505 while let Some(base_rev) = entry.base_rev_or_base_of_delta_chain {
506 506 let base_rev = if uses_generaldelta {
507 507 base_rev
508 508 } else {
509 509 entry.rev - 1
510 510 };
511 511 delta_chain.push(entry);
512 512 entry = self.revlog.get_entry_internal(base_rev)?;
513 513 }
514 514
515 515 let data = if delta_chain.is_empty() {
516 516 entry.data_chunk()?
517 517 } else {
518 518 Revlog::build_data_from_deltas(entry, &delta_chain)?.into()
519 519 };
520 520
521 521 Ok(data)
522 522 }
523 523
524 524 fn check_data(
525 525 &self,
526 526 data: Cow<'revlog, [u8]>,
527 527 ) -> Result<Cow<'revlog, [u8]>, HgError> {
528 528 if self.revlog.check_hash(
529 529 self.p1,
530 530 self.p2,
531 531 self.hash.as_bytes(),
532 532 &data,
533 533 ) {
534 534 Ok(data)
535 535 } else {
536 536 if (self.flags & REVISION_FLAG_ELLIPSIS) != 0 {
537 537 return Err(HgError::unsupported(
538 538 "ellipsis revisions are not supported by rhg",
539 539 ));
540 540 }
541 541 Err(corrupted(format!(
542 542 "hash check failed for revision {}",
543 543 self.rev
544 544 )))
545 545 }
546 546 }
547 547
548 548 pub fn data(&self) -> Result<Cow<'revlog, [u8]>, HgError> {
549 549 let data = self.rawdata()?;
550 550 if self.is_censored() {
551 551 return Err(HgError::CensoredNodeError);
552 552 }
553 553 self.check_data(data)
554 554 }
555 555
556 556 /// Extract the data contained in the entry.
557 557 /// This may be a delta. (See `is_delta`.)
558 558 fn data_chunk(&self) -> Result<Cow<'revlog, [u8]>, HgError> {
559 559 if self.bytes.is_empty() {
560 560 return Ok(Cow::Borrowed(&[]));
561 561 }
562 562 match self.bytes[0] {
563 563 // Revision data is the entirety of the entry, including this
564 564 // header.
565 565 b'\0' => Ok(Cow::Borrowed(self.bytes)),
566 566 // Raw revision data follows.
567 567 b'u' => Ok(Cow::Borrowed(&self.bytes[1..])),
568 568 // zlib (RFC 1950) data.
569 569 b'x' => Ok(Cow::Owned(self.uncompressed_zlib_data()?)),
570 570 // zstd data.
571 571 b'\x28' => Ok(Cow::Owned(self.uncompressed_zstd_data()?)),
572 572 // A proper new format should have had a repo/store requirement.
573 573 format_type => Err(corrupted(format!(
574 574 "unknown compression header '{}'",
575 575 format_type
576 576 ))),
577 577 }
578 578 }
579 579
580 580 fn uncompressed_zlib_data(&self) -> Result<Vec<u8>, HgError> {
581 581 let mut decoder = ZlibDecoder::new(self.bytes);
582 582 if self.is_delta() {
583 583 let mut buf = Vec::with_capacity(self.compressed_len as usize);
584 584 decoder
585 585 .read_to_end(&mut buf)
586 586 .map_err(|e| corrupted(e.to_string()))?;
587 587 Ok(buf)
588 588 } else {
589 589 let cap = self.uncompressed_len.max(0) as usize;
590 590 let mut buf = vec![0; cap];
591 591 decoder
592 592 .read_exact(&mut buf)
593 593 .map_err(|e| corrupted(e.to_string()))?;
594 594 Ok(buf)
595 595 }
596 596 }
597 597
598 598 fn uncompressed_zstd_data(&self) -> Result<Vec<u8>, HgError> {
599 let cap = self.uncompressed_len.max(0) as usize;
599 600 if self.is_delta() {
600 let mut buf = Vec::with_capacity(self.compressed_len as usize);
601 // [cap] is usually an over-estimate of the space needed because
602 // it's the length of delta-decoded data, but we're interested
603 // in the size of the delta.
604 // This means we have to [shrink_to_fit] to avoid holding on
605 // to a large chunk of memory, but it also means we must have a
606 // fallback branch, for the case when the delta is longer than
607 // the original data (surprisingly, this does happen in practice)
608 let mut buf = Vec::with_capacity(cap);
609 match zstd_decompress_to_buffer(self.bytes, &mut buf) {
610 Ok(_) => buf.shrink_to_fit(),
611 Err(_) => {
612 buf.clear();
601 613 zstd::stream::copy_decode(self.bytes, &mut buf)
602 614 .map_err(|e| corrupted(e.to_string()))?;
615 }
616 };
603 617 Ok(buf)
604 618 } else {
605 let cap = self.uncompressed_len.max(0) as usize;
606 619 let mut buf = Vec::with_capacity(cap);
607 620 let len = zstd_decompress_to_buffer(self.bytes, &mut buf)
608 621 .map_err(|e| corrupted(e.to_string()))?;
609 622 if len != self.uncompressed_len as usize {
610 623 Err(corrupted("uncompressed length does not match"))
611 624 } else {
612 625 Ok(buf)
613 626 }
614 627 }
615 628 }
616 629
617 630 /// Tell if the entry is a snapshot or a delta
618 631 /// (influences on decompression).
619 632 fn is_delta(&self) -> bool {
620 633 self.base_rev_or_base_of_delta_chain.is_some()
621 634 }
622 635 }
623 636
624 637 /// Calculate the hash of a revision given its data and its parents.
625 638 fn hash(
626 639 data: &[u8],
627 640 p1_hash: &[u8],
628 641 p2_hash: &[u8],
629 642 ) -> [u8; NODE_BYTES_LENGTH] {
630 643 let mut hasher = Sha1::new();
631 644 let (a, b) = (p1_hash, p2_hash);
632 645 if a > b {
633 646 hasher.update(b);
634 647 hasher.update(a);
635 648 } else {
636 649 hasher.update(a);
637 650 hasher.update(b);
638 651 }
639 652 hasher.update(data);
640 653 *hasher.finalize().as_ref()
641 654 }
642 655
643 656 #[cfg(test)]
644 657 mod tests {
645 658 use super::*;
646 659 use crate::index::{IndexEntryBuilder, INDEX_ENTRY_SIZE};
647 660 use itertools::Itertools;
648 661
649 662 #[test]
650 663 fn test_empty() {
651 664 let temp = tempfile::tempdir().unwrap();
652 665 let vfs = Vfs { base: temp.path() };
653 666 std::fs::write(temp.path().join("foo.i"), b"").unwrap();
654 667 let revlog = Revlog::open(&vfs, "foo.i", None, false).unwrap();
655 668 assert!(revlog.is_empty());
656 669 assert_eq!(revlog.len(), 0);
657 670 assert!(revlog.get_entry(0).is_err());
658 671 assert!(!revlog.has_rev(0));
659 672 }
660 673
661 674 #[test]
662 675 fn test_inline() {
663 676 let temp = tempfile::tempdir().unwrap();
664 677 let vfs = Vfs { base: temp.path() };
665 678 let node0 = Node::from_hex("2ed2a3912a0b24502043eae84ee4b279c18b90dd")
666 679 .unwrap();
667 680 let node1 = Node::from_hex("b004912a8510032a0350a74daa2803dadfb00e12")
668 681 .unwrap();
669 682 let node2 = Node::from_hex("dd6ad206e907be60927b5a3117b97dffb2590582")
670 683 .unwrap();
671 684 let entry0_bytes = IndexEntryBuilder::new()
672 685 .is_first(true)
673 686 .with_version(1)
674 687 .with_inline(true)
675 688 .with_offset(INDEX_ENTRY_SIZE)
676 689 .with_node(node0)
677 690 .build();
678 691 let entry1_bytes = IndexEntryBuilder::new()
679 692 .with_offset(INDEX_ENTRY_SIZE)
680 693 .with_node(node1)
681 694 .build();
682 695 let entry2_bytes = IndexEntryBuilder::new()
683 696 .with_offset(INDEX_ENTRY_SIZE)
684 697 .with_p1(0)
685 698 .with_p2(1)
686 699 .with_node(node2)
687 700 .build();
688 701 let contents = vec![entry0_bytes, entry1_bytes, entry2_bytes]
689 702 .into_iter()
690 703 .flatten()
691 704 .collect_vec();
692 705 std::fs::write(temp.path().join("foo.i"), contents).unwrap();
693 706 let revlog = Revlog::open(&vfs, "foo.i", None, false).unwrap();
694 707
695 708 let entry0 = revlog.get_entry(0).ok().unwrap();
696 709 assert_eq!(entry0.revision(), 0);
697 710 assert_eq!(*entry0.node(), node0);
698 711 assert!(!entry0.has_p1());
699 712 assert_eq!(entry0.p1(), None);
700 713 assert_eq!(entry0.p2(), None);
701 714 let p1_entry = entry0.p1_entry().unwrap();
702 715 assert!(p1_entry.is_none());
703 716 let p2_entry = entry0.p2_entry().unwrap();
704 717 assert!(p2_entry.is_none());
705 718
706 719 let entry1 = revlog.get_entry(1).ok().unwrap();
707 720 assert_eq!(entry1.revision(), 1);
708 721 assert_eq!(*entry1.node(), node1);
709 722 assert!(!entry1.has_p1());
710 723 assert_eq!(entry1.p1(), None);
711 724 assert_eq!(entry1.p2(), None);
712 725 let p1_entry = entry1.p1_entry().unwrap();
713 726 assert!(p1_entry.is_none());
714 727 let p2_entry = entry1.p2_entry().unwrap();
715 728 assert!(p2_entry.is_none());
716 729
717 730 let entry2 = revlog.get_entry(2).ok().unwrap();
718 731 assert_eq!(entry2.revision(), 2);
719 732 assert_eq!(*entry2.node(), node2);
720 733 assert!(entry2.has_p1());
721 734 assert_eq!(entry2.p1(), Some(0));
722 735 assert_eq!(entry2.p2(), Some(1));
723 736 let p1_entry = entry2.p1_entry().unwrap();
724 737 assert!(p1_entry.is_some());
725 738 assert_eq!(p1_entry.unwrap().revision(), 0);
726 739 let p2_entry = entry2.p2_entry().unwrap();
727 740 assert!(p2_entry.is_some());
728 741 assert_eq!(p2_entry.unwrap().revision(), 1);
729 742 }
730 743 }
General Comments 0
You need to be logged in to leave comments. Login now