[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__

/* get lsn fields */
#define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
#define BLOCK_LSN(lsn) ((uint)(lsn))

/* this is used in a spot where we might otherwise double-endian-flip */
#define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])

#ifdef __KERNEL__
/*
 * 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_reserve()
 *
 *	XFS_LOG_PERM_RESERV: Permanent reservation.  When writes are
 *		performed against this type of reservation, the reservation
 *		is not decreased.  Long running transactions should use this.
 */
#define XFS_LOG_PERM_RESERV	0x2

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

#endif	/* __KERNEL__ */


/* Log Clients */
#define XFS_TRANSACTION		0x69
#define XFS_VOLUME		0x2
#define XFS_LOG			0xaa


/* Region types for iovec's i_type */
#define XLOG_REG_TYPE_BFORMAT		1
#define XLOG_REG_TYPE_BCHUNK		2
#define XLOG_REG_TYPE_EFI_FORMAT	3
#define XLOG_REG_TYPE_EFD_FORMAT	4
#define XLOG_REG_TYPE_IFORMAT		5
#define XLOG_REG_TYPE_ICORE		6
#define XLOG_REG_TYPE_IEXT		7
#define XLOG_REG_TYPE_IBROOT		8
#define XLOG_REG_TYPE_ILOCAL		9
#define XLOG_REG_TYPE_IATTR_EXT		10
#define XLOG_REG_TYPE_IATTR_BROOT	11
#define XLOG_REG_TYPE_IATTR_LOCAL	12
#define XLOG_REG_TYPE_QFORMAT		13
#define XLOG_REG_TYPE_DQUOT		14
#define XLOG_REG_TYPE_QUOTAOFF		15
#define XLOG_REG_TYPE_LRHEADER		16
#define XLOG_REG_TYPE_UNMOUNT		17
#define XLOG_REG_TYPE_COMMIT		18
#define XLOG_REG_TYPE_TRANSHDR		19
#define XLOG_REG_TYPE_MAX		19

typedef struct xfs_log_iovec {
	void		*i_addr;	/* beginning address of region */
	int		i_len;		/* length in bytes of region */
	uint		i_type;		/* type of region */
} xfs_log_iovec_t;

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 */
};

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


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

void	xfs_log_item_init(struct xfs_mount	*mp,
			struct xfs_log_item	*item,
			int			type,
			struct xfs_item_ops	*ops);

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);
void	  xfs_log_move_tail(struct xfs_mount	*mp,
			    xfs_lsn_t		tail_lsn);
int	  xfs_log_notify(struct xfs_mount	*mp,
			 struct xlog_in_core	*iclog,
			 xfs_log_callback_t	*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,
			  uint		   flags,
			  uint		   t_type);
int	  xfs_log_write(struct xfs_mount *mp,
			xfs_log_iovec_t  region[],
			int		 nentries,
			struct xlog_ticket *ticket,
			xfs_lsn_t	 *start_lsn);
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,
				struct xfs_log_vec *log_vector,
				xfs_lsn_t *commit_lsn, int flags);
bool	xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);

#endif
#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
	21	/* get lsn fields */
1da177e4 LT	22	#define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
1da177e4 LT	23	#define BLOCK_LSN(lsn) ((uint)(lsn))
b53e675d	24
1da177e4	25	/* this is used in a spot where we might otherwise double-endian-flip */
b53e675d	26	#define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
1da177e4 LT	27
	28	#ifdef __KERNEL__
	29	/*
c41564b5	30	* By comparing each component, we don't have to worry about extra
1da177e4 LT	31	* endian issues in treating two 32 bit numbers as one 64 bit number
1da177e4 LT	32	*/
a1365647	33	static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
1da177e4 LT	34	{
	35	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
	36	return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
	37
	38	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
	39	return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
	40
	41	return 0;
	42	}
	43
	44	#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
	45
	46	/*
	47	* Macros, structures, prototypes for interface to the log manager.
	48	*/
	49
1da177e4 LT	50	/*
	51	* Flags to xfs_log_done()
	52	*/
	53	#define XFS_LOG_REL_PERM_RESERV 0x1
	54
1da177e4 LT	55	/*
	56	* Flags to xfs_log_reserve()
	57	*
1da177e4 LT	58	* XFS_LOG_PERM_RESERV: Permanent reservation. When writes are
	59	* performed against this type of reservation, the reservation
	60	* is not decreased. Long running transactions should use this.
	61	*/
1da177e4	62	#define XFS_LOG_PERM_RESERV 0x2
1da177e4 LT	63
	64	/*
	65	* Flags to xfs_log_force()
	66	*
	67	* XFS_LOG_SYNC: Synchronous force in-core log to disk
1da177e4 LT	68	*/
1da177e4 LT	69	#define XFS_LOG_SYNC 0x1
1da177e4 LT	70
	71	#endif /* __KERNEL__ */
	72
	73
	74	/* Log Clients */
	75	#define XFS_TRANSACTION 0x69
	76	#define XFS_VOLUME 0x2
	77	#define XFS_LOG 0xaa
	78
