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 23 #define CYCLE_LSN(lsn) ((uint)((lsn)>>32)) 24 #define BLOCK_LSN(lsn) ((uint)(lsn)) 25 26 /* this is used in a spot where we might otherwise double-endian-flip */ 27 #define CYCLE_LSN_DISK(lsn) (((__be32 *)&(lsn))[0]) 28 29 #ifdef __KERNEL__ 30 /* 31 * By comparing each component, we don't have to worry about extra 32 * endian issues in treating two 32 bit numbers as one 64 bit number 33 */ 34 static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2) 35 { 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 /* 52 * Flags to xfs_log_done() 53 */ 54 #define XFS_LOG_REL_PERM_RESERV 0x1 55 56 /* 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 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 #endif /* __KERNEL__ */ 77 78 79 /* Log Clients */ 80 #define XFS_TRANSACTION 0x69 81 #define XFS_VOLUME 0x2 82 #define XFS_LOG 0xaa 83 84 85 /* Region types for iovec's i_type */ 86 #define XLOG_REG_TYPE_BFORMAT 1 87 #define XLOG_REG_TYPE_BCHUNK 2 88 #define XLOG_REG_TYPE_EFI_FORMAT 3 89 #define XLOG_REG_TYPE_EFD_FORMAT 4 90 #define XLOG_REG_TYPE_IFORMAT 5 91 #define XLOG_REG_TYPE_ICORE 6 92 #define XLOG_REG_TYPE_IEXT 7 93 #define XLOG_REG_TYPE_IBROOT 8 94 #define XLOG_REG_TYPE_ILOCAL 9 95 #define XLOG_REG_TYPE_IATTR_EXT 10 96 #define XLOG_REG_TYPE_IATTR_BROOT 11 97 #define XLOG_REG_TYPE_IATTR_LOCAL 12 98 #define XLOG_REG_TYPE_QFORMAT 13 99 #define XLOG_REG_TYPE_DQUOT 14 100 #define XLOG_REG_TYPE_QUOTAOFF 15 101 #define XLOG_REG_TYPE_LRHEADER 16 102 #define XLOG_REG_TYPE_UNMOUNT 17 103 #define XLOG_REG_TYPE_COMMIT 18 104 #define XLOG_REG_TYPE_TRANSHDR 19 105 #define XLOG_REG_TYPE_MAX 19 106 107 typedef struct xfs_log_iovec { 108 xfs_caddr_t i_addr; /* beginning address of region */ 109 int i_len; /* length in bytes of region */ 110 uint i_type; /* type of region */ 111 } xfs_log_iovec_t; 112 113 /* 114 * Structure used to pass callback function and the function's argument 115 * to the log manager. 116 */ 117 typedef struct xfs_log_callback { 118 struct xfs_log_callback *cb_next; 119 void (*cb_func)(void *, int); 120 void *cb_arg; 121 } xfs_log_callback_t; 122 123 124 #ifdef __KERNEL__ 125 /* Log manager interfaces */ 126 struct xfs_mount; 127 struct xlog_in_core; 128 struct xlog_ticket; 129 struct xfs_log_item; 130 struct xfs_item_ops; 131 132 void xfs_log_item_init(struct xfs_mount *mp, 133 struct xfs_log_item *item, 134 int type, 135 struct xfs_item_ops *ops); 136 137 xfs_lsn_t xfs_log_done(struct xfs_mount *mp, 138 struct xlog_ticket *ticket, 139 struct xlog_in_core **iclog, 140 uint flags); 141 int _xfs_log_force(struct xfs_mount *mp, 142 uint flags, 143 int *log_forced); 144 void xfs_log_force(struct xfs_mount *mp, 145 uint flags); 146 int _xfs_log_force_lsn(struct xfs_mount *mp, 147 xfs_lsn_t lsn, 148 uint flags, 149 int *log_forced); 150 void xfs_log_force_lsn(struct xfs_mount *mp, 151 xfs_lsn_t lsn, 152 uint flags); 153 int xfs_log_mount(struct xfs_mount *mp, 154 struct xfs_buftarg *log_target, 155 xfs_daddr_t start_block, 156 int num_bblocks); 157 int xfs_log_mount_finish(struct xfs_mount *mp); 158 void xfs_log_move_tail(struct xfs_mount *mp, 159 xfs_lsn_t tail_lsn); 160 int xfs_log_notify(struct xfs_mount *mp, 161 struct xlog_in_core *iclog, 162 xfs_log_callback_t *callback_entry); 163 int xfs_log_release_iclog(struct xfs_mount *mp, 164 struct xlog_in_core *iclog); 165 int xfs_log_reserve(struct xfs_mount *mp, 166 int length, 167 int count, 168 struct xlog_ticket **ticket, 169 __uint8_t clientid, 170 uint flags, 171 uint t_type); 172 int xfs_log_write(struct xfs_mount *mp, 173 xfs_log_iovec_t region[], 174 int nentries, 175 struct xlog_ticket *ticket, 176 xfs_lsn_t *start_lsn); 177 int xfs_log_unmount_write(struct xfs_mount *mp); 178 void xfs_log_unmount(struct xfs_mount *mp); 179 int xfs_log_force_umount(struct xfs_mount *mp, int logerror); 180 int xfs_log_need_covered(struct xfs_mount *mp); 181 182 void xlog_iodone(struct xfs_buf *); 183 184 struct xlog_ticket * xfs_log_ticket_get(struct xlog_ticket *ticket); 185 void xfs_log_ticket_put(struct xlog_ticket *ticket); 186 187 #endif 188 189 190 extern int xlog_debug; /* set to 1 to enable real log */ 191 192 193 #endif /* __XFS_LOG_H__ */ 194