xref: /openbmc/linux/fs/xfs/xfs_log.h (revision 77d84ff8)
1 /*
2  * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
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.
13  *
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
17  */
18 #ifndef	__XFS_LOG_H__
19 #define __XFS_LOG_H__
20 
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 */
28 	int			lv_size;	/* size of allocated lv */
29 };
30 
31 #define XFS_LOG_VEC_ORDERED	(-1)
32 
33 /*
34  * Structure used to pass callback function and the function's argument
35  * to the log manager.
36  */
37 typedef struct xfs_log_callback {
38 	struct xfs_log_callback	*cb_next;
39 	void			(*cb_func)(void *, int);
40 	void			*cb_arg;
41 } xfs_log_callback_t;
42 
43 /*
44  * By comparing each component, we don't have to worry about extra
45  * endian issues in treating two 32 bit numbers as one 64 bit number
46  */
47 static inline xfs_lsn_t	_lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
48 {
49 	if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
50 		return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
51 
52 	if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
53 		return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
54 
55 	return 0;
56 }
57 
58 #define	XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
59 
60 /*
61  * Macros, structures, prototypes for interface to the log manager.
62  */
63 
64 /*
65  * Flags to xfs_log_done()
66  */
67 #define XFS_LOG_REL_PERM_RESERV	0x1
68 
69 /*
70  * Flags to xfs_log_force()
71  *
72  *	XFS_LOG_SYNC:	Synchronous force in-core log to disk
73  */
74 #define XFS_LOG_SYNC		0x1
75 
76 /* Log manager interfaces */
77 struct xfs_mount;
78 struct xlog_in_core;
79 struct xlog_ticket;
80 struct xfs_log_item;
81 struct xfs_item_ops;
82 struct xfs_trans;
83 struct xfs_log_callback;
84 
85 xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
86 		       struct xlog_ticket *ticket,
87 		       struct xlog_in_core **iclog,
88 		       uint		flags);
89 int	  _xfs_log_force(struct xfs_mount *mp,
90 			 uint		flags,
91 			 int		*log_forced);
92 void	  xfs_log_force(struct xfs_mount	*mp,
93 			uint			flags);
94 int	  _xfs_log_force_lsn(struct xfs_mount *mp,
95 			     xfs_lsn_t		lsn,
96 			     uint		flags,
97 			     int		*log_forced);
98 void	  xfs_log_force_lsn(struct xfs_mount	*mp,
99 			    xfs_lsn_t		lsn,
100 			    uint		flags);
101 int	  xfs_log_mount(struct xfs_mount	*mp,
102 			struct xfs_buftarg	*log_target,
103 			xfs_daddr_t		start_block,
104 			int		 	num_bblocks);
105 int	  xfs_log_mount_finish(struct xfs_mount *mp);
106 xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
107 xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
108 void	  xfs_log_space_wake(struct xfs_mount *mp);
109 int	  xfs_log_notify(struct xfs_mount	*mp,
110 			 struct xlog_in_core	*iclog,
111 			 struct xfs_log_callback *callback_entry);
112 int	  xfs_log_release_iclog(struct xfs_mount *mp,
113 			 struct xlog_in_core	 *iclog);
114 int	  xfs_log_reserve(struct xfs_mount *mp,
115 			  int		   length,
116 			  int		   count,
117 			  struct xlog_ticket **ticket,
118 			  __uint8_t	   clientid,
119 			  bool		   permanent,
120 			  uint		   t_type);
121 int	  xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
122 int	  xfs_log_unmount_write(struct xfs_mount *mp);
123 void      xfs_log_unmount(struct xfs_mount *mp);
124 int	  xfs_log_force_umount(struct xfs_mount *mp, int logerror);
125 int	  xfs_log_need_covered(struct xfs_mount *mp);
126 
127 void	  xlog_iodone(struct xfs_buf *);
128 
129 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
130 void	  xfs_log_ticket_put(struct xlog_ticket *ticket);
131 
132 int	xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
133 				xfs_lsn_t *commit_lsn, int flags);
134 bool	xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
135 
136 void	xfs_log_work_queue(struct xfs_mount *mp);
137 void	xfs_log_worker(struct work_struct *work);
138 void	xfs_log_quiesce(struct xfs_mount *mp);
139 
140 #endif	/* __XFS_LOG_H__ */
141