Compute the content hash only when head and tail match (closes #61) #65
@@ -9,8 +9,9 @@ across very large filesystems without reading every byte of every file.
|
|||||||
Files are considered duplicates when their sizes are equal and they
|
Files are considered duplicates when their sizes are equal and they
|
||||||
agree on a short ladder of hashes. A file under 10 MiB is hashed in full
|
agree on a short ladder of hashes. A file under 10 MiB is hashed in full
|
||||||
and compared directly. A larger file is gated first on the SHA-256 of
|
and compared directly. A larger file is gated first on the SHA-256 of
|
||||||
its first 64 KiB and of its last 64 KiB, and then compared on a content
|
its first 64 KiB and of its last 64 KiB, and only when its size and
|
||||||
hash — the SHA-256 of the whole file when it is under 50 MiB, or of
|
both of those match another file's is it read for a content hash to
|
||||||
|
compare — the SHA-256 of the whole file when it is under 50 MiB, or of
|
||||||
gigabyte-spaced 1 MiB samples when it is 50 MiB or larger. Below 50 MiB
|
gigabyte-spaced 1 MiB samples when it is 50 MiB or larger. Below 50 MiB
|
||||||
the content hash is proof of identical content; at or above 50 MiB it is
|
the content hash is proof of identical content; at or above 50 MiB it is
|
||||||
a strong candidate signal rather than proof, because the gaps between
|
a strong candidate signal rather than proof, because the gaps between
|
||||||
@@ -37,7 +38,8 @@ export SFDUPES_DATABASE="$HOME/.local/share/sfdupes/db.sqlite"
|
|||||||
record per regular file (path, size, mtime, head hash, tail hash,
|
record per regular file (path, size, mtime, head hash, tail hash,
|
||||||
content hash). The
|
content hash). The
|
||||||
database persists between runs; a rescan only hashes files that are new
|
database persists between runs; a rescan only hashes files that are new
|
||||||
or changed, and removes records for files that no longer exist.
|
or changed, or that may have gained a duplicate since the last scan,
|
||||||
|
and removes records for files that no longer exist.
|
||||||
`report` reads the database and prints the file-level duplicates
|
`report` reads the database and prints the file-level duplicates
|
||||||
report. `trees` reads the same database and prints the duplicate-tree
|
report. `trees` reads the same database and prints the duplicate-tree
|
||||||
report. A missing/invalid subcommand — or a `scan` invocation with no
|
report. A missing/invalid subcommand — or a `scan` invocation with no
|
||||||
@@ -55,14 +57,17 @@ Duplicate finders that hash entire files do not scale to the target
|
|||||||
environment: ~10 million files and ~150 TB on possibly slow or busy
|
environment: ~10 million files and ~150 TB on possibly slow or busy
|
||||||
disks (a ZFS pool under resilver). sfdupes spends disk I/O only on files
|
disks (a ZFS pool under resilver). sfdupes spends disk I/O only on files
|
||||||
whose size at least one other file shares, since a size-unique file
|
whose size at least one other file shares, since a size-unique file
|
||||||
cannot be a duplicate; for those it reads the cheap end windows first
|
cannot be a duplicate. Of those, a file under 10 MiB is read in full; a
|
||||||
and a content hash second — the whole file below 50 MiB, but only
|
larger one has its cheap end windows read first, and is read for a
|
||||||
gigabyte-spaced samples at or above 50 MiB, so the largest files are
|
content hash only when its size and both end windows match another
|
||||||
never read in full. This keeps a full-filesystem sweep tractable, and
|
file's — the whole file below 50 MiB, but only gigabyte-spaced samples
|
||||||
the signatures are kept in a persistent database, so
|
at or above 50 MiB, so the largest files are never read in full. This
|
||||||
the expensive filesystem pass is incremental: a rescan re-hashes only
|
keeps a full-filesystem sweep tractable, and the signatures are kept in
|
||||||
files whose recorded mtime or size changed, and all analysis happens
|
a persistent database, so the expensive filesystem pass is incremental:
|
||||||
offline from the database alone. The end goal is
|
a rescan re-hashes only files whose recorded mtime or size changed, plus
|
||||||
|
— for its content hash — a file of 10 MiB or more whose size and end
|
||||||
|
windows have come to match another file's. All analysis happens offline
|
||||||
|
from the database alone. The end goal is
|
||||||
not individual files but whole duplicated trees — duplicate
|
not individual files but whole duplicated trees — duplicate
|
||||||
extractions, duplicate downloads, copied project trees — which an
|
extractions, duplicate downloads, copied project trees — which an
|
||||||
operator can consider removing as a unit.
|
operator can consider removing as a unit.
|
||||||
@@ -82,16 +87,19 @@ Goals, in order:
|
|||||||
size-unique file cannot be a duplicate. Those are compared by the
|
size-unique file cannot be a duplicate. Those are compared by the
|
||||||
ladder in "Duplicate detection" below: a file under 10 MiB is hashed
|
ladder in "Duplicate detection" below: a file under 10 MiB is hashed
|
||||||
in full, while a larger file is gated on cheap 64 KiB end windows
|
in full, while a larger file is gated on cheap 64 KiB end windows
|
||||||
first, then a content hash that reads the whole file below 50 MiB
|
first, and gets a content hash only when its size and both end
|
||||||
but only gigabyte-spaced 1 MiB samples at or above it, so the very
|
windows match another file's. That hash reads the whole file below
|
||||||
largest files are still never read in full. Scale target: tens of
|
50 MiB but only gigabyte-spaced 1 MiB samples at or above it, so the
|
||||||
|
very largest files are still never read in full. Scale target: tens of
|
||||||
millions of files, ~150 TB filesystem, possibly slow or busy disks
|
millions of files, ~150 TB filesystem, possibly slow or busy disks
|
||||||
(ZFS pool under resilver). Holding one small record (path, size,
|
(ZFS pool under resilver). Holding one small record (path, size,
|
||||||
mtime) per file in memory during a scan is acceptable; holding
|
mtime) per file in memory during a scan is acceptable; holding
|
||||||
every file's hashes is not (they stay in the database).
|
every file's hashes is not (they stay in the database).
|
||||||
3. **Scan incrementally, analyze offline.** The expensive filesystem
|
3. **Scan incrementally, analyze offline.** The expensive filesystem
|
||||||
scan maintains a persistent database; an unchanged file is never
|
scan maintains a persistent database; an unchanged file is never
|
||||||
read again on a rescan. All analysis (`report`, `trees`) works from
|
read again on a rescan, except to compute its content hash once a
|
||||||
|
file of 10 MiB or more comes to match another on size and both end
|
||||||
|
windows. All analysis (`report`, `trees`) works from
|
||||||
the database alone and must never touch the scanned filesystem
|
the database alone and must never touch the scanned filesystem
|
||||||
again. `scan` is designed to be cronned; the reports run at any
|
again. `scan` is designed to be cronned; the reports run at any
|
||||||
time against the last completed scan.
|
time against the last completed scan.
|
||||||
@@ -176,17 +184,20 @@ All three subcommands operate on a single SQLite database file:
|
|||||||
the first- and last-64 KiB hashes and `content` the whole-file or
|
the first- and last-64 KiB hashes and `content` the whole-file or
|
||||||
sampled hash. All three are empty strings when the file has never
|
sampled hash. All three are empty strings when the file has never
|
||||||
been hashed because its size was unique as of the last scan that
|
been hashed because its size was unique as of the last scan that
|
||||||
covered it; such records still define the file for tree
|
covered it. `content` alone is empty for a file of 10 MiB or more
|
||||||
reconstruction but never participate in duplicate groups.
|
that matches no other record on size, `head`, and `tail` yet, or
|
||||||
|
whose content read failed. A record with an empty `content` still
|
||||||
|
defines the file for tree reconstruction but is not a duplicate
|
||||||
|
until a later scan fills it in.
|
||||||
|
|
||||||
### Duplicate detection
|
### Duplicate detection
|
||||||
|
|
||||||
Two files are duplicates only when they agree on every rung of this
|
Two files are duplicates only when they agree on every rung of this
|
||||||
ladder; a mismatch at any rung means they are not duplicates. `scan`
|
ladder; a mismatch at any rung means they are not duplicates. `scan`
|
||||||
stores each file's hashes once, and `report` and `trees` group files by
|
stores each file's hashes, and `report` and `trees` group files by the
|
||||||
the whole signature — size, `head`, `tail`, and `content` — so the
|
whole signature — size, `head`, `tail`, and `content` — so the grouping
|
||||||
grouping is exactly this ladder applied across everything scanned into
|
is exactly this ladder applied across everything scanned into the
|
||||||
the database, even across separate scans.
|
database, even across separate scans.
|
||||||
|
|
||||||
1. **Size.** Files of different sizes are never compared. Only files
|
1. **Size.** Files of different sizes are never compared. Only files
|
||||||
whose size at least one other file shares are hashed at all.
|
whose size at least one other file shares are hashed at all.
|
||||||
@@ -199,7 +210,13 @@ the database, even across separate scans.
|
|||||||
3. **10 MiB and above: head and tail.** For a larger file, the SHA-256
|
3. **10 MiB and above: head and tail.** For a larger file, the SHA-256
|
||||||
of the first 64 KiB (`head`) and of the last 64 KiB (`tail`) are a
|
of the first 64 KiB (`head`) and of the last 64 KiB (`tail`) are a
|
||||||
cheap gate that eliminates most same-size pairs before any bulk
|
cheap gate that eliminates most same-size pairs before any bulk
|
||||||
reading. At 10 MiB and above the two windows never overlap.
|
reading: the content hash of the next two rungs is computed only for
|
||||||
|
a file whose size, `head`, and `tail` match another file's, whether
|
||||||
|
that file is scanned in the same run or stored by an earlier scan.
|
||||||
|
A stored file that first gains such a match in a later scan gets its
|
||||||
|
content hash then; until it has one, its `content` is empty and it
|
||||||
|
is not a duplicate. At 10 MiB and above the two windows never
|
||||||
|
overlap.
|
||||||
4. **10 MiB and above, content below 50 MiB.** The SHA-256 of the
|
4. **10 MiB and above, content below 50 MiB.** The SHA-256 of the
|
||||||
entire file. Agreement here is proof of identical content (barring a
|
entire file. Agreement here is proof of identical content (barring a
|
||||||
SHA-256 collision).
|
SHA-256 collision).
|
||||||
@@ -239,10 +256,10 @@ scanned operands:
|
|||||||
|
|
||||||
- Only a file whose size at least one other file shares is ever
|
- Only a file whose size at least one other file shares is ever
|
||||||
read: a size-unique file cannot be a duplicate, so it is recorded
|
read: a size-unique file cannot be a duplicate, so it is recorded
|
||||||
without hashes (`head` and `tail` empty). The size census covers
|
without hashes (`head`, `tail`, and `content` empty). The size
|
||||||
every file walked this scan plus every database record outside
|
census covers every file walked this scan plus every database
|
||||||
the scanned operands, so a possible duplicate of a separately
|
record outside the scanned operands, so a possible duplicate of a
|
||||||
scanned tree is still recognized.
|
separately scanned tree is still recognized.
|
||||||
- A file not yet in the database is inserted: hashed when its size
|
- A file not yet in the database is inserted: hashed when its size
|
||||||
is shared, without hashes otherwise.
|
is shared, without hashes otherwise.
|
||||||
- A file already in the database is **skipped without reading its
|
- A file already in the database is **skipped without reading its
|
||||||
@@ -251,7 +268,10 @@ scanned operands:
|
|||||||
makes a daily rescan cheap. Exception: an unchanged file whose
|
makes a daily rescan cheap. Exception: an unchanged file whose
|
||||||
record lacks hashes is hashed — and its record updated — once its
|
record lacks hashes is hashed — and its record updated — once its
|
||||||
size becomes shared, so hashing deferred by size-uniqueness
|
size becomes shared, so hashing deferred by size-uniqueness
|
||||||
happens as soon as it could matter.
|
happens as soon as it could matter. Likewise, an unchanged file of
|
||||||
|
10 MiB or more whose record has no `content` hash is read for one
|
||||||
|
by the content phase below once its size, `head`, and `tail` match
|
||||||
|
another record's.
|
||||||
- A file whose mtime is newer than recorded, or whose size differs,
|
- A file whose mtime is newer than recorded, or whose size differs,
|
||||||
is processed as if new: re-hashed, or recorded without hashes,
|
is processed as if new: re-hashed, or recorded without hashes,
|
||||||
per the shared-size rule.
|
per the shared-size rule.
|
||||||
@@ -260,12 +280,18 @@ scanned operands:
|
|||||||
removes records for deleted files. It also removes records for
|
removes records for deleted files. It also removes records for
|
||||||
paths that failed to stat or hash this run: the database only ever
|
paths that failed to stat or hash this run: the database only ever
|
||||||
contains signatures verified by the most recent scan that covered
|
contains signatures verified by the most recent scan that covered
|
||||||
them (a subsequent successful scan re-adds such files).
|
them (a subsequent successful scan re-adds such files). A failed
|
||||||
|
content read in the content phase below removes nothing: the
|
||||||
|
record keeps its `head` and `tail`, with `content` empty.
|
||||||
- Database records outside the scanned operands are untouched, so
|
- Database records outside the scanned operands are untouched, so
|
||||||
disjoint trees can be scanned on different schedules into the same
|
disjoint trees can be scanned on different schedules into the same
|
||||||
database.
|
database. The one exception is the content phase below: a stored
|
||||||
|
file of 10 MiB or more without a `content` hash is read for one,
|
||||||
|
wherever it lies, once its size, `head`, and `tail` match another
|
||||||
|
record's. If that file is gone or has changed since its record was
|
||||||
|
written, the record is left as it is.
|
||||||
|
|
||||||
`scan` runs **three sequential phases over the whole scan**.
|
`scan` runs **four sequential phases over the whole scan**.
|
||||||
Parallelism lives inside each phase; batched database writes begin
|
Parallelism lives inside each phase; batched database writes begin
|
||||||
during the hash phase:
|
during the hash phase:
|
||||||
|
|
||||||
@@ -285,11 +311,13 @@ during the hash phase:
|
|||||||
decides its fate. Size-unique files are never read: new or
|
decides its fate. Size-unique files are never read: new or
|
||||||
changed ones are recorded without hashes in the update phase,
|
changed ones are recorded without hashes in the update phase,
|
||||||
unchanged unhashed ones simply keep their records. Every file
|
unchanged unhashed ones simply keep their records. Every file
|
||||||
with a shared size is hashed by the worker pool, computing the
|
with a shared size is hashed by the worker pool as described in
|
||||||
full signature — head, tail, and content — described in "Duplicate
|
"Duplicate detection" above: a file under 10 MiB in full, which
|
||||||
detection" below. Zero-length files have constant
|
gives its `head`, `tail`, and `content` alike, and a larger file
|
||||||
hashes and are never opened. Files are hashed in **inode order**
|
only in its end windows, which give its `head` and `tail`; its
|
||||||
(minimizing seeks on spinning disks), and paths that are hard
|
content hash is left to the content phase. Zero-length files have
|
||||||
|
constant hashes and are never opened. Files are hashed in **inode
|
||||||
|
order** (minimizing seeks on spinning disks), and paths that are hard
|
||||||
links to the same inode are **read once**, all sharing the one
|
links to the same inode are **read once**, all sharing the one
|
||||||
result — a hard-link backup farm costs one read per inode, not
|
result — a hard-link backup farm costs one read per inode, not
|
||||||
per path. The phase total counts actual reads, so progress and
|
per path. The phase total counts actual reads, so progress and
|
||||||
@@ -301,6 +329,23 @@ during the hash phase:
|
|||||||
records for size-unique new and changed files, and the deletions
|
records for size-unique new and changed files, and the deletions
|
||||||
for records the scan did not verify (vanished files, plus paths
|
for records the scan did not verify (vanished files, plus paths
|
||||||
that failed to stat or hash).
|
that failed to stat or hash).
|
||||||
|
4. **content** — find every record of 10 MiB or more without a
|
||||||
|
`content` hash whose size, `head`, and `tail` equal another
|
||||||
|
record's, anywhere in the database: records from this scan and
|
||||||
|
records stored by earlier scans, inside or outside the scanned
|
||||||
|
operands. SQLite finds them, so only their records are loaded into
|
||||||
|
memory, never every file's hashes. Each such file is checked with
|
||||||
|
`lstat` first; one that is gone, is no longer a regular file, or
|
||||||
|
has changed (a different size, or an mtime newer than recorded)
|
||||||
|
keeps its record as it is and is not a duplicate. The files that
|
||||||
|
pass are read only if at least two records sharing their size,
|
||||||
|
`head`, and `tail` remain, counting those that already have a
|
||||||
|
`content` hash, so a file whose only matches are stale costs no
|
||||||
|
read. They are read by a worker pool as in the hash phase, in inode
|
||||||
|
order and once per inode, and their content hashes are committed in
|
||||||
|
batches. A failed read is warned about and counted as skipped; its
|
||||||
|
record keeps an empty `content`, so it is not a duplicate, and a
|
||||||
|
later scan tries again.
|
||||||
|
|
||||||
Rules for the walk:
|
Rules for the walk:
|
||||||
|
|
||||||
@@ -318,18 +363,18 @@ Rules for the walk:
|
|||||||
path, and continue. Per-file errors never abort the run; the final
|
path, and continue. Per-file errors never abort the run; the final
|
||||||
summary reports how many were skipped. As specified above, a
|
summary reports how many were skipped. As specified above, a
|
||||||
skipped path that has a database record from an earlier scan loses
|
skipped path that has a database record from an earlier scan loses
|
||||||
that record; an unreadable directory subtree likewise loses its
|
that record, unless only its content read failed; an unreadable
|
||||||
records (accepted: the database mirrors what the latest scan could
|
directory subtree likewise loses its records (accepted: the
|
||||||
actually verify).
|
database mirrors what the latest scan could actually verify).
|
||||||
|
|
||||||
Concurrency: the walk phase (which also stats files) and the hash
|
Concurrency: the walk phase (which also stats files), the hash phase,
|
||||||
phase each use a worker pool of `--workers` workers (default
|
and the content phase each use a worker pool of `--workers` workers
|
||||||
`runtime.NumCPU()`); the walk parallelizes across directories,
|
(default `runtime.NumCPU()`); the walk parallelizes across
|
||||||
hashing across files. Both phases are seek-bound on spinning disks,
|
directories, hashing across files. All three phases are seek-bound on
|
||||||
so raising `--workers` well past the core count can help on pools
|
spinning disks, so raising `--workers` well past the core count can
|
||||||
with many spindles. The main goroutine owns partitioning, database
|
help on pools with many spindles. The main goroutine owns
|
||||||
writes, and progress rendering; progress display must never block
|
partitioning, database writes, and progress rendering; progress
|
||||||
the workers.
|
display must never block the workers.
|
||||||
|
|
||||||
`scan` writes nothing to stdout. The summary line on stderr reports the
|
`scan` writes nothing to stdout. The summary line on stderr reports the
|
||||||
files seen this run broken down by disposition, plus skips:
|
files seen this run broken down by disposition, plus skips:
|
||||||
@@ -354,11 +399,12 @@ mounted.
|
|||||||
|
|
||||||
Processing:
|
Processing:
|
||||||
|
|
||||||
- Records without hashes (size-unique when last scanned) are
|
- Records without a `content` hash (size-unique when last scanned,
|
||||||
excluded: their content is unknown, so they are never reported as
|
or 10 MiB or more and not yet matched on size, `head`, and `tail`)
|
||||||
duplicates.
|
are excluded: their content is unknown, so they are never reported
|
||||||
|
as duplicates.
|
||||||
- Group the remaining records by the key
|
- Group the remaining records by the key
|
||||||
`(size, head_hash, tail_hash)`.
|
`(size, head, tail, content)`.
|
||||||
- Every group with two or more paths is a duplicate group.
|
- Every group with two or more paths is a duplicate group.
|
||||||
- Within each group, sort paths lexicographically (byte order). The
|
- Within each group, sort paths lexicographically (byte order). The
|
||||||
first path is the group's `first`; every other path is a `dupe`.
|
first path is the group's `first`; every other path is a `dupe`.
|
||||||
@@ -394,11 +440,11 @@ the paths in the records, split on `/`.
|
|||||||
|
|
||||||
Definitions:
|
Definitions:
|
||||||
|
|
||||||
- A file's **signature** is `(size, head_hash, tail_hash)` — mtime is
|
- A file's **signature** is `(size, head, tail, content)` — mtime is
|
||||||
informational and excluded. An unhashed record (empty hashes) has
|
informational and excluded. A record without a `content` hash has
|
||||||
unknown content: its signature is treated as unique to that file,
|
unknown content: its signature is treated as unique to that file,
|
||||||
so a tree containing an unhashed file never compares equal to any
|
so a tree containing such a file never compares equal to any other
|
||||||
other tree.
|
tree.
|
||||||
- A directory's **digest** is a SHA-256 Merkle digest computed
|
- A directory's **digest** is a SHA-256 Merkle digest computed
|
||||||
bottom-up: serialize the directory's child entries — for a file
|
bottom-up: serialize the directory's child entries — for a file
|
||||||
child, its name and signature; for a subdirectory child, its name
|
child, its name and signature; for a subdirectory child, its name
|
||||||
@@ -461,10 +507,10 @@ Each phase gets its own display, rendered the moment the phase
|
|||||||
starts — a scan must never look hung. Loading the existing-record
|
starts — a scan must never look hung. Loading the existing-record
|
||||||
index (`load`) and the walk have no known totals while running: show
|
index (`load`) and the walk have no known totals while running: show
|
||||||
a live count, rate, and elapsed time (spinner-style, no percentage or
|
a live count, rate, and elapsed time (spinner-style, no percentage or
|
||||||
ETA). The hash and update phases
|
ETA). The hash, update, and content phases
|
||||||
have exact totals — only files that actually need hashing appear in
|
have exact totals — only files that actually need hashing appear in
|
||||||
the hash total, so its ETA is meaningful. Required elements for the
|
the hash and content totals, so their ETAs are meaningful. Required
|
||||||
bars with known totals:
|
elements for the bars with known totals:
|
||||||
|
|
||||||
- elapsed time
|
- elapsed time
|
||||||
- estimated time remaining
|
- estimated time remaining
|
||||||
@@ -691,9 +737,10 @@ Tracked in [TODO.md](TODO.md).
|
|||||||
|
|
||||||
## Non-goals
|
## Non-goals
|
||||||
|
|
||||||
- No full-content verification, no byte-for-byte compare, no deletion
|
- No byte-for-byte compare, and no deletion or linking of
|
||||||
or linking of duplicates. The reports are advisory; acting on them is
|
duplicates. Files that match are compared by a SHA-256 of the whole
|
||||||
the user's job.
|
file below 50 MiB, and only by samples at 50 MiB and over. The
|
||||||
|
reports are advisory; acting on them is the user's job.
|
||||||
- No persistence beyond the SQLite database described above; no
|
- No persistence beyond the SQLite database described above; no
|
||||||
export/import formats.
|
export/import formats.
|
||||||
- No daemon or filesystem watcher; scheduling rescans is cron's job.
|
- No daemon or filesystem watcher; scheduling rescans is cron's job.
|
||||||
|
|||||||
@@ -34,11 +34,16 @@
|
|||||||
https://git.eeqj.de/sneak/sfdupes/issues/61): a file under 10 MiB is
|
https://git.eeqj.de/sneak/sfdupes/issues/61): a file under 10 MiB is
|
||||||
hashed in full and compared directly, with no end-window step — its
|
hashed in full and compared directly, with no end-window step — its
|
||||||
`head`, `tail`, and `content` all hold the whole-file hash. A file at
|
`head`, `tail`, and `content` all hold the whole-file hash. A file at
|
||||||
10 MiB or above is gated on the 64 KiB `head` and `tail`, then
|
10 MiB or above gets only the 64 KiB `head` and `tail` in the hash
|
||||||
compared on a `content` hash — the whole file below 50 MiB,
|
phase; a new content phase, after the update phase, reads it for its
|
||||||
gigabyte-spaced 1 MiB samples at or above. The `content` column is
|
`content` hash — the whole file below 50 MiB, gigabyte-spaced 1 MiB
|
||||||
part of the version 1 schema. `report` and `trees` group by the
|
samples at or above — only when its size, `head`, and `tail` match
|
||||||
extended signature, so the ladder is applied across the whole
|
another record's, from the same scan or stored by an earlier one, so
|
||||||
|
a stored file gains its content hash when it gains a match. A file
|
||||||
|
that is gone or has changed since its record was written is not
|
||||||
|
read. The `content` column is part of the version 1 schema. `report`
|
||||||
|
and `trees` group by the extended signature and leave out any record
|
||||||
|
without a `content` hash, so the ladder is applied across the whole
|
||||||
database. README "Duplicate detection" documents every rung including
|
database. README "Duplicate detection" documents every rung including
|
||||||
the probabilistic large-file path.
|
the probabilistic large-file path.
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -456,7 +456,7 @@ func TestHashWorkerDropsQueuedRuns(t *testing.T) {
|
|||||||
go func() {
|
go func() {
|
||||||
defer close(done)
|
defer close(done)
|
||||||
|
|
||||||
hashWorker(cancelledContext(t), jobs, results)
|
hashWorker(cancelledContext(t), jobs, results, hashSignature)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
awaitReturn(t, done, "hashWorker")
|
awaitReturn(t, done, "hashWorker")
|
||||||
|
|||||||
@@ -278,6 +278,64 @@ func loadFileMeta(ctx context.Context, db *sql.DB,
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// contentCandidatesSQL selects every record of at least headTailMin
|
||||||
|
// bytes that has no content hash but whose size, head, and tail equal
|
||||||
|
// another record's, with the number of records in its group (the
|
||||||
|
// records sharing that size, head, and tail) that already have a
|
||||||
|
// content hash. SQLite does the grouping, so no other record's hashes
|
||||||
|
// are loaded into memory; the rows come ordered by size, head, and
|
||||||
|
// tail, so each group's rows arrive together.
|
||||||
|
const contentCandidatesSQL = `
|
||||||
|
SELECT f.path, f.size, f.mtime, f.head, f.tail, g.hashed
|
||||||
|
FROM files AS f
|
||||||
|
JOIN (
|
||||||
|
SELECT size, head, tail, SUM(content <> '') AS hashed
|
||||||
|
FROM files
|
||||||
|
WHERE size >= ? AND head <> ''
|
||||||
|
GROUP BY size, head, tail
|
||||||
|
HAVING COUNT(*) > 1
|
||||||
|
) AS g USING (size, head, tail)
|
||||||
|
WHERE f.content = ''
|
||||||
|
ORDER BY size, head, tail
|
||||||
|
`
|
||||||
|
|
||||||
|
// loadContentCandidates streams the rows of contentCandidatesSQL to fn:
|
||||||
|
// each record, without its content hash, and the number of records in
|
||||||
|
// its group that already have one.
|
||||||
|
func loadContentCandidates(ctx context.Context, db *sql.DB,
|
||||||
|
fn func(r scanRec, hashed int),
|
||||||
|
) error {
|
||||||
|
rows, err := db.QueryContext(ctx, contentCandidatesSQL, headTailMin)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read records: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
defer func() { _ = rows.Close() }()
|
||||||
|
|
||||||
|
for rows.Next() {
|
||||||
|
var (
|
||||||
|
path []byte
|
||||||
|
r scanRec
|
||||||
|
hashed int
|
||||||
|
)
|
||||||
|
|
||||||
|
err = rows.Scan(&path, &r.size, &r.mtime, &r.head, &r.tail, &hashed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read record: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
r.path = string(path)
|
||||||
|
fn(r, hashed)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = rows.Err()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read records: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// updateBatchSize is the number of record changes committed per
|
// updateBatchSize is the number of record changes committed per
|
||||||
// transaction during the update pass. The filesystem is authoritative
|
// transaction during the update pass. The filesystem is authoritative
|
||||||
// and the database an eventually-consistent reflection of it, so
|
// and the database an eventually-consistent reflection of it, so
|
||||||
|
|||||||
+10
-4
@@ -136,10 +136,14 @@ func TestApplyChangesRoundTrip(t *testing.T) {
|
|||||||
db := openTestDB(t)
|
db := openTestDB(t)
|
||||||
|
|
||||||
// Paths may contain tabs and newlines; the database must store
|
// Paths may contain tabs and newlines; the database must store
|
||||||
// them byte-exactly.
|
// them byte-exactly. Every hash, content included, comes back as
|
||||||
|
// written.
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 2, mtime: 20, head: "h2", tail: "t2", path: "/a/tab\tnew\nline"},
|
{
|
||||||
{size: 1, mtime: 10, head: "h1", tail: "t1", path: "/a/x"},
|
size: 2, mtime: 20, head: "h2", tail: "t2", content: "c2",
|
||||||
|
path: "/a/tab\tnew\nline",
|
||||||
|
},
|
||||||
|
{size: 1, mtime: 10, head: "h1", tail: "t1", content: "c1", path: "/a/x"},
|
||||||
}
|
}
|
||||||
|
|
||||||
err := applyChanges(t.Context(), db, recs, nil,
|
err := applyChanges(t.Context(), db, recs, nil,
|
||||||
@@ -163,7 +167,9 @@ func TestApplyChangesRoundTrip(t *testing.T) {
|
|||||||
|
|
||||||
// An upsert for an existing path updates in place; a delete
|
// An upsert for an existing path updates in place; a delete
|
||||||
// removes exactly its path.
|
// removes exactly its path.
|
||||||
upd := scanRec{size: 3, mtime: 30, head: "h3", tail: "t3", path: "/a/x"}
|
upd := scanRec{
|
||||||
|
size: 3, mtime: 30, head: "h3", tail: "t3", content: "c3", path: "/a/x",
|
||||||
|
}
|
||||||
|
|
||||||
err = applyChanges(t.Context(), db, []scanRec{upd},
|
err = applyChanges(t.Context(), db, []scanRec{upd},
|
||||||
[]string{"/a/tab\tnew\nline"}, newProgress("update", 2))
|
[]string{"/a/tab\tnew\nline"}, newProgress("update", 2))
|
||||||
|
|||||||
@@ -3,7 +3,8 @@
|
|||||||
// Files are considered duplicates when their sizes are equal and they
|
// Files are considered duplicates when their sizes are equal and they
|
||||||
// agree on a short ladder of SHA-256 hashes. A file under 10 MiB is
|
// agree on a short ladder of SHA-256 hashes. A file under 10 MiB is
|
||||||
// hashed in full. A larger file is compared on the hashes of its first
|
// hashed in full. A larger file is compared on the hashes of its first
|
||||||
// and last 64 KiB and on a content hash: of the whole file when it is
|
// and last 64 KiB, and only when those match another file's is its
|
||||||
|
// content hash computed and compared: of the whole file when it is
|
||||||
// under 50 MiB, or of gigabyte-spaced 1 MiB samples when it is 50 MiB
|
// under 50 MiB, or of gigabyte-spaced 1 MiB samples when it is 50 MiB
|
||||||
// or larger. scan maintains a persistent SQLite database of file
|
// or larger. scan maintains a persistent SQLite database of file
|
||||||
// signatures (SFDUPES_DATABASE, default /var/lib/sfdupes/db.sqlite)
|
// signatures (SFDUPES_DATABASE, default /var/lib/sfdupes/db.sqlite)
|
||||||
@@ -100,7 +101,7 @@ func run(args []string, stderr io.Writer) int {
|
|||||||
func newRootCommand(stderr io.Writer) *cobra.Command {
|
func newRootCommand(stderr io.Writer) *cobra.Command {
|
||||||
root := &cobra.Command{
|
root := &cobra.Command{
|
||||||
Use: "sfdupes",
|
Use: "sfdupes",
|
||||||
Short: "Find candidate duplicate files by size and head/tail SHA-256",
|
Short: "Find candidate duplicate files by size and head/tail/content SHA-256",
|
||||||
Version: Version,
|
Version: Version,
|
||||||
Args: cobra.NoArgs,
|
Args: cobra.NoArgs,
|
||||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||||
@@ -130,7 +131,7 @@ func newRootCommand(stderr io.Writer) *cobra.Command {
|
|||||||
}),
|
}),
|
||||||
}
|
}
|
||||||
scanCmd.Flags().IntVar(&scanWorkers, "workers", runtime.NumCPU(),
|
scanCmd.Flags().IntVar(&scanWorkers, "workers", runtime.NumCPU(),
|
||||||
"concurrent workers for the walk and hash phases")
|
"concurrent workers for the walk, hash, and content phases")
|
||||||
scanCmd.Flags().BoolVarP(&scanOneFS, "one-file-system", "x", false,
|
scanCmd.Flags().BoolVarP(&scanOneFS, "one-file-system", "x", false,
|
||||||
"do not cross filesystem boundaries")
|
"do not cross filesystem boundaries")
|
||||||
|
|
||||||
|
|||||||
@@ -117,10 +117,11 @@ func collectDupeGroups(recs []scanRec) []dupeGroup {
|
|||||||
groups := make(map[fileSig][]string)
|
groups := make(map[fileSig][]string)
|
||||||
|
|
||||||
for _, r := range recs {
|
for _, r := range recs {
|
||||||
// A record without hashes (its size was unique when last
|
// A record without a content hash has unknown content and is
|
||||||
// scanned) has unknown content and is never reported as a
|
// never reported as a duplicate: its size was unique when last
|
||||||
// duplicate.
|
// scanned, or it is headTailMin or more and has not yet matched
|
||||||
if r.head == "" {
|
// another record on size, head, and tail.
|
||||||
|
if r.content == "" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+21
-17
@@ -9,15 +9,15 @@ func TestCollectDupeGroups(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 100, head: "h", tail: "t", path: "/z/b"},
|
{size: 100, head: "h", tail: "t", content: "c", path: "/z/b"},
|
||||||
{size: 100, head: "h", tail: "t", path: "/z/a"},
|
{size: 100, head: "h", tail: "t", content: "c", path: "/z/a"},
|
||||||
{size: 100, head: "h", tail: "t", path: "/z/c"},
|
{size: 100, head: "h", tail: "t", content: "c", path: "/z/c"},
|
||||||
{size: 4000, head: "H", tail: "T", path: "/big/2"},
|
{size: 4000, head: "H", tail: "T", content: "C", path: "/big/2"},
|
||||||
{size: 4000, head: "H", tail: "T", path: "/big/1"},
|
{size: 4000, head: "H", tail: "T", content: "C", path: "/big/1"},
|
||||||
// Same size as the /z group but a different head hash.
|
// Same size as the /z group but a different head hash.
|
||||||
{size: 100, head: "other", tail: "t", path: "/z/d"},
|
{size: 100, head: "other", tail: "t", content: "c", path: "/z/d"},
|
||||||
// A singleton signature must not form a group.
|
// A singleton signature must not form a group.
|
||||||
{size: 7, head: "u", tail: "u", path: "/lonely"},
|
{size: 7, head: "u", tail: "u", content: "u", path: "/lonely"},
|
||||||
}
|
}
|
||||||
|
|
||||||
groups := collectDupeGroups(recs)
|
groups := collectDupeGroups(recs)
|
||||||
@@ -43,10 +43,14 @@ func TestCollectDupeGroupsContentSeparates(t *testing.T) {
|
|||||||
|
|
||||||
// Same size, head, and tail, but different content hashes: the final
|
// Same size, head, and tail, but different content hashes: the final
|
||||||
// rung keeps them apart, so no group forms. Matching content groups.
|
// rung keeps them apart, so no group forms. Matching content groups.
|
||||||
|
// Records without a content hash never group, not even with each
|
||||||
|
// other.
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 100, head: "h", tail: "t", content: "c1", path: "/a"},
|
{size: 100, head: "h", tail: "t", content: "c1", path: "/a"},
|
||||||
{size: 100, head: "h", tail: "t", content: "c2", path: "/b"},
|
{size: 100, head: "h", tail: "t", content: "c2", path: "/b"},
|
||||||
{size: 100, head: "h", tail: "t", content: "c1", path: "/c"},
|
{size: 100, head: "h", tail: "t", content: "c1", path: "/c"},
|
||||||
|
{size: 100, head: "h", tail: "t", path: "/d"},
|
||||||
|
{size: 100, head: "h", tail: "t", path: "/e"},
|
||||||
}
|
}
|
||||||
|
|
||||||
groups := collectDupeGroups(recs)
|
groups := collectDupeGroups(recs)
|
||||||
@@ -66,8 +70,8 @@ func TestCollectDupeGroupsMtimeExcluded(t *testing.T) {
|
|||||||
// mtime is informational only; records differing only in mtime
|
// mtime is informational only; records differing only in mtime
|
||||||
// still group together.
|
// still group together.
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 9, mtime: 100, head: "h", tail: "t", path: "/m/1"},
|
{size: 9, mtime: 100, head: "h", tail: "t", content: "c", path: "/m/1"},
|
||||||
{size: 9, mtime: 200, head: "h", tail: "t", path: "/m/2"},
|
{size: 9, mtime: 200, head: "h", tail: "t", content: "c", path: "/m/2"},
|
||||||
}
|
}
|
||||||
|
|
||||||
groups := collectDupeGroups(recs)
|
groups := collectDupeGroups(recs)
|
||||||
@@ -80,10 +84,10 @@ func TestCollectDupeGroupsTieBreak(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 50, head: "b", tail: "b", path: "/beta/2"},
|
{size: 50, head: "b", tail: "b", content: "b", path: "/beta/2"},
|
||||||
{size: 50, head: "b", tail: "b", path: "/beta/1"},
|
{size: 50, head: "b", tail: "b", content: "b", path: "/beta/1"},
|
||||||
{size: 50, head: "a", tail: "a", path: "/alpha/2"},
|
{size: 50, head: "a", tail: "a", content: "a", path: "/alpha/2"},
|
||||||
{size: 50, head: "a", tail: "a", path: "/alpha/1"},
|
{size: 50, head: "a", tail: "a", content: "a", path: "/alpha/1"},
|
||||||
}
|
}
|
||||||
|
|
||||||
groups := collectDupeGroups(recs)
|
groups := collectDupeGroups(recs)
|
||||||
@@ -102,10 +106,10 @@ func TestCollectDupeGroupsDeterministic(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 1, head: "a", tail: "a", path: "/p/1"},
|
{size: 1, head: "a", tail: "a", content: "a", path: "/p/1"},
|
||||||
{size: 1, head: "a", tail: "a", path: "/p/2"},
|
{size: 1, head: "a", tail: "a", content: "a", path: "/p/2"},
|
||||||
{size: 2, head: "b", tail: "b", path: "/q/1"},
|
{size: 2, head: "b", tail: "b", content: "b", path: "/q/1"},
|
||||||
{size: 2, head: "b", tail: "b", path: "/q/2"},
|
{size: 2, head: "b", tail: "b", content: "b", path: "/q/2"},
|
||||||
}
|
}
|
||||||
|
|
||||||
forward := collectDupeGroups(recs)
|
forward := collectDupeGroups(recs)
|
||||||
|
|||||||
@@ -21,7 +21,10 @@ import (
|
|||||||
// detection"). A same-size candidate below headTailMin is hashed in
|
// detection"). A same-size candidate below headTailMin is hashed in
|
||||||
// full and compared directly; a larger one is separated first by the
|
// full and compared directly; a larger one is separated first by the
|
||||||
// hashes of its end windows, then by a content hash that is exact below
|
// hashes of its end windows, then by a content hash that is exact below
|
||||||
// wholeFileMax and deliberately sampled at or above it.
|
// wholeFileMax and deliberately sampled at or above it. The hash phase
|
||||||
|
// reads only the end windows of a larger file; the content phase reads
|
||||||
|
// it for its content hash only once its size, head, and tail match
|
||||||
|
// another file's.
|
||||||
|
|
||||||
// headTailMin is the size threshold for the end-window gate. A file
|
// headTailMin is the size threshold for the end-window gate. A file
|
||||||
// smaller than this is hashed in full directly, with no separate head
|
// smaller than this is hashed in full directly, with no separate head
|
||||||
@@ -74,16 +77,17 @@ type fileMeta struct {
|
|||||||
hashed bool
|
hashed bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// runScan implements the scan subcommand: three sequential phases —
|
// runScan implements the scan subcommand: four sequential phases —
|
||||||
// walk (which stats each file as it is discovered), hash, update —
|
// walk (which stats each file as it is discovered), hash, update,
|
||||||
// that synchronize the persistent database with the filesystem state
|
// content — that synchronize the persistent database with the
|
||||||
// under the PATH operands. Only files whose size at least one other
|
// filesystem state under the PATH operands. Only files whose size at
|
||||||
// file shares are ever hashed: a size-unique file cannot be a
|
// least one other file shares are ever hashed: a size-unique file
|
||||||
// duplicate. Flag parsing and the at-least-one-operand check are done
|
// cannot be a duplicate. A file of headTailMin or more gets its content
|
||||||
// by cobra. Errors are returned rather than exiting, so that the
|
// hash only when its size, head, and tail match another file's. Flag
|
||||||
// deferred close — which checkpoints the SQLite WAL — always runs.
|
// parsing and the at-least-one-operand check are done by cobra. Errors
|
||||||
// Cancelling ctx unwinds the worker pools and aborts the scan with the
|
// are returned rather than exiting, so that the deferred close — which
|
||||||
// context's error.
|
// checkpoints the SQLite WAL — always runs. Cancelling ctx unwinds the
|
||||||
|
// worker pools and aborts the scan with the context's error.
|
||||||
func runScan(ctx context.Context, roots []string, workers int,
|
func runScan(ctx context.Context, roots []string, workers int,
|
||||||
oneFS bool,
|
oneFS bool,
|
||||||
) error {
|
) error {
|
||||||
@@ -196,13 +200,16 @@ type scanState struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// syncScan synchronizes the database with the filesystem under roots
|
// syncScan synchronizes the database with the filesystem under roots
|
||||||
// in three sequential phases: walk (enumerate and stat every file,
|
// in four sequential phases: walk (enumerate and stat every file,
|
||||||
// building a complete size census), hash (read only the new or
|
// building a complete size census), hash (read only the new or
|
||||||
// changed — or previously unhashed — files whose size at least one
|
// changed — or previously unhashed — files whose size at least one
|
||||||
// other file shares, committing results in batches as they arrive),
|
// other file shares, committing results in batches as they arrive),
|
||||||
// and update (record the size-unique files without reading them, and
|
// update (record the size-unique files without reading them, and
|
||||||
// delete the records the scan no longer verifies). Records outside
|
// delete the records the scan no longer verifies), and content (fill
|
||||||
// the roots are never touched.
|
// in the content hash of every record of headTailMin or more whose
|
||||||
|
// size, head, and tail match another record's). Records outside the
|
||||||
|
// roots are never touched, except that the content phase fills in
|
||||||
|
// their content hash.
|
||||||
func syncScan(ctx context.Context, db *sql.DB, roots []string,
|
func syncScan(ctx context.Context, db *sql.DB, roots []string,
|
||||||
workers int, oneFS bool,
|
workers int, oneFS bool,
|
||||||
) (scanStats, error) {
|
) (scanStats, error) {
|
||||||
@@ -237,7 +244,12 @@ func syncScan(ctx context.Context, db *sql.DB, roots []string,
|
|||||||
return s.st, err
|
return s.st, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return s.st, s.updatePhase(ctx)
|
err = s.updatePhase(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return s.st, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return s.st, s.contentPhase(ctx, workers)
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadIndex indexes the database records under the scan roots for
|
// loadIndex indexes the database records under the scan roots for
|
||||||
@@ -271,7 +283,8 @@ func (s *scanState) loadIndex(ctx context.Context, roots []string) error {
|
|||||||
|
|
||||||
// walkPhase drains the walk, appending every walked file's size to
|
// walkPhase drains the walk, appending every walked file's size to
|
||||||
// the census and resolving what it can immediately: an unchanged file
|
// the census and resolving what it can immediately: an unchanged file
|
||||||
// whose record already has hashes needs nothing further. It returns
|
// whose record already has hashes needs nothing from the hash phase
|
||||||
|
// (the content phase may still fill in its content hash). It returns
|
||||||
// the new-or-changed files and the unchanged files whose records lack
|
// the new-or-changed files and the unchanged files whose records lack
|
||||||
// hashes; both remain candidates until the census decides whether
|
// hashes; both remain candidates until the census decides whether
|
||||||
// their sizes are shared.
|
// their sizes are shared.
|
||||||
@@ -410,27 +423,40 @@ func sameInode(a, b fileRec) bool {
|
|||||||
return (a.dev != 0 || a.ino != 0) && a.dev == b.dev && a.ino == b.ino
|
return (a.dev != 0 || a.ino != 0) && a.dev == b.dev && a.ino == b.ino
|
||||||
}
|
}
|
||||||
|
|
||||||
// hashPhase hashes every queued file with the worker pool — one read
|
// hashPhase hashes every queued file with hashSignature — the head and
|
||||||
// per inode run, in inode order — committing completed records to the
|
// tail of a file of headTailMin or more, the whole file below that —
|
||||||
// database in batches as results arrive, so a long scan persists its
|
// committing completed records to the database in batches as results
|
||||||
// progress as it goes (an interrupted scan resumes cheaply: the next
|
// arrive, so a long scan persists its progress as it goes (an
|
||||||
// run skips everything already recorded). The total counts actual
|
// interrupted scan resumes cheaply: the next run skips everything
|
||||||
// reads, so the bar shows a real ETA. A run that fails to hash is
|
// already recorded). A run that fails to hash is warned about and
|
||||||
// warned about and skipped; stale records for its paths, if any, are
|
// skipped; stale records for its paths, if any, are deleted by the
|
||||||
// deleted by the update phase.
|
// update phase.
|
||||||
|
func (s *scanState) hashPhase(ctx context.Context, workers int) error {
|
||||||
|
runs := hashRuns(s.toHash)
|
||||||
|
s.toHash = nil
|
||||||
|
|
||||||
|
return s.readRuns(ctx, workers, "hash", runs, hashSignature, s.recordRun)
|
||||||
|
}
|
||||||
|
|
||||||
|
// readRuns reads runs with the worker pool, one read per inode run, in
|
||||||
|
// the order given, under a progress display named label. The workers
|
||||||
|
// compute each run's hashes with hash, and each result goes to record;
|
||||||
|
// a run that fails to read is warned about and counted as skipped
|
||||||
|
// instead. The total counts actual reads, so the bar shows a real ETA.
|
||||||
//
|
//
|
||||||
// Returning early — a failed database write, or a cancelled scan — must
|
// Returning early — a failed database write, or a cancelled scan — must
|
||||||
// not strand the pool: the feeder would park forever on a full jobs
|
// not strand the pool: the feeder would park forever on a full jobs
|
||||||
// channel and every worker on a full results channel. The deferred stop
|
// channel and every worker on a full results channel. The deferred stop
|
||||||
// is what prevents that.
|
// is what prevents that.
|
||||||
func (s *scanState) hashPhase(ctx context.Context, workers int) error {
|
func (s *scanState) readRuns(ctx context.Context, workers int,
|
||||||
runs := hashRuns(s.toHash)
|
label string, runs [][]fileRec,
|
||||||
s.toHash = nil
|
hash func(path string, size int64) (string, string, string, error),
|
||||||
|
record func(ctx context.Context, r hashResult) error,
|
||||||
pool := startHashPool(ctx, runs, workers)
|
) error {
|
||||||
|
pool := startHashPool(ctx, runs, workers, hash)
|
||||||
defer pool.stop()
|
defer pool.stop()
|
||||||
|
|
||||||
prog := newProgress("hash", int64(len(runs)))
|
prog := newProgress(label, int64(len(runs)))
|
||||||
defer prog.finish()
|
defer prog.finish()
|
||||||
|
|
||||||
for range runs {
|
for range runs {
|
||||||
@@ -447,12 +473,12 @@ func (s *scanState) hashPhase(ctx context.Context, workers int) error {
|
|||||||
if r.err != nil {
|
if r.err != nil {
|
||||||
s.st.skipped += len(r.run)
|
s.st.skipped += len(r.run)
|
||||||
|
|
||||||
prog.warnf("hash %s: %v", r.run[0].path, r.err)
|
prog.warnf("%s %s: %v", label, r.run[0].path, r.err)
|
||||||
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err := s.recordRun(ctx, r)
|
err := record(ctx, r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -478,6 +504,12 @@ func (s *scanState) recordRun(ctx context.Context, r hashResult) error {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return s.commitFullBatch(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// commitFullBatch commits the running batch once it holds
|
||||||
|
// updateBatchSize records.
|
||||||
|
func (s *scanState) commitFullBatch(ctx context.Context) error {
|
||||||
if len(s.batch) < updateBatchSize {
|
if len(s.batch) < updateBatchSize {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -535,6 +567,112 @@ func (s *scanState) updatePhase(ctx context.Context) error {
|
|||||||
return applyChanges(ctx, s.db, nil, deletes, prog)
|
return applyChanges(ctx, s.db, nil, deletes, prog)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// contentPhase fills in the content hash of every record of headTailMin
|
||||||
|
// or more that lacks one and whose size, head, and tail equal another
|
||||||
|
// record's, anywhere in the database: records from this scan and
|
||||||
|
// records stored by earlier scans, inside or outside the roots. Only
|
||||||
|
// such a file can still be a duplicate, so no other file of headTailMin
|
||||||
|
// or more is read beyond its end windows. The files are read with the
|
||||||
|
// hash phase's worker pool and their records written back in batches. A
|
||||||
|
// failed read is warned about and counted as skipped; the record keeps
|
||||||
|
// its empty content, so it is never grouped, and a later scan tries
|
||||||
|
// again.
|
||||||
|
func (s *scanState) contentPhase(ctx context.Context, workers int) error {
|
||||||
|
toRead, recs, err := contentCandidates(ctx, s.db)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = s.readRuns(ctx, workers, "content", hashRuns(toRead),
|
||||||
|
hashContentOnly, func(ctx context.Context, r hashResult) error {
|
||||||
|
// Every path in the run keeps its record's head and tail
|
||||||
|
// and gains the one content hash read for the run.
|
||||||
|
for _, f := range r.run {
|
||||||
|
rec := recs[f.path]
|
||||||
|
rec.content = r.content
|
||||||
|
s.batch = append(s.batch, rec)
|
||||||
|
}
|
||||||
|
|
||||||
|
return s.commitFullBatch(ctx)
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return applyChanges(ctx, s.db, s.batch, nil, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// contentCandidates returns the files the content phase reads, and the
|
||||||
|
// records of the files that passed the check, by path. Every record
|
||||||
|
// contentCandidatesSQL returns has its file checked with lstat: a file
|
||||||
|
// that is gone, is no longer a regular file, or has changed by the
|
||||||
|
// walk's rule keeps its record as it is and is not a duplicate. The
|
||||||
|
// files of a group that pass are read only if the group still has at
|
||||||
|
// least minGroupSize members, counting its records that already have a
|
||||||
|
// content hash, so a group whose other members are all stale costs no
|
||||||
|
// reads.
|
||||||
|
func contentCandidates(ctx context.Context,
|
||||||
|
db *sql.DB,
|
||||||
|
) ([]fileRec, map[string]scanRec, error) {
|
||||||
|
var (
|
||||||
|
toRead []fileRec
|
||||||
|
passed []fileRec // the current group's files that passed the check
|
||||||
|
first scanRec // the current group's first record
|
||||||
|
hashed int // the current group's records with a content hash
|
||||||
|
)
|
||||||
|
|
||||||
|
recs := make(map[string]scanRec)
|
||||||
|
|
||||||
|
// endGroup queues the current group's files that passed the check,
|
||||||
|
// if the group still has at least minGroupSize members.
|
||||||
|
endGroup := func() {
|
||||||
|
if len(passed)+hashed >= minGroupSize {
|
||||||
|
toRead = append(toRead, passed...)
|
||||||
|
}
|
||||||
|
|
||||||
|
passed = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
err := loadContentCandidates(ctx, db, func(r scanRec, groupHashed int) {
|
||||||
|
if r.size != first.size || r.head != first.head || r.tail != first.tail {
|
||||||
|
endGroup()
|
||||||
|
|
||||||
|
first, hashed = r, groupHashed
|
||||||
|
}
|
||||||
|
|
||||||
|
f, ok := unchangedFile(r)
|
||||||
|
if ok {
|
||||||
|
passed = append(passed, f)
|
||||||
|
recs[r.path] = r
|
||||||
|
}
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
endGroup()
|
||||||
|
|
||||||
|
return toRead, recs, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// unchangedFile lstats the file r names and returns it for reading if
|
||||||
|
// it is still the regular file r records: the same size, and an mtime
|
||||||
|
// no newer than recorded (the walk's change rule). Otherwise it
|
||||||
|
// reports false.
|
||||||
|
func unchangedFile(r scanRec) (fileRec, bool) {
|
||||||
|
fi, err := os.Lstat(r.path)
|
||||||
|
if err != nil || !fi.Mode().IsRegular() || fi.Size() != r.size ||
|
||||||
|
fi.ModTime().Unix() > r.mtime {
|
||||||
|
return fileRec{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
dev, ino := inodeOfInfo(fi)
|
||||||
|
|
||||||
|
return fileRec{
|
||||||
|
path: r.path, size: r.size, mtime: r.mtime, dev: dev, ino: ino,
|
||||||
|
}, true
|
||||||
|
}
|
||||||
|
|
||||||
// underAnyRoot reports whether path is any of the roots or lies under
|
// underAnyRoot reports whether path is any of the roots or lies under
|
||||||
// one of them.
|
// one of them.
|
||||||
func underAnyRoot(path string, roots []string) bool {
|
func underAnyRoot(path string, roots []string) bool {
|
||||||
@@ -865,9 +1003,10 @@ func inodeOfInfo(fi fs.FileInfo) (uint64, uint64) {
|
|||||||
return statDev(st), st.Ino
|
return statDev(st), st.Ino
|
||||||
}
|
}
|
||||||
|
|
||||||
// hashResult carries one inode run's signature hashes — head, tail, and
|
// hashResult carries the hashes computed for one inode run (or the
|
||||||
// content — (or the error that prevented hashing it) from the hash
|
// error that prevented computing them) from the pool's workers to the
|
||||||
// workers to the hash phase.
|
// phase that started the pool: head, tail, and content from
|
||||||
|
// hashSignature, content alone from hashContentOnly.
|
||||||
type hashResult struct {
|
type hashResult struct {
|
||||||
run []fileRec
|
run []fileRec
|
||||||
head string
|
head string
|
||||||
@@ -889,10 +1028,10 @@ type hashPool struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// startHashPool starts the feeder and the workers over runs. Workers
|
// startHashPool starts the feeder and the workers over runs. Workers
|
||||||
// hash each run's first path (all paths in a run are hard links to the
|
// hash each run's first path with hash (all paths in a run are hard
|
||||||
// same inode) and write one result per run.
|
// links to the same inode) and write one result per run.
|
||||||
func startHashPool(ctx context.Context, runs [][]fileRec,
|
func startHashPool(ctx context.Context, runs [][]fileRec, workers int,
|
||||||
workers int,
|
hash func(path string, size int64) (string, string, string, error),
|
||||||
) *hashPool {
|
) *hashPool {
|
||||||
ctx, cancel := context.WithCancel(ctx)
|
ctx, cancel := context.WithCancel(ctx)
|
||||||
|
|
||||||
@@ -904,7 +1043,7 @@ func startHashPool(ctx context.Context, runs [][]fileRec,
|
|||||||
wg.Go(func() { feedHashJobs(ctx, runs, jobs) })
|
wg.Go(func() { feedHashJobs(ctx, runs, jobs) })
|
||||||
|
|
||||||
for range workers {
|
for range workers {
|
||||||
wg.Go(func() { hashWorker(ctx, jobs, results) })
|
wg.Go(func() { hashWorker(ctx, jobs, results, hash) })
|
||||||
}
|
}
|
||||||
|
|
||||||
done := make(chan struct{})
|
done := make(chan struct{})
|
||||||
@@ -950,20 +1089,21 @@ func feedHashJobs(ctx context.Context, runs [][]fileRec,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// hashWorker hashes one inode run at a time until jobs is closed or the
|
// hashWorker hashes one inode run at a time with hash until jobs is
|
||||||
// scan is cancelled. A cancelled worker drops the runs still queued
|
// closed or the scan is cancelled. A cancelled worker drops the runs
|
||||||
// instead of stopping its reads of jobs: the range must run out for the
|
// still queued instead of stopping its reads of jobs: the range must
|
||||||
// pool to tear down, and reading a file nobody wants the hash of only
|
// run out for the pool to tear down, and reading a file nobody wants
|
||||||
// delays that.
|
// the hash of only delays that.
|
||||||
func hashWorker(ctx context.Context, jobs <-chan []fileRec,
|
func hashWorker(ctx context.Context, jobs <-chan []fileRec,
|
||||||
results chan<- hashResult,
|
results chan<- hashResult,
|
||||||
|
hash func(path string, size int64) (string, string, string, error),
|
||||||
) {
|
) {
|
||||||
for run := range jobs {
|
for run := range jobs {
|
||||||
if ctx.Err() != nil {
|
if ctx.Err() != nil {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
head, tail, content, err := hashSignature(run[0].path, run[0].size)
|
head, tail, content, err := hash(run[0].path, run[0].size)
|
||||||
|
|
||||||
select {
|
select {
|
||||||
case results <- hashResult{
|
case results <- hashResult{
|
||||||
@@ -980,18 +1120,18 @@ func hashWorker(ctx context.Context, jobs <-chan []fileRec,
|
|||||||
const emptyHash = "e3b0c44298fc1c149afbf4c8996fb924" +
|
const emptyHash = "e3b0c44298fc1c149afbf4c8996fb924" +
|
||||||
"27ae41e4649b934ca495991b7852b855"
|
"27ae41e4649b934ca495991b7852b855"
|
||||||
|
|
||||||
// hashSignature computes the three content hashes that, with the file
|
// hashSignature computes the hashes the hash phase records for a file
|
||||||
// size, form its duplicate signature. A file below headTailMin is
|
// whose size is shared; with the file size they form its duplicate
|
||||||
// hashed in full and its whole-file SHA-256 is returned as head, tail,
|
// signature. A file below headTailMin is hashed in full and its
|
||||||
// and content alike — that range takes no separate end-window step. For
|
// whole-file SHA-256 is returned as head, tail, and content alike —
|
||||||
// a file at or above headTailMin the head and tail are the SHA-256 of
|
// that range takes no separate end-window step. For a file at or above
|
||||||
// its first and last headTailWindow bytes, and content is the SHA-256
|
// headTailMin only the head and tail are computed, the SHA-256 of its
|
||||||
// of the whole file below wholeFileMax (the exact rung) or of
|
// first and last headTailWindow bytes, and content is returned empty:
|
||||||
// gigabyte-spaced samples at or above it (the sampled, deliberately
|
// the content phase computes it with hashContentOnly once the file's
|
||||||
// probabilistic rung). Two files are duplicates only when all four
|
// size, head, and tail match another file's. Two files are duplicates
|
||||||
// agree; any mismatch means not a duplicate. size is the value recorded
|
// only when all four agree; any mismatch means not a duplicate. size
|
||||||
// when the file was statted; a zero-length file has constant hashes and
|
// is the value recorded when the file was statted; a zero-length file
|
||||||
// is never opened.
|
// has constant hashes and is never opened.
|
||||||
func hashSignature(path string, size int64) (string, string, string, error) {
|
func hashSignature(path string, size int64) (string, string, string, error) {
|
||||||
if size == 0 {
|
if size == 0 {
|
||||||
return emptyHash, emptyHash, emptyHash, nil
|
return emptyHash, emptyHash, emptyHash, nil
|
||||||
@@ -1021,12 +1161,25 @@ func hashSignature(path string, size int64) (string, string, string, error) {
|
|||||||
return "", "", "", err
|
return "", "", "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
content, err := hashContent(f, size)
|
return head, tail, "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// hashContentOnly returns the content hash of the file at path, which
|
||||||
|
// is at least headTailMin bytes: the content phase's read. head and
|
||||||
|
// tail are returned empty, because the content phase keeps the ones its
|
||||||
|
// records already hold.
|
||||||
|
func hashContentOnly(path string, size int64) (string, string, string, error) {
|
||||||
|
//nolint:gosec // hashing operator-supplied paths is the tool's purpose
|
||||||
|
f, err := os.Open(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", "", "", err
|
return "", "", "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
return head, tail, content, nil
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
content, err := hashContent(f, size)
|
||||||
|
|
||||||
|
return "", "", content, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// hashEnds returns the SHA-256 of the first and last headTailWindow
|
// hashEnds returns the SHA-256 of the first and last headTailWindow
|
||||||
|
|||||||
+305
-43
@@ -106,6 +106,8 @@ func TestHashSignatureBelowThreshold(t *testing.T) {
|
|||||||
// difference in the last window changes only tail, and a difference
|
// difference in the last window changes only tail, and a difference
|
||||||
// between the windows changes neither end hash but does change the
|
// between the windows changes neither end hash but does change the
|
||||||
// whole-file content rung (the file is below wholeFileMax).
|
// whole-file content rung (the file is below wholeFileMax).
|
||||||
|
// hashSignature leaves the content hash of a file this size to the
|
||||||
|
// content phase, so that rung is checked through a scan.
|
||||||
func TestHashSignatureEnds(t *testing.T) {
|
func TestHashSignatureEnds(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -125,8 +127,11 @@ func TestHashSignatureEnds(t *testing.T) {
|
|||||||
pokeAt(t, midDiff, size/2, []byte{1})
|
pokeAt(t, midDiff, size/2, []byte{1})
|
||||||
|
|
||||||
bHead, bTail, bContent := sig(t, base, size)
|
bHead, bTail, bContent := sig(t, base, size)
|
||||||
|
if bContent != "" {
|
||||||
|
t.Errorf("content = %q, want none from the hash phase", bContent)
|
||||||
|
}
|
||||||
|
|
||||||
h, tl, c := sig(t, headDiff, size)
|
h, tl, _ := sig(t, headDiff, size)
|
||||||
if h == bHead {
|
if h == bHead {
|
||||||
t.Error("a byte in the first window did not change head")
|
t.Error("a byte in the first window did not change head")
|
||||||
}
|
}
|
||||||
@@ -135,11 +140,7 @@ func TestHashSignatureEnds(t *testing.T) {
|
|||||||
t.Error("a byte in the first window changed tail")
|
t.Error("a byte in the first window changed tail")
|
||||||
}
|
}
|
||||||
|
|
||||||
if c == bContent {
|
h, tl, _ = sig(t, tailDiff, size)
|
||||||
t.Error("a byte in the first window did not change content")
|
|
||||||
}
|
|
||||||
|
|
||||||
h, tl, c = sig(t, tailDiff, size)
|
|
||||||
if tl == bTail {
|
if tl == bTail {
|
||||||
t.Error("a byte in the last window did not change tail")
|
t.Error("a byte in the last window did not change tail")
|
||||||
}
|
}
|
||||||
@@ -148,16 +149,15 @@ func TestHashSignatureEnds(t *testing.T) {
|
|||||||
t.Error("a byte in the last window changed head")
|
t.Error("a byte in the last window changed head")
|
||||||
}
|
}
|
||||||
|
|
||||||
if c == bContent {
|
h, tl, _ = sig(t, midDiff, size)
|
||||||
t.Error("a byte in the last window did not change content")
|
|
||||||
}
|
|
||||||
|
|
||||||
h, tl, c = sig(t, midDiff, size)
|
|
||||||
if h != bHead || tl != bTail {
|
if h != bHead || tl != bTail {
|
||||||
t.Error("a byte between the windows changed an end hash")
|
t.Error("a byte between the windows changed an end hash")
|
||||||
}
|
}
|
||||||
|
|
||||||
if c == bContent {
|
// base and midDiff match on size, head, and tail, so the scan reads
|
||||||
|
// both for their content hashes.
|
||||||
|
c := scanContents(t, dir, base, midDiff)
|
||||||
|
if c[midDiff] == c[base] {
|
||||||
t.Error("whole-file content rung ignored a byte between the windows")
|
t.Error("whole-file content rung ignored a byte between the windows")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -246,19 +246,38 @@ func pokeAt(t *testing.T, path string, off int64, data []byte) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// contentHash returns just the content rung of a file's signature.
|
// scanContents scans dir into a fresh database and returns the content
|
||||||
func contentHash(t *testing.T, path string, size int64) string {
|
// hash recorded for each file, by path, failing the test if one of want
|
||||||
|
// has none. A file of headTailMin or more gets a content hash only when
|
||||||
|
// it is scanned with a file of the same size, head, and tail.
|
||||||
|
func scanContents(t *testing.T, dir string,
|
||||||
|
want ...string,
|
||||||
|
) map[string]string {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
_, _, content := sig(t, path, size)
|
db := openTestDB(t)
|
||||||
|
syncTree(t, db, dir)
|
||||||
|
|
||||||
return content
|
contents := make(map[string]string)
|
||||||
|
for _, r := range dbRecords(t, db) {
|
||||||
|
contents[r.path] = r.content
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, p := range want {
|
||||||
|
if contents[p] == "" {
|
||||||
|
t.Fatalf("%s: no content hash", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return contents
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestContentRungBoundary checks the 50 MiB boundary between the two
|
// TestContentRungBoundary checks the 50 MiB boundary between the two
|
||||||
// content rungs: just below it the whole file is hashed and any byte
|
// content rungs: just below it the whole file is hashed and any byte
|
||||||
// difference shows; at the boundary only the gigabyte-spaced samples are
|
// difference shows; at the boundary only the gigabyte-spaced samples are
|
||||||
// hashed, so a difference outside a sample window is invisible.
|
// hashed, so a difference outside a sample window is invisible. The
|
||||||
|
// files of each pair match on size, head, and tail, so the scan reads
|
||||||
|
// both for their content hashes.
|
||||||
func TestContentRungBoundary(t *testing.T) {
|
func TestContentRungBoundary(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -275,10 +294,6 @@ func TestContentRungBoundary(t *testing.T) {
|
|||||||
|
|
||||||
pokeAt(t, underPoked, off, []byte{1})
|
pokeAt(t, underPoked, off, []byte{1})
|
||||||
|
|
||||||
if contentHash(t, underBase, under) == contentHash(t, underPoked, under) {
|
|
||||||
t.Error("whole-file rung ignored a byte difference below wholeFileMax")
|
|
||||||
}
|
|
||||||
|
|
||||||
// At the boundary: only [0, sampleWindow) is sampled, so the poked
|
// At the boundary: only [0, sampleWindow) is sampled, so the poked
|
||||||
// byte at off is invisible and the two content hashes match.
|
// byte at off is invisible and the two content hashes match.
|
||||||
at := int64(wholeFileMax)
|
at := int64(wholeFileMax)
|
||||||
@@ -287,7 +302,13 @@ func TestContentRungBoundary(t *testing.T) {
|
|||||||
|
|
||||||
pokeAt(t, atPoked, off, []byte{1})
|
pokeAt(t, atPoked, off, []byte{1})
|
||||||
|
|
||||||
if contentHash(t, atBase, at) != contentHash(t, atPoked, at) {
|
c := scanContents(t, dir, underBase, underPoked, atBase, atPoked)
|
||||||
|
|
||||||
|
if c[underBase] == c[underPoked] {
|
||||||
|
t.Error("whole-file rung ignored a byte difference below wholeFileMax")
|
||||||
|
}
|
||||||
|
|
||||||
|
if c[atBase] != c[atPoked] {
|
||||||
t.Error("sampled rung saw a byte outside every sample window")
|
t.Error("sampled rung saw a byte outside every sample window")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -295,7 +316,8 @@ func TestContentRungBoundary(t *testing.T) {
|
|||||||
// TestContentRungMultiGigabyte exercises the sampled rung across several
|
// TestContentRungMultiGigabyte exercises the sampled rung across several
|
||||||
// gigabytes using sparse files: a difference inside the third sample
|
// gigabytes using sparse files: a difference inside the third sample
|
||||||
// window (at offset 2*sampleStride) changes the hash, while a difference
|
// window (at offset 2*sampleStride) changes the hash, while a difference
|
||||||
// in the gap after it does not.
|
// in the gap after it does not. The three files match on size, head,
|
||||||
|
// and tail, so the scan reads each for its content hash.
|
||||||
func TestContentRungMultiGigabyte(t *testing.T) {
|
func TestContentRungMultiGigabyte(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -314,17 +336,244 @@ func TestContentRungMultiGigabyte(t *testing.T) {
|
|||||||
pokeAt(t, inSample, thirdSample, []byte{1})
|
pokeAt(t, inSample, thirdSample, []byte{1})
|
||||||
pokeAt(t, inGap, gap, []byte{1})
|
pokeAt(t, inGap, gap, []byte{1})
|
||||||
|
|
||||||
baseHash := contentHash(t, base, size)
|
c := scanContents(t, dir, base, inSample, inGap)
|
||||||
|
|
||||||
if contentHash(t, inSample, size) == baseHash {
|
if c[inSample] == c[base] {
|
||||||
t.Error("sample at 2 GiB was not read: difference there was invisible")
|
t.Error("sample at 2 GiB was not read: difference there was invisible")
|
||||||
}
|
}
|
||||||
|
|
||||||
if contentHash(t, inGap, size) != baseHash {
|
if c[inGap] != c[base] {
|
||||||
t.Error("a byte in an unsampled gap changed the content hash")
|
t.Error("a byte in an unsampled gap changed the content hash")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// sparseFileWithoutMatch writes name in dir as a sparse file of size
|
||||||
|
// bytes, next to another file of that size whose first byte differs. A
|
||||||
|
// scan then reads the file's head and tail, since its size is shared,
|
||||||
|
// but finds no file matching them, so it gets no content hash.
|
||||||
|
func sparseFileWithoutMatch(t *testing.T, dir, name string,
|
||||||
|
size int64,
|
||||||
|
) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
p := sparseFile(t, dir, name, size)
|
||||||
|
other := sparseFile(t, dir, name+"-other-head", size)
|
||||||
|
|
||||||
|
pokeAt(t, other, 0, []byte{1})
|
||||||
|
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestScanContentGate checks that a file of headTailMin or more is read
|
||||||
|
// for its content hash only when its size, head, and tail match another
|
||||||
|
// file's: a same-size pair whose heads differ and one whose tails differ
|
||||||
|
// get no content hash and are not reported, while an identical pair is
|
||||||
|
// read and reported.
|
||||||
|
func TestScanContentGate(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
db := openTestDB(t)
|
||||||
|
|
||||||
|
// Three sizes, so that no pair meets another.
|
||||||
|
headA := sparseFile(t, dir, "head-a", headTailMin)
|
||||||
|
headB := sparseFile(t, dir, "head-b", headTailMin)
|
||||||
|
tailA := sparseFile(t, dir, "tail-a", headTailMin+1)
|
||||||
|
tailB := sparseFile(t, dir, "tail-b", headTailMin+1)
|
||||||
|
same := []string{
|
||||||
|
sparseFile(t, dir, "same-a", headTailMin+2),
|
||||||
|
sparseFile(t, dir, "same-b", headTailMin+2),
|
||||||
|
}
|
||||||
|
|
||||||
|
pokeAt(t, headB, 0, []byte{1})
|
||||||
|
pokeAt(t, tailB, headTailMin, []byte{1}) // its last byte
|
||||||
|
|
||||||
|
syncTree(t, db, dir)
|
||||||
|
|
||||||
|
recs := dbRecords(t, db)
|
||||||
|
for _, p := range []string{headA, headB, tailA, tailB} {
|
||||||
|
r := recordByPath(t, recs, p)
|
||||||
|
if r.head == "" || r.tail == "" || r.content != "" {
|
||||||
|
t.Errorf("%s: head = %q tail = %q content = %q, "+
|
||||||
|
"want head and tail only", p, r.head, r.tail, r.content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
groups := collectDupeGroups(recs)
|
||||||
|
if len(groups) != 1 || !slices.Equal(groups[0].paths, same) {
|
||||||
|
t.Fatalf("groups = %+v, want only the identical pair %q",
|
||||||
|
groups, same)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestScanContentAcrossOperands checks that a stored file gets its
|
||||||
|
// content hash when a later scan of a separate operand brings its
|
||||||
|
// match: tree A's file has a head and tail but no content hash until
|
||||||
|
// tree B, holding an identical file, is scanned.
|
||||||
|
func TestScanContentAcrossOperands(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := openTestDB(t)
|
||||||
|
a := sparseFileWithoutMatch(t, t.TempDir(), "a", headTailMin)
|
||||||
|
|
||||||
|
syncTree(t, db, filepath.Dir(a))
|
||||||
|
|
||||||
|
if r := recordByPath(t, dbRecords(t, db), a); r.head == "" || r.content != "" {
|
||||||
|
t.Fatalf("after scanning A: %+v, want head and tail only", r)
|
||||||
|
}
|
||||||
|
|
||||||
|
b := sparseFile(t, t.TempDir(), "b", headTailMin)
|
||||||
|
|
||||||
|
syncTree(t, db, filepath.Dir(b))
|
||||||
|
|
||||||
|
recs := dbRecords(t, db)
|
||||||
|
if r := recordByPath(t, recs, a); r.content == "" {
|
||||||
|
t.Fatalf("after scanning B: %+v, want A's file content-hashed", r)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := []string{a, b}
|
||||||
|
slices.Sort(want)
|
||||||
|
|
||||||
|
groups := collectDupeGroups(recs)
|
||||||
|
if len(groups) != 1 || !slices.Equal(groups[0].paths, want) {
|
||||||
|
t.Fatalf("groups = %+v, want the pair %q", groups, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestScanContentWithinOperand checks that a rescan adding a match next
|
||||||
|
// to an unchanged stored file gives the stored file its content hash,
|
||||||
|
// though the hash phase leaves it alone as unchanged.
|
||||||
|
func TestScanContentWithinOperand(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
db := openTestDB(t)
|
||||||
|
stored := sparseFileWithoutMatch(t, dir, "d1", headTailMin)
|
||||||
|
|
||||||
|
syncTree(t, db, dir)
|
||||||
|
|
||||||
|
added := sparseFile(t, dir, "d2", headTailMin)
|
||||||
|
|
||||||
|
st := syncTree(t, db, dir)
|
||||||
|
if st != (scanStats{added: 1, unchanged: 2}) {
|
||||||
|
t.Fatalf("rescan stats = %+v, want 1 added 2 unchanged", st)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := []string{stored, added}
|
||||||
|
|
||||||
|
groups := collectDupeGroups(dbRecords(t, db))
|
||||||
|
if len(groups) != 1 || !slices.Equal(groups[0].paths, want) {
|
||||||
|
t.Fatalf("groups = %+v, want the pair %q", groups, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestScanContentStalePartners checks that a stored file outside the
|
||||||
|
// operand that has vanished, or changed, since it was recorded is not
|
||||||
|
// read, and that its match inside the operand is not read either: the
|
||||||
|
// match has no other partner left, so neither gets a content hash and
|
||||||
|
// no duplicate is reported.
|
||||||
|
func TestScanContentStalePartners(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := openTestDB(t)
|
||||||
|
dirA := t.TempDir()
|
||||||
|
gone := sparseFileWithoutMatch(t, dirA, "gone", headTailMin)
|
||||||
|
changed := sparseFileWithoutMatch(t, dirA, "changed", headTailMin+1)
|
||||||
|
|
||||||
|
syncTree(t, db, dirA)
|
||||||
|
|
||||||
|
before := dbRecords(t, db)
|
||||||
|
|
||||||
|
err := os.Remove(gone)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
future := time.Now().Add(time.Hour)
|
||||||
|
|
||||||
|
err = os.Chtimes(changed, future, future)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
dirB := t.TempDir()
|
||||||
|
sparseFile(t, dirB, "gone-copy", headTailMin)
|
||||||
|
sparseFile(t, dirB, "changed-copy", headTailMin+1)
|
||||||
|
|
||||||
|
st := syncTree(t, db, dirB)
|
||||||
|
if st != (scanStats{added: 2}) {
|
||||||
|
t.Errorf("stats = %+v, want 2 added and nothing skipped", st)
|
||||||
|
}
|
||||||
|
|
||||||
|
recs := dbRecords(t, db)
|
||||||
|
for _, r := range recs {
|
||||||
|
if r.content != "" {
|
||||||
|
t.Errorf("%s: content = %q, want none: its only match is stale",
|
||||||
|
r.path, r.content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, old := range before {
|
||||||
|
if r := recordByPath(t, recs, old.path); r != old {
|
||||||
|
t.Errorf("record = %+v, want it left as %+v", r, old)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if groups := collectDupeGroups(recs); len(groups) != 0 {
|
||||||
|
t.Errorf("groups = %+v, want none", groups)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestScanContentReadFailure checks that a failed content read is
|
||||||
|
// counted as skipped and leaves the record without a content hash, and
|
||||||
|
// that a later scan tries the read again.
|
||||||
|
func TestScanContentReadFailure(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
db := openTestDB(t)
|
||||||
|
a := sparseFileWithoutMatch(t, t.TempDir(), "a", headTailMin)
|
||||||
|
|
||||||
|
syncTree(t, db, filepath.Dir(a))
|
||||||
|
|
||||||
|
// lstat still works on the unreadable file, so it passes the check
|
||||||
|
// and fails only when it is read.
|
||||||
|
err := os.Chmod(a, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
dirB := t.TempDir()
|
||||||
|
b := sparseFile(t, dirB, "b", headTailMin)
|
||||||
|
|
||||||
|
st := syncTree(t, db, dirB)
|
||||||
|
if st != (scanStats{added: 1, skipped: 1}) {
|
||||||
|
t.Fatalf("stats = %+v, want 1 added 1 skipped", st)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r := recordByPath(t, dbRecords(t, db), a); r.content != "" {
|
||||||
|
t.Fatalf("unreadable file: %+v, want no content hash", r)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = os.Chmod(a, 0o600)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
st = syncTree(t, db, dirB)
|
||||||
|
if st != (scanStats{unchanged: 1}) {
|
||||||
|
t.Fatalf("rescan stats = %+v, want 1 unchanged", st)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := []string{a, b}
|
||||||
|
slices.Sort(want)
|
||||||
|
|
||||||
|
groups := collectDupeGroups(dbRecords(t, db))
|
||||||
|
if len(groups) != 1 || !slices.Equal(groups[0].paths, want) {
|
||||||
|
t.Fatalf("groups = %+v, want the pair %q after the retry",
|
||||||
|
groups, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// collectWalk runs a walk over roots and returns the emitted records
|
// collectWalk runs a walk over roots and returns the emitted records
|
||||||
// and the number of warning events.
|
// and the number of warning events.
|
||||||
func collectWalk(t *testing.T, roots []string, oneFS bool,
|
func collectWalk(t *testing.T, roots []string, oneFS bool,
|
||||||
@@ -910,9 +1159,9 @@ func TestScanSkipsUniqueSizes(t *testing.T) {
|
|||||||
|
|
||||||
recs := dbRecords(t, db)
|
recs := dbRecords(t, db)
|
||||||
for _, r := range recs {
|
for _, r := range recs {
|
||||||
if r.head != "" || r.tail != "" {
|
if r.head != "" || r.tail != "" || r.content != "" {
|
||||||
t.Errorf("%s: head = %q tail = %q, want unhashed",
|
t.Errorf("%s: head = %q tail = %q content = %q, want unhashed",
|
||||||
r.path, r.head, r.tail)
|
r.path, r.head, r.tail, r.content)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -944,23 +1193,36 @@ func TestScanSkipsUniqueSizes(t *testing.T) {
|
|||||||
func TestTreesUnhashedNeverEqual(t *testing.T) {
|
func TestTreesUnhashedNeverEqual(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
// Two trees identical except for unhashed same-name, same-size
|
// Two trees identical except for same-name, same-size files without
|
||||||
// files (possible when the trees were scanned separately) must not
|
// a content hash must not compare equal: their content is unknown.
|
||||||
// compare equal: unhashed content is unknown.
|
// That holds for unhashed files (possible when the trees were
|
||||||
shared := pattern(1, 100)
|
// scanned separately) and for files of headTailMin or more that
|
||||||
recs := []scanRec{
|
// have only a head and tail.
|
||||||
{path: "/x/t1/f1", size: 100, head: hexSum(shared), tail: hexSum(shared)},
|
sum := hexSum(pattern(1, 100))
|
||||||
{path: "/x/t2/f1", size: 100, head: hexSum(shared), tail: hexSum(shared)},
|
shared := []scanRec{
|
||||||
{path: "/x/t1/u", size: 50},
|
{path: "/x/t1/f1", size: 100, head: sum, tail: sum, content: sum},
|
||||||
{path: "/x/t2/u", size: 50},
|
{path: "/x/t2/f1", size: 100, head: sum, tail: sum, content: sum},
|
||||||
}
|
}
|
||||||
|
|
||||||
super, dirs := buildHierarchy(recs)
|
cases := map[string][]scanRec{
|
||||||
super.compute()
|
"unhashed": {
|
||||||
|
{path: "/x/t1/u", size: 50},
|
||||||
|
{path: "/x/t2/u", size: 50},
|
||||||
|
},
|
||||||
|
"head and tail only": {
|
||||||
|
{path: "/x/t1/u", size: headTailMin, head: "h", tail: "t"},
|
||||||
|
{path: "/x/t2/u", size: headTailMin, head: "h", tail: "t"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
if tg := collectTreeGroups(dirs, super); len(tg) != 0 {
|
for name, unknown := range cases {
|
||||||
t.Fatalf("tree groups = %d, want 0 (unhashed files differ)",
|
super, dirs := buildHierarchy(append(slices.Clone(shared), unknown...))
|
||||||
len(tg))
|
super.compute()
|
||||||
|
|
||||||
|
if tg := collectTreeGroups(dirs, super); len(tg) != 0 {
|
||||||
|
t.Errorf("%s: tree groups = %d, want 0 (the files may differ)",
|
||||||
|
name, len(tg))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -127,12 +127,14 @@ func buildHierarchy(recs []scanRec) (*treeNode, []*treeNode) {
|
|||||||
size: r.size, head: r.head, tail: r.tail, content: r.content,
|
size: r.size, head: r.head, tail: r.tail, content: r.content,
|
||||||
}
|
}
|
||||||
|
|
||||||
// An unhashed record (its size was unique when last scanned)
|
// A record without a content hash (its size was unique when
|
||||||
// has unknown content: give it a signature no other file can
|
// last scanned, or it is headTailMin or more and has not yet
|
||||||
// share, so trees containing it never compare equal. Real
|
// matched another record on size, head, and tail) has unknown
|
||||||
// heads are hex, so the NUL-prefixed form cannot collide.
|
// content: give it a signature no other file can share, so
|
||||||
if sig.head == "" {
|
// trees containing it never compare equal. Real hashes are
|
||||||
sig.head = "unhashed\x00" + r.path
|
// hex, so the NUL-prefixed form cannot collide.
|
||||||
|
if sig.content == "" {
|
||||||
|
sig.content = "unhashed\x00" + r.path
|
||||||
}
|
}
|
||||||
|
|
||||||
node.files[comps[len(comps)-1]] = sig
|
node.files[comps[len(comps)-1]] = sig
|
||||||
|
|||||||
+20
-17
@@ -7,22 +7,25 @@ import (
|
|||||||
|
|
||||||
// Signature hashes shared by the smoke-test records.
|
// Signature hashes shared by the smoke-test records.
|
||||||
const (
|
const (
|
||||||
f1Head = "f1h"
|
f1Head = "f1h"
|
||||||
f1Tail = "f1t"
|
f1Tail = "f1t"
|
||||||
f2Head = "f2h"
|
f1Content = "f1c"
|
||||||
f2Tail = "f2t"
|
f2Head = "f2h"
|
||||||
|
f2Tail = "f2t"
|
||||||
|
f2Content = "f2c"
|
||||||
)
|
)
|
||||||
|
|
||||||
// smokeTreeRecs mirrors the README smoke-test tree layout: /d/t1 and
|
// smokeTreeRecs mirrors the README smoke-test tree layout: /d/t1 and
|
||||||
// /d/t2 are identical, /d/t3 differs from them only by one filename.
|
// /d/t2 are identical, /d/t3 differs from them only by one filename.
|
||||||
func smokeTreeRecs() []scanRec {
|
func smokeTreeRecs() []scanRec {
|
||||||
return []scanRec{
|
return []scanRec{
|
||||||
{size: 3000, head: f1Head, tail: f1Tail, path: "/d/t1/f1"},
|
{size: 3000, head: f1Head, tail: f1Tail, content: f1Content, path: "/d/t1/f1"},
|
||||||
{size: 100, head: f2Head, tail: f2Tail, path: "/d/t1/sub/f2"},
|
{size: 100, head: f2Head, tail: f2Tail, content: f2Content, path: "/d/t1/sub/f2"},
|
||||||
{size: 3000, head: f1Head, tail: f1Tail, path: "/d/t2/f1"},
|
{size: 3000, head: f1Head, tail: f1Tail, content: f1Content, path: "/d/t2/f1"},
|
||||||
{size: 100, head: f2Head, tail: f2Tail, path: "/d/t2/sub/f2"},
|
{size: 100, head: f2Head, tail: f2Tail, content: f2Content, path: "/d/t2/sub/f2"},
|
||||||
{size: 3000, head: f1Head, tail: f1Tail, path: "/d/t3/f1"},
|
{size: 3000, head: f1Head, tail: f1Tail, content: f1Content, path: "/d/t3/f1"},
|
||||||
{size: 100, head: f2Head, tail: f2Tail, path: "/d/t3/sub/f2renamed"},
|
{size: 100, head: f2Head, tail: f2Tail, content: f2Content,
|
||||||
|
path: "/d/t3/sub/f2renamed"},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -114,8 +117,8 @@ func TestTreeDigestContentSensitivity(t *testing.T) {
|
|||||||
const sharedTail = "same"
|
const sharedTail = "same"
|
||||||
|
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 10, head: sharedTail, tail: sharedTail, path: "/r/a/f"},
|
{size: 10, head: sharedTail, tail: sharedTail, content: "c", path: "/r/a/f"},
|
||||||
{size: 10, head: "DIFF", tail: sharedTail, path: "/r/b/f"},
|
{size: 10, head: "DIFF", tail: sharedTail, content: "c", path: "/r/b/f"},
|
||||||
}
|
}
|
||||||
|
|
||||||
super, dirs := buildHierarchy(recs)
|
super, dirs := buildHierarchy(recs)
|
||||||
@@ -181,8 +184,8 @@ func TestCollectTreeGroupsSiblings(t *testing.T) {
|
|||||||
// Identical sibling dirs share a parent, so their group cannot be
|
// Identical sibling dirs share a parent, so their group cannot be
|
||||||
// implied by a parent group and must be reported.
|
// implied by a parent group and must be reported.
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 10, head: "h", tail: "t", path: "/p/x1/f"},
|
{size: 10, head: "h", tail: "t", content: "c", path: "/p/x1/f"},
|
||||||
{size: 10, head: "h", tail: "t", path: "/p/x2/f"},
|
{size: 10, head: "h", tail: "t", content: "c", path: "/p/x2/f"},
|
||||||
}
|
}
|
||||||
|
|
||||||
super, dirs := buildHierarchy(recs)
|
super, dirs := buildHierarchy(recs)
|
||||||
@@ -203,9 +206,9 @@ func TestCollectTreeGroupsDifferingParents(t *testing.T) {
|
|||||||
// extra file, so the parents' digests differ and the x group must
|
// extra file, so the parents' digests differ and the x group must
|
||||||
// be reported.
|
// be reported.
|
||||||
recs := []scanRec{
|
recs := []scanRec{
|
||||||
{size: 10, head: "h", tail: "t", path: "/p/a/x/f"},
|
{size: 10, head: "h", tail: "t", content: "c", path: "/p/a/x/f"},
|
||||||
{size: 99, head: "e", tail: "e", path: "/p/a/extra"},
|
{size: 99, head: "e", tail: "e", content: "e", path: "/p/a/extra"},
|
||||||
{size: 10, head: "h", tail: "t", path: "/q/b/x/f"},
|
{size: 10, head: "h", tail: "t", content: "c", path: "/q/b/x/f"},
|
||||||
}
|
}
|
||||||
|
|
||||||
super, dirs := buildHierarchy(recs)
|
super, dirs := buildHierarchy(recs)
|
||||||
|
|||||||
Reference in New Issue
Block a user