7e9c6396 TS	79
7e9c6396 TS	80	/* Region types for iovec's i_type */
7e9c6396 TS	81	#define XLOG_REG_TYPE_BFORMAT 1
	82	#define XLOG_REG_TYPE_BCHUNK 2
	83	#define XLOG_REG_TYPE_EFI_FORMAT 3
	84	#define XLOG_REG_TYPE_EFD_FORMAT 4
	85	#define XLOG_REG_TYPE_IFORMAT 5
	86	#define XLOG_REG_TYPE_ICORE 6
	87	#define XLOG_REG_TYPE_IEXT 7
	88	#define XLOG_REG_TYPE_IBROOT 8
	89	#define XLOG_REG_TYPE_ILOCAL 9
	90	#define XLOG_REG_TYPE_IATTR_EXT 10
	91	#define XLOG_REG_TYPE_IATTR_BROOT 11
	92	#define XLOG_REG_TYPE_IATTR_LOCAL 12
	93	#define XLOG_REG_TYPE_QFORMAT 13
	94	#define XLOG_REG_TYPE_DQUOT 14
	95	#define XLOG_REG_TYPE_QUOTAOFF 15
	96	#define XLOG_REG_TYPE_LRHEADER 16
	97	#define XLOG_REG_TYPE_UNMOUNT 17
	98	#define XLOG_REG_TYPE_COMMIT 18
	99	#define XLOG_REG_TYPE_TRANSHDR 19
	100	#define XLOG_REG_TYPE_MAX 19
7e9c6396	101
1da177e4	102	typedef struct xfs_log_iovec {
4e0d5f92	103	void i_addr; / beginning address of region */
1da177e4	104	int i_len; /* length in bytes of region */
1259845d	105	uint i_type; /* type of region */
1da177e4 LT	106	} xfs_log_iovec_t;
1da177e4 LT	107
55b66332 DC	108	struct xfs_log_vec {
	109	struct xfs_log_vec lv_next; / next lv in build list */
	110	int lv_niovecs; /* number of iovecs in lv */
	111	struct xfs_log_iovec lv_iovecp; / iovec array */
71e330b5 DC	112	struct xfs_log_item lv_item; / owner */
	113	char lv_buf; / formatted buffer */
	114	int lv_buf_len; /* size of formatted buffer */
55b66332 DC	115	};
55b66332 DC	116
1da177e4 LT	117	/*
	118	* Structure used to pass callback function and the function's argument
	119	* to the log manager.
	120	*/
	121	typedef struct xfs_log_callback {
	122	struct xfs_log_callback *cb_next;
	123	void (cb_func)(void , int);
	124	void *cb_arg;
	125	} xfs_log_callback_t;
	126
	127
	128	#ifdef __KERNEL__
	129	/* Log manager interfaces */
	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;
43f5efc5 DC	136
	137	void xfs_log_item_init(struct xfs_mount *mp,
	138	struct xfs_log_item *item,
	139	int type,
	140	struct xfs_item_ops *ops);
35a8a72f	141
1da177e4	142	xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
35a8a72f CH	143	struct xlog_ticket *ticket,
35a8a72f CH	144	struct xlog_in_core **iclog,
1da177e4	145	uint flags);
f538d4da	146	int _xfs_log_force(struct xfs_mount *mp,
f538d4da CH	147	uint flags,
f538d4da CH	148	int *log_forced);
b911ca04	149	void xfs_log_force(struct xfs_mount *mp,
b911ca04	150	uint flags);
a14a348b CH	151	int _xfs_log_force_lsn(struct xfs_mount *mp,
	152	xfs_lsn_t lsn,
	153	uint flags,
	154	int *log_forced);
	155	void xfs_log_force_lsn(struct xfs_mount *mp,
	156	xfs_lsn_t lsn,
	157	uint flags);
1da177e4 LT	158	int xfs_log_mount(struct xfs_mount *mp,
	159	struct xfs_buftarg *log_target,
	160	xfs_daddr_t start_block,
	161	int num_bblocks);
4249023a	162	int xfs_log_mount_finish(struct xfs_mount *mp);
1da177e4 LT	163	void xfs_log_move_tail(struct xfs_mount *mp,
	164	xfs_lsn_t tail_lsn);
	165	int xfs_log_notify(struct xfs_mount *mp,
35a8a72f	166	struct xlog_in_core *iclog,
1da177e4 LT	167	xfs_log_callback_t *callback_entry);
1da177e4 LT	168	int xfs_log_release_iclog(struct xfs_mount *mp,
35a8a72f	169	struct xlog_in_core *iclog);
1da177e4 LT	170	int xfs_log_reserve(struct xfs_mount *mp,
	171	int length,
	172	int count,
35a8a72f	173	struct xlog_ticket **ticket,
1da177e4	174	__uint8_t clientid,
7e9c6396 TS	175	uint flags,
7e9c6396 TS	176	uint t_type);
1da177e4 LT	177	int xfs_log_write(struct xfs_mount *mp,
	178	xfs_log_iovec_t region[],
	179	int nentries,
35a8a72f	180	struct xlog_ticket *ticket,
1da177e4	181	xfs_lsn_t *start_lsn);
1da177e4	182	int xfs_log_unmount_write(struct xfs_mount *mp);
21b699c8	183	void xfs_log_unmount(struct xfs_mount *mp);
1da177e4 LT	184	int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
	185	int xfs_log_need_covered(struct xfs_mount *mp);
	186
	187	void xlog_iodone(struct xfs_buf *);
	188
71e330b5	189	struct xlog_ticket xfs_log_ticket_get(struct xlog_ticket ticket);
cc09c0dc DC	190	void xfs_log_ticket_put(struct xlog_ticket *ticket);
cc09c0dc DC	191
c6f990d1	192	void xfs_log_commit_cil(struct xfs_mount mp, struct xfs_trans tp,
71e330b5 DC	193	struct xfs_log_vec *log_vector,
71e330b5 DC	194	xfs_lsn_t *commit_lsn, int flags);
ccf7c23f	195	bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
71e330b5	196
1da177e4	197	#endif
1da177e4	198	#endif /* __XFS_LOG_H__ */