[linux.git] / fs / xfs / xfs_log.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef	__XFS_LOG_H__
#define __XFS_LOG_H__

struct xfs_log_vec {
	struct xfs_log_vec	*lv_next;	/* next lv in build list */
	int			lv_niovecs;	/* number of iovecs in lv */
	struct xfs_log_iovec	*lv_iovecp;	/* iovec array */
	struct xfs_log_item	*lv_item;	/* owner */
	char			*lv_buf;	/* formatted buffer */
	int			lv_bytes;	/* accounted space in buffer */
	int			lv_buf_len;	/* aligned size of buffer */
	int			lv_size;	/* size of allocated lv */
};

#define XFS_LOG_VEC_ORDERED	(-1)

static inline void *
xlog_prepare_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
		uint type)
{
	struct xfs_log_iovec *vec = *vecp;

	if (vec) {
		ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
		vec++;
	} else {
		vec = &lv->lv_iovecp[0];
	}

	vec->i_type = type;
	vec->i_addr = lv->lv_buf + lv->lv_buf_len;

	ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));

	*vecp = vec;
	return vec->i_addr;
}

/*
 * We need to make sure the next buffer is naturally aligned for the biggest
 * basic data type we put into it.  We already accounted for this padding when
 * sizing the buffer.
 *
 * However, this padding does not get written into the log, and hence we have to
 * track the space used by the log vectors separately to prevent log space hangs
 * due to inaccurate accounting (i.e. a leak) of the used log space through the
 * CIL context ticket.
 */
static inline void
xlog_finish_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec *vec, int len)
{
	lv->lv_buf_len += round_up(len, sizeof(uint64_t));
	lv->lv_bytes += len;
	vec->i_len = len;
}

static inline void *
xlog_copy_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
		uint type, void *data, int len)
{
	void *buf;

	buf = xlog_prepare_iovec(lv, vecp, type);
	memcpy(buf, data, len);
	xlog_finish_iovec(lv, *vecp, len);
	return buf;
}

/*
 * Structure used to pass callback function and the function's argument
 * to the log manager.
 */
typedef struct xfs_log_callback {
	struct xfs_log_callback	*cb_next;
	void			(*cb_func)(void *, int);
	void			*cb_arg;
} xfs_log_callback_t;

/*
 * By comparing each component, we don't have to worry about extra
 * endian issues in treating two 32 bit numbers as one 64 bit number
 */
static inline xfs_lsn_t	_lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
{
	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
		return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;

	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
		return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;

	return 0;
}

#define	XFS_LSN_CMP(x,y) _lsn_cmp(x,y)

/*
 * Flags to xfs_log_force()
 *
 *	XFS_LOG_SYNC:	Synchronous force in-core log to disk
 */
#define XFS_LOG_SYNC		0x1

/* Log manager interfaces */
struct xfs_mount;
struct xlog_in_core;
struct xlog_ticket;
struct xfs_log_item;
struct xfs_item_ops;
struct xfs_trans;

xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
		       struct xlog_ticket *ticket,
		       struct xlog_in_core **iclog,
		       bool regrant);
int	  xfs_log_force(struct xfs_mount *mp, uint flags);
int	  xfs_log_force_lsn(struct xfs_mount *mp, xfs_lsn_t lsn, uint flags,
		int *log_forced);
int	  xfs_log_mount(struct xfs_mount	*mp,
			struct xfs_buftarg	*log_target,
			xfs_daddr_t		start_block,
			int		 	num_bblocks);
int	  xfs_log_mount_finish(struct xfs_mount *mp);
int	xfs_log_mount_cancel(struct xfs_mount *);
xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
void	  xfs_log_space_wake(struct xfs_mount *mp);
int	  xfs_log_notify(struct xlog_in_core	*iclog,
			 struct xfs_log_callback *callback_entry);
int	  xfs_log_release_iclog(struct xfs_mount *mp,
			 struct xlog_in_core	 *iclog);
