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 /* get lsn fields */
22 #define CYCLE_LSN(lsn) ((uint)((lsn)>>32))
23 #define BLOCK_LSN(lsn) ((uint)(lsn))
24
25 /* this is used in a spot where we might otherwise double-endian-flip */
26 #define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
27
28 #ifdef __KERNEL__
29 /*
30 * By comparing each component, we don't have to worry about extra
31 * endian issues in treating two 32 bit numbers as one 64 bit number
32 */
_lsn_cmp(xfs_lsn_t lsn1,xfs_lsn_t lsn2)33 static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
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
50 /*
51 * Flags to xfs_log_done()
52 */
53 #define XFS_LOG_REL_PERM_RESERV 0x1
54
55 /*
56 * Flags to xfs_log_force()
57 *
58 * XFS_LOG_SYNC: Synchronous force in-core log to disk
59 */
60 #define XFS_LOG_SYNC 0x1
61
62 #endif /* __KERNEL__ */
63
64
65 /* Log Clients */
66 #define XFS_TRANSACTION 0x69
67 #define XFS_VOLUME 0x2
68 #define XFS_LOG 0xaa
69
70
71 /* Region types for iovec's i_type */
72 #define XLOG_REG_TYPE_BFORMAT 1
73 #define XLOG_REG_TYPE_BCHUNK 2
74 #define XLOG_REG_TYPE_EFI_FORMAT 3
75 #define XLOG_REG_TYPE_EFD_FORMAT 4
76 #define XLOG_REG_TYPE_IFORMAT 5
77 #define XLOG_REG_TYPE_ICORE 6
78 #define XLOG_REG_TYPE_IEXT 7
79 #define XLOG_REG_TYPE_IBROOT 8
80 #define XLOG_REG_TYPE_ILOCAL 9
81 #define XLOG_REG_TYPE_IATTR_EXT 10
82 #define XLOG_REG_TYPE_IATTR_BROOT 11
83 #define XLOG_REG_TYPE_IATTR_LOCAL 12
84 #define XLOG_REG_TYPE_QFORMAT 13
85 #define XLOG_REG_TYPE_DQUOT 14
86 #define XLOG_REG_TYPE_QUOTAOFF 15
87 #define XLOG_REG_TYPE_LRHEADER 16
88 #define XLOG_REG_TYPE_UNMOUNT 17
89 #define XLOG_REG_TYPE_COMMIT 18
90 #define XLOG_REG_TYPE_TRANSHDR 19
91 #define XLOG_REG_TYPE_MAX 19
92
93 typedef struct xfs_log_iovec {
94 void *i_addr; /* beginning address of region */
95 int i_len; /* length in bytes of region */
96 uint i_type; /* type of region */
97 } xfs_log_iovec_t;
98
99 struct xfs_log_vec {
100 struct xfs_log_vec *lv_next; /* next lv in build list */
101 int lv_niovecs; /* number of iovecs in lv */
102 struct xfs_log_iovec *lv_iovecp; /* iovec array */
103 struct xfs_log_item *lv_item; /* owner */
104 char *lv_buf; /* formatted buffer */
105 int lv_buf_len; /* size of formatted buffer */
106 };
107
108 /*
109 * Structure used to pass callback function and the function's argument
110 * to the log manager.
111 */
112 typedef struct xfs_log_callback {
113 struct xfs_log_callback *cb_next;
114 void (*cb_func)(void *, int);
115 void *cb_arg;
116 } xfs_log_callback_t;
117
118
119 #ifdef __KERNEL__
120 /* Log manager interfaces */
121 struct xfs_mount;
122 struct xlog_in_core;
123 struct xlog_ticket;
124 struct xfs_log_item;
125 struct xfs_item_ops;
126 struct xfs_trans;
127
128 void xfs_log_item_init(struct xfs_mount *mp,
129 struct xfs_log_item *item,
130 int type,
131 const struct xfs_item_ops *ops);
132
133 xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
134 struct xlog_ticket *ticket,
135 struct xlog_in_core **iclog,
136 uint flags);
137 int _xfs_log_force(struct xfs_mount *mp,
138 uint flags,
139 int *log_forced);
140 void xfs_log_force(struct xfs_mount *mp,
141 uint flags);
142 int _xfs_log_force_lsn(struct xfs_mount *mp,
143 xfs_lsn_t lsn,
144 uint flags,
145 int *log_forced);
146 void xfs_log_force_lsn(struct xfs_mount *mp,
147 xfs_lsn_t lsn,
148 uint flags);
149 int xfs_log_mount(struct xfs_mount *mp,
150 struct xfs_buftarg *log_target,
151 xfs_daddr_t start_block,
152 int num_bblocks);
153 int xfs_log_mount_finish(struct xfs_mount *mp);
154 xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
155 void xfs_log_space_wake(struct xfs_mount *mp);
156 int xfs_log_notify(struct xfs_mount *mp,
157 struct xlog_in_core *iclog,
158 xfs_log_callback_t *callback_entry);
159 int xfs_log_release_iclog(struct xfs_mount *mp,
160 struct xlog_in_core *iclog);
161 int xfs_log_reserve(struct xfs_mount *mp,
162 int length,
163 int count,
164 struct xlog_ticket **ticket,
165 __uint8_t clientid,
166 bool permanent,
167 uint t_type);
168 int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
169 int xfs_log_unmount_write(struct xfs_mount *mp);
170 void xfs_log_unmount(struct xfs_mount *mp);
171 int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
172 int xfs_log_need_covered(struct xfs_mount *mp);
173
174 void xlog_iodone(struct xfs_buf *);
175
176 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
177 void xfs_log_ticket_put(struct xlog_ticket *ticket);
178
179 int xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
180 xfs_lsn_t *commit_lsn, int flags);
181 bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
182
183 #endif
184 #endif /* __XFS_LOG_H__ */
185