[mirror_ubuntu-zesty-kernel.git] / fs / xfs / xfs_log.h

/*
 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#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)

/*
 * Macros, structures, prototypes for interface to the log manager.
 */

/*
 * Flags to xfs_log_done()
 */
#define XFS_LOG_REL_PERM_RESERV	0x1

/*
 * 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;
struct xfs_log_callback;

xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
		       struct xlog_ticket *ticket,
		       struct xlog_in_core **iclog,
		       uint		flags);
int	  _xfs_log_force(struct xfs_mount *mp,
			 uint		flags,
			 int		*log_forced);
void	  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);
void	  xfs_log_force_lsn(struct xfs_mount	*mp,
			    xfs_lsn_t		lsn,
			    uint		flags);
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);
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 xfs_mount	*mp,
			 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,
			  uint		   t_type);
int	  xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
int	  xfs_log_unmount_write(struct xfs_mount *mp);
void      xfs_log_unmount(struct xfs_mount *mp);
int	  xfs_log_force_umount(struct xfs_mount *mp, int logerror);
int	  xfs_log_need_covered(struct xfs_mount *mp);

void	  xlog_iodone(struct xfs_buf *);

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, int flags);
bool	xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);

void	xfs_log_work_queue(struct xfs_mount *mp);
void	xfs_log_worker(struct work_struct *work);
void	xfs_log_quiesce(struct xfs_mount *mp);

#endif	/* __XFS_LOG_H__ */
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	9	* This program is distributed in the hope that it would be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
1da177e4	13	*
7b718769 NS	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write the Free Software Foundation,
	16	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
1da177e4 LT	17	*/
	18	#ifndef __XFS_LOG_H__
	19	#define __XFS_LOG_H__
	20
fc06c6d0 DC	21	struct xfs_log_vec {
	22	struct xfs_log_vec lv_next; / next lv in build list */
	23	int lv_niovecs; /* number of iovecs in lv */
	24	struct xfs_log_iovec lv_iovecp; / iovec array */
	25	struct xfs_log_item lv_item; / owner */
	26	char lv_buf; / formatted buffer */
110dc24a DC	27	int lv_bytes; /* accounted space in buffer */
110dc24a DC	28	int lv_buf_len; /* aligned size of buffer */
7492c5b4	29	int lv_size; /* size of allocated lv */
fc06c6d0 DC	30	};
	31
	32	#define XFS_LOG_VEC_ORDERED (-1)
	33
1234351c	34	static inline void *
bde7cff6 CH	35	xlog_prepare_iovec(struct xfs_log_vec lv, struct xfs_log_iovec *vecp,
bde7cff6 CH	36	uint type)
1234351c CH	37	{
	38	struct xfs_log_iovec vec = vecp;
	39
bde7cff6 CH	40	if (vec) {
	41	ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
	42	vec++;
	43	} else {
	44	vec = &lv->lv_iovecp[0];
	45	}
	46
1234351c	47	vec->i_type = type;
bde7cff6 CH	48	vec->i_addr = lv->lv_buf + lv->lv_buf_len;
	49
	50	ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));
1234351c	51
bde7cff6	52	*vecp = vec;
1234351c CH	53	return vec->i_addr;
	54	}
	55
110dc24a DC	56	/*
	57	* We need to make sure the next buffer is naturally aligned for the biggest
	58	* basic data type we put into it. We already accounted for this padding when
	59	* sizing the buffer.
	60	*
	61	* However, this padding does not get written into the log, and hence we have to
	62	* track the space used by the log vectors separately to prevent log space hangs
	63	* due to inaccurate accounting (i.e. a leak) of the used log space through the
	64	* CIL context ticket.
	65	*/
bde7cff6 CH	66	static inline void
	67	xlog_finish_iovec(struct xfs_log_vec lv, struct xfs_log_iovec vec, int len)
	68	{
bde7cff6	69	lv->lv_buf_len += round_up(len, sizeof(uint64_t));
110dc24a	70	lv->lv_bytes += len;
bde7cff6 CH	71	vec->i_len = len;
	72	}
	73
	74	static inline void *
	75	xlog_copy_iovec(struct xfs_log_vec lv, struct xfs_log_iovec *vecp,
	76	uint type, void *data, int len)
	77	{
	78	void *buf;
	79
	80	buf = xlog_prepare_iovec(lv, vecp, type);
	81	memcpy(buf, data, len);
	82	xlog_finish_iovec(lv, *vecp, len);
	83	return buf;
	84	}
	85
fc06c6d0 DC	86	/*
	87	* Structure used to pass callback function and the function's argument
	88	* to the log manager.
	89	*/
	90	typedef struct xfs_log_callback {
	91	struct xfs_log_callback *cb_next;
	92	void (cb_func)(void , int);
	93	void *cb_arg;
	94	} xfs_log_callback_t;
