block: make gendisk hold a reference to its queue
[linux-2.6.git] / fs / xfs / xfs_log.h
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  */
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_reserve()
57  *
58  *      XFS_LOG_PERM_RESERV: Permanent reservation.  When writes are
59  *              performed against this type of reservation, the reservation
60  *              is not decreased.  Long running transactions should use this.
61  */
62 #define XFS_LOG_PERM_RESERV     0x2
63
64 /*
65  * Flags to xfs_log_force()
66  *
67  *      XFS_LOG_SYNC:   Synchronous force in-core log to disk
68  */
69 #define XFS_LOG_SYNC            0x1
70
71 #endif  /* __KERNEL__ */
72
73
74 /* Log Clients */
75 #define XFS_TRANSACTION         0x69
76 #define XFS_VOLUME              0x2
77 #define XFS_LOG                 0xaa
78
79
80 /* Region types for iovec's i_type */
81 #define XLOG_REG_TYPE_BFORMAT           1
82 #define XLOG_REG_TYPE_BCHUNK            2
83 #define XLOG_REG_TYPE_EFI_FORMAT        3
84 #define XLOG_REG_TYPE_EFD_FORMAT        4
85 #define XLOG_REG_TYPE_IFORMAT           5
86 #define XLOG_REG_TYPE_ICORE             6
87 #define XLOG_REG_TYPE_IEXT              7
88 #define XLOG_REG_TYPE_IBROOT            8
89 #define XLOG_REG_TYPE_ILOCAL            9
90 #define XLOG_REG_TYPE_IATTR_EXT         10
91 #define XLOG_REG_TYPE_IATTR_BROOT       11
92 #define XLOG_REG_TYPE_IATTR_LOCAL       12
93 #define XLOG_REG_TYPE_QFORMAT           13
94 #define XLOG_REG_TYPE_DQUOT             14
95 #define XLOG_REG_TYPE_QUOTAOFF          15
96 #define XLOG_REG_TYPE_LRHEADER          16
97 #define XLOG_REG_TYPE_UNMOUNT           17
98 #define XLOG_REG_TYPE_COMMIT            18
99 #define XLOG_REG_TYPE_TRANSHDR          19
100 #define XLOG_REG_TYPE_MAX               19
101
102 typedef struct xfs_log_iovec {
103         void            *i_addr;        /* beginning address of region */
104         int             i_len;          /* length in bytes of region */
105         uint            i_type;         /* type of region */
106 } xfs_log_iovec_t;
107
108 struct xfs_log_vec {
109         struct xfs_log_vec      *lv_next;       /* next lv in build list */
110         int                     lv_niovecs;     /* number of iovecs in lv */
111         struct xfs_log_iovec    *lv_iovecp;     /* iovec array */
112         struct xfs_log_item     *lv_item;       /* owner */
113         char                    *lv_buf;        /* formatted buffer */
114         int                     lv_buf_len;     /* size of formatted buffer */
115 };
116
117 /*
118  * Structure used to pass callback function and the function's argument
119  * to the log manager.
120  */
121 typedef struct xfs_log_callback {
122         struct xfs_log_callback *cb_next;
123         void                    (*cb_func)(void *, int);
124         void                    *cb_arg;
125 } xfs_log_callback_t;
126
127
128 #ifdef __KERNEL__
129 /* Log manager interfaces */
130 struct xfs_mount;
131 struct xlog_in_core;
132 struct xlog_ticket;
133 struct xfs_log_item;
134 struct xfs_item_ops;
135 struct xfs_trans;
136
137 void    xfs_log_item_init(struct xfs_mount      *mp,
138                         struct xfs_log_item     *item,
139                         int                     type,
140                         struct xfs_item_ops     *ops);
141
142 xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
143                        struct xlog_ticket *ticket,
144                        struct xlog_in_core **iclog,
145                        uint             flags);
146 int       _xfs_log_force(struct xfs_mount *mp,
147                          uint           flags,
148                          int            *log_forced);
149 void      xfs_log_force(struct xfs_mount        *mp,
150                         uint                    flags);
151 int       _xfs_log_force_lsn(struct xfs_mount *mp,
152                              xfs_lsn_t          lsn,
153                              uint               flags,
154                              int                *log_forced);
155 void      xfs_log_force_lsn(struct xfs_mount    *mp,
156                             xfs_lsn_t           lsn,
157                             uint                flags);
158 int       xfs_log_mount(struct xfs_mount        *mp,
159                         struct xfs_buftarg      *log_target,
160                         xfs_daddr_t             start_block,
161                         int                     num_bblocks);
162 int       xfs_log_mount_finish(struct xfs_mount *mp);
163 void      xfs_log_move_tail(struct xfs_mount    *mp,
164                             xfs_lsn_t           tail_lsn);
165 int       xfs_log_notify(struct xfs_mount       *mp,
166                          struct xlog_in_core    *iclog,
167                          xfs_log_callback_t     *callback_entry);
168 int       xfs_log_release_iclog(struct xfs_mount *mp,
169                          struct xlog_in_core     *iclog);
170 int       xfs_log_reserve(struct xfs_mount *mp,
171                           int              length,
172                           int              count,
173                           struct xlog_ticket **ticket,
174                           __uint8_t        clientid,
175                           uint             flags,
176                           uint             t_type);
177 int       xfs_log_write(struct xfs_mount *mp,
178                         xfs_log_iovec_t  region[],
179                         int              nentries,
180                         struct xlog_ticket *ticket,
181                         xfs_lsn_t        *start_lsn);
182 int       xfs_log_unmount_write(struct xfs_mount *mp);
183 void      xfs_log_unmount(struct xfs_mount *mp);
184 int       xfs_log_force_umount(struct xfs_mount *mp, int logerror);
185 int       xfs_log_need_covered(struct xfs_mount *mp);
186
187 void      xlog_iodone(struct xfs_buf *);
188
189 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
190 void      xfs_log_ticket_put(struct xlog_ticket *ticket);
191
192 void    xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
193                                 struct xfs_log_vec *log_vector,
194                                 xfs_lsn_t *commit_lsn, int flags);
195 bool    xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
196
197 #endif
198 #endif  /* __XFS_LOG_H__ */