[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) (((uint *)&(lsn))[0])

#ifdef __KERNEL__
/*
 * By comparing each compnent, we don't have to worry about extra
 * endian issues in treating two 32 bit numbers as one 64 bit number
 */
static
#if defined(__GNUC__) && (__GNUC__ == 2) && ( (__GNUC_MINOR__ == 95) || (__GNUC_MINOR__ == 96))
__attribute__((unused))	/* gcc 2.95, 2.96 miscompile this when inlined */
#else
__inline__
#endif
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_mount
 */
#define XFS_LOG_RECOVER		0x1

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


/*
 * Flags to xfs_log_reserve()
 *
 *	XFS_LOG_SLEEP:	 If space is not available, sleep (default)
 *	XFS_LOG_NOSLEEP: If space is not available, return error
 *	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_SLEEP		0x0
#define XFS_LOG_NOSLEEP		0x1
#define XFS_LOG_PERM_RESERV	0x2
#define XFS_LOG_RESV_ALL	(XFS_LOG_NOSLEEP|XFS_LOG_PERM_RESERV)


/*
 * Flags to xfs_log_force()
 *
 *	XFS_LOG_SYNC:	Synchronous force in-core log to disk
 *	XFS_LOG_FORCE:	Start in-core log write now.
 *	XFS_LOG_URGE:	Start write within some window of time.
 *
 * Note: Either XFS_LOG_FORCE or XFS_LOG_URGE must be set.
 */
#define XFS_LOG_SYNC		0x1
#define XFS_LOG_FORCE		0x2
#define XFS_LOG_URGE		0x4

#endif	/* __KERNEL__ */


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


/* Region types for iovec's i_type */
#if defined(XFS_LOG_RES_DEBUG)
#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
#endif

#if defined(XFS_LOG_RES_DEBUG)
#define XLOG_VEC_SET_TYPE(vecp, t) ((vecp)->i_type = (t))
#else
#define XLOG_VEC_SET_TYPE(vecp, t)
#endif


typedef struct xfs_log_iovec {
	xfs_caddr_t		i_addr;		/* beginning address of region */
	int		i_len;		/* length in bytes of region */
#if defined(XFS_LOG_RES_DEBUG)
 	uint		i_type;		/* type of region */
#endif
} xfs_log_iovec_t;

typedef void* xfs_log_ticket_t;

/*
 * 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;
xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
		       xfs_log_ticket_t ticket,
		       void		**iclog,
		       uint		flags);
int	  _xfs_log_force(struct xfs_mount *mp,
			 xfs_lsn_t	lsn,
			 uint		flags,
			 int		*log_forced);
#define xfs_log_force(mp, lsn, flags) \
	_xfs_log_force(mp, lsn, flags, NULL);
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);
void	  xfs_log_move_tail(struct xfs_mount	*mp,
			    xfs_lsn_t		tail_lsn);
int	  xfs_log_notify(struct xfs_mount	*mp,
			 void			*iclog,
			 xfs_log_callback_t	*callback_entry);
int	  xfs_log_release_iclog(struct xfs_mount *mp,
			 void			 *iclog_hndl);
int	  xfs_log_reserve(struct xfs_mount *mp,
			  int		   length,
			  int		   count,
			  xfs_log_ticket_t *ticket,
			  __uint8_t	   clientid,
			  uint		   flags,
			  uint		   t_type);
int	  xfs_log_write(struct xfs_mount *mp,
			xfs_log_iovec_t  region[],
			int		 nentries,
			xfs_log_ticket_t ticket,
			xfs_lsn_t	 *start_lsn);
int	  xfs_log_unmount(struct xfs_mount *mp);
int	  xfs_log_unmount_write(struct xfs_mount *mp);
void      xfs_log_unmount_dealloc(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 *);

#endif


extern int xlog_debug;		/* set to 1 to enable real log */


