[deliverable/linux.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_buf_len;	/* size of formatted 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;
}

static inline void
xlog_finish_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec *vec, int len)
{
	/*
	 * 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 when sizing the buffer.
	 */
	lv->lv_buf_len += round_up(len, sizeof(uint64_t));
	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);

int	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 */
	27	int lv_buf_len; /* size of formatted buffer */
7492c5b4	28	int lv_size; /* size of allocated lv */
fc06c6d0 DC	29	};
	30
	31	#define XFS_LOG_VEC_ORDERED (-1)
	32
1234351c	33	static inline void *
bde7cff6 CH	34	xlog_prepare_iovec(struct xfs_log_vec lv, struct xfs_log_iovec *vecp,
bde7cff6 CH	35	uint type)
1234351c CH	36	{
	37	struct xfs_log_iovec vec = vecp;
	38
bde7cff6 CH	39	if (vec) {
	40	ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
	41	vec++;
	42	} else {
	43	vec = &lv->lv_iovecp[0];
	44	}
	45
1234351c	46	vec->i_type = type;
bde7cff6 CH	47	vec->i_addr = lv->lv_buf + lv->lv_buf_len;
	48
	49	ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));
1234351c	50
bde7cff6	51	*vecp = vec;
1234351c CH	52	return vec->i_addr;
	53	}
	54
bde7cff6 CH	55	static inline void
	56	xlog_finish_iovec(struct xfs_log_vec lv, struct xfs_log_iovec vec, int len)
	57	{
	58	/*
	59	* We need to make sure the next buffer is naturally aligned for the
	60	* biggest basic data type we put into it. We already accounted for
	61	* this when sizing the buffer.
	62	*/
	63	lv->lv_buf_len += round_up(len, sizeof(uint64_t));
	64	vec->i_len = len;
	65	}
	66
	67	static inline void *
	68	xlog_copy_iovec(struct xfs_log_vec lv, struct xfs_log_iovec *vecp,
	69	uint type, void *data, int len)
	70	{
	71	void *buf;
	72
	73	buf = xlog_prepare_iovec(lv, vecp, type);
	74	memcpy(buf, data, len);
	75	xlog_finish_iovec(lv, *vecp, len);
	76	return buf;
	77	}
	78
fc06c6d0 DC	79	/*
	80	* Structure used to pass callback function and the function's argument
	81	* to the log manager.
	82	*/
	83	typedef struct xfs_log_callback {
	84	struct xfs_log_callback *cb_next;
	85	void (cb_func)(void , int);
	86	void *cb_arg;
	87	} xfs_log_callback_t;
1da177e4	88
1da177e4	89	/*
c41564b5	90	* By comparing each component, we don't have to worry about extra
1da177e4 LT	91	* endian issues in treating two 32 bit numbers as one 64 bit number
1da177e4 LT	92	*/
a1365647	93	static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
1da177e4 LT	94	{
	95	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
	96	return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
	97
	98	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
	99	return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
	100
	101	return 0;
	102	}
	103
	104	#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
	105
	106	/*
	107	* Macros, structures, prototypes for interface to the log manager.
	108	*/
	109
1da177e4 LT	110	/*
	111	* Flags to xfs_log_done()
	112	*/
	113	#define XFS_LOG_REL_PERM_RESERV 0x1
	114
1da177e4 LT	115	/*
	116	* Flags to xfs_log_force()
	117	*
	118	* XFS_LOG_SYNC: Synchronous force in-core log to disk
1da177e4 LT	119	*/
1da177e4 LT	120	#define XFS_LOG_SYNC 0x1
1da177e4	121
1da177e4 LT	122	/* Log manager interfaces */
1da177e4 LT	123	struct xfs_mount;
35a8a72f	124	struct xlog_in_core;
cc09c0dc	125	struct xlog_ticket;
43f5efc5 DC	126	struct xfs_log_item;
43f5efc5 DC	127	struct xfs_item_ops;
955833cf	128	struct xfs_trans;
239880ef	129	struct xfs_log_callback;
35a8a72f	130
1da177e4	131	xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
35a8a72f CH	132	struct xlog_ticket *ticket,
35a8a72f CH	133	struct xlog_in_core **iclog,
1da177e4	134	uint flags);
f538d4da	135	int _xfs_log_force(struct xfs_mount *mp,
f538d4da CH	136	uint flags,
f538d4da CH	137	int *log_forced);
b911ca04	138	void xfs_log_force(struct xfs_mount *mp,
b911ca04	139	uint flags);
a14a348b CH	140	int _xfs_log_force_lsn(struct xfs_mount *mp,
	141	xfs_lsn_t lsn,
	142	uint flags,
	143	int *log_forced);
	144	void xfs_log_force_lsn(struct xfs_mount *mp,
	145	xfs_lsn_t lsn,
	146	uint flags);
1da177e4 LT	147	int xfs_log_mount(struct xfs_mount *mp,
	148	struct xfs_buftarg *log_target,
	149	xfs_daddr_t start_block,
	150	int num_bblocks);
4249023a	151	int xfs_log_mount_finish(struct xfs_mount *mp);
09a423a3	152	xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
1c304625	153	xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
cfb7cdca	154	void xfs_log_space_wake(struct xfs_mount *mp);
1da177e4	155	int xfs_log_notify(struct xfs_mount *mp,
35a8a72f	156	struct xlog_in_core *iclog,
239880ef	157	struct xfs_log_callback *callback_entry);
1da177e4	158	int xfs_log_release_iclog(struct xfs_mount *mp,
35a8a72f	159	struct xlog_in_core *iclog);
1da177e4 LT	160	int xfs_log_reserve(struct xfs_mount *mp,
	161	int length,
	162	int count,
35a8a72f	163	struct xlog_ticket **ticket,
1da177e4	164	__uint8_t clientid,
9006fb91	165	bool permanent,
7e9c6396	166	uint t_type);
9006fb91	167	int xfs_log_regrant(struct xfs_mount mp, struct xlog_ticket tic);
1da177e4	168	int xfs_log_unmount_write(struct xfs_mount *mp);
21b699c8	169	void xfs_log_unmount(struct xfs_mount *mp);
1da177e4 LT	170	int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
	171	int xfs_log_need_covered(struct xfs_mount *mp);
	172
	173	void xlog_iodone(struct xfs_buf *);
	174
71e330b5	175	struct xlog_ticket xfs_log_ticket_get(struct xlog_ticket ticket);
cc09c0dc DC	176	void xfs_log_ticket_put(struct xlog_ticket *ticket);
cc09c0dc DC	177
0244b960	178	int xfs_log_commit_cil(struct xfs_mount mp, struct xfs_trans tp,
71e330b5	179	xfs_lsn_t *commit_lsn, int flags);
ccf7c23f	180	bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
71e330b5	181
f661f1e0 DC	182	void xfs_log_work_queue(struct xfs_mount *mp);
f661f1e0 DC	183	void xfs_log_worker(struct work_struct *work);
c75921a7	184	void xfs_log_quiesce(struct xfs_mount *mp);
f661f1e0	185
1da177e4	186	#endif /* __XFS_LOG_H__ */