1da177e4	95
1da177e4	96	/*
c41564b5	97	* By comparing each component, we don't have to worry about extra
1da177e4 LT	98	* endian issues in treating two 32 bit numbers as one 64 bit number
1da177e4 LT	99	*/
a1365647	100	static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
1da177e4 LT	101	{
	102	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
	103	return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
	104
	105	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
	106	return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
	107
	108	return 0;
	109	}
	110
	111	#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
	112
	113	/*
	114	* Macros, structures, prototypes for interface to the log manager.
	115	*/
	116
1da177e4 LT	117	/*
	118	* Flags to xfs_log_done()
	119	*/
	120	#define XFS_LOG_REL_PERM_RESERV 0x1
	121
1da177e4 LT	122	/*
	123	* Flags to xfs_log_force()
	124	*
	125	* XFS_LOG_SYNC: Synchronous force in-core log to disk
1da177e4 LT	126	*/
1da177e4 LT	127	#define XFS_LOG_SYNC 0x1
1da177e4	128
1da177e4 LT	129	/* Log manager interfaces */
1da177e4 LT	130	struct xfs_mount;
35a8a72f	131	struct xlog_in_core;
cc09c0dc	132	struct xlog_ticket;
43f5efc5 DC	133	struct xfs_log_item;
43f5efc5 DC	134	struct xfs_item_ops;
955833cf	135	struct xfs_trans;
239880ef	136	struct xfs_log_callback;
35a8a72f	137
1da177e4	138	xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
35a8a72f CH	139	struct xlog_ticket *ticket,
35a8a72f CH	140	struct xlog_in_core **iclog,
1da177e4	141	uint flags);
f538d4da	142	int _xfs_log_force(struct xfs_mount *mp,
f538d4da CH	143	uint flags,
f538d4da CH	144	int *log_forced);
b911ca04	145	void xfs_log_force(struct xfs_mount *mp,
b911ca04	146	uint flags);
a14a348b CH	147	int _xfs_log_force_lsn(struct xfs_mount *mp,
	148	xfs_lsn_t lsn,
	149	uint flags,
	150	int *log_forced);
	151	void xfs_log_force_lsn(struct xfs_mount *mp,
	152	xfs_lsn_t lsn,
	153	uint flags);
1da177e4 LT	154	int xfs_log_mount(struct xfs_mount *mp,
	155	struct xfs_buftarg *log_target,
	156	xfs_daddr_t start_block,
	157	int num_bblocks);
4249023a	158	int xfs_log_mount_finish(struct xfs_mount *mp);
09a423a3	159	xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
1c304625	160	xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
cfb7cdca	161	void xfs_log_space_wake(struct xfs_mount *mp);
1da177e4	162	int xfs_log_notify(struct xfs_mount *mp,
35a8a72f	163	struct xlog_in_core *iclog,
239880ef	164	struct xfs_log_callback *callback_entry);
1da177e4	165	int xfs_log_release_iclog(struct xfs_mount *mp,
35a8a72f	166	struct xlog_in_core *iclog);
1da177e4 LT	167	int xfs_log_reserve(struct xfs_mount *mp,
	168	int length,
	169	int count,
35a8a72f	170	struct xlog_ticket **ticket,
1da177e4	171	__uint8_t clientid,
9006fb91	172	bool permanent,
7e9c6396	173	uint t_type);
9006fb91	174	int xfs_log_regrant(struct xfs_mount mp, struct xlog_ticket tic);
1da177e4	175	int xfs_log_unmount_write(struct xfs_mount *mp);
21b699c8	176	void xfs_log_unmount(struct xfs_mount *mp);
1da177e4 LT	177	int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
	178	int xfs_log_need_covered(struct xfs_mount *mp);
	179
	180	void xlog_iodone(struct xfs_buf *);
	181
71e330b5	182	struct xlog_ticket xfs_log_ticket_get(struct xlog_ticket ticket);
cc09c0dc DC	183	void xfs_log_ticket_put(struct xlog_ticket *ticket);
cc09c0dc DC	184
c6f97264	185	void xfs_log_commit_cil(struct xfs_mount mp, struct xfs_trans tp,
71e330b5	186	xfs_lsn_t *commit_lsn, int flags);
ccf7c23f	187	bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
71e330b5	188
f661f1e0 DC	189	void xfs_log_work_queue(struct xfs_mount *mp);
f661f1e0 DC	190	void xfs_log_worker(struct work_struct *work);
c75921a7	191	void xfs_log_quiesce(struct xfs_mount *mp);
f661f1e0	192
1da177e4	193	#endif /* __XFS_LOG_H__ */