]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - repair/xfs_repair.c
xfs_repair: enforce that inode btree chunks can't point to AG headers
[thirdparty/xfsprogs-dev.git] / repair / xfs_repair.c
CommitLineData
959ef981 1// SPDX-License-Identifier: GPL-2.0
2bd0ea18 2/*
da23017d
NS
3 * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
2bd0ea18
NS
5 */
6
6b803e5a
CH
7#include "libxfs.h"
8#include "libxlog.h"
12be365e 9#include <sys/resource.h>
4a32b9e9 10#include "xfs_multidisk.h"
2bd0ea18 11#include "avl.h"
b4a09f89 12#include "libfrog/avl64.h"
2bd0ea18
NS
13#include "globals.h"
14#include "versions.h"
15#include "agheader.h"
16#include "protos.h"
17#include "incore.h"
18#include "err_protos.h"
cb5b3ef4 19#include "prefetch.h"
3b6ac903 20#include "threads.h"
06fbdda9 21#include "progress.h"
beed0dc8 22#include "dinode.h"
9e0f480e
DW
23#include "slab.h"
24#include "rmap.h"
fee68490 25#include "libfrog/fsgeom.h"
b658de93 26#include "libfrog/platform.h"
2bd0ea18 27
2bd0ea18
NS
28/*
29 * option tables for getsubopt calls
30 */
31
32/*
4af916f8 33 * -o: user-supplied override options
2bd0ea18 34 */
98884b66
DW
35enum o_opt_nums {
36 ASSUME_XFS = 0,
37 IHASH_SIZE,
38 BHASH_SIZE,
39 AG_STRIDE,
40 FORCE_GEO,
41 PHASE2_THREADS,
42 O_MAX_OPTS,
43};
44
8b8a6b02 45static char *o_opts[] = {
98884b66
DW
46 [ASSUME_XFS] = "assume_xfs",
47 [IHASH_SIZE] = "ihash",
48 [BHASH_SIZE] = "bhash",
49 [AG_STRIDE] = "ag_stride",
50 [FORCE_GEO] = "force_geometry",
51 [PHASE2_THREADS] = "phase2_threads",
52 [O_MAX_OPTS] = NULL,
2bd0ea18
NS
53};
54
4af916f8
BN
55/*
56 * -c: conversion options
57 */
98884b66
DW
58enum c_opt_nums {
59 CONVERT_LAZY_COUNT = 0,
60 C_MAX_OPTS,
61};
62
8b8a6b02 63static char *c_opts[] = {
98884b66
DW
64 [CONVERT_LAZY_COUNT] = "lazycount",
65 [C_MAX_OPTS] = NULL,
4af916f8
BN
66};
67
68
2556c98b 69static int bhash_option_used;
12be365e 70static long max_mem_specified; /* in megabytes */
364a126c 71static int phase2_threads = 32;
7c3e94a3 72static bool report_corrected;
2556c98b 73
2bd0ea18
NS
74static void
75usage(void)
76{
4af916f8
BN
77 do_warn(_(
78"Usage: %s [options] device\n"
79"\n"
80"Options:\n"
81" -f The device is a file\n"
82" -L Force log zeroing. Do this as a last resort.\n"
83" -l logdev Specifies the device where the external log resides.\n"
84" -m maxmem Maximum amount of memory to be used in megabytes.\n"
85" -n No modify mode, just checks the filesystem for damage.\n"
7c3e94a3 86" (Cannot be used together with -e.)\n"
4af916f8
BN
87" -P Disables prefetching.\n"
88" -r rtdev Specifies the device where the realtime section resides.\n"
89" -v Verbose output.\n"
90" -c subopts Change filesystem parameters - use xfs_admin.\n"
91" -o subopts Override default behaviour, refer to man page.\n"
79e106f0 92" -t interval Reporting interval in seconds.\n"
4af916f8 93" -d Repair dangerously.\n"
7c3e94a3
JT
94" -e Exit with a non-zero code if any errors were repaired.\n"
95" (Cannot be used together with -n.)\n"
4af916f8 96" -V Reports version and exits.\n"), progname);
2bd0ea18
NS
97 exit(1);
98}
99
2bd0ea18
NS
100char *
101err_string(int err_code)
102{
507f4e33
NS
103 static char *err_message[XR_BAD_ERR_CODE];
104 static int done;
105
106 if (!done) {
107 err_message[XR_OK] = _("no error");
108 err_message[XR_BAD_MAGIC] = _("bad magic number");
109 err_message[XR_BAD_BLOCKSIZE] = _("bad blocksize field");
110 err_message[XR_BAD_BLOCKLOG] = _("bad blocksize log field");
4af916f8 111 err_message[XR_BAD_VERSION] = _("bad or unsupported version");
507f4e33
NS
112 err_message[XR_BAD_INPROGRESS] =
113 _("filesystem mkfs-in-progress bit set");
114 err_message[XR_BAD_FS_SIZE_DATA] =
115 _("inconsistent filesystem geometry information");
116 err_message[XR_BAD_INO_SIZE_DATA] =
117 _("bad inode size or inconsistent with number of inodes/block"),
118 err_message[XR_BAD_SECT_SIZE_DATA] = _("bad sector size");
119 err_message[XR_AGF_GEO_MISMATCH] =
120 _("AGF geometry info conflicts with filesystem geometry");
121 err_message[XR_AGI_GEO_MISMATCH] =
122 _("AGI geometry info conflicts with filesystem geometry");
123 err_message[XR_SB_GEO_MISMATCH] =
124 _("AG superblock geometry info conflicts with filesystem geometry");
125 err_message[XR_EOF] = _("attempted to perform I/O beyond EOF");
126 err_message[XR_BAD_RT_GEO_DATA] =
127 _("inconsistent filesystem geometry in realtime filesystem component");
128 err_message[XR_BAD_INO_MAX_PCT] =
129 _("maximum indicated percentage of inodes > 100%");
130 err_message[XR_BAD_INO_ALIGN] =
131 _("inconsistent inode alignment value");
132 err_message[XR_INSUFF_SEC_SB] =
133 _("not enough secondary superblocks with matching geometry");
134 err_message[XR_BAD_SB_UNIT] =
135 _("bad stripe unit in superblock");
136 err_message[XR_BAD_SB_WIDTH] =
137 _("bad stripe width in superblock");
138 err_message[XR_BAD_SVN] =
139 _("bad shared version number in superblock");
88f364a9
DC
140 err_message[XR_BAD_CRC] =
141 _("bad CRC in superblock");
02b56f87
DW
142 err_message[XR_BAD_DIR_SIZE_DATA] =
143 _("inconsistent directory geometry information");
eb9cee60
DW
144 err_message[XR_BAD_LOG_GEOMETRY] =
145 _("inconsistent log geometry information");
507f4e33
NS
146 done = 1;
147 }
148
2bd0ea18 149 if (err_code < XR_OK || err_code >= XR_BAD_ERR_CODE)
507f4e33 150 do_abort(_("bad error code - %d\n"), err_code);
2bd0ea18
NS
151
152 return(err_message[err_code]);
153}
154
155static void
156noval(char opt, char *tbl[], int idx)
157{
507f4e33 158 do_warn(_("-%c %s option cannot have a value\n"), opt, tbl[idx]);
2bd0ea18
NS
159 usage();
160}
161
162static void
163respec(char opt, char *tbl[], int idx)
164{
165 do_warn("-%c ", opt);
166 if (tbl)
167 do_warn("%s ", tbl[idx]);
507f4e33 168 do_warn(_("option respecified\n"));
2bd0ea18
NS
169 usage();
170}
171
172static void
173unknown(char opt, char *s)
174{
507f4e33 175 do_warn(_("unknown option -%c %s\n"), opt, s);
2bd0ea18
NS
176 usage();
177}
178
179/*
180 * sets only the global argument flags and variables
181 */
8b8a6b02 182static void
2bd0ea18
NS
183process_args(int argc, char **argv)
184{
185 char *p;
186 int c;
187
188 log_spec = 0;
189 fs_is_dirty = 0;
190 verbose = 0;
191 no_modify = 0;
c781939c 192 dangerously = 0;
2bd0ea18 193 isa_file = 0;
d321ceac 194 zap_log = 0;
2bd0ea18 195 dumpcore = 0;
0f012a4c 196 full_ino_ex_data = 0;
2bd0ea18
NS
197 force_geo = 0;
198 assume_xfs = 0;
6bf4721d 199 copied_sunit = 0;
2bd0ea18
NS
200 sb_inoalignmt = 0;
201 sb_unit = 0;
202 sb_width = 0;
add3cb90 203 ag_stride = 0;
2556c98b 204 thread_count = 1;
06fbdda9 205 report_interval = PROG_RPT_DEFAULT;
7c3e94a3 206 report_corrected = false;
2bd0ea18
NS
207
208 /*
209 * XXX have to add suboption processing here
210 * attributes, quotas, nlinks, aligned_inos, sb_fbits
211 */
7c3e94a3 212 while ((c = getopt(argc, argv, "c:o:fl:m:r:LnDvVdPet:")) != EOF) {
2bd0ea18
NS
213 switch (c) {
214 case 'D':
215 dumpcore = 1;
216 break;
217 case 'o':
218 p = optarg;
219 while (*p != '\0') {
220 char *val;
221
ab870d0e 222 switch (getsubopt(&p, o_opts, &val)) {
2bd0ea18
NS
223 case ASSUME_XFS:
224 if (val)
225 noval('o', o_opts, ASSUME_XFS);
226 if (assume_xfs)
227 respec('o', o_opts, ASSUME_XFS);
228 assume_xfs = 1;
229 break;
9f38f08d 230 case IHASH_SIZE:
3a19fb7d
CH
231 do_warn(
232 _("-o ihash option has been removed and will be ignored\n"));
9f38f08d
MV
233 break;
234 case BHASH_SIZE:
12be365e
BN
235 if (max_mem_specified)
236 do_abort(
3a19fb7d 237 _("-o bhash option cannot be used with -m option\n"));
1f8480b6
DW
238 if (!val)
239 do_abort(
240 _("-o bhash requires a parameter\n"));
5e656dbb 241 libxfs_bhash_size = (int)strtol(val, NULL, 0);
2556c98b 242 bhash_option_used = 1;
cb5b3ef4 243 break;
add3cb90 244 case AG_STRIDE:
1f8480b6
DW
245 if (!val)
246 do_abort(
247 _("-o ag_stride requires a parameter\n"));
5e656dbb 248 ag_stride = (int)strtol(val, NULL, 0);
3b6ac903 249 break;
d4dd6ab5
CH
250 case FORCE_GEO:
251 if (val)
252 noval('o', o_opts, FORCE_GEO);
253 if (force_geo)
254 respec('o', o_opts, FORCE_GEO);
255 force_geo = 1;
256 break;
364a126c 257 case PHASE2_THREADS:
1f8480b6
DW
258 if (!val)
259 do_abort(
260 _("-o phase2_threads requires a parameter\n"));
364a126c
DC
261 phase2_threads = (int)strtol(val, NULL, 0);
262 break;
2bd0ea18
NS
263 default:
264 unknown('o', val);
265 break;
266 }
267 }
268 break;
4af916f8
BN
269 case 'c':
270 p = optarg;
271 while (*p) {
272 char *val;
273
ab870d0e 274 switch (getsubopt(&p, c_opts, &val)) {
4af916f8 275 case CONVERT_LAZY_COUNT:
1f8480b6
DW
276 if (!val)
277 do_abort(
278 _("-c lazycount requires a parameter\n"));
5e656dbb 279 lazy_count = (int)strtol(val, NULL, 0);
4af916f8
BN
280 convert_lazy_count = 1;
281 break;
282 default:
283 unknown('c', val);
284 break;
285 }
286 }
287 break;
2bd0ea18
NS
288 case 'l':
289 log_name = optarg;
290 log_spec = 1;
291 break;
42a564ab
ES
292 case 'r':
293 rt_name = optarg;
294 rt_spec = 1;
295 break;
2bd0ea18
NS
296 case 'f':
297 isa_file = 1;
298 break;
12be365e
BN
299 case 'm':
300 if (bhash_option_used)
301 do_abort(_("-m option cannot be used with "
302 "-o bhash option\n"));
5e656dbb 303 max_mem_specified = strtol(optarg, NULL, 0);
12be365e 304 break;
d321ceac
NS
305 case 'L':
306 zap_log = 1;
307 break;
2bd0ea18
NS
308 case 'n':
309 no_modify = 1;
310 break;
6089b6f0
NS
311 case 'd':
312 dangerously = 1;
313 break;
2bd0ea18 314 case 'v':
3b6ac903 315 verbose++;
2bd0ea18
NS
316 break;
317 case 'V':
507f4e33 318 printf(_("%s version %s\n"), progname, VERSION);
3d98fe63 319 exit(0);
cb5b3ef4 320 case 'P':
2556c98b 321 do_prefetch = 0;
3b6ac903 322 break;
06fbdda9 323 case 't':
5e656dbb 324 report_interval = (int)strtol(optarg, NULL, 0);
06fbdda9 325 break;
7c3e94a3
JT
326 case 'e':
327 report_corrected = true;
328 break;
2bd0ea18
NS
329 case '?':
330 usage();
331 }
332 }
333
334 if (argc - optind != 1)
335 usage();
336
337 if ((fs_name = argv[optind]) == NULL)
338 usage();
7c3e94a3
JT
339
340 if (report_corrected && no_modify)
341 usage();
2bd0ea18
NS
342}
343
b1559967 344void __attribute__((noreturn))
2bd0ea18
NS
345do_error(char const *msg, ...)
346{
347 va_list args;
348
507f4e33 349 fprintf(stderr, _("\nfatal error -- "));
2bd0ea18
NS
350
351 va_start(args, msg);
079afa09
CH
352 vfprintf(stderr, msg, args);
353 if (dumpcore)
354 abort();
355 exit(1);
2bd0ea18
NS
356}
357
358/*
359 * like do_error, only the error is internal, no system
360 * error so no oserror processing
361 */
b1559967 362void __attribute__((noreturn))
2bd0ea18
NS
363do_abort(char const *msg, ...)
364{
365 va_list args;
366
367 va_start(args, msg);
079afa09
CH
368 vfprintf(stderr, msg, args);
369 if (dumpcore)
370 abort();
371 exit(1);
2bd0ea18
NS
372}
373
374void
375do_warn(char const *msg, ...)
376{
377 va_list args;
378
379 fs_is_dirty = 1;
380
381 va_start(args, msg);
079afa09 382 vfprintf(stderr, msg, args);
2bd0ea18
NS
383 va_end(args);
384}
385
386/* no formatting */
387
388void
389do_log(char const *msg, ...)
390{
391 va_list args;
392
393 va_start(args, msg);
079afa09 394 vfprintf(stderr, msg, args);
2bd0ea18
NS
395 va_end(args);
396}
397
8b8a6b02 398static void
2bd0ea18
NS
399calc_mkfs(xfs_mount_t *mp)
400{
401 xfs_agblock_t fino_bno;
402 int do_inoalign;
403
e7fd2b6f 404 do_inoalign = M_IGEO(mp)->ialloc_align;
2bd0ea18
NS
405
406 /*
7b370905
BF
407 * Pre-calculate the geometry of ag 0. We know what it looks like
408 * because we know what mkfs does: 2 allocation btree roots (by block
409 * and by size), the inode allocation btree root, the free inode
410 * allocation btree root (if enabled) and some number of blocks to
411 * prefill the agfl.
de046644
DC
412 *
413 * Because the current shape of the btrees may differ from the current
414 * shape, we open code the mkfs freelist block count here. mkfs creates
415 * single level trees, so the calculation is pertty straight forward for
7ddb50f8 416 * the trees that use the AGFL.
2bd0ea18
NS
417 */
418 bnobt_root = howmany(4 * mp->m_sb.sb_sectsize, mp->m_sb.sb_blocksize);
419 bcntbt_root = bnobt_root + 1;
420 inobt_root = bnobt_root + 2;
de046644 421 fino_bno = inobt_root + (2 * min(2, mp->m_ag_maxlevels)) + 1;
7b370905
BF
422 if (xfs_sb_version_hasfinobt(&mp->m_sb))
423 fino_bno++;
7ddb50f8
DW
424 if (xfs_sb_version_hasrmapbt(&mp->m_sb)) {
425 fino_bno += min(2, mp->m_rmap_maxlevels); /* agfl blocks */
0f94fa4b 426 fino_bno++;
7ddb50f8 427 }
18c44aa9
DW
428 if (xfs_sb_version_hasreflink(&mp->m_sb))
429 fino_bno++;
2bd0ea18 430
d4dd6ab5 431 /*
649bfa9a
CH
432 * If the log is allocated in the first allocation group we need to
433 * add the number of blocks used by the log to the above calculation.
434 *
435 * This can happens with filesystems that only have a single
436 * allocation group, or very odd geometries created by old mkfs
437 * versions on very small filesystems.
d4dd6ab5 438 */
649bfa9a
CH
439 if (mp->m_sb.sb_logstart &&
440 XFS_FSB_TO_AGNO(mp, mp->m_sb.sb_logstart) == 0) {
441
d4dd6ab5
CH
442 /*
443 * XXX(hch): verify that sb_logstart makes sense?
444 */
445 fino_bno += mp->m_sb.sb_logblocks;
446 }
447
2bd0ea18
NS
448 /*
449 * ditto the location of the first inode chunks in the fs ('/')
450 */
5e656dbb 451 if (xfs_sb_version_hasdalign(&mp->m_sb) && do_inoalign) {
7516da71
DW
452 first_prealloc_ino = XFS_AGB_TO_AGINO(mp, roundup(fino_bno,
453 mp->m_sb.sb_unit));
5e656dbb 454 } else if (xfs_sb_version_hasalign(&mp->m_sb) &&
2bd0ea18 455 mp->m_sb.sb_inoalignmt > 1) {
7516da71 456 first_prealloc_ino = XFS_AGB_TO_AGINO(mp,
2bd0ea18 457 roundup(fino_bno,
7516da71 458 mp->m_sb.sb_inoalignmt));
2bd0ea18 459 } else {
7516da71 460 first_prealloc_ino = XFS_AGB_TO_AGINO(mp, fino_bno);
2bd0ea18
NS
461 }
462
2bd0ea18
NS
463 /*
464 * now the first 3 inodes in the system
465 */
466 if (mp->m_sb.sb_rootino != first_prealloc_ino) {
467 do_warn(
5d1b7f0f 468_("sb root inode value %" PRIu64 " %sinconsistent with calculated value %u\n"),
507f4e33
NS
469 mp->m_sb.sb_rootino,
470 (mp->m_sb.sb_rootino == NULLFSINO ? "(NULLFSINO) ":""),
471 first_prealloc_ino);
2bd0ea18
NS
472
473 if (!no_modify)
474 do_warn(
5d1b7f0f 475 _("resetting superblock root inode pointer to %u\n"),
2bd0ea18
NS
476 first_prealloc_ino);
477 else
478 do_warn(
5d1b7f0f 479 _("would reset superblock root inode pointer to %u\n"),
2bd0ea18
NS
480 first_prealloc_ino);
481
482 /*
483 * just set the value -- safe since the superblock
484 * doesn't get flushed out if no_modify is set
485 */
486 mp->m_sb.sb_rootino = first_prealloc_ino;
487 }
488
489 if (mp->m_sb.sb_rbmino != first_prealloc_ino + 1) {
490 do_warn(
5d1b7f0f 491_("sb realtime bitmap inode %" PRIu64 " %sinconsistent with calculated value %u\n"),
507f4e33
NS
492 mp->m_sb.sb_rbmino,
493 (mp->m_sb.sb_rbmino == NULLFSINO ? "(NULLFSINO) ":""),
494 first_prealloc_ino + 1);
2bd0ea18
NS
495
496 if (!no_modify)
497 do_warn(
5d1b7f0f 498 _("resetting superblock realtime bitmap ino pointer to %u\n"),
2bd0ea18
NS
499 first_prealloc_ino + 1);
500 else
501 do_warn(
5d1b7f0f 502 _("would reset superblock realtime bitmap ino pointer to %u\n"),
2bd0ea18
NS
503 first_prealloc_ino + 1);
504
505 /*
506 * just set the value -- safe since the superblock
507 * doesn't get flushed out if no_modify is set
508 */
509 mp->m_sb.sb_rbmino = first_prealloc_ino + 1;
510 }
511
512 if (mp->m_sb.sb_rsumino != first_prealloc_ino + 2) {
513 do_warn(
5d1b7f0f
CH
514_("sb realtime summary inode %" PRIu64 " %sinconsistent with calculated value %u\n"),
515 mp->m_sb.sb_rsumino,
516 (mp->m_sb.sb_rsumino == NULLFSINO ? "(NULLFSINO) ":""),
517 first_prealloc_ino + 2);
2bd0ea18
NS
518
519 if (!no_modify)
520 do_warn(
5d1b7f0f 521 _("resetting superblock realtime summary ino pointer to %u\n"),
2bd0ea18
NS
522 first_prealloc_ino + 2);
523 else
524 do_warn(
5d1b7f0f 525 _("would reset superblock realtime summary ino pointer to %u\n"),
2bd0ea18
NS
526 first_prealloc_ino + 2);
527
528 /*
529 * just set the value -- safe since the superblock
530 * doesn't get flushed out if no_modify is set
531 */
532 mp->m_sb.sb_rsumino = first_prealloc_ino + 2;
533 }
534
535}
536
1926558d
BF
537/*
538 * v5 superblock metadata track the LSN of last modification and thus require
539 * that the current LSN is always moving forward. The current LSN is reset if
540 * the log has been cleared, which puts the log behind parts of the filesystem
541 * on-disk and can disrupt log recovery.
542 *
543 * We have tracked the maximum LSN of every piece of metadata that has been read
544 * in via the read verifiers. Compare the max LSN with the log and if the log is
545 * behind, bump the cycle number and reformat the log.
546 */
547static void
548format_log_max_lsn(
549 struct xfs_mount *mp)
550{
551 struct xlog *log = mp->m_log;
552 int max_cycle;
553 int max_block;
554 int new_cycle;
555 xfs_daddr_t logstart;
556 xfs_daddr_t logblocks;
557 int logversion;
558
559 if (!xfs_sb_version_hascrc(&mp->m_sb))
560 return;
561
562 /*
563 * If the log is ahead of the highest metadata LSN we've seen, we're
564 * safe and there's nothing to do.
565 */
566 max_cycle = CYCLE_LSN(libxfs_max_lsn);
567 max_block = BLOCK_LSN(libxfs_max_lsn);
568 if (max_cycle < log->l_curr_cycle ||
569 (max_cycle == log->l_curr_cycle && max_block < log->l_curr_block))
570 return;
571
572 /*
573 * Going to the next cycle should be sufficient but we bump by a few
574 * counts to help cover any metadata LSNs we could have missed.
575 */
576 new_cycle = max_cycle + 3;
577 logstart = XFS_FSB_TO_DADDR(mp, mp->m_sb.sb_logstart);
578 logblocks = XFS_FSB_TO_BB(mp, mp->m_sb.sb_logblocks);
579 logversion = xfs_sb_version_haslogv2(&mp->m_sb) ? 2 : 1;
580
581 do_warn(_("Maximum metadata LSN (%d:%d) is ahead of log (%d:%d).\n"),
582 max_cycle, max_block, log->l_curr_cycle, log->l_curr_block);
583
584 if (no_modify) {
585 do_warn(_("Would format log to cycle %d.\n"), new_cycle);
586 return;
587 }
588
589 do_warn(_("Format log to cycle %d.\n"), new_cycle);
1c12a814
BF
590 libxfs_log_clear(log->l_dev, NULL, logstart, logblocks,
591 &mp->m_sb.sb_uuid, logversion, mp->m_sb.sb_logsunit,
571a78a7 592 XLOG_FMT, new_cycle, true);
1926558d
BF
593}
594
4a32b9e9
DC
595/*
596 * mkfs increases the AG count for "multidisk" configurations, we want
597 * to target these for an increase in thread count. Hence check the superlock
598 * geometry information to determine if mkfs considered this a multidisk
599 * configuration.
600 */
601static bool
602is_multidisk_filesystem(
603 struct xfs_mount *mp)
604{
605 struct xfs_sb *sbp = &mp->m_sb;
606
607 /* High agcount filesystems are always considered "multidisk" */
608 if (sbp->sb_agcount >= XFS_MULTIDISK_AGCOUNT)
609 return true;
610
611 /*
612 * If it doesn't have a sunit/swidth, mkfs didn't consider it a
613 * multi-disk array, so we don't either.
614 */
615 if (!sbp->sb_unit)
616 return false;
617
618 ASSERT(sbp->sb_width);
619 return true;
620}
621
28a0a30f
ZL
622/*
623 * if the sector size of the filesystem we are trying to repair is
624 * smaller than that of the underlying filesystem (i.e. we are repairing
625 * an image), the we have to turn off direct IO because we cannot do IO
626 * smaller than the host filesystem's sector size.
627 */
628static void
629check_fs_vs_host_sectsize(
630 struct xfs_sb *sb)
631{
9612817d 632 int fd, ret;
28a0a30f 633 long old_flags;
9612817d 634 struct xfs_fsop_geom geom = { 0 };
28a0a30f
ZL
635
636 fd = libxfs_device_to_fd(x.ddev);
637
03d96c64 638 ret = -xfrog_geometry(fd, &geom);
9612817d 639 if (ret) {
28a0a30f
ZL
640 do_log(_("Cannot get host filesystem geometry.\n"
641 "Repair may fail if there is a sector size mismatch between\n"
642 "the image and the host filesystem.\n"));
643 geom.sectsize = BBSIZE;
644 }
645
646 if (sb->sb_sectsize < geom.sectsize) {
647 old_flags = fcntl(fd, F_GETFL, 0);
648 if (fcntl(fd, F_SETFL, old_flags & ~O_DIRECT) < 0) {
649 do_warn(_(
650 "Sector size on host filesystem larger than image sector size.\n"
651 "Cannot turn off direct IO, so exiting.\n"));
652 exit(1);
653 }
654 }
655}
656
2bd0ea18
NS
657int
658main(int argc, char **argv)
659{
2bd0ea18
NS
660 xfs_mount_t *temp_mp;
661 xfs_mount_t *mp;
5e656dbb 662 xfs_dsb_t *dsb;
2bd0ea18
NS
663 xfs_buf_t *sbp;
664 xfs_mount_t xfs_m;
1d6cb115 665 struct xlog log = {0};
06fbdda9 666 char *msgbuf;
88f364a9
DC
667 struct xfs_sb psb;
668 int rval;
e7fd2b6f 669 struct xfs_ino_geometry *igeo;
2bd0ea18
NS
670
671 progname = basename(argv[0]);
507f4e33
NS
672 setlocale(LC_ALL, "");
673 bindtextdomain(PACKAGE, LOCALEDIR);
674 textdomain(PACKAGE);
beed0dc8 675 dinode_bmbt_translation_init();
2bd0ea18
NS
676
677 temp_mp = &xfs_m;
678 setbuf(stdout, NULL);
679
680 process_args(argc, argv);
d321ceac 681 xfs_init(&x);
2bd0ea18 682
2556c98b
BN
683 msgbuf = malloc(DURATION_BUF_SIZE);
684
06fbdda9
MV
685 timestamp(PHASE_START, 0, NULL);
686 timestamp(PHASE_END, 0, NULL);
687
28a0a30f
ZL
688 /* -f forces this, but let's be nice and autodetect it, as well. */
689 if (!isa_file) {
690 int fd = libxfs_device_to_fd(x.ddev);
691 struct stat statbuf;
692
693 if (fstat(fd, &statbuf) < 0)
694 do_warn(_("%s: couldn't stat \"%s\"\n"),
695 progname, fs_name);
696 else if (S_ISREG(statbuf.st_mode))
697 isa_file = 1;
698 }
699
700 if (isa_file) {
701 /* Best effort attempt to validate fs vs host sector size */
702 rval = get_sb(&psb, 0, XFS_MAX_SECTORSIZE, 0);
703 if (rval == XR_OK)
704 check_fs_vs_host_sectsize(&psb);
705 }
706
2bd0ea18
NS
707 /* do phase1 to make sure we have a superblock */
708 phase1(temp_mp);
06fbdda9 709 timestamp(PHASE_END, 1, NULL);
2bd0ea18
NS
710
711 if (no_modify && primary_sb_modified) {
507f4e33
NS
712 do_warn(_("Primary superblock would have been modified.\n"
713 "Cannot proceed further in no_modify mode.\n"
714 "Exiting now.\n"));
2bd0ea18
NS
715 exit(1);
716 }
717
88f364a9
DC
718 rval = get_sb(&psb, 0, XFS_MAX_SECTORSIZE, 0);
719 if (rval != XR_OK) {
720 do_warn(_("Primary superblock bad after phase 1!\n"
721 "Exiting now.\n"));
722 exit(1);
723 }
2bd0ea18 724
f63fd268 725 /*
28a0a30f
ZL
726 * Now that we have completely validated the superblock, geometry may
727 * have changed; re-check geometry vs the host filesystem geometry
f63fd268 728 */
28a0a30f
ZL
729 if (isa_file)
730 check_fs_vs_host_sectsize(&psb);
88f364a9 731
1d6cb115
BF
732 /*
733 * Prepare the mount structure. Point the log reference to our local
734 * copy so it's available to the various phases. The log bits are
735 * initialized in phase 2.
736 */
88f364a9
DC
737 memset(&xfs_m, 0, sizeof(xfs_mount_t));
738 mp = libxfs_mount(&xfs_m, &psb, x.ddev, x.logdev, x.rtdev, 0);
2bd0ea18
NS
739
740 if (!mp) {
507f4e33
NS
741 fprintf(stderr,
742 _("%s: cannot repair this filesystem. Sorry.\n"),
2bd0ea18
NS
743 progname);
744 exit(1);
745 }
1d6cb115 746 mp->m_log = &log;
e7fd2b6f 747 igeo = M_IGEO(mp);
2bd0ea18 748
23639f77
ES
749 /* Spit out function & line on these corruption macros */
750 if (verbose > 2)
751 mp->m_flags |= LIBXFS_MOUNT_WANT_CORRUPTED;
752
2bd0ea18
NS
753 /*
754 * set XFS-independent status vars from the mount/sb structure
755 */
756 glob_agcount = mp->m_sb.sb_agcount;
757
758 chunks_pblock = mp->m_sb.sb_inopblock / XFS_INODES_PER_CHUNK;
5a707ca1 759 max_symlink_blocks = libxfs_symlink_blocks(mp, XFS_SYMLINK_MAXLEN);
2bd0ea18 760
0cce4aa1
DC
761 /*
762 * Automatic striding for high agcount filesystems.
763 *
764 * More AGs indicates that the filesystem is either large or can handle
765 * more IO parallelism. Either way, we should try to process multiple
766 * AGs at a time in such a configuration to try to saturate the
767 * underlying storage and speed the repair process. Only do this if
768 * prefetching is enabled.
769 *
770 * Given mkfs defaults for 16AGs for "multidisk" configurations, we want
771 * to target these for an increase in thread count. Hence a stride value
772 * of 15 is chosen to ensure we get at least 2 AGs being scanned at once
773 * on such filesystems.
12b55baf
DC
774 *
775 * Limit the maximum thread count based on the available CPU power that
776 * is available. If we use too many threads, we might run out of memory
777 * and CPU power before we run out of IO concurrency. We limit to 8
778 * threads/CPU as this is enough threads to saturate a CPU on fast
779 * devices, yet few enough that it will saturate but won't overload slow
780 * devices.
4a32b9e9
DC
781 *
782 * Multidisk filesystems can handle more IO parallelism so we should try
783 * to process multiple AGs at a time in such a configuration to try to
784 * saturate the underlying storage and speed the repair process. Only do
785 * this if prefetching is enabled.
0cce4aa1 786 */
4a32b9e9
DC
787 if (!ag_stride && do_prefetch && is_multidisk_filesystem(mp)) {
788 /*
789 * For small agcount multidisk systems, just double the
790 * parallelism. For larger AG count filesystems (32 and above)
791 * use more parallelism, and linearly increase the parallelism
792 * with the number of AGs.
793 */
794 ag_stride = min(glob_agcount, XFS_MULTIDISK_AGCOUNT / 2) - 1;
795 }
0cce4aa1 796
add3cb90 797 if (ag_stride) {
12b55baf
DC
798 int max_threads = platform_nproc() * 8;
799
2556c98b 800 thread_count = (glob_agcount + ag_stride - 1) / ag_stride;
12b55baf
DC
801 while (thread_count > max_threads) {
802 ag_stride *= 2;
803 thread_count = (glob_agcount + ag_stride - 1) /
804 ag_stride;
805 }
806 if (thread_count > 0)
807 thread_init();
808 else {
809 thread_count = 1;
810 ag_stride = 0;
811 }
add3cb90
BN
812 }
813
2556c98b 814 if (ag_stride && report_interval) {
06fbdda9 815 init_progress_rpt();
06fbdda9
MV
816 if (msgbuf) {
817 do_log(_(" - reporting progress in intervals of %s\n"),
818 duration(report_interval, msgbuf));
06fbdda9
MV
819 }
820 }
821
2556c98b
BN
822 /*
823 * Adjust libxfs cache sizes based on system memory,
824 * filesystem size and inode count.
825 *
826 * We'll set the cache size based on 3/4s the memory minus
827 * space used by the inode AVL tree and block usage map.
828 *
829 * Inode AVL tree space is approximately 4 bytes per inode,
830 * block usage map is currently 1 byte for 2 blocks.
831 *
832 * We assume most blocks will be inode clusters.
833 *
834 * Calculations are done in kilobyte units.
835 */
836
12be365e 837 if (!bhash_option_used || max_mem_specified) {
2556c98b 838 unsigned long mem_used;
12be365e
BN
839 unsigned long max_mem;
840 struct rlimit rlim;
2556c98b 841
2556c98b 842 libxfs_bcache_purge();
2556c98b
BN
843 cache_destroy(libxfs_bcache);
844
845 mem_used = (mp->m_sb.sb_icount >> (10 - 2)) +
12be365e
BN
846 (mp->m_sb.sb_dblocks >> (10 + 1)) +
847 50000; /* rough estimate of 50MB overhead */
848 max_mem = max_mem_specified ? max_mem_specified * 1024 :
4e5fe123 849 platform_physmem() * 3 / 4;
12be365e
BN
850
851 if (getrlimit(RLIMIT_AS, &rlim) != -1 &&
852 rlim.rlim_cur != RLIM_INFINITY) {
853 rlim.rlim_cur = rlim.rlim_max;
854 setrlimit(RLIMIT_AS, &rlim);
855 /* use approximately 80% of rlimit to avoid overrun */
68d16907 856 max_mem = min(max_mem, rlim.rlim_cur / 1280);
12be365e 857 } else
68d16907 858 max_mem = min(max_mem, (LONG_MAX >> 10) + 1);
2556c98b
BN
859
860 if (verbose > 1)
5d1b7f0f
CH
861 do_log(
862 _(" - max_mem = %lu, icount = %" PRIu64 ", imem = %" PRIu64 ", dblock = %" PRIu64 ", dmem = %" PRIu64 "\n"),
12be365e
BN
863 max_mem, mp->m_sb.sb_icount,
864 mp->m_sb.sb_icount >> (10 - 2),
865 mp->m_sb.sb_dblocks,
866 mp->m_sb.sb_dblocks >> (10 + 1));
867
868 if (max_mem <= mem_used) {
0335a835
DC
869 if (max_mem_specified) {
870 do_abort(
871 _("Required memory for repair is greater that the maximum specified\n"
872 "with the -m option. Please increase it to at least %lu.\n"),
12be365e 873 mem_used / 1024);
0335a835 874 }
70a4820f 875 do_log(
61510437
DC
876 _("Memory available for repair (%luMB) may not be sufficient.\n"
877 "At least %luMB is needed to repair this filesystem efficiently\n"
878 "If repair fails due to lack of memory, please\n"),
879 max_mem / 1024, mem_used / 1024);
880 if (do_prefetch)
70a4820f 881 do_log(
61510437
DC
882 _("turn prefetching off (-P) to reduce the memory footprint.\n"));
883 else
70a4820f 884 do_log(
61510437
DC
885 _("increase system RAM and/or swap space to at least %luMB.\n"),
886 mem_used * 2 / 1024);
887
888 max_mem = mem_used;
2556c98b
BN
889 }
890
61510437
DC
891 max_mem -= mem_used;
892 if (max_mem >= (1 << 30))
893 max_mem = 1 << 30;
894 libxfs_bhash_size = max_mem / (HASH_CACHE_RATIO *
e7fd2b6f 895 (igeo->inode_cluster_size >> 10));
61510437
DC
896 if (libxfs_bhash_size < 512)
897 libxfs_bhash_size = 512;
898
2556c98b
BN
899 if (verbose)
900 do_log(_(" - block cache size set to %d entries\n"),
901 libxfs_bhash_size * HASH_CACHE_RATIO);
902
ba9ecd40 903 libxfs_bcache = cache_init(0, libxfs_bhash_size,
2556c98b
BN
904 &libxfs_bcache_operations);
905 }
906
2bd0ea18
NS
907 /*
908 * calculate what mkfs would do to this filesystem
909 */
910 calc_mkfs(mp);
911
912 /*
c1f7a46c 913 * initialize block alloc map
2bd0ea18 914 */
c1f7a46c
BN
915 init_bmaps(mp);
916 incore_ino_init(mp);
917 incore_ext_init(mp);
2d273771 918 rmaps_init(mp);
c1f7a46c
BN
919
920 /* initialize random globals now that we know the fs geometry */
921 inodes_per_block = mp->m_sb.sb_inopblock;
2bd0ea18
NS
922
923 if (parse_sb_version(&mp->m_sb)) {
924 do_warn(
507f4e33 925 _("Found unsupported filesystem features. Exiting now.\n"));
2bd0ea18
NS
926 return(1);
927 }
928
929 /* make sure the per-ag freespace maps are ok so we can mount the fs */
364a126c 930 phase2(mp, phase2_threads);
06fbdda9 931 timestamp(PHASE_END, 2, NULL);
2bd0ea18 932
2556c98b
BN
933 if (do_prefetch)
934 init_prefetch(mp);
935
8100dd79 936 phase3(mp, phase2_threads);
06fbdda9 937 timestamp(PHASE_END, 3, NULL);
2bd0ea18
NS
938
939 phase4(mp);
06fbdda9 940 timestamp(PHASE_END, 4, NULL);
2bd0ea18
NS
941
942 if (no_modify)
507f4e33 943 printf(_("No modify flag set, skipping phase 5\n"));
3b6ac903 944 else {
2bd0ea18 945 phase5(mp);
3b6ac903 946 }
06fbdda9 947 timestamp(PHASE_END, 5, NULL);
2bd0ea18 948
c1f7a46c
BN
949 /*
950 * Done with the block usage maps, toss them...
951 */
2d273771 952 rmaps_free(mp);
c1f7a46c
BN
953 free_bmaps(mp);
954
2bd0ea18
NS
955 if (!bad_ino_btree) {
956 phase6(mp);
06fbdda9 957 timestamp(PHASE_END, 6, NULL);
2bd0ea18 958
e161d4a8 959 phase7(mp, phase2_threads);
06fbdda9 960 timestamp(PHASE_END, 7, NULL);
2bd0ea18
NS
961 } else {
962 do_warn(
507f4e33 963_("Inode allocation btrees are too corrupted, skipping phases 6 and 7\n"));
2bd0ea18
NS
964 }
965
0340d706 966 if (lost_quotas && !have_uquotino && !have_gquotino && !have_pquotino) {
2bd0ea18
NS
967 if (!no_modify) {
968 do_warn(
507f4e33 969_("Warning: no quota inodes were found. Quotas disabled.\n"));
2bd0ea18
NS
970 } else {
971 do_warn(
507f4e33 972_("Warning: no quota inodes were found. Quotas would be disabled.\n"));
2bd0ea18
NS
973 }
974 } else if (lost_quotas) {
975 if (!no_modify) {
976 do_warn(
507f4e33 977_("Warning: quota inodes were cleared. Quotas disabled.\n"));
2bd0ea18
NS
978 } else {
979 do_warn(
507f4e33 980_("Warning: quota inodes would be cleared. Quotas would be disabled.\n"));
2bd0ea18
NS
981 }
982 } else {
983 if (lost_uquotino) {
984 if (!no_modify) {
985 do_warn(
507f4e33
NS
986_("Warning: user quota information was cleared.\n"
987 "User quotas can not be enforced until limit information is recreated.\n"));
2bd0ea18
NS
988 } else {
989 do_warn(
507f4e33
NS
990_("Warning: user quota information would be cleared.\n"
991 "User quotas could not be enforced until limit information was recreated.\n"));
2bd0ea18
NS
992 }
993 }
994
b36eef04 995 if (lost_gquotino) {
2bd0ea18
NS
996 if (!no_modify) {
997 do_warn(
507f4e33
NS
998_("Warning: group quota information was cleared.\n"
999 "Group quotas can not be enforced until limit information is recreated.\n"));
2bd0ea18
NS
1000 } else {
1001 do_warn(
507f4e33
NS
1002_("Warning: group quota information would be cleared.\n"
1003 "Group quotas could not be enforced until limit information was recreated.\n"));
9b27bdbb
NS
1004 }
1005 }
1006
1007 if (lost_pquotino) {
1008 if (!no_modify) {
1009 do_warn(
1010_("Warning: project quota information was cleared.\n"
1011 "Project quotas can not be enforced until limit information is recreated.\n"));
1012 } else {
1013 do_warn(
1014_("Warning: project quota information would be cleared.\n"
1015 "Project quotas could not be enforced until limit information was recreated.\n"));
2bd0ea18
NS
1016 }
1017 }
1018 }
1019
2556c98b 1020 if (ag_stride && report_interval)
06fbdda9 1021 stop_progress_rpt();
9f38f08d 1022
2bd0ea18 1023 if (no_modify) {
1926558d
BF
1024 /*
1025 * Warn if the current LSN is problematic and the log requires a
1026 * reformat.
1027 */
1028 format_log_max_lsn(mp);
1029
2bd0ea18 1030 do_log(
507f4e33 1031 _("No modify flag set, skipping filesystem flush and exiting.\n"));
3b6ac903 1032 if (verbose)
06fbdda9 1033 summary_report();
2bd0ea18
NS
1034 if (fs_is_dirty)
1035 return(1);
1036
1037 return(0);
1038 }
1039
1040 /*
1041 * Clear the quota flags if they're on.
1042 */
67c4a324 1043 sbp = libxfs_getsb(mp);
2bd0ea18 1044 if (!sbp)
507f4e33 1045 do_error(_("couldn't get superblock\n"));
2bd0ea18 1046
5e656dbb 1047 dsb = XFS_BUF_TO_SBP(sbp);
2bd0ea18 1048
342aef1e 1049 if (be16_to_cpu(dsb->sb_qflags) & XFS_ALL_QUOTA_CHKD) {
5e656dbb
BN
1050 do_warn(_("Note - quota info will be regenerated on next "
1051 "quota mount.\n"));
342aef1e 1052 dsb->sb_qflags &= cpu_to_be16(~XFS_ALL_QUOTA_CHKD);
2bd0ea18
NS
1053 }
1054
6bf4721d 1055 if (copied_sunit) {
2bd0ea18 1056 do_warn(
6bf4721d
ES
1057_("Note - stripe unit (%d) and width (%d) were copied from a backup superblock.\n"
1058 "Please reset with mount -o sunit=<value>,swidth=<value> if necessary\n"),
5e656dbb 1059 be32_to_cpu(dsb->sb_unit), be32_to_cpu(dsb->sb_width));
dfc130f3 1060 }
2bd0ea18
NS
1061
1062 libxfs_writebuf(sbp, 0);
1063
2556c98b 1064 /*
1926558d
BF
1065 * Done. Flush all cached buffers and inodes first to ensure all
1066 * verifiers are run (where we discover the max metadata LSN), reformat
1067 * the log if necessary and unmount.
2556c98b
BN
1068 */
1069 libxfs_bcache_flush();
1926558d 1070 format_log_max_lsn(mp);
2bd0ea18 1071 libxfs_umount(mp);
1926558d 1072
d321ceac
NS
1073 if (x.rtdev)
1074 libxfs_device_close(x.rtdev);
1075 if (x.logdev && x.logdev != x.ddev)
1076 libxfs_device_close(x.logdev);
1077 libxfs_device_close(x.ddev);
2ce8bff5 1078 libxfs_destroy();
2bd0ea18 1079
06fbdda9
MV
1080 if (verbose)
1081 summary_report();
507f4e33 1082 do_log(_("done\n"));
3ae81520
ES
1083
1084 if (dangerously && !no_modify)
1085 do_warn(
1086_("Repair of readonly mount complete. Immediate reboot encouraged.\n"));
1087
4c0a98ae
BN
1088 pftrace_done();
1089
0a223eb8
ES
1090 free(msgbuf);
1091
7c3e94a3
JT
1092 if (fs_is_dirty && report_corrected)
1093 return (4);
3b6ac903
MV
1094 return (0);
1095}