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