int	  xfs_log_reserve(struct xfs_mount *mp,
			  int		   length,
			  int		   count,
			  struct xlog_ticket **ticket,
			  uint8_t		   clientid,
			  bool		   permanent);
int	  xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
void      xfs_log_unmount(struct xfs_mount *mp);
int	  xfs_log_force_umount(struct xfs_mount *mp, int logerror);

struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
void	  xfs_log_ticket_put(struct xlog_ticket *ticket);

void	xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
				xfs_lsn_t *commit_lsn, bool regrant);
bool	xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);

void	xfs_log_work_queue(struct xfs_mount *mp);
void	xfs_log_quiesce(struct xfs_mount *mp);
bool	xfs_log_check_lsn(struct xfs_mount *, xfs_lsn_t);
bool	xfs_log_in_recovery(struct xfs_mount *);

#endif	/* __XFS_LOG_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
1da177e4	2	/*
7b718769 NS	3	* Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
7b718769 NS	4	* All Rights Reserved.
1da177e4 LT	5	*/
	6	#ifndef __XFS_LOG_H__
	7	#define __XFS_LOG_H__
	8
fc06c6d0 DC	9	struct xfs_log_vec {
	10	struct xfs_log_vec lv_next; / next lv in build list */
	11	int lv_niovecs; /* number of iovecs in lv */
	12	struct xfs_log_iovec lv_iovecp; / iovec array */
	13	struct xfs_log_item lv_item; / owner */
	14	char lv_buf; / formatted buffer */
110dc24a DC	15	int lv_bytes; /* accounted space in buffer */
110dc24a DC	16	int lv_buf_len; /* aligned size of buffer */
7492c5b4	17	int lv_size; /* size of allocated lv */
fc06c6d0 DC	18	};
	19
	20	#define XFS_LOG_VEC_ORDERED (-1)
	21
1234351c	22	static inline void *
bde7cff6 CH	23	xlog_prepare_iovec(struct xfs_log_vec lv, struct xfs_log_iovec *vecp,
bde7cff6 CH	24	uint type)
1234351c CH	25	{
	26	struct xfs_log_iovec vec = vecp;
	27
bde7cff6 CH	28	if (vec) {
	29	ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
	30	vec++;
	31	} else {
	32	vec = &lv->lv_iovecp[0];
	33	}
	34
1234351c	35	vec->i_type = type;
bde7cff6 CH	36	vec->i_addr = lv->lv_buf + lv->lv_buf_len;
	37
	38	ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));
1234351c	39
bde7cff6	40	*vecp = vec;
1234351c CH	41	return vec->i_addr;
	42	}
	43
110dc24a DC	44	/*
	45	* We need to make sure the next buffer is naturally aligned for the biggest
	46	* basic data type we put into it. We already accounted for this padding when
	47	* sizing the buffer.
	48	*
	49	* However, this padding does not get written into the log, and hence we have to
	50	* track the space used by the log vectors separately to prevent log space hangs
	51	* due to inaccurate accounting (i.e. a leak) of the used log space through the
	52	* CIL context ticket.
	53	*/
bde7cff6 CH	54	static inline void
	55	xlog_finish_iovec(struct xfs_log_vec lv, struct xfs_log_iovec vec, int len)
	56	{
bde7cff6	57	lv->lv_buf_len += round_up(len, sizeof(uint64_t));
110dc24a	58	lv->lv_bytes += len;
bde7cff6 CH	59	vec->i_len = len;
	60	}
	61
	62	static inline void *
	63	xlog_copy_iovec(struct xfs_log_vec lv, struct xfs_log_iovec *vecp,
	64	uint type, void *data, int len)
	65	{
	66	void *buf;
	67
	68	buf = xlog_prepare_iovec(lv, vecp, type);
	69	memcpy(buf, data, len);
	70	xlog_finish_iovec(lv, *vecp, len);
	71	return buf;
	72	}
	73
fc06c6d0 DC	74	/*
	75	* Structure used to pass callback function and the function's argument
	76	* to the log manager.
	77	*/
	78	typedef struct xfs_log_callback {
	79	struct xfs_log_callback *cb_next;
	80	void (cb_func)(void , int);
	81	void *cb_arg;
	82	} xfs_log_callback_t;
