blob: 4cdac048df5e2265c3516ca402fcc547034a3206 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
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))
Christoph Hellwigb53e6752007-10-12 10:59:34 +100025
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/* this is used in a spot where we might otherwise double-endian-flip */
Christoph Hellwigb53e6752007-10-12 10:59:34 +100027#define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0])
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#ifdef __KERNEL__
30/*
Nathan Scottc41564b2006-03-29 08:55:14 +100031 * By comparing each component, we don't have to worry about extra
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 * endian issues in treating two 32 bit numbers as one 64 bit number
33 */
Andrew Mortona1365642006-01-08 01:04:09 -080034static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070035{
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
51/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * Flags to xfs_log_done()
53 */
54#define XFS_LOG_REL_PERM_RESERV 0x1
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/*
70 * Flags to xfs_log_force()
71 *
72 * XFS_LOG_SYNC: Synchronous force in-core log to disk
73 * XFS_LOG_FORCE: Start in-core log write now.
74 * XFS_LOG_URGE: Start write within some window of time.
75 *
76 * Note: Either XFS_LOG_FORCE or XFS_LOG_URGE must be set.
77 */
78#define XFS_LOG_SYNC 0x1
79#define XFS_LOG_FORCE 0x2
80#define XFS_LOG_URGE 0x4
81
82#endif /* __KERNEL__ */
83
84
85/* Log Clients */
86#define XFS_TRANSACTION 0x69
87#define XFS_VOLUME 0x2
88#define XFS_LOG 0xaa
89
Tim Shimmin7e9c6392005-09-02 16:42:05 +100090
91/* Region types for iovec's i_type */
Tim Shimmin7e9c6392005-09-02 16:42:05 +100092#define XLOG_REG_TYPE_BFORMAT 1
93#define XLOG_REG_TYPE_BCHUNK 2
94#define XLOG_REG_TYPE_EFI_FORMAT 3
95#define XLOG_REG_TYPE_EFD_FORMAT 4
96#define XLOG_REG_TYPE_IFORMAT 5
97#define XLOG_REG_TYPE_ICORE 6
98#define XLOG_REG_TYPE_IEXT 7
99#define XLOG_REG_TYPE_IBROOT 8
100#define XLOG_REG_TYPE_ILOCAL 9
101#define XLOG_REG_TYPE_IATTR_EXT 10
102#define XLOG_REG_TYPE_IATTR_BROOT 11
103#define XLOG_REG_TYPE_IATTR_LOCAL 12
104#define XLOG_REG_TYPE_QFORMAT 13
105#define XLOG_REG_TYPE_DQUOT 14
106#define XLOG_REG_TYPE_QUOTAOFF 15
107#define XLOG_REG_TYPE_LRHEADER 16
108#define XLOG_REG_TYPE_UNMOUNT 17
109#define XLOG_REG_TYPE_COMMIT 18
110#define XLOG_REG_TYPE_TRANSHDR 19
111#define XLOG_REG_TYPE_MAX 19
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000112
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000113#define XLOG_VEC_SET_TYPE(vecp, t) ((vecp)->i_type = (t))
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115typedef struct xfs_log_iovec {
116 xfs_caddr_t i_addr; /* beginning address of region */
117 int i_len; /* length in bytes of region */
Tim Shimmin12598452006-01-11 21:02:47 +1100118 uint i_type; /* type of region */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119} xfs_log_iovec_t;
120
121typedef void* xfs_log_ticket_t;
122
123/*
124 * Structure used to pass callback function and the function's argument
125 * to the log manager.
126 */
127typedef struct xfs_log_callback {
128 struct xfs_log_callback *cb_next;
129 void (*cb_func)(void *, int);
130 void *cb_arg;
131} xfs_log_callback_t;
132
133
134#ifdef __KERNEL__
135/* Log manager interfaces */
136struct xfs_mount;
137xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
138 xfs_log_ticket_t ticket,
139 void **iclog,
140 uint flags);
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100141int _xfs_log_force(struct xfs_mount *mp,
142 xfs_lsn_t lsn,
143 uint flags,
144 int *log_forced);
145#define xfs_log_force(mp, lsn, flags) \
146 _xfs_log_force(mp, lsn, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147int xfs_log_mount(struct xfs_mount *mp,
148 struct xfs_buftarg *log_target,
149 xfs_daddr_t start_block,
150 int num_bblocks);
151int xfs_log_mount_finish(struct xfs_mount *mp, int);
152void xfs_log_move_tail(struct xfs_mount *mp,
153 xfs_lsn_t tail_lsn);
154int xfs_log_notify(struct xfs_mount *mp,
155 void *iclog,
156 xfs_log_callback_t *callback_entry);
157int xfs_log_release_iclog(struct xfs_mount *mp,
158 void *iclog_hndl);
159int xfs_log_reserve(struct xfs_mount *mp,
160 int length,
161 int count,
162 xfs_log_ticket_t *ticket,
163 __uint8_t clientid,
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000164 uint flags,
165 uint t_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166int xfs_log_write(struct xfs_mount *mp,
167 xfs_log_iovec_t region[],
168 int nentries,
169 xfs_log_ticket_t ticket,
170 xfs_lsn_t *start_lsn);
171int xfs_log_unmount(struct xfs_mount *mp);
172int xfs_log_unmount_write(struct xfs_mount *mp);
173void xfs_log_unmount_dealloc(struct xfs_mount *mp);
174int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
175int xfs_log_need_covered(struct xfs_mount *mp);
176
177void xlog_iodone(struct xfs_buf *);
178
179#endif
180
181
182extern int xlog_debug; /* set to 1 to enable real log */
183
184
185#endif /* __XFS_LOG_H__ */