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

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

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

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

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);

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