File: duperemove.8

package info (click to toggle)
duperemove 0.11.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 844 kB
  • sloc: ansic: 11,586; makefile: 110
file content (411 lines) | stat: -rw-r--r-- 16,018 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
.TH "duperemove" "8" "September 2016" "Version 0.11"
.SH "NAME"
duperemove \- Find duplicate extents and print them to stdout
.SH "SYNOPSIS"
\fBduperemove\fR \fI[options]\fR \fIfiles...\fI
.SH "DESCRIPTION"
.PP
\fBduperemove\fR is a simple tool for finding duplicated extents and
submitting them for deduplication. When given a list of files it will
hash the contents of their extents and compare those hashes to each
other, finding and categorizing extents that match each other. When
given the \fB-d\fR option, \fBduperemove\fR will submit those extents
for deduplication using the Linux kernel extent-same ioctl.

\fBduperemove\fR can store the hashes it computes in a \fIhashfile\fR. If
given an existing hashfile, \fBduperemove\fR will only compute hashes
for those files which have changed since the last run.  Thus you can run
\fBduperemove\fR repeatedly on your data as it changes, without having to
re-checksum unchanged data.  For more on hashfiles see the
\fB--hashfile\fR option below as well as the \fIExamples\fR section.

\fBduperemove\fR can also take input from the \fBfdupes\fR program, see the
\fB--fdupes\fR option below.

.SH "GENERAL"
Duperemove has two major modes of operation one of which is a subset
of the other.

.SS "Readonly / Non-deduplicating Mode"

When run without \fB-d\fR (the default) duperemove will print out one or
more tables of matching extents it has determined would be ideal
candidates for deduplication. As a result, readonly mode is useful for
seeing what duperemove might do when run with \fB-d\fR.

Generally, duperemove does not concern itself with the underlying
representation of the extents it processes. Some of them could be
compressed, undergoing I/O, or even have already been deduplicated. In
dedupe mode, the kernel handles those details and therefore we try not
to replicate that work.

.SS "Deduping Mode"

This functions similarly to readonly mode with the exception that the
duplicated extents found in our "read, hash, and compare" step will
actually be submitted for deduplication. Extents that have already
been deduped will be skipped. An estimate of the total data
deduplicated will be printed after the operation is complete. This
estimate is calculated by comparing the total amount of shared bytes
in each file before and after the dedupe.

.SH "OPTIONS"
\fIfiles\fR can refer to a list of regular files and directories or be
a hyphen (-) to read them from standard input.
If a directory is specified, all regular files within it will also be
scanned. Duperemove can also be told to recursively scan directories with
the '-r' switch.

.TP
\fB\-r\fR
Enable recursive dir traversal.

.TP
\fB\-d\fR
De-dupe the results - only works on \fIbtrfs\fR and \fIxfs\FR.

.TP
\fB\-A\fR
Opens files readonly when deduping. Primarily for use by privileged
users on readonly snapshots.

.TP
\fB\-h\fR
Print numbers in human-readable format.

.TP
\fB\-q\fR
Quiet mode. Duperemove will only print errors and a short summary of any dedupe.

.TP
\fB\--hashfile=hashfile\fR
Use a file for storage of hashes instead of memory. This option drastically
reduces the memory footprint of duperemove and is recommended when your data
set is more than a few files large.  \fIHashfiles\fR are also reusable,
allowing you to further reduce the amount of hashing done on subsequent
dedupe runs.

If \fIhashfile\fR does not exist it will be created.  If it exists,
\fBduperemove\fR will check the file paths stored inside of it for changes.
Files which have changed will be rescanned and their updated hashes will be
written to the \fIhashfile\fR.  Deleted files will be removed from the \fIhashfile\fR.

New files are only added to the \fIhashfile\fR if they are discoverable via
the \fIfiles\fR argument.  For that reason you probably want to provide the
same \fIfiles\fR list and \fB-r\fR arguments on each run of
\fBduperemove\fR.  The file discovery algorithm is efficient and will only
visit each file once, even if it is already in the \fIhashfile\fR.

Adding a new path to a hashfile is as simple as adding it to the \fIfiles\fR
argument.

When deduping from a hashfile, duperemove will avoid deduping files which
have not changed since the last dedupe.

.TP
\fB\-L\fR
Print all files in the hashfile and exit. Requires the \fB\--hashfile\fR option.
Will print additional information about each file when run with \fB\-v\fR.

.TP
\fB\-R [file]\fR
Remove file from the db and exit. Can be specified multiple
times. Duperemove will read the list from standard input if a hyphen
(-) is provided. Requires the \fB\--hashfile\fR option.

\fBNote:\fR If you are piping filenames from another duperemove instance it
is advisable to do so into a temporary file first as running duperemove
simultaneously on the same hashfile may corrupt that hashfile.

.TP
\fB\--fdupes\fR
Run in \fBfdupes\fR mode. With this option you can pipe the output of
\fBfdupes\fR to duperemove to dedupe any duplicate files found. When
receiving a file list in this manner, duperemove will skip the hashing phase.

.TP
\fB\-v\fR
Be verbose.

