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 struct 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 */
  27         int                     lv_buf_len;     /* size of formatted buffer */
  28         int                     lv_size;        /* size of allocated lv */
  29 };
  30
  31 #define XFS_LOG_VEC_ORDERED     (-1)
  32
  33 static inline void *
  34 xlog_copy_iovec(struct xfs_log_iovec **vecp, uint type, void *data, int len)
  35 {
  36         struct xfs_log_iovec *vec = *vecp;
  37
  38         vec->i_type = type;
  39         vec->i_addr = data;
  40         vec->i_len = len;
  41
  42         *vecp = vec + 1;
  43         return vec->i_addr;
  44 }
  45
  46 /*
  47  * Structure used to pass callback function and the function's argument
  48  * to the log manager.
  49  */
  50 typedef struct xfs_log_callback {
  51         struct xfs_log_callback *cb_next;
  52         void                    (*cb_func)(void *, int);
  53         void                    *cb_arg;
  54 } xfs_log_callback_t;
  55
  56 /*
  57  * By comparing each component, we don't have to worry about extra
  58  * endian issues in treating two 32 bit numbers as one 64 bit number
  59  */
  60 static inline xfs_lsn_t _lsn_cmp(xfs_lsn_t lsn1, xfs_lsn_t lsn2)
  61 {
  62         if (CYCLE_LSN(lsn1) != CYCLE_LSN(lsn2))
  63                 return (CYCLE_LSN(lsn1)<CYCLE_LSN(lsn2))? -999 : 999;
  64
  65         if (BLOCK_LSN(lsn1) != BLOCK_LSN(lsn2))
  66                 return (BLOCK_LSN(lsn1)<BLOCK_LSN(lsn2))? -999 : 999;
  67
  68         return 0;
  69 }
  70
  71 #define XFS_LSN_CMP(x,y) _lsn_cmp(x,y)
  72
  73 /*
  74  * Macros, structures, prototypes for interface to the log manager.
  75  */
  76
  77 /*
  78  * Flags to xfs_log_done()
  79  */
  80 #define XFS_LOG_REL_PERM_RESERV 0x1
  81
  82 /*
  83  * Flags to xfs_log_force()
  84  *
  85  *      XFS_LOG_SYNC:   Synchronous force in-core log to disk
  86  */
  87 #define XFS_LOG_SYNC            0x1
  88
  89 /* Log manager interfaces */
  90 struct xfs_mount;
  91 struct xlog_in_core;
  92 struct xlog_ticket;
  93 struct xfs_log_item;
  94 struct xfs_item_ops;
  95 struct xfs_trans;
  96 struct xfs_log_callback;
  97
  98 xfs_lsn_t xfs_log_done(struct xfs_mount *mp,
  99                        struct xlog_ticket *ticket,
 100                        struct xlog_in_core **iclog,
 101                        uint             flags);
 102 int       _xfs_log_force(struct xfs_mount *mp,
 103                          uint           flags,
 104                          int            *log_forced);
 105 void      xfs_log_force(struct xfs_mount        *mp,
 106                         uint                    flags);
 107 int       _xfs_log_force_lsn(struct xfs_mount *mp,
 108                              xfs_lsn_t          lsn,
 109                              uint               flags,
 110                              int                *log_forced);
 111 void      xfs_log_force_lsn(struct xfs_mount    *mp,
 112                             xfs_lsn_t           lsn,
 113                             uint                flags);
 114 int       xfs_log_mount(struct xfs_mount        *mp,
 115                         struct xfs_buftarg      *log_target,
 116                         xfs_daddr_t             start_block,
 117                         int                     num_bblocks);
 118 int       xfs_log_mount_finish(struct xfs_mount *mp);
 119 xfs_lsn_t xlog_assign_tail_lsn(struct xfs_mount *mp);
 120 xfs_lsn_t xlog_assign_tail_lsn_locked(struct xfs_mount *mp);
 121 void      xfs_log_space_wake(struct xfs_mount *mp);
 122 int       xfs_log_notify(struct xfs_mount       *mp,
 123                          struct xlog_in_core    *iclog,
 124                          struct xfs_log_callback *callback_entry);
 125 int       xfs_log_release_iclog(struct xfs_mount *mp,
 126                          struct xlog_in_core     *iclog);
 127 int       xfs_log_reserve(struct xfs_mount *mp,
 128                           int              length,
 129                           int              count,
 130                           struct xlog_ticket **ticket,
 131                           __uint8_t        clientid,
 132                           bool             permanent,
 133                           uint             t_type);
 134 int       xfs_log_regrant(struct xfs_mount *mp, struct xlog_ticket *tic);
 135 int       xfs_log_unmount_write(struct xfs_mount *mp);
 136 void      xfs_log_unmount(struct xfs_mount *mp);
 137 int       xfs_log_force_umount(struct xfs_mount *mp, int logerror);
 138 int       xfs_log_need_covered(struct xfs_mount *mp);
 139
 140 void      xlog_iodone(struct xfs_buf *);
 141
 142 struct xlog_ticket *xfs_log_ticket_get(struct xlog_ticket *ticket);
 143 void      xfs_log_ticket_put(struct xlog_ticket *ticket);
 144
 145 int     xfs_log_commit_cil(struct xfs_mount *mp, struct xfs_trans *tp,
 146                                 xfs_lsn_t *commit_lsn, int flags);
 147 bool    xfs_log_item_in_current_chkpt(struct xfs_log_item *lip);
 148
 149 void    xfs_log_work_queue(struct xfs_mount *mp);
 150 void    xfs_log_worker(struct work_struct *work);
 151 void    xfs_log_quiesce(struct xfs_mount *mp);
 152
 153 #endif  /* __XFS_LOG_H__ */