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