.TP
\fB\--skip-zeroes\fR
Read data blocks and skip any zeroed blocks, useful for speedup duperemove,
but can prevent deduplication of zeroed files.

.TP
\fB\-b size\fR
Use the specified block size for reading file extents. Defaults to 128K.

.TP
\fB\--io-threads=N\fR
Use N threads for I/O. This is used by the file hashing and dedupe
stages. Default is automatically detected based on number of
host cpus.

.TP
\fB\--cpu-threads=N\fR
Use N threads for CPU bound tasks. This is used by the duplicate
extent finding stage. Default is automatically detected based on
number of host cpus.

\fBNote:\fR Hyperthreading can adversely affect performance of the
extent finding stage. If duperemove detects an Intel CPU with
hyperthreading it will use half the number of cores reported by the
system for cpu bound tasks.

.TP
\fB\--dedupe-options=\fR\fIoptions\fR
Comma separated list of options which alter how we dedupe. Prepend 'no' to an
option in order to turn it off.
.RS
.TP
\fB[no]partial\fR
Duperemove can often find more dedupe by comparing portions of extents
to each other. This can be a lengthy, CPU intensive task so it is
turned off by default.

The code behind this option is under active development and as a
result the semantics of the \fIpartial\fR argument may change.

.TP
\fB[no]same\fR
Defaults to \fBoff\fR. Allow dedupe of extents within the same
file.
.TP
\fB[no]fiemap\fR
Defaults to \fBon\fR. Duperemove uses the \fIfiemap\fR ioctl during
the dedupe stage to optimize out already deduped extents as well as to
provide an estimate of the space saved after dedupe operations are
complete.

Unfortunately, some versions of Btrfs exhibit extremely poor
performance in fiemap as the number of references on a file extent
goes up. If you are experiencing the dedupe phase slowing down
or 'locking up' this option may give you a significant amount of
performance back.

\fBNote:\fR This does not turn off all usage of fiemap, to disable
fiemap during the file scan stage, you will also want to use the
\fB--lookup-extents=no\fR option.
.TP
\fB[no]block\fR
Deprecated.
.RE

.TP
\fB\--help\fR
Prints help text.

.TP
\fB\--lookup-extents=[yes|no]\fR
Defaults to \fByes\fR. Allows duperemove to skip checksumming some blocks by
checking their extent state.

.TP
\fB\--read-hashes=hashfile\fR
\fB\This option is primarily for testing.\fR See the \fB--hashfile\fR option if you want to use hashfiles.

Read hashes from a hashfile. A file list is not required with this
option. Dedupe can be done if duperemove is run from the same base
directory as is stored in the hash file (basically duperemove has to
be able to find the files).

.TP
\fB\--write-hashes=hashfile\fR
\fB\This option is primarily for testing.\fR See the \fB--hashfile\fR option if you want to use hashfiles.

Write hashes to a hashfile. These can be read in at a later date and
deduped from.

.TP
\fB\--debug\fR
Print debug messages, forces \fB-v\fR if selected.

.TP
\fB\--hash-threads=N\fR
Deprecated, see \fB--io-threads\fR above.

.TP
\fB\--hash=alg\fR
You can choose between murmur3 and xxhash. The default is murmur3 as
it is very fast and can generate 128 bit digests for a very small
chance of collision. Xxhash may be faster but generates only 64 bit
digests. Both hashes are fast enough that the default should work well
for the overwhelming majority of users.

.TP
\fB\--exclude=PATTERN\fR
You an exclude certain files and folders from the deduplication process. This
might be benefical for skipping subvolume snapshot mounts, for instance. You
need to provide full path for exclusion. For example providing just a file name
with a wildcard i.e \fBduperemove --exclude file-*\fR won't ever match because internally
duperemove works with absolute paths. Another thing to keep in mind is that
shells usually expand glob pattern so the passed in pattern ought to also be
quoted. Taking everything into consideration the correct way to pass an exclusion
pattern is \fBduperemove --exclude "/path/to/dir/file*" /path/to/dir\fR

.SH "EXAMPLES"
.SS "Simple Usage"
Dedupe the files in directory /foo, recurse into all subdirectories. You only want to use this for small data sets.
.IP
duperemove -dr /foo
.PP
Use duperemove with fdupes to dedupe identical files below directory foo.
.IP
fdupes -r /foo | duperemove --fdupes

.SS "Using Hashfiles"
Duperemove can optionally store the hashes it calculates in a
hashfile. Hashfiles have two primary advantages - memory usage and
re-usability. When using a hashfile, duperemove will stream computed
hashes to it, instead of main memory.

If Duperemove is run with an existing hashfile, it will only scan
those files which have changed since the last time the hashfile was
updated. The \fIfiles\fR argument controls which directories
duperemove will scan for newly added files. In the simplest usage, you
rerun duperemove with the same parameters and it will only scan
changed or newly added files - see the first example below.

