[people/ms/linux.git] / fs / gfs2 / util.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) Sistina Software, Inc.  1997-2003 All rights reserved.
 * Copyright (C) 2004-2006 Red Hat, Inc.  All rights reserved.
 */

#ifndef __UTIL_DOT_H__
#define __UTIL_DOT_H__

#ifdef pr_fmt
#undef pr_fmt
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
#endif

#include <linux/mempool.h>

#include "incore.h"

#define fs_emerg(fs, fmt, ...)						\
	pr_emerg("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
#define fs_warn(fs, fmt, ...)						\
	pr_warn("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
#define fs_err(fs, fmt, ...)						\
	pr_err("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
#define fs_info(fs, fmt, ...)						\
	pr_info("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)

void gfs2_assert_i(struct gfs2_sbd *sdp);

#define gfs2_assert(sdp, assertion) \
do { \
	if (unlikely(!(assertion))) { \
		gfs2_assert_i(sdp); \
		BUG(); \
        } \
} while (0)


void gfs2_assert_withdraw_i(struct gfs2_sbd *sdp, char *assertion,
			    const char *function, char *file, unsigned int line,
			    bool delayed);

#define gfs2_assert_withdraw(sdp, assertion) \
	({ \
		bool _bool = (assertion); \
		if (unlikely(!_bool)) \
			gfs2_assert_withdraw_i((sdp), #assertion, \
					__func__, __FILE__, __LINE__, false); \
		!_bool; \
	})

#define gfs2_assert_withdraw_delayed(sdp, assertion) \
	({ \
		bool _bool = (assertion); \
		if (unlikely(!_bool)) \
			gfs2_assert_withdraw_i((sdp), #assertion, \
					__func__, __FILE__, __LINE__, true); \
		!_bool; \
	})

void gfs2_assert_warn_i(struct gfs2_sbd *sdp, char *assertion,
			const char *function, char *file, unsigned int line);

#define gfs2_assert_warn(sdp, assertion) \
	({ \
		bool _bool = (assertion); \
		if (unlikely(!_bool)) \
			gfs2_assert_warn_i((sdp), #assertion, \
					__func__, __FILE__, __LINE__); \
		!_bool; \
	})

void gfs2_consist_i(struct gfs2_sbd *sdp,
		    const char *function, char *file, unsigned int line);

#define gfs2_consist(sdp) \
gfs2_consist_i((sdp), __func__, __FILE__, __LINE__)


void gfs2_consist_inode_i(struct gfs2_inode *ip,
			  const char *function, char *file, unsigned int line);

#define gfs2_consist_inode(ip) \
gfs2_consist_inode_i((ip), __func__, __FILE__, __LINE__)


void gfs2_consist_rgrpd_i(struct gfs2_rgrpd *rgd,
			  const char *function, char *file, unsigned int line);

#define gfs2_consist_rgrpd(rgd) \
gfs2_consist_rgrpd_i((rgd), __func__, __FILE__, __LINE__)


int gfs2_meta_check_ii(struct gfs2_sbd *sdp, struct buffer_head *bh,
		       const char *type, const char *function,
		       char *file, unsigned int line);

static inline int gfs2_meta_check(struct gfs2_sbd *sdp,
				    struct buffer_head *bh)
{
	struct gfs2_meta_header *mh = (struct gfs2_meta_header *)bh->b_data;
	u32 magic = be32_to_cpu(mh->mh_magic);
	if (unlikely(magic != GFS2_MAGIC)) {
		fs_err(sdp, "Magic number missing at %llu\n",
		       (unsigned long long)bh->b_blocknr);
		return -EIO;
	}
	return 0;
}

int gfs2_metatype_check_ii(struct gfs2_sbd *sdp, struct buffer_head *bh,
			   u16 type, u16 t,
			   const char *function,
			   char *file, unsigned int line);

static inline int gfs2_metatype_check_i(struct gfs2_sbd *sdp,
					struct buffer_head *bh,
					u16 type,
					const char *function,
					char *file, unsigned int line)
{
	struct gfs2_meta_header *mh = (struct gfs2_meta_header *)bh->b_data;
	u32 magic = be32_to_cpu(mh->mh_magic);
	u16 t = be32_to_cpu(mh->mh_type);
	if (unlikely(magic != GFS2_MAGIC))
		return gfs2_meta_check_ii(sdp, bh, "magic number", function,
					  file, line);
        if (unlikely(t != type))
		return gfs2_metatype_check_ii(sdp, bh, type, t, function,
					      file, line);
	return 0;
}

#define gfs2_metatype_check(sdp, bh, type) \
gfs2_metatype_check_i((sdp), (bh), (type), __func__, __FILE__, __LINE__)

static inline void gfs2_metatype_set(struct buffer_head *bh, u16 type,
				     u16 format)
{
	struct gfs2_meta_header *mh;
	mh = (struct gfs2_meta_header *)bh->b_data;
	mh->mh_type = cpu_to_be32(type);
	mh->mh_format = cpu_to_be32(format);
}


int gfs2_io_error_i(struct gfs2_sbd *sdp, const char *function,
		    char *file, unsigned int line);

extern int check_journal_clean(struct gfs2_sbd *sdp, struct gfs2_jdesc *jd,
			       bool verbose);
extern int gfs2_freeze_lock(struct gfs2_sbd *sdp,
			    struct gfs2_holder *freeze_gh, int caller_flags);
extern void gfs2_freeze_unlock(struct gfs2_holder *freeze_gh);

#define gfs2_io_error(sdp) \
gfs2_io_error_i((sdp), __func__, __FILE__, __LINE__)


void gfs2_io_error_bh_i(struct gfs2_sbd *sdp, struct buffer_head *bh,
			const char *function, char *file, unsigned int line,
			bool withdraw);

#define gfs2_io_error_bh_wd(sdp, bh) \
gfs2_io_error_bh_i((sdp), (bh), __func__, __FILE__, __LINE__, true)

#define gfs2_io_error_bh(sdp, bh) \
gfs2_io_error_bh_i((sdp), (bh), __func__, __FILE__, __LINE__, false)


extern struct kmem_cache *gfs2_glock_cachep;
extern struct kmem_cache *gfs2_glock_aspace_cachep;
extern struct kmem_cache *gfs2_inode_cachep;
extern struct kmem_cache *gfs2_bufdata_cachep;
extern struct kmem_cache *gfs2_rgrpd_cachep;
extern struct kmem_cache *gfs2_quotad_cachep;
extern struct kmem_cache *gfs2_qadata_cachep;
extern struct kmem_cache *gfs2_trans_cachep;
extern mempool_t *gfs2_page_pool;
extern struct workqueue_struct *gfs2_control_wq;

static inline unsigned int gfs2_tune_get_i(struct gfs2_tune *gt,
					   unsigned int *p)
{
	unsigned int x;
	spin_lock(&gt->gt_spin);
	x = *p;
	spin_unlock(&gt->gt_spin);
	return x;
}

/**
 * gfs2_withdraw_delayed - withdraw as soon as possible without deadlocks
 * @sdp: the superblock
 */
static inline void gfs2_withdraw_delayed(struct gfs2_sbd *sdp)
{
	set_bit(SDF_WITHDRAWING, &sdp->sd_flags);
}

/**
 * gfs2_withdrawn - test whether the file system is withdrawing or withdrawn
 * @sdp: the superblock
 */
static inline bool gfs2_withdrawn(struct gfs2_sbd *sdp)
{
	return test_bit(SDF_WITHDRAWN, &sdp->sd_flags) ||
		test_bit(SDF_WITHDRAWING, &sdp->sd_flags);
}

/**
 * gfs2_withdrawing - check if a withdraw is pending
 * @sdp: the superblock
 */
static inline bool gfs2_withdrawing(struct gfs2_sbd *sdp)
{
	return test_bit(SDF_WITHDRAWING, &sdp->sd_flags) &&
	       !test_bit(SDF_WITHDRAWN, &sdp->sd_flags);
}

static inline bool gfs2_withdraw_in_prog(struct gfs2_sbd *sdp)
{
	return test_bit(SDF_WITHDRAW_IN_PROG, &sdp->sd_flags);
}

#define gfs2_tune_get(sdp, field) \
gfs2_tune_get_i(&(sdp)->sd_tune, &(sdp)->sd_tune.field)

__printf(2, 3)
void gfs2_lm(struct gfs2_sbd *sdp, const char *fmt, ...);
int gfs2_withdraw(struct gfs2_sbd *sdp);

#endif /* __UTIL_DOT_H__ */
Commit	Line	Data
7336d0e6	1	/* SPDX-License-Identifier: GPL-2.0-only */
b3b94faa DT	2	/*
b3b94faa DT	3	* Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
3a8a9a10	4	* Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
b3b94faa DT	5	*/
	6
	7	#ifndef __UTIL_DOT_H__
	8	#define __UTIL_DOT_H__
	9
d77d1b58 JP	10	#ifdef pr_fmt
	11	#undef pr_fmt
	12	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	13	#endif
	14
75ca61c1 SW	15	#include <linux/mempool.h>
75ca61c1 SW	16
f2f7ba52	17	#include "incore.h"
b3b94faa	18
8382e26b JP	19	#define fs_emerg(fs, fmt, ...) \
8382e26b JP	20	pr_emerg("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
d77d1b58 JP	21	#define fs_warn(fs, fmt, ...) \
	22	pr_warn("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
	23	#define fs_err(fs, fmt, ...) \
	24	pr_err("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
	25	#define fs_info(fs, fmt, ...) \
	26	pr_info("fsid=%s: " fmt, (fs)->sd_fsname, ##__VA_ARGS__)
b3b94faa DT	27
	28	void gfs2_assert_i(struct gfs2_sbd *sdp);
	29
	30	#define gfs2_assert(sdp, assertion) \
	31	do { \
	32	if (unlikely(!(assertion))) { \
	33	gfs2_assert_i(sdp); \
1e09ae54	34	BUG(); \
b3b94faa DT	35	} \
	36	} while (0)
	37
	38
8e28ef1f	39	void gfs2_assert_withdraw_i(struct gfs2_sbd sdp, char assertion,
ca399c96 BP	40	const char function, char file, unsigned int line,
ca399c96 BP	41	bool delayed);
b3b94faa DT	42
b3b94faa DT	43	#define gfs2_assert_withdraw(sdp, assertion) \
8e28ef1f AG	44	({ \
	45	bool _bool = (assertion); \
	46	if (unlikely(!_bool)) \
	47	gfs2_assert_withdraw_i((sdp), #assertion, \
ca399c96 BP	48	__func__, __FILE__, __LINE__, false); \
	49	!_bool; \
	50	})
	51
	52	#define gfs2_assert_withdraw_delayed(sdp, assertion) \
	53	({ \
	54	bool _bool = (assertion); \
	55	if (unlikely(!_bool)) \
	56	gfs2_assert_withdraw_i((sdp), #assertion, \
	57	__func__, __FILE__, __LINE__, true); \
8e28ef1f AG	58	!_bool; \
8e28ef1f AG	59	})
b3b94faa	60
8e28ef1f AG	61	void gfs2_assert_warn_i(struct gfs2_sbd sdp, char assertion,
8e28ef1f AG	62	const char function, char file, unsigned int line);
b3b94faa DT	63
b3b94faa DT	64	#define gfs2_assert_warn(sdp, assertion) \
8e28ef1f AG	65	({ \
	66	bool _bool = (assertion); \
	67	if (unlikely(!_bool)) \
	68	gfs2_assert_warn_i((sdp), #assertion, \
	69	__func__, __FILE__, __LINE__); \
	70	!_bool; \
	71	})
b3b94faa	72
a5ca2f1c AG	73	void gfs2_consist_i(struct gfs2_sbd *sdp,
a5ca2f1c AG	74	const char function, char file, unsigned int line);
b3b94faa DT	75
b3b94faa DT	76	#define gfs2_consist(sdp) \
d7e7ab3f	77	gfs2_consist_i((sdp), __func__, __FILE__, __LINE__)
b3b94faa DT	78
b3b94faa DT	79
a5ca2f1c AG	80	void gfs2_consist_inode_i(struct gfs2_inode *ip,
a5ca2f1c AG	81	const char function, char file, unsigned int line);
b3b94faa DT	82
b3b94faa DT	83	#define gfs2_consist_inode(ip) \
d7e7ab3f	84	gfs2_consist_inode_i((ip), __func__, __FILE__, __LINE__)
b3b94faa DT	85
b3b94faa DT	86
a5ca2f1c AG	87	void gfs2_consist_rgrpd_i(struct gfs2_rgrpd *rgd,
a5ca2f1c AG	88	const char function, char file, unsigned int line);
b3b94faa DT	89
b3b94faa DT	90	#define gfs2_consist_rgrpd(rgd) \
d7e7ab3f	91	gfs2_consist_rgrpd_i((rgd), __func__, __FILE__, __LINE__)
b3b94faa DT	92
	93
	94	int gfs2_meta_check_ii(struct gfs2_sbd sdp, struct buffer_head bh,
	95	const char type, const char function,
	96	char *file, unsigned int line);
	97
1b8ba31a SW	98	static inline int gfs2_meta_check(struct gfs2_sbd *sdp,
1b8ba31a SW	99	struct buffer_head *bh)
b3b94faa DT	100	{
b3b94faa DT	101	struct gfs2_meta_header mh = (struct gfs2_meta_header )bh->b_data;
b44b84d7	102	u32 magic = be32_to_cpu(mh->mh_magic);
1b8ba31a	103	if (unlikely(magic != GFS2_MAGIC)) {
e54c78a2	104	fs_err(sdp, "Magic number missing at %llu\n",
1b8ba31a SW	105	(unsigned long long)bh->b_blocknr);
	106	return -EIO;
	107	}
b3b94faa DT	108	return 0;
	109	}
	110
b3b94faa	111	int gfs2_metatype_check_ii(struct gfs2_sbd sdp, struct buffer_head bh,
cd915493	112	u16 type, u16 t,
b3b94faa DT	113	const char *function,
	114	char *file, unsigned int line);
	115
	116	static inline int gfs2_metatype_check_i(struct gfs2_sbd *sdp,
	117	struct buffer_head *bh,
cd915493	118	u16 type,
b3b94faa DT	119	const char *function,
	120	char *file, unsigned int line)
	121	{
	122	struct gfs2_meta_header mh = (struct gfs2_meta_header )bh->b_data;
b44b84d7	123	u32 magic = be32_to_cpu(mh->mh_magic);
cd915493	124	u16 t = be32_to_cpu(mh->mh_type);
b3b94faa DT	125	if (unlikely(magic != GFS2_MAGIC))
	126	return gfs2_meta_check_ii(sdp, bh, "magic number", function,
	127	file, line);
b3b94faa DT	128	if (unlikely(t != type))
	129	return gfs2_metatype_check_ii(sdp, bh, type, t, function,
	130	file, line);
	131	return 0;
	132	}
	133
	134	#define gfs2_metatype_check(sdp, bh, type) \
8e24eea7	135	gfs2_metatype_check_i((sdp), (bh), (type), __func__, __FILE__, __LINE__)
b3b94faa	136
cd915493 SW	137	static inline void gfs2_metatype_set(struct buffer_head *bh, u16 type,
cd915493 SW	138	u16 format)
b3b94faa DT	139	{
	140	struct gfs2_meta_header *mh;
	141	mh = (struct gfs2_meta_header *)bh->b_data;
e3167ded SW	142	mh->mh_type = cpu_to_be32(type);
e3167ded SW	143	mh->mh_format = cpu_to_be32(format);
b3b94faa DT	144	}
	145
	146
	147	int gfs2_io_error_i(struct gfs2_sbd sdp, const char function,
	148	char *file, unsigned int line);
7d9f9249 BP	149
	150	extern int check_journal_clean(struct gfs2_sbd sdp, struct gfs2_jdesc jd,
	151	bool verbose);
c77b52c0 BP	152	extern int gfs2_freeze_lock(struct gfs2_sbd *sdp,
	153	struct gfs2_holder *freeze_gh, int caller_flags);
	154	extern void gfs2_freeze_unlock(struct gfs2_holder *freeze_gh);
b3b94faa DT	155
b3b94faa DT	156	#define gfs2_io_error(sdp) \
28c332b9	157	gfs2_io_error_i((sdp), __func__, __FILE__, __LINE__)
b3b94faa DT	158
b3b94faa DT	159
9e1a9ecd AG	160	void gfs2_io_error_bh_i(struct gfs2_sbd sdp, struct buffer_head bh,
	161	const char function, char file, unsigned int line,
	162	bool withdraw);
	163
	164	#define gfs2_io_error_bh_wd(sdp, bh) \
28c332b9	165	gfs2_io_error_bh_i((sdp), (bh), __func__, __FILE__, __LINE__, true)
b3b94faa DT	166
b3b94faa DT	167	#define gfs2_io_error_bh(sdp, bh) \
28c332b9	168	gfs2_io_error_bh_i((sdp), (bh), __func__, __FILE__, __LINE__, false)
b3b94faa DT	169
b3b94faa DT	170
e18b890b	171	extern struct kmem_cache *gfs2_glock_cachep;
009d8518	172	extern struct kmem_cache *gfs2_glock_aspace_cachep;
e18b890b CL	173	extern struct kmem_cache *gfs2_inode_cachep;
e18b890b CL	174	extern struct kmem_cache *gfs2_bufdata_cachep;
6bdd9be6	175	extern struct kmem_cache *gfs2_rgrpd_cachep;
37b2c837	176	extern struct kmem_cache *gfs2_quotad_cachep;
b54e9a0b	177	extern struct kmem_cache *gfs2_qadata_cachep;
b839dada	178	extern struct kmem_cache *gfs2_trans_cachep;
e8c92ed7	179	extern mempool_t *gfs2_page_pool;
27c3b415	180	extern struct workqueue_struct *gfs2_control_wq;
b3b94faa	181
b3b94faa DT	182	static inline unsigned int gfs2_tune_get_i(struct gfs2_tune *gt,
	183	unsigned int *p)
	184	{
	185	unsigned int x;
	186	spin_lock(&gt->gt_spin);
	187	x = *p;
	188	spin_unlock(&gt->gt_spin);
	189	return x;
	190	}
	191
69511080 BP	192	/**
	193	* gfs2_withdraw_delayed - withdraw as soon as possible without deadlocks
	194	* @sdp: the superblock
	195	*/
	196	static inline void gfs2_withdraw_delayed(struct gfs2_sbd *sdp)
	197	{
	198	set_bit(SDF_WITHDRAWING, &sdp->sd_flags);
	199	}
	200
eb43e660 BP	201	/**
	202	* gfs2_withdrawn - test whether the file system is withdrawing or withdrawn
	203	* @sdp: the superblock
	204	*/
	205	static inline bool gfs2_withdrawn(struct gfs2_sbd *sdp)
	206	{
69511080 BP	207	return test_bit(SDF_WITHDRAWN, &sdp->sd_flags) \|\|
69511080 BP	208	test_bit(SDF_WITHDRAWING, &sdp->sd_flags);
eb43e660 BP	209	}
eb43e660 BP	210
5a61ae14 AG	211	/**
	212	* gfs2_withdrawing - check if a withdraw is pending
	213	* @sdp: the superblock
	214	*/
	215	static inline bool gfs2_withdrawing(struct gfs2_sbd *sdp)
	216	{
	217	return test_bit(SDF_WITHDRAWING, &sdp->sd_flags) &&
	218	!test_bit(SDF_WITHDRAWN, &sdp->sd_flags);
	219	}
	220
8cc67f70 BP	221	static inline bool gfs2_withdraw_in_prog(struct gfs2_sbd *sdp)
	222	{
	223	return test_bit(SDF_WITHDRAW_IN_PROG, &sdp->sd_flags);
	224	}
	225
b3b94faa DT	226	#define gfs2_tune_get(sdp, field) \
	227	gfs2_tune_get_i(&(sdp)->sd_tune, &(sdp)->sd_tune.field)
	228
cb94eb06	229	__printf(2, 3)
badb55ec AG	230	void gfs2_lm(struct gfs2_sbd sdp, const char fmt, ...);
badb55ec AG	231	int gfs2_withdraw(struct gfs2_sbd *sdp);
b3b94faa DT	232
b3b94faa DT	233	#endif /* __UTIL_DOT_H__ */