LXR linux/fs/xfs/xfs

   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 */
  34static 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 *      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
  90
  91/* Region types for iovec's i_type */
  92#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
 112
 113#define XLOG_VEC_SET_TYPE(vecp, t) ((vecp)->i_type = (t))
 114
 115typedef struct xfs_log_iovec {
 116        xfs_caddr_t             i_addr;         /* beginning address of region */
 117        int             i_len;          /* length in bytes of region */
 118        uint            i_type;         /* type of region */
 119} 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;
 137struct xlog_ticket;
 138xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
 139                       xfs_log_ticket_t ticket,
 140                       void             **iclog,
 141                       uint             flags);
 142int       _xfs_log_force(struct xfs_mount *mp,
 143                         xfs_lsn_t      lsn,
 144                         uint           flags,
 145                         int            *log_forced);
 146void      xfs_log_force(struct xfs_mount        *mp,
 147                        xfs_lsn_t               lsn,
 148                        uint                    flags);
 149int       xfs_log_mount(struct xfs_mount        *mp,
 150                        struct xfs_buftarg      *log_target,
 151                        xfs_daddr_t             start_block,
 152                        int                     num_bblocks);
 153int       xfs_log_mount_finish(struct xfs_mount *mp);
 154void      xfs_log_move_tail(struct xfs_mount    *mp,
 155                            xfs_lsn_t           tail_lsn);
 156int       xfs_log_notify(struct xfs_mount       *mp,
 157                         void                   *iclog,
 158                         xfs_log_callback_t     *callback_entry);
 159int       xfs_log_release_iclog(struct xfs_mount *mp,
 160                         void                    *iclog_hndl);
 161int       xfs_log_reserve(struct xfs_mount *mp,
 162                          int              length,
 163                          int              count,
 164                          xfs_log_ticket_t *ticket,
 165                          __uint8_t        clientid,
 166                          uint             flags,
 167                          uint             t_type);
 168int       xfs_log_write(struct xfs_mount *mp,
 169                        xfs_log_iovec_t  region[],
 170                        int              nentries,
 171                        xfs_log_ticket_t ticket,
 172                        xfs_lsn_t        *start_lsn);
 173int       xfs_log_unmount_write(struct xfs_mount *mp);
 174void      xfs_log_unmount(struct xfs_mount *mp);
 175int       xfs_log_force_umount(struct xfs_mount *mp, int logerror);
 176int       xfs_log_need_covered(struct xfs_mount *mp);
 177
 178void      xlog_iodone(struct xfs_buf *);
 179
 180struct xlog_ticket * xfs_log_ticket_get(struct xlog_ticket *ticket);
 181void      xfs_log_ticket_put(struct xlog_ticket *ticket);
 182
 183#endif
 184
 185
 186extern int xlog_debug;          /* set to 1 to enable real log */
 187
 188
 189#endif  /* __XFS_LOG_H__ */
 190