]>
Commit | Line | Data |
---|---|---|
d46a5499 KZ |
1 | /* |
2 | * fallocate - utility to use the fallocate system call | |
3 | * | |
4 | * Copyright (C) 2008-2009 Red Hat, Inc. All rights reserved. | |
5 | * Written by Eric Sandeen <sandeen@redhat.com> | |
6 | * Karel Zak <kzak@redhat.com> | |
7 | * | |
8 | * cvtnum routine taken from xfsprogs, | |
9 | * Copyright (c) 2003-2005 Silicon Graphics, Inc. | |
10 | * | |
11 | * This program is free software; you can redistribute it and/or | |
12 | * modify it under the terms of the GNU General Public License as | |
13 | * published by the Free Software Foundation. | |
14 | * | |
15 | * This program is distributed in the hope that it would be useful, | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | * GNU General Public License for more details. | |
19 | * | |
7cebf0bb SK |
20 | * You should have received a copy of the GNU General Public License along |
21 | * with this program; if not, write to the Free Software Foundation, Inc., | |
22 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
d46a5499 KZ |
23 | */ |
24 | #include <sys/stat.h> | |
25 | #include <sys/types.h> | |
24b2a479 | 26 | #include <sys/mman.h> |
d46a5499 KZ |
27 | #include <ctype.h> |
28 | #include <errno.h> | |
29 | #include <fcntl.h> | |
30 | #include <stdio.h> | |
31 | #include <stdlib.h> | |
32 | #include <unistd.h> | |
33 | #include <getopt.h> | |
6264af59 | 34 | #include <limits.h> |
24b2a479 | 35 | #include <string.h> |
d46a5499 KZ |
36 | |
37 | #ifndef HAVE_FALLOCATE | |
38 | # include <sys/syscall.h> | |
39 | #endif | |
40 | ||
bc5ddf0c | 41 | #if defined(HAVE_LINUX_FALLOC_H) && \ |
83cc932d | 42 | (!defined(FALLOC_FL_KEEP_SIZE) || !defined(FALLOC_FL_PUNCH_HOLE) || \ |
b4390656 FF |
43 | !defined(FALLOC_FL_COLLAPSE_RANGE) || !defined(FALLOC_FL_ZERO_RANGE) || \ |
44 | !defined(FALLOC_FL_INSERT_RANGE)) | |
bc5ddf0c | 45 | # include <linux/falloc.h> /* non-libc fallback for FALLOC_FL_* flags */ |
f75b8e5c KZ |
46 | #endif |
47 | ||
b7f3f147 | 48 | |
f75b8e5c | 49 | #ifndef FALLOC_FL_KEEP_SIZE |
1fd4f609 | 50 | # define FALLOC_FL_KEEP_SIZE 0x1 |
f75b8e5c KZ |
51 | #endif |
52 | ||
53 | #ifndef FALLOC_FL_PUNCH_HOLE | |
1fd4f609 | 54 | # define FALLOC_FL_PUNCH_HOLE 0x2 |
fac8b4bd | 55 | #endif |
d46a5499 | 56 | |
83cc932d | 57 | #ifndef FALLOC_FL_COLLAPSE_RANGE |
1fd4f609 LC |
58 | # define FALLOC_FL_COLLAPSE_RANGE 0x8 |
59 | #endif | |
60 | ||
61 | #ifndef FALLOC_FL_ZERO_RANGE | |
62 | # define FALLOC_FL_ZERO_RANGE 0x10 | |
83cc932d DP |
63 | #endif |
64 | ||
b4390656 FF |
65 | #ifndef FALLOC_FL_INSERT_RANGE |
66 | # define FALLOC_FL_INSERT_RANGE 0x20 | |
67 | #endif | |
68 | ||
d46a5499 | 69 | #include "nls.h" |
8abcf290 | 70 | #include "strutils.h" |
eb76ca98 | 71 | #include "c.h" |
efb8854f | 72 | #include "closestream.h" |
24b2a479 | 73 | #include "xalloc.h" |
b7f3f147 | 74 | #include "optutils.h" |
d46a5499 | 75 | |
782c290c KZ |
76 | static int verbose; |
77 | static char *filename; | |
78 | ||
86be6a32 | 79 | static void __attribute__((__noreturn__)) usage(void) |
d46a5499 | 80 | { |
86be6a32 | 81 | FILE *out = stdout; |
584aed6b | 82 | fputs(USAGE_HEADER, out); |
130bf041 KZ |
83 | fprintf(out, |
84 | _(" %s [options] <filename>\n"), program_invocation_short_name); | |
14c9b680 | 85 | |
451dbcfa BS |
86 | fputs(USAGE_SEPARATOR, out); |
87 | fputs(_("Preallocate space to, or deallocate space from a file.\n"), out); | |
88 | ||
89 | fputs(USAGE_OPTIONS, out); | |
14c9b680 PB |
90 | fputs(_(" -c, --collapse-range remove a range from the file\n"), out); |
91 | fputs(_(" -d, --dig-holes detect zeroes and replace with holes\n"), out); | |
b4390656 | 92 | fputs(_(" -i, --insert-range insert a hole at range, shifting existing data\n"), out); |
14c9b680 PB |
93 | fputs(_(" -l, --length <num> length for range operations, in bytes\n"), out); |
94 | fputs(_(" -n, --keep-size maintain the apparent size of the file\n"), out); | |
95 | fputs(_(" -o, --offset <num> offset for range operations, in bytes\n"), out); | |
96 | fputs(_(" -p, --punch-hole replace a range with a hole (implies -n)\n"), out); | |
97 | fputs(_(" -z, --zero-range zero and ensure allocation of a range\n"), out); | |
833f9a7a DC |
98 | #ifdef HAVE_POSIX_FALLOCATE |
99 | fputs(_(" -x, --posix use posix_fallocate(3) instead of fallocate(2)\n"), out); | |
100 | #endif | |
83cc932d | 101 | fputs(_(" -v, --verbose verbose mode\n"), out); |
782c290c | 102 | |
584aed6b | 103 | fputs(USAGE_SEPARATOR, out); |
f45f3ec3 | 104 | printf(USAGE_HELP_OPTIONS(22)); |
14c9b680 | 105 | |
f45f3ec3 | 106 | printf(USAGE_MAN_TAIL("fallocate(1)")); |
d46a5499 | 107 | |
86be6a32 | 108 | exit(EXIT_SUCCESS); |
d46a5499 KZ |
109 | } |
110 | ||
d46a5499 KZ |
111 | static loff_t cvtnum(char *s) |
112 | { | |
3b6b039a | 113 | uintmax_t x; |
6264af59 | 114 | |
3b6b039a | 115 | if (strtosize(s, &x)) |
d46a5499 | 116 | return -1LL; |
d46a5499 | 117 | |
3b6b039a | 118 | return x; |
d46a5499 KZ |
119 | } |
120 | ||
24b2a479 | 121 | static void xfallocate(int fd, int mode, off_t offset, off_t length) |
bcd9315d RC |
122 | { |
123 | int error; | |
562adaed | 124 | |
bcd9315d RC |
125 | #ifdef HAVE_FALLOCATE |
126 | error = fallocate(fd, mode, offset, length); | |
127 | #else | |
128 | error = syscall(SYS_fallocate, fd, mode, offset, length); | |
129 | #endif | |
130 | /* | |
131 | * EOPNOTSUPP: The FALLOC_FL_KEEP_SIZE is unsupported | |
132 | * ENOSYS: The filesystem does not support sys_fallocate | |
133 | */ | |
134 | if (error < 0) { | |
24b2a479 | 135 | if ((mode & FALLOC_FL_KEEP_SIZE) && errno == EOPNOTSUPP) |
049bfa06 | 136 | errx(EXIT_FAILURE, _("fallocate failed: keep size mode is unsupported")); |
24b2a479 RC |
137 | err(EXIT_FAILURE, _("fallocate failed")); |
138 | } | |
139 | } | |
140 | ||
833f9a7a DC |
141 | #ifdef HAVE_POSIX_FALLOCATE |
142 | static void xposix_fallocate(int fd, off_t offset, off_t length) | |
143 | { | |
144 | int error = posix_fallocate(fd, offset, length); | |
145 | if (error < 0) { | |
146 | err(EXIT_FAILURE, _("fallocate failed")); | |
147 | } | |
148 | } | |
149 | #endif | |
db5f00bc | 150 | |
4b01c5a1 KZ |
151 | /* The real buffer size has to be bufsize + sizeof(uintptr_t) */ |
152 | static int is_nul(void *buf, size_t bufsize) | |
c4172cc3 KZ |
153 | { |
154 | typedef uintptr_t word; | |
155 | void const *vp; | |
156 | char const *cbuf = buf, *cp; | |
157 | word const *wp = buf; | |
158 | ||
4b01c5a1 KZ |
159 | /* set sentinel */ |
160 | memset((char *) buf + bufsize, '\1', sizeof(word)); | |
161 | ||
c4172cc3 KZ |
162 | /* Find first nonzero *word*, or the word with the sentinel. */ |
163 | while (*wp++ == 0) | |
164 | continue; | |
165 | ||
166 | /* Find the first nonzero *byte*, or the sentinel. */ | |
167 | vp = wp - 1; | |
168 | cp = vp; | |
169 | ||
170 | while (*cp++ == 0) | |
171 | continue; | |
172 | ||
7ff635bf | 173 | return cbuf + bufsize < cp; |
c4172cc3 KZ |
174 | } |
175 | ||
173ef882 | 176 | static void dig_holes(int fd, off_t file_off, off_t len) |
24b2a479 | 177 | { |
173ef882 | 178 | off_t file_end = len ? file_off + len : 0; |
d6cecc3f KZ |
179 | off_t hole_start = 0, hole_sz = 0; |
180 | uintmax_t ct = 0; | |
0407c1be | 181 | size_t bufsz; |
c4172cc3 | 182 | char *buf; |
d6cecc3f | 183 | struct stat st; |
0407c1be | 184 | #if defined(POSIX_FADV_SEQUENTIAL) && defined(HAVE_POSIX_FADVISE) |
173ef882 | 185 | off_t cache_start = file_off; |
c12eff4c KZ |
186 | /* |
187 | * We don't want to call POSIX_FADV_DONTNEED to discard cached | |
188 | * data in PAGE_SIZE steps. IMHO it's overkill (too many syscalls). | |
189 | * | |
190 | * Let's assume that 1MiB (on system with 4K page size) is just | |
191 | * a good compromise. | |
192 | * -- kzak Feb-2014 | |
193 | */ | |
0407c1be SK |
194 | const size_t cachesz = getpagesize() * 256; |
195 | #endif | |
196 | ||
197 | if (fstat(fd, &st) != 0) | |
fc14ceba | 198 | err(EXIT_FAILURE, _("stat of %s failed"), filename); |
0407c1be SK |
199 | |
200 | bufsz = st.st_blksize; | |
c12eff4c | 201 | |
173ef882 | 202 | if (lseek(fd, file_off, SEEK_SET) < 0) |
d6cecc3f KZ |
203 | err(EXIT_FAILURE, _("seek on %s failed"), filename); |
204 | ||
4b01c5a1 KZ |
205 | /* buffer + extra space for is_nul() sentinel */ |
206 | buf = xmalloc(bufsz + sizeof(uintptr_t)); | |
173ef882 KZ |
207 | while (file_end == 0 || file_off < file_end) { |
208 | /* | |
09cb6b42 | 209 | * Detect data area (skip holes) |
173ef882 KZ |
210 | */ |
211 | off_t end, off; | |
212 | ||
213 | off = lseek(fd, file_off, SEEK_DATA); | |
214 | if ((off == -1 && errno == ENXIO) || | |
215 | (file_end && off >= file_end)) | |
216 | break; | |
217 | ||
218 | end = lseek(fd, off, SEEK_HOLE); | |
219 | if (file_end && end > file_end) | |
220 | end = file_end; | |
221 | ||
edf9c218 KZ |
222 | if (off < 0 || end < 0) |
223 | break; | |
224 | ||
c12eff4c | 225 | #if defined(POSIX_FADV_SEQUENTIAL) && defined(HAVE_POSIX_FADVISE) |
edf9c218 | 226 | (void) posix_fadvise(fd, off, end, POSIX_FADV_SEQUENTIAL); |
d6cecc3f | 227 | #endif |
173ef882 KZ |
228 | /* |
229 | * Dig holes in the area | |
230 | */ | |
231 | while (off < end) { | |
232 | ssize_t rsz = pread(fd, buf, bufsz, off); | |
233 | if (rsz < 0 && errno) | |
234 | err(EXIT_FAILURE, _("%s: read failed"), filename); | |
235 | if (end && rsz > 0 && off > end - rsz) | |
236 | rsz = end - off; | |
237 | if (rsz <= 0) | |
238 | break; | |
239 | ||
240 | if (is_nul(buf, rsz)) { | |
241 | if (!hole_sz) /* new hole detected */ | |
242 | hole_start = off; | |
243 | hole_sz += rsz; | |
244 | } else if (hole_sz) { | |
245 | xfallocate(fd, FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE, | |
246 | hole_start, hole_sz); | |
247 | ct += hole_sz; | |
248 | hole_sz = hole_start = 0; | |
249 | } | |
24b2a479 | 250 | |
173ef882 KZ |
251 | #if defined(POSIX_FADV_DONTNEED) && defined(HAVE_POSIX_FADVISE) |
252 | /* discard cached data */ | |
253 | if (off - cache_start > (off_t) cachesz) { | |
254 | size_t clen = off - cache_start; | |
24b2a479 | 255 | |
173ef882 | 256 | clen = (clen / cachesz) * cachesz; |
edf9c218 | 257 | (void) posix_fadvise(fd, cache_start, clen, POSIX_FADV_DONTNEED); |
173ef882 | 258 | cache_start = cache_start + clen; |
db5f00bc | 259 | } |
173ef882 KZ |
260 | #endif |
261 | off += rsz; | |
262 | } | |
263 | if (hole_sz) { | |
d6cecc3f | 264 | xfallocate(fd, FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE, |
173ef882 | 265 | hole_start, hole_sz); |
d6cecc3f | 266 | ct += hole_sz; |
d6cecc3f | 267 | } |
173ef882 | 268 | file_off = off; |
bcd9315d | 269 | } |
24b2a479 | 270 | |
24b2a479 | 271 | free(buf); |
d6cecc3f KZ |
272 | |
273 | if (verbose) { | |
274 | char *str = size_to_human_string(SIZE_SUFFIX_3LETTER | SIZE_SUFFIX_SPACE, ct); | |
275 | fprintf(stdout, _("%s: %s (%ju bytes) converted to sparse holes.\n"), | |
276 | filename, str, ct); | |
277 | free(str); | |
278 | } | |
bcd9315d RC |
279 | } |
280 | ||
d46a5499 KZ |
281 | int main(int argc, char **argv) |
282 | { | |
d46a5499 | 283 | int c; |
d46a5499 KZ |
284 | int fd; |
285 | int mode = 0; | |
d6cecc3f | 286 | int dig = 0; |
833f9a7a | 287 | int posix = 0; |
d46a5499 KZ |
288 | loff_t length = -2LL; |
289 | loff_t offset = 0; | |
290 | ||
6c7d5ae9 | 291 | static const struct option longopts[] = { |
87918040 SK |
292 | { "help", no_argument, NULL, 'h' }, |
293 | { "version", no_argument, NULL, 'V' }, | |
294 | { "keep-size", no_argument, NULL, 'n' }, | |
295 | { "punch-hole", no_argument, NULL, 'p' }, | |
296 | { "collapse-range", no_argument, NULL, 'c' }, | |
297 | { "dig-holes", no_argument, NULL, 'd' }, | |
298 | { "insert-range", no_argument, NULL, 'i' }, | |
299 | { "zero-range", no_argument, NULL, 'z' }, | |
300 | { "offset", required_argument, NULL, 'o' }, | |
301 | { "length", required_argument, NULL, 'l' }, | |
302 | { "posix", no_argument, NULL, 'x' }, | |
303 | { "verbose", no_argument, NULL, 'v' }, | |
304 | { NULL, 0, NULL, 0 } | |
d46a5499 KZ |
305 | }; |
306 | ||
a7349ee3 | 307 | static const ul_excl_t excl[] = { /* rows and cols in ASCII order */ |
b7f3f147 KZ |
308 | { 'c', 'd', 'p', 'z' }, |
309 | { 'c', 'n' }, | |
833f9a7a | 310 | { 'x', 'c', 'd', 'i', 'n', 'p', 'z'}, |
b7f3f147 KZ |
311 | { 0 } |
312 | }; | |
313 | int excl_st[ARRAY_SIZE(excl)] = UL_EXCL_STATUS_INIT; | |
314 | ||
d46a5499 KZ |
315 | setlocale(LC_ALL, ""); |
316 | bindtextdomain(PACKAGE, LOCALEDIR); | |
317 | textdomain(PACKAGE); | |
2c308875 | 318 | close_stdout_atexit(); |
d46a5499 | 319 | |
833f9a7a | 320 | while ((c = getopt_long(argc, argv, "hvVncpdizxl:o:", longopts, NULL)) |
83cc932d | 321 | != -1) { |
b7f3f147 KZ |
322 | |
323 | err_exclusive_options(c, longopts, excl, excl_st); | |
324 | ||
d46a5499 | 325 | switch(c) { |
83cc932d DP |
326 | case 'c': |
327 | mode |= FALLOC_FL_COLLAPSE_RANGE; | |
328 | break; | |
24b2a479 | 329 | case 'd': |
d6cecc3f | 330 | dig = 1; |
24b2a479 | 331 | break; |
b4390656 FF |
332 | case 'i': |
333 | mode |= FALLOC_FL_INSERT_RANGE; | |
334 | break; | |
d46a5499 KZ |
335 | case 'l': |
336 | length = cvtnum(optarg); | |
337 | break; | |
b7f3f147 KZ |
338 | case 'n': |
339 | mode |= FALLOC_FL_KEEP_SIZE; | |
340 | break; | |
d46a5499 KZ |
341 | case 'o': |
342 | offset = cvtnum(optarg); | |
343 | break; | |
b7f3f147 KZ |
344 | case 'p': |
345 | mode |= FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE; | |
346 | break; | |
347 | case 'z': | |
348 | mode |= FALLOC_FL_ZERO_RANGE; | |
349 | break; | |
833f9a7a DC |
350 | case 'x': |
351 | #ifdef HAVE_POSIX_FALLOCATE | |
352 | posix = 1; | |
353 | break; | |
354 | #else | |
f1a7cfcb | 355 | errx(EXIT_FAILURE, _("posix_fallocate support is not compiled")); |
833f9a7a | 356 | #endif |
782c290c KZ |
357 | case 'v': |
358 | verbose++; | |
359 | break; | |
2c308875 KZ |
360 | |
361 | case 'h': | |
362 | usage(); | |
b7f3f147 | 363 | case 'V': |
2c308875 | 364 | print_version(EXIT_SUCCESS); |
d46a5499 | 365 | default: |
677ec86c | 366 | errtryhelp(EXIT_FAILURE); |
d46a5499 KZ |
367 | } |
368 | } | |
38a5440c BV |
369 | |
370 | if (optind == argc) | |
1d231190 | 371 | errx(EXIT_FAILURE, _("no filename specified")); |
38a5440c BV |
372 | |
373 | filename = argv[optind++]; | |
374 | ||
375 | if (optind != argc) | |
376 | errx(EXIT_FAILURE, _("unexpected number of arguments")); | |
377 | ||
d6cecc3f | 378 | if (dig) { |
dac1cb53 | 379 | /* for --dig-holes the default is analyze all file */ |
d6cecc3f KZ |
380 | if (length == -2LL) |
381 | length = 0; | |
382 | if (length < 0) | |
383 | errx(EXIT_FAILURE, _("invalid length value specified")); | |
384 | } else { | |
dac1cb53 | 385 | /* it's safer to require the range specification (--length --offset) */ |
d6cecc3f KZ |
386 | if (length == -2LL) |
387 | errx(EXIT_FAILURE, _("no length argument specified")); | |
388 | if (length <= 0) | |
389 | errx(EXIT_FAILURE, _("invalid length value specified")); | |
390 | } | |
d46a5499 KZ |
391 | if (offset < 0) |
392 | errx(EXIT_FAILURE, _("invalid offset value specified")); | |
fd1ee3b9 | 393 | |
575718a0 KZ |
394 | /* O_CREAT makes sense only for the default fallocate(2) behavior |
395 | * when mode is no specified and new space is allocated */ | |
185aa9e5 KZ |
396 | fd = open(filename, O_RDWR | (!dig && !mode ? O_CREAT : 0), |
397 | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH); | |
d46a5499 | 398 | if (fd < 0) |
782c290c | 399 | err(EXIT_FAILURE, _("cannot open %s"), filename); |
d46a5499 | 400 | |
d6cecc3f KZ |
401 | if (dig) |
402 | dig_holes(fd, offset, length); | |
833f9a7a DC |
403 | #ifdef HAVE_POSIX_FALLOCATE |
404 | else if (posix) | |
405 | xposix_fallocate(fd, offset, length); | |
406 | #endif | |
d6cecc3f | 407 | else |
24b2a479 | 408 | xfallocate(fd, mode, offset, length); |
d46a5499 | 409 | |
5f52af50 | 410 | if (close_fd(fd) != 0) |
782c290c | 411 | err(EXIT_FAILURE, _("write failed: %s"), filename); |
24b2a479 | 412 | |
d46a5499 KZ |
413 | return EXIT_SUCCESS; |
414 | } |