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 /* this is used in a spot where we might otherwise double-endian-flip */ 26 #define CYCLE_LSN_DISK(lsn) (((uint *)&(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_mount 52 */ 53 #define XFS_LOG_RECOVER 0x1 54 55 /* 56 * Flags to xfs_log_done() 57 */ 58 #define XFS_LOG_REL_PERM_RESERV 0x1 59 60 61 /* 62 * Flags to xfs_log_reserve() 63 * 64 * XFS_LOG_SLEEP: If space is not available, sleep (default) 65 * XFS_LOG_NOSLEEP: If space is not available, return error 66 * XFS_LOG_PERM_RESERV: Permanent reservation. When writes are 67 * performed against this type of reservation, the reservation 68 * is not decreased. Long running transactions should use this. 69 */ 70 #define XFS_LOG_SLEEP 0x0 71 #define XFS_LOG_NOSLEEP 0x1 72 #define XFS_LOG_PERM_RESERV 0x2 73 #define XFS_LOG_RESV_ALL (XFS_LOG_NOSLEEP|XFS_LOG_PERM_RESERV) 74 75 76 /* 77 * Flags to xfs_log_force() 78 * 79 * XFS_LOG_SYNC: Synchronous force in-core log to disk 80 * XFS_LOG_FORCE: Start in-core log write now. 81 * XFS_LOG_URGE: Start write within some window of time. 82 * 83 * Note: Either XFS_LOG_FORCE or XFS_LOG_URGE must be set. 84 */ 85 #define XFS_LOG_SYNC 0x1 86 #define XFS_LOG_FORCE 0x2 87 #define XFS_LOG_URGE 0x4 88 89 #endif /* __KERNEL__ */ 90 91 92 /* Log Clients */ 93 #define XFS_TRANSACTION 0x69 94 #define XFS_VOLUME 0x2 95 #define XFS_LOG 0xaa 96 97 98 /* Region types for iovec's i_type */ 99 #define XLOG_REG_TYPE_BFORMAT 1 100 #define XLOG_REG_TYPE_BCHUNK 2 101 #define XLOG_REG_TYPE_EFI_FORMAT 3 102 #define XLOG_REG_TYPE_EFD_FORMAT 4 103 #define XLOG_REG_TYPE_IFORMAT 5 104 #define XLOG_REG_TYPE_ICORE 6 105 #define XLOG_REG_TYPE_IEXT 7 106 #define XLOG_REG_TYPE_IBROOT 8 107 #define XLOG_REG_TYPE_ILOCAL 9 108 #define XLOG_REG_TYPE_IATTR_EXT 10 109 #define XLOG_REG_TYPE_IATTR_BROOT 11 110 #define XLOG_REG_TYPE_IATTR_LOCAL 12 111 #define XLOG_REG_TYPE_QFORMAT 13 112 #define XLOG_REG_TYPE_DQUOT 14 113 #define XLOG_REG_TYPE_QUOTAOFF 15 114 #define XLOG_REG_TYPE_LRHEADER 16 115 #define XLOG_REG_TYPE_UNMOUNT 17 116 #define XLOG_REG_TYPE_COMMIT 18 117 #define XLOG_REG_TYPE_TRANSHDR 19 118 #define XLOG_REG_TYPE_MAX 19 119 120 #define XLOG_VEC_SET_TYPE(vecp, t) ((vecp)->i_type = (t)) 121 122 typedef struct xfs_log_iovec { 123 xfs_caddr_t i_addr; /* beginning address of region */ 124 int i_len; /* length in bytes of region */ 125 uint i_type; /* type of region */ 126 } xfs_log_iovec_t; 127 128 typedef void* xfs_log_ticket_t; 129 130 /* 131 * Structure used to pass callback function and the function's argument 132 * to the log manager. 133 */ 134 typedef struct xfs_log_callback { 135 struct xfs_log_callback *cb_next; 136 void (*cb_func)(void *, int); 137 void *cb_arg; 138 } xfs_log_callback_t; 139 140 141 #ifdef __KERNEL__ 142 /* Log manager interfaces */ 143 struct xfs_mount; 144 xfs_lsn_t xfs_log_done(struct xfs_mount *mp, 145 xfs_log_ticket_t ticket, 146 void **iclog, 147 uint flags); 148 int _xfs_log_force(struct xfs_mount *mp, 149 xfs_lsn_t lsn, 150 uint flags, 151 int *log_forced); 152 #define xfs_log_force(mp, lsn, flags) \ 153 _xfs_log_force(mp, lsn, flags, NULL); 154 int xfs_log_mount(struct xfs_mount *mp, 155 struct xfs_buftarg *log_target, 156 xfs_daddr_t start_block, 157 int num_bblocks); 158 int xfs_log_mount_finish(struct xfs_mount *mp, int); 159 void xfs_log_move_tail(struct xfs_mount *mp, 160 xfs_lsn_t tail_lsn); 161 int xfs_log_notify(struct xfs_mount *mp, 162 void *iclog, 163 xfs_log_callback_t *callback_entry); 164 int xfs_log_release_iclog(struct xfs_mount *mp, 165 void *iclog_hndl); 166 int xfs_log_reserve(struct xfs_mount *mp, 167 int length, 168 int count, 169 xfs_log_ticket_t *ticket, 170 __uint8_t clientid, 171 uint flags, 172 uint t_type); 173 int xfs_log_write(struct xfs_mount *mp, 174 xfs_log_iovec_t region[], 175 int nentries, 176 xfs_log_ticket_t ticket, 177 xfs_lsn_t *start_lsn); 178 int xfs_log_unmount(struct xfs_mount *mp); 179 int xfs_log_unmount_write(struct xfs_mount *mp); 180 void xfs_log_unmount_dealloc(struct xfs_mount *mp); 181 int xfs_log_force_umount(struct xfs_mount *mp, int logerror); 182 int xfs_log_need_covered(struct xfs_mount *mp); 183 184 void xlog_iodone(struct xfs_buf *); 185 186 #endif 187 188 189 extern int xlog_debug; /* set to 1 to enable real log */ 190 191 192 #endif /* __XFS_LOG_H__ */ 193