[thirdparty/xfsprogs-dev.git] / scrub / common.h

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2018 Oracle.  All Rights Reserved.
 * Author: Darrick J. Wong <darrick.wong@oracle.com>
 */
#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 xfs_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);

#ifndef HAVE_SYNCFS
static inline int syncfs(int fd)
{
	sync();
	return 0;
}
#endif

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_ */
Commit	Line	Data
959ef981	1	// SPDX-License-Identifier: GPL-2.0+
95b1e505 DW	2	/*
95b1e505 DW	3	* Copyright (C) 2018 Oracle. All Rights Reserved.
95b1e505	4	* Author: Darrick J. Wong <darrick.wong@oracle.com>
95b1e505 DW	5	*/
	6	#ifndef XFS_SCRUB_COMMON_H_
	7	#define XFS_SCRUB_COMMON_H_
	8
f0585fce DW	9	/*
	10	* When reporting a defective metadata object to the console, this
	11	* is the size of the buffer to use to store the description of that
	12	* item.
	13	*/
	14	#define DESCR_BUFSZ 256
	15
	16	bool xfs_scrub_excessive_errors(struct scrub_ctx *ctx);
	17
	18	enum error_level {
	19	S_ERROR = 0,
abc2e70d	20	S_CORRUPT,
49e05cb0	21	S_UNFIXABLE,
f0585fce DW	22	S_WARN,
f0585fce DW	23	S_INFO,
ca427fe8	24	S_REPAIR,
19852474	25	S_PREEN,
f0585fce DW	26	};
	27
	28	void __str_out(struct scrub_ctx ctx, const char descr, enum error_level level,
	29	int error, const char file, int line, const char format, ...);
	30
	31	#define str_errno(ctx, str) \
	32	__str_out(ctx, str, S_ERROR, errno, __FILE__, __LINE__, NULL)
9612817d DW	33	#define str_liberror(ctx, error, str) \
9612817d DW	34	__str_out(ctx, str, S_ERROR, error, __FILE__, __LINE__, NULL)
abc2e70d DW	35	#define str_corrupt(ctx, str, ...) \
abc2e70d DW	36	__str_out(ctx, str, S_CORRUPT, 0, __FILE__, __LINE__, __VA_ARGS__)
f0585fce DW	37	#define str_error(ctx, str, ...) \
	38	__str_out(ctx, str, S_ERROR, 0, __FILE__, __LINE__, __VA_ARGS__)
	39	#define str_warn(ctx, str, ...) \
	40	__str_out(ctx, str, S_WARN, 0, __FILE__, __LINE__, __VA_ARGS__)
	41	#define str_info(ctx, str, ...) \
	42	__str_out(ctx, str, S_INFO, 0, __FILE__, __LINE__, __VA_ARGS__)
19852474 DW	43	#define record_repair(ctx, str, ...) \
	44	__str_out(ctx, str, S_REPAIR, 0, __FILE__, __LINE__, __VA_ARGS__)
	45	#define record_preen(ctx, str, ...) \
	46	__str_out(ctx, str, S_PREEN, 0, __FILE__, __LINE__, __VA_ARGS__)
49e05cb0 DW	47	#define str_unfixable_error(ctx, str, ...) \
49e05cb0 DW	48	__str_out(ctx, str, S_UNFIXABLE, 0, __FILE__, __LINE__, __VA_ARGS__)
f0585fce DW	49
	50	#define dbg_printf(fmt, ...) \
	51	do {if (debug > 1) {printf(fmt, __VA_ARGS__);}} while (0)
	52
7c309151 DW	53	void __str_log(struct scrub_ctx *ctx, enum error_level level,
	54	const char *format, ...);
	55
	56	#define log_info(ctx, ...) \
	57	__str_log(ctx, S_INFO, __VA_ARGS__)
	58	#define log_warn(ctx, ...) \
	59	__str_log(ctx, S_WARN, __VA_ARGS__)
	60	#define log_err(ctx, ...) \
	61	__str_log(ctx, S_ERROR, __VA_ARGS__)
	62
828105d1 DW	63	/* Is this debug tweak enabled? */
	64	static inline bool
	65	debug_tweak_on(
	66	const char *name)
	67	{
	68	return debug && getenv(name) != NULL;
	69	}
	70
173a0283 DW	71	double timeval_subtract(struct timeval tv1, struct timeval tv2);
173a0283 DW	72	double auto_space_units(unsigned long long kilobytes, char **units);
058f45da	73	double auto_units(unsigned long long number, char *units, int precision);
e031d90f DW	74	unsigned int scrub_nproc(struct scrub_ctx *ctx);
e031d90f DW	75	unsigned int scrub_nproc_workqueue(struct scrub_ctx *ctx);
173a0283	76
50a573a7 DW	77	#ifndef HAVE_SYNCFS
	78	static inline int syncfs(int fd)
	79	{
	80	sync();
	81	return 0;
	82	}
	83	#endif
	84
fd7d73c0	85	void background_sleep(void);
396cd022 DW	86	char string_escape(const char in);
	87
	88	#define TOO_MANY_NAME_WARNINGS 10000
	89	bool should_warn_about_name(struct scrub_ctx *ctx);
50a573a7	90
698c6c7c DW	91	bool within_range(struct scrub_ctx *ctx, unsigned long long value,
	92	unsigned long long desired, unsigned long long abs_threshold,
	93	unsigned int n, unsigned int d, const char *descr);
	94
15589f0a DW	95	int scrub_render_ino_descr(const struct scrub_ctx ctx, char buf,
	96	size_t buflen, uint64_t ino, uint32_t gen,
	97	const char *format, ...);
	98
95b1e505	99	#endif /* XFS_SCRUB_COMMON_H_ */