1da177e4	83
1da177e4	84	/*
c41564b5	85	* By comparing each component, we don't have to worry about extra
1da177e4 LT	86	* endian issues in treating two 32 bit numbers as one 64 bit number
1da177e4 LT	87	*/
a1365647	88	static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
1da177e4 LT	89	{
	90	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
	91	return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
	92
	93	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
	94	return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
	95
	96	return 0;
	97	}
	98
	99	#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
	100
1da177e4 LT	101	/*
	102	* Flags to xfs_log_force()
	103	*
	104	* XFS_LOG_SYNC: Synchronous force in-core log to disk
1da177e4 LT	105	*/
1da177e4 LT	106	#define XFS_LOG_SYNC 0x1
1da177e4	107
1da177e4 LT	108	/* Log manager interfaces */
1da177e4 LT	109	struct xfs_mount;
35a8a72f	110	struct xlog_in_core;
cc09c0dc	111	struct xlog_ticket;
43f5efc5 DC	112	struct xfs_log_item;
43f5efc5 DC	113	struct xfs_item_ops;
955833cf	114	struct xfs_trans;
35a8a72f	115
1da177e4	116	xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
35a8a72f CH	117	struct xlog_ticket *ticket,
35a8a72f CH	118	struct xlog_in_core **iclog,
f78c3901	119	bool regrant);
60e5bb78	120	int xfs_log_force(struct xfs_mount *mp, uint flags);
656de4ff CH	121	int xfs_log_force_lsn(struct xfs_mount *mp, xfs_lsn_t lsn, uint flags,
656de4ff CH	122	int *log_forced);
1da177e4 LT	123	int xfs_log_mount(struct xfs_mount *mp,
	124	struct xfs_buftarg *log_target,
	125	xfs_daddr_t start_block,
	126	int num_bblocks);
4249023a	127	int xfs_log_mount_finish(struct xfs_mount *mp);
f0b2efad	128	int xfs_log_mount_cancel(struct xfs_mount *);
09a423a3	129	xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
1c304625	130	xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
cfb7cdca	131	void xfs_log_space_wake(struct xfs_mount *mp);
a1f69417	132	int xfs_log_notify(struct xlog_in_core *iclog,
239880ef	133	struct xfs_log_callback *callback_entry);
1da177e4	134	int xfs_log_release_iclog(struct xfs_mount *mp,
35a8a72f	135	struct xlog_in_core *iclog);
1da177e4 LT	136	int xfs_log_reserve(struct xfs_mount *mp,
	137	int length,
	138	int count,
35a8a72f	139	struct xlog_ticket **ticket,
c8ce540d	140	uint8_t clientid,
710b1e2c	141	bool permanent);
9006fb91	142	int xfs_log_regrant(struct xfs_mount mp, struct xlog_ticket tic);
21b699c8	143	void xfs_log_unmount(struct xfs_mount *mp);
1da177e4	144	int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
1da177e4	145
71e330b5	146	struct xlog_ticket xfs_log_ticket_get(struct xlog_ticket ticket);
cc09c0dc DC	147	void xfs_log_ticket_put(struct xlog_ticket *ticket);
cc09c0dc DC	148
c6f97264	149	void xfs_log_commit_cil(struct xfs_mount mp, struct xfs_trans tp,
70393313	150	xfs_lsn_t *commit_lsn, bool regrant);
ccf7c23f	151	bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
71e330b5	152
f661f1e0	153	void xfs_log_work_queue(struct xfs_mount *mp);
c75921a7	154	void xfs_log_quiesce(struct xfs_mount *mp);
a45086e2	155	bool xfs_log_check_lsn(struct xfs_mount *, xfs_lsn_t);
0c60d3aa	156	bool xfs_log_in_recovery(struct xfs_mount *);
f661f1e0	157
1da177e4	158	#endif /* __XFS_LOG_H__ */