| // SPDX-License-Identifier: GPL-2.0-or-later |
| /* |
| * Copyright (C) 2018-2024 Oracle. All Rights Reserved. |
| * Author: Darrick J. Wong <djwong@kernel.org> |
| */ |
| #ifndef XFS_SCRUB_COMMON_H_ |
| #define XFS_SCRUB_COMMON_H_ |
| |
| /* |
| * When reporting a defective metadata object to the console, this |
| * is the size of the buffer to use to store the description of that |
| * item. |
| */ |
| #define DESCR_BUFSZ 256 |
| |
| bool scrub_excessive_errors(struct scrub_ctx *ctx); |
| |
| enum error_level { |
| S_ERROR = 0, |
| S_CORRUPT, |
| S_UNFIXABLE, |
| S_WARN, |
| S_INFO, |
| S_REPAIR, |
| S_PREEN, |
| }; |
| |
| void __str_out(struct scrub_ctx *ctx, const char *descr, enum error_level level, |
| int error, const char *file, int line, const char *format, ...); |
| |
| #define str_errno(ctx, str) \ |
| __str_out(ctx, str, S_ERROR, errno, __FILE__, __LINE__, NULL) |
| #define str_liberror(ctx, error, str) \ |
| __str_out(ctx, str, S_ERROR, error, __FILE__, __LINE__, NULL) |
| #define str_corrupt(ctx, str, ...) \ |
| __str_out(ctx, str, S_CORRUPT, 0, __FILE__, __LINE__, __VA_ARGS__) |
| #define str_error(ctx, str, ...) \ |
| __str_out(ctx, str, S_ERROR, 0, __FILE__, __LINE__, __VA_ARGS__) |
| #define str_warn(ctx, str, ...) \ |
| __str_out(ctx, str, S_WARN, 0, __FILE__, __LINE__, __VA_ARGS__) |
| #define str_info(ctx, str, ...) \ |
| __str_out(ctx, str, S_INFO, 0, __FILE__, __LINE__, __VA_ARGS__) |
| #define record_repair(ctx, str, ...) \ |
| __str_out(ctx, str, S_REPAIR, 0, __FILE__, __LINE__, __VA_ARGS__) |
| #define record_preen(ctx, str, ...) \ |
| __str_out(ctx, str, S_PREEN, 0, __FILE__, __LINE__, __VA_ARGS__) |
| #define str_unfixable_error(ctx, str, ...) \ |
| __str_out(ctx, str, S_UNFIXABLE, 0, __FILE__, __LINE__, __VA_ARGS__) |
| |
| #define dbg_printf(fmt, ...) \ |
| do {if (debug > 1) {printf(fmt, __VA_ARGS__);}} while (0) |
| |
| void __str_log(struct scrub_ctx *ctx, enum error_level level, |
| const char *format, ...); |
| |
| #define log_info(ctx, ...) \ |
| __str_log(ctx, S_INFO, __VA_ARGS__) |
| #define log_warn(ctx, ...) \ |
| __str_log(ctx, S_WARN, __VA_ARGS__) |
| #define log_err(ctx, ...) \ |
| __str_log(ctx, S_ERROR, __VA_ARGS__) |
| |
| /* Is this debug tweak enabled? */ |
| static inline bool |
| debug_tweak_on( |
| const char *name) |
| { |
| return debug && getenv(name) != NULL; |
| } |
| |
| double timeval_subtract(struct timeval *tv1, struct timeval *tv2); |
| double auto_space_units(unsigned long long kilobytes, char **units); |
| double auto_units(unsigned long long number, char **units, int *precision); |
| unsigned int scrub_nproc(struct scrub_ctx *ctx); |
| unsigned int scrub_nproc_workqueue(struct scrub_ctx *ctx); |
| |
| void background_sleep(void); |
| char *string_escape(const char *in); |
| |
| #define TOO_MANY_NAME_WARNINGS 10000 |
| bool should_warn_about_name(struct scrub_ctx *ctx); |
| |
| bool within_range(struct scrub_ctx *ctx, unsigned long long value, |
| unsigned long long desired, unsigned long long abs_threshold, |
| unsigned int n, unsigned int d, const char *descr); |
| |
| int scrub_render_ino_descr(const struct scrub_ctx *ctx, char *buf, |
| size_t buflen, uint64_t ino, uint32_t gen, |
| const char *format, ...); |
| |
| #endif /* XFS_SCRUB_COMMON_H_ */ |