blob: 84e0deb95abda6181b5a10b2a3f790df9c6f04ff [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
Dave Chinnerfc06c6d2013-08-12 20:49:22 +100021struct 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 */
Dave Chinner110dc242014-05-20 08:18:09 +100027 int lv_bytes; /* accounted space in buffer */
28 int lv_buf_len; /* aligned size of buffer */
Dave Chinner7492c5b2013-08-12 20:50:05 +100029 int lv_size; /* size of allocated lv */
Dave Chinnerfc06c6d2013-08-12 20:49:22 +100030};
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Dave Chinnerfc06c6d2013-08-12 20:49:22 +100032#define XFS_LOG_VEC_ORDERED (-1)
33
Christoph Hellwig12343512013-12-13 11:00:43 +110034static inline void *
Christoph Hellwigbde7cff2013-12-13 11:34:02 +110035xlog_prepare_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
36 uint type)
Christoph Hellwig12343512013-12-13 11:00:43 +110037{
38 struct xfs_log_iovec *vec = *vecp;
39
Christoph Hellwigbde7cff2013-12-13 11:34:02 +110040 if (vec) {
41 ASSERT(vec - lv->lv_iovecp < lv->lv_niovecs);
42 vec++;
43 } else {
44 vec = &lv->lv_iovecp[0];
45 }
Christoph Hellwig12343512013-12-13 11:00:43 +110046
Christoph Hellwigbde7cff2013-12-13 11:34:02 +110047 vec->i_type = type;
48 vec->i_addr = lv->lv_buf + lv->lv_buf_len;
49
50 ASSERT(IS_ALIGNED((unsigned long)vec->i_addr, sizeof(uint64_t)));
51
52 *vecp = vec;
Christoph Hellwig12343512013-12-13 11:00:43 +110053 return vec->i_addr;
54}
55
Dave Chinner110dc242014-05-20 08:18:09 +100056/*
57 * We need to make sure the next buffer is naturally aligned for the biggest
58 * basic data type we put into it. We already accounted for this padding when
59 * sizing the buffer.
60 *
61 * However, this padding does not get written into the log, and hence we have to
62 * track the space used by the log vectors separately to prevent log space hangs
63 * due to inaccurate accounting (i.e. a leak) of the used log space through the
64 * CIL context ticket.
65 */
Christoph Hellwigbde7cff2013-12-13 11:34:02 +110066static inline void
67xlog_finish_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec *vec, int len)
68{
Christoph Hellwigbde7cff2013-12-13 11:34:02 +110069 lv->lv_buf_len += round_up(len, sizeof(uint64_t));
Dave Chinner110dc242014-05-20 08:18:09 +100070 lv->lv_bytes += len;
Christoph Hellwigbde7cff2013-12-13 11:34:02 +110071 vec->i_len = len;
72}
73
74static inline void *
75xlog_copy_iovec(struct xfs_log_vec *lv, struct xfs_log_iovec **vecp,
76 uint type, void *data, int len)
77{
78 void *buf;
79
80 buf = xlog_prepare_iovec(lv, vecp, type);
81 memcpy(buf, data, len);
82 xlog_finish_iovec(lv, *vecp, len);
83 return buf;
84}
85
Dave Chinnerfc06c6d2013-08-12 20:49:22 +100086/*
87 * Structure used to pass callback function and the function's argument
88 * to the log manager.
89 */
90typedef struct xfs_log_callback {
91 struct xfs_log_callback *cb_next;
92 void (*cb_func)(void *, int);
93 void *cb_arg;
94} xfs_log_callback_t;
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/*
Nathan Scottc41564b2006-03-29 08:55:14 +100097 * By comparing each component, we don't have to worry about extra
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 * endian issues in treating two 32 bit numbers as one 64 bit number
99 */
Andrew Mortona1365642006-01-08 01:04:09 -0800100static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
102 if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
103 return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
104
105 if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
106 return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
107
108 return 0;
109}
110
111#define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
112
113/*
114 * Macros, structures, prototypes for interface to the log manager.
115 */
116
117/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 * Flags to xfs_log_done()
119 */
120#define XFS_LOG_REL_PERM_RESERV 0x1
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 * Flags to xfs_log_force()
124 *
125 * XFS_LOG_SYNC: Synchronous force in-core log to disk
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 */
127#define XFS_LOG_SYNC 0x1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/* Log manager interfaces */
130struct xfs_mount;
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000131struct xlog_in_core;
Dave Chinnercc09c0d2008-11-17 17:37:10 +1100132struct xlog_ticket;
Dave Chinner43f5efc2010-03-23 10:10:00 +1100133struct xfs_log_item;
134struct xfs_item_ops;
Dave Chinner955833c2010-05-14 21:41:46 +1000135struct xfs_trans;
Dave Chinner239880e2013-10-23 10:50:10 +1100136struct xfs_log_callback;
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000139 struct xlog_ticket *ticket,
140 struct xlog_in_core **iclog,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 uint flags);
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100142int _xfs_log_force(struct xfs_mount *mp,
Christoph Hellwigf538d4d2005-11-02 10:26:59 +1100143 uint flags,
144 int *log_forced);
David Chinnerb911ca02008-04-10 12:24:30 +1000145void xfs_log_force(struct xfs_mount *mp,
David Chinnerb911ca02008-04-10 12:24:30 +1000146 uint flags);
Christoph Hellwiga14a3482010-01-19 09:56:46 +0000147int _xfs_log_force_lsn(struct xfs_mount *mp,
148 xfs_lsn_t lsn,
149 uint flags,
150 int *log_forced);
151void xfs_log_force_lsn(struct xfs_mount *mp,
152 xfs_lsn_t lsn,
153 uint flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154int xfs_log_mount(struct xfs_mount *mp,
155 struct xfs_buftarg *log_target,
156 xfs_daddr_t start_block,
157 int num_bblocks);
Christoph Hellwig42490232008-08-13 16:49:32 +1000158int xfs_log_mount_finish(struct xfs_mount *mp);
Christoph Hellwig09a423a2012-02-20 02:31:20 +0000159xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
Christoph Hellwig1c304622012-04-23 15:58:33 +1000160xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
Christoph Hellwigcfb7cdc2012-02-20 02:31:23 +0000161void xfs_log_space_wake(struct xfs_mount *mp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162int xfs_log_notify(struct xfs_mount *mp,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000163 struct xlog_in_core *iclog,
Dave Chinner239880e2013-10-23 10:50:10 +1100164 struct xfs_log_callback *callback_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165int xfs_log_release_iclog(struct xfs_mount *mp,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000166 struct xlog_in_core *iclog);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167int xfs_log_reserve(struct xfs_mount *mp,
168 int length,
169 int count,
Christoph Hellwig35a8a722010-02-15 23:34:54 +0000170 struct xlog_ticket **ticket,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 __uint8_t clientid,
Christoph Hellwig9006fb92012-02-20 02:31:31 +0000172 bool permanent,
Tim Shimmin7e9c6392005-09-02 16:42:05 +1000173 uint t_type);
Christoph Hellwig9006fb92012-02-20 02:31:31 +0000174int xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175int xfs_log_unmount_write(struct xfs_mount *mp);
Christoph Hellwig21b699c2009-03-16 08:19:29 +0100176void xfs_log_unmount(struct xfs_mount *mp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177int xfs_log_force_umount(struct xfs_mount *mp, int logerror);
178int xfs_log_need_covered(struct xfs_mount *mp);
179
180void xlog_iodone(struct xfs_buf *);
181
Dave Chinner71e330b2010-05-21 14:37:18 +1000182struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
Dave Chinnercc09c0d2008-11-17 17:37:10 +1100183void xfs_log_ticket_put(struct xlog_ticket *ticket);
184
Jie Liuc6f97262014-02-07 15:26:07 +1100185void xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
Dave Chinner71e330b2010-05-21 14:37:18 +1000186 xfs_lsn_t *commit_lsn, int flags);
Dave Chinnerccf7c232010-05-20 23:19:42 +1000187bool xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
Dave Chinner71e330b2010-05-21 14:37:18 +1000188
Dave Chinnerf661f1e2012-10-08 21:56:02 +1100189void xfs_log_work_queue(struct xfs_mount *mp);
190void xfs_log_worker(struct work_struct *work);
Dave Chinnerc75921a2012-10-08 21:56:08 +1100191void xfs_log_quiesce(struct xfs_mount *mp);
Dave Chinnerf661f1e2012-10-08 21:56:02 +1100192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193#endif /* __XFS_LOG_H__ */