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

#include "xfs_log_format.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 */
};

#define XFS_LOG_VEC_ORDERED	(-1)

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

void	xfs_log_item_init(struct xfs_mount	*mp,
			struct xfs_log_item	*item,
			int			type,
			const 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);
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,
			 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,
			  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	21	#include "xfs_log_format.h"
b53e675d	22
fc06c6d0 DC	23	struct xfs_log_vec {
	24	struct xfs_log_vec lv_next; / next lv in build list */
	25	int lv_niovecs; /* number of iovecs in lv */
	26	struct xfs_log_iovec lv_iovecp; / iovec array */
	27	struct xfs_log_item lv_item; / owner */
	28	char lv_buf; / formatted buffer */
	29	int lv_buf_len; /* size of formatted buffer */
	30	};
	31
	32	#define XFS_LOG_VEC_ORDERED (-1)
	33
	34	/*
	35	* Structure used to pass callback function and the function's argument
	36	* to the log manager.
	37	*/
	38	typedef struct xfs_log_callback {
	39	struct xfs_log_callback *cb_next;
	40	void (cb_func)(void , int);
	41	void *cb_arg;
	42	} xfs_log_callback_t;
1da177e4	43
1da177e4	44	/*
c41564b5	45	* By comparing each component, we don't have to worry about extra
1da177e4 LT	46	* endian issues in treating two 32 bit numbers as one 64 bit number
1da177e4 LT	47	*/
a1365647	48	static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
1da177e4 LT	49	{
	50	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
	51	return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
	52
	53	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
	54	return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
	55
	56	return 0;
	57	}
	58
	59	#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
	60
	61	/*
	62	* Macros, structures, prototypes for interface to the log manager.
	63	*/
	64
1da177e4 LT	65	/*
	66	* Flags to xfs_log_done()
	67	*/
	68	#define XFS_LOG_REL_PERM_RESERV 0x1
	69
1da177e4 LT	70	/*
	71	* Flags to xfs_log_force()
	72	*
	73	* XFS_LOG_SYNC: Synchronous force in-core log to disk
1da177e4 LT	74	*/
1da177e4 LT	75	#define XFS_LOG_SYNC 0x1
1da177e4	76
1da177e4 LT	77	/* Log manager interfaces */
1da177e4 LT	78	struct xfs_mount;
35a8a72f	79	struct xlog_in_core;
cc09c0dc	80	struct xlog_ticket;
43f5efc5 DC	81	struct xfs_log_item;
43f5efc5 DC	82	struct xfs_item_ops;
955833cf	83	struct xfs_trans;
43f5efc5 DC	84
	85	void xfs_log_item_init(struct xfs_mount *mp,
	86	struct xfs_log_item *item,
	87	int type,
272e42b2	88	const struct xfs_item_ops *ops);
35a8a72f	89
1da177e4	90	xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
35a8a72f CH	91	struct xlog_ticket *ticket,
35a8a72f CH	92	struct xlog_in_core **iclog,
1da177e4	93	uint flags);
f538d4da	94	int _xfs_log_force(struct xfs_mount *mp,
f538d4da CH	95	uint flags,
f538d4da CH	96	int *log_forced);
b911ca04	97	void xfs_log_force(struct xfs_mount *mp,
b911ca04	98	uint flags);
a14a348b CH	99	int _xfs_log_force_lsn(struct xfs_mount *mp,
	100	xfs_lsn_t lsn,
	101	uint flags,
	102	int *log_forced);
	103	void xfs_log_force_lsn(struct xfs_mount *mp,
	104	xfs_lsn_t lsn,
	105	uint flags);
1da177e4 LT	106	int xfs_log_mount(struct xfs_mount *mp,
	107	struct xfs_buftarg *log_target,
	108	xfs_daddr_t start_block,
	109	int num_bblocks);
4249023a	110	int xfs_log_mount_finish(struct xfs_mount *mp);
09a423a3	111	xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
1c304625	112	xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
cfb7cdca	113	void xfs_log_space_wake(struct xfs_mount *mp);
1da177e4	114	int xfs_log_notify(struct xfs_mount *mp,
35a8a72f	115	struct xlog_in_core *iclog,
1da177e4 LT	116	xfs_log_callback_t *callback_entry);
1da177e4 LT	117	int xfs_log_release_iclog(struct xfs_mount *mp,
35a8a72f	118	struct xlog_in_core *iclog);
1da177e4 LT	119	int xfs_log_reserve(struct xfs_mount *mp,
	120	int length,
	121	int count,
35a8a72f	122	struct xlog_ticket **ticket,
1da177e4	123	__uint8_t clientid,
9006fb91	124	bool permanent,
7e9c6396	125	uint t_type);
9006fb91	126	int xfs_log_regrant(struct xfs_mount mp, struct xlog_ticket tic);
1da177e4	127	int xfs_log_unmount_write(struct xfs_mount *mp);
21b699c8	128	void xfs_log_unmount(struct xfs_mount *mp);
1da177e4 LT	129	int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
	130	int xfs_log_need_covered(struct xfs_mount *mp);
	131
	132	void xlog_iodone(struct xfs_buf *);
	133
71e330b5	134	struct xlog_ticket xfs_log_ticket_get(struct xlog_ticket ticket);
cc09c0dc DC	135	void xfs_log_ticket_put(struct xlog_ticket *ticket);
cc09c0dc DC	136
0244b960	137	int xfs_log_commit_cil(struct xfs_mount mp, struct xfs_trans tp,
71e330b5	138	xfs_lsn_t *commit_lsn, int flags);
ccf7c23f	139	bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
71e330b5	140
f661f1e0 DC	141	void xfs_log_work_queue(struct xfs_mount *mp);
f661f1e0 DC	142	void xfs_log_worker(struct work_struct *work);
c75921a7	143	void xfs_log_quiesce(struct xfs_mount *mp);
f661f1e0	144
1da177e4	145	#endif /* __XFS_LOG_H__ */