#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 */
	22
	23	#define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
	24	#define BLOCK_LSN(lsn) ((uint)(lsn))
	25	/* this is used in a spot where we might otherwise double-endian-flip */
	26	#define CYCLE_LSN_DISK(lsn) (((uint *)&(lsn))[0])
	27
	28	#ifdef __KERNEL__
	29	/*
	30	* By comparing each compnent, we don't have to worry about extra
	31	* endian issues in treating two 32 bit numbers as one 64 bit number
	32	*/
	33	static
	34	#if defined(__GNUC__) && (__GNUC__ == 2) && ( (__GNUC_MINOR__ == 95) \|\| (__GNUC_MINOR__ == 96))
	35	__attribute__((unused)) /* gcc 2.95, 2.96 miscompile this when inlined */
	36	#else
	37	__inline__
	38	#endif
	39	xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
	40	{
	41	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
	42	return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
	43
	44	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
	45	return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
	46
	47	return 0;
	48	}
	49
	50	#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
	51
	52	/*
	53	* Macros, structures, prototypes for interface to the log manager.
	54	*/
	55
	56	/*
	57	* Flags to xfs_log_mount
	58	*/
	59	#define XFS_LOG_RECOVER 0x1
	60
	61	/*
	62	* Flags to xfs_log_done()
	63	*/
	64	#define XFS_LOG_REL_PERM_RESERV 0x1
	65
	66
	67	/*
	68	* Flags to xfs_log_reserve()
	69	*
	70	* XFS_LOG_SLEEP: If space is not available, sleep (default)
	71	* XFS_LOG_NOSLEEP: If space is not available, return error
	72	* XFS_LOG_PERM_RESERV: Permanent reservation. When writes are
	73	* performed against this type of reservation, the reservation
	74	* is not decreased. Long running transactions should use this.
	75	*/
	76	#define XFS_LOG_SLEEP 0x0
	77	#define XFS_LOG_NOSLEEP 0x1
	78	#define XFS_LOG_PERM_RESERV 0x2
	79	#define XFS_LOG_RESV_ALL (XFS_LOG_NOSLEEP\|XFS_LOG_PERM_RESERV)
	80
81
82	/*
83	* Flags to xfs_log_force()
84	*
85	* XFS_LOG_SYNC: Synchronous force in-core log to disk
86	* XFS_LOG_FORCE: Start in-core log write now.
87	* XFS_LOG_URGE: Start write within some window of time.
88	*
89	* Note: Either XFS_LOG_FORCE or XFS_LOG_URGE must be set.
90	*/
91	#define XFS_LOG_SYNC 0x1
92	#define XFS_LOG_FORCE 0x2
93	#define XFS_LOG_URGE 0x4
94
95	#endif /* __KERNEL__ */
96
97
98	/* Log Clients */
99	#define XFS_TRANSACTION 0x69
100	#define XFS_VOLUME 0x2
101	#define XFS_LOG 0xaa
102
7e9c6396 TS	103
	104	/* Region types for iovec's i_type */
	105	#if defined(XFS_LOG_RES_DEBUG)
	106	#define XLOG_REG_TYPE_BFORMAT 1
	107	#define XLOG_REG_TYPE_BCHUNK 2
	108	#define XLOG_REG_TYPE_EFI_FORMAT 3
	109	#define XLOG_REG_TYPE_EFD_FORMAT 4
	110	#define XLOG_REG_TYPE_IFORMAT 5
	111	#define XLOG_REG_TYPE_ICORE 6
	112	#define XLOG_REG_TYPE_IEXT 7
	113	#define XLOG_REG_TYPE_IBROOT 8
	114	#define XLOG_REG_TYPE_ILOCAL 9
	115	#define XLOG_REG_TYPE_IATTR_EXT 10
	116	#define XLOG_REG_TYPE_IATTR_BROOT 11
	117	#define XLOG_REG_TYPE_IATTR_LOCAL 12
	118	#define XLOG_REG_TYPE_QFORMAT 13
	119	#define XLOG_REG_TYPE_DQUOT 14
	120	#define XLOG_REG_TYPE_QUOTAOFF 15
	121	#define XLOG_REG_TYPE_LRHEADER 16
	122	#define XLOG_REG_TYPE_UNMOUNT 17
	123	#define XLOG_REG_TYPE_COMMIT 18
	124	#define XLOG_REG_TYPE_TRANSHDR 19
	125	#define XLOG_REG_TYPE_MAX 19
	126	#endif
	127
	128	#if defined(XFS_LOG_RES_DEBUG)
	129	#define XLOG_VEC_SET_TYPE(vecp, t) ((vecp)->i_type = (t))
	130	#else
	131	#define XLOG_VEC_SET_TYPE(vecp, t)
	132	#endif
	133
	134