.PP
Dedupe the files in directory foo, storing hashes in foo.hash. We can
run this command multiple times and duperemove will only checksum and
dedupe changed or newly added files.
.IP
duperemove -dr --hashfile=foo.hash foo/
.PP
Don't scan for new files, only update changed or deleted files, then dedupe.
.IP
duperemove -dr --hashfile=foo.hash
.PP
Add directory bar to our hashfile and discover any files that were
recently added to foo.
.IP
duperemove -dr --hashfile=foo.hash foo/ bar/
.PP
List the files tracked by foo.hash.
.IP
duperemove -L --hashfile=foo.hash

.SH "FAQ"
.SS Is there an upper limit to the amount of data duperemove can process?

Duperemove v0.11 is fast at reading and cataloging data. Dedupe runs will be
memory limited unless the '--hashfile' option is used. '--hashfile' allows
duperemove to temporarily store duplicated hashes to disk, thus removing the
large memory overhead and allowing for a far larger amount of data to be
scanned and deduped. Realistically though you will be limited by the speed of
your disks and cpu. In those situations where resources are limited you may
have success by breaking up the input data set into smaller pieces.

When using a hashfile, duperemove will only store duplicate hashes in
memory. During normal operation then the hash tree will make up the
largest portion of duperemove memory usage. As of Duperemove v0.11
hash entries are 88 bytes in size. If you know the number of duplicate
blocks in your data set you can get a rough approximation of memory
usage by multiplying with the hash entry size.

Actual performance numbers are dependent on hardware - up to date
testing information is kept on the duperemove wiki (see below for the link).

.SS How large of a hashfile will duperemove create?

Hashfiles are essentially sqlite3 database files with several tables,
the largest of which are the files and extents tables. Each extents
table entry is about 72 bytes though that may grow as features are
added. The size of a files table entry depends on the file path but a
good estimate is around 270 bytes per file. The number of extents in a
data set is directly proportional to file fragmentation level.

If you know the total number of extents and files in your data set then
you can calculate the hashfile size as:

\fBHashfile Size = Num Hashes X 72 + Num Files X 270\fR

Using a real world example of 1TB (8388608 128K blocks) of data over 1000 files:

8388608 * 72 + 270 * 1000 = 755244720 or about \fB720MB for 1TB spread over 1000 files.\fR

\fBNote that none of this takes database overhead into account.\fR

.SS Is is safe to interrupt the program (Ctrl-C)?

Yes, Duperemove uses a transactional database engine and organizes db
changes to take advantage of those features. The result is that you
should be able to ctrl-c the program at any point and re-run without
experiencing corruption of your hashfile.

.SS I got two identical files, why are they not deduped?

Duperemove by default works on extent granularity. What this means is if there
are two files which are logically identical (have the same content) but are
laid out on disk with different extent structure they won't be deduped. For
example if 2 files are 128k each and their content are identical but one of
them consists of a single 128k extent and the other of 2 x 64k extents then
they won't be deduped. This behavior is dependent on the current implementation
and is subject to change as duperemove is being improved.

.SS How can I find out my space savings after a dedupe?

Duperemove will print out an estimate of the saved space after a
dedupe operation for you.

You can get a more accurate picture by running 'btrfs fi df' before
and after each duperemove run.

Be careful about using the 'df' tool on btrfs - it is common for space
reporting to be 'behind' while delayed updates get processed, so an
immediate df after deduping might not show any savings.

.SS Why is the total deduped data report an estimate?

At the moment duperemove can detect that some underlying extents are
shared with other files, but it can not resolve which files those
extents are shared with.

Imagine duperemove is examing a series of files and it notes a shared
data region in one of them. That data could be shared with a file
outside of the series. Since duperemove can't resolve that information
it will account the shared data against our dedupe operation while in
reality, the kernel might deduplicate it further for us.

.SS Why are my files showing dedupe but my disk space is not shrinking?

This is a little complicated, but it comes down to a feature in Btrfs
called _bookending_. The Btrfs wiki explains this in detail:
http://en.wikipedia.org/wiki/Btrfs#Extents.

Essentially though, the underlying representation of an extent in
Btrfs can not be split (with small exception). So sometimes we can end
up in a situation where a file extent gets partially deduped (and the
extents marked as shared) but the underlying extent item is not freed
or truncated.

.SS Is duperemove safe for my data?

Yes. To be specific, duperemove does not deduplicate the data itself.
It simply finds candidates for dedupe and submits them to the Linux
kernel extent-same ioctl. In order to ensure data integrity, the
kernel locks out other access to the file and does a byte-by-byte
compare before proceeding with the dedupe.

.SS What is the cost of deduplication?

Deduplication will lead to increased fragmentation. The blocksize
chosen can have an effect on this. Larger blocksizes will fragment
less but may not save you as much space. Conversely, smaller block
sizes may save more space at the cost of increased fragmentation.

.SH "NOTES"
Deduplication is currently only supported by the \fIbtrfs\fR and \fIxfs\fR filesystem.

The Duperemove project page can be found at https://github.com/markfasheh/duperemove

There is also a wiki at https://github.com/markfasheh/duperemove/wiki

.SH "SEE ALSO"
.BR hashstats(8)
.BR filesystems(5)
.BR btrfs(8)
.BR xfs(8)
.BR fdupes(1)