1da177e4 LT	135	typedef struct xfs_log_iovec {
	136	xfs_caddr_t i_addr; /* beginning address of region */
	137	int i_len; /* length in bytes of region */
7e9c6396 TS	138	#if defined(XFS_LOG_RES_DEBUG)
	139	uint i_type; /* type of region */
	140	#endif
1da177e4 LT	141	} xfs_log_iovec_t;
	142
	143	typedef void* xfs_log_ticket_t;
	144
	145	/*
	146	* Structure used to pass callback function and the function's argument
	147	* to the log manager.
	148	*/
	149	typedef struct xfs_log_callback {
	150	struct xfs_log_callback *cb_next;
	151	void (cb_func)(void , int);
	152	void *cb_arg;
	153	} xfs_log_callback_t;
	154
	155
	156	#ifdef __KERNEL__
	157	/* Log manager interfaces */
	158	struct xfs_mount;
	159	xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
	160	xfs_log_ticket_t ticket,
	161	void **iclog,
	162	uint flags);
f538d4da CH	163	int _xfs_log_force(struct xfs_mount *mp,
	164	xfs_lsn_t lsn,
	165	uint flags,
	166	int *log_forced);
	167	#define xfs_log_force(mp, lsn, flags) \
	168	_xfs_log_force(mp, lsn, flags, NULL);
1da177e4 LT	169	int xfs_log_mount(struct xfs_mount *mp,
	170	struct xfs_buftarg *log_target,
	171	xfs_daddr_t start_block,
	172	int num_bblocks);
	173	int xfs_log_mount_finish(struct xfs_mount *mp, int);
	174	void xfs_log_move_tail(struct xfs_mount *mp,
	175	xfs_lsn_t tail_lsn);
	176	int xfs_log_notify(struct xfs_mount *mp,
	177	void *iclog,
	178	xfs_log_callback_t *callback_entry);
	179	int xfs_log_release_iclog(struct xfs_mount *mp,
	180	void *iclog_hndl);
	181	int xfs_log_reserve(struct xfs_mount *mp,
	182	int length,
	183	int count,
	184	xfs_log_ticket_t *ticket,
	185	__uint8_t clientid,
7e9c6396 TS	186	uint flags,
7e9c6396 TS	187	uint t_type);
1da177e4 LT	188	int xfs_log_write(struct xfs_mount *mp,
	189	xfs_log_iovec_t region[],
	190	int nentries,
	191	xfs_log_ticket_t ticket,
	192	xfs_lsn_t *start_lsn);
	193	int xfs_log_unmount(struct xfs_mount *mp);
	194	int xfs_log_unmount_write(struct xfs_mount *mp);
	195	void xfs_log_unmount_dealloc(struct xfs_mount *mp);
	196	int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
	197	int xfs_log_need_covered(struct xfs_mount *mp);
	198
	199	void xlog_iodone(struct xfs_buf *);
	200
	201	#endif
	202
	203
	204	extern int xlog_debug; /* set to 1 to enable real log */
	205
	206
	207	#endif /* __XFS_LOG_H__ */