fs/xfs/xfs_trans.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2000-2002,2005 Silicon Graphics, Inc.
   4  * All Rights Reserved.
   5  */
   6 #ifndef __XFS_TRANS_H__
   7 #define __XFS_TRANS_H__
   8
   9 /* kernel only transaction subsystem defines */
  10
  11 struct xfs_buf;
  12 struct xfs_buftarg;
  13 struct xfs_efd_log_item;
  14 struct xfs_efi_log_item;
  15 struct xfs_inode;
  16 struct xfs_item_ops;
  17 struct xfs_log_iovec;
  18 struct xfs_mount;
  19 struct xfs_trans;
  20 struct xfs_trans_res;
  21 struct xfs_dquot_acct;
  22 struct xfs_rud_log_item;
  23 struct xfs_rui_log_item;
  24 struct xfs_btree_cur;
  25 struct xfs_cui_log_item;
  26 struct xfs_cud_log_item;
  27 struct xfs_bui_log_item;
  28 struct xfs_bud_log_item;
  29
  30 typedef struct xfs_log_item {
  31         struct list_head                li_ail;         /* AIL pointers */
  32         struct list_head                li_trans;       /* transaction list */
  33         xfs_lsn_t                       li_lsn;         /* last on-disk lsn */
  34         struct xfs_mount                *li_mountp;     /* ptr to fs mount */
  35         struct xfs_ail                  *li_ailp;       /* ptr to AIL */
  36         uint                            li_type;        /* item type */
  37         unsigned long                   li_flags;       /* misc flags */
  38         struct xfs_buf                  *li_buf;        /* real buffer pointer */
  39         struct list_head                li_bio_list;    /* buffer item list */
  40         void                            (*li_cb)(struct xfs_buf *,
  41                                                  struct xfs_log_item *);
  42                                                         /* buffer item iodone */
  43                                                         /* callback func */
  44         const struct xfs_item_ops       *li_ops;        /* function list */
  45
  46         /* delayed logging */
  47         struct list_head                li_cil;         /* CIL pointers */
  48         struct xfs_log_vec              *li_lv;         /* active log vector */
  49         struct xfs_log_vec              *li_lv_shadow;  /* standby vector */
  50         xfs_lsn_t                       li_seq;         /* CIL commit seq */
  51 } xfs_log_item_t;
  52
  53 /*
  54  * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
  55  * race with each other and we don't want to have to use the AIL lock to
  56  * serialise all updates.
  57  */
  58 #define XFS_LI_IN_AIL   0
  59 #define XFS_LI_ABORTED  1
  60 #define XFS_LI_FAILED   2
  61 #define XFS_LI_DIRTY    3       /* log item dirty in transaction */
  62
  63 #define XFS_LI_FLAGS \
  64         { (1 << XFS_LI_IN_AIL),         "IN_AIL" }, \
  65         { (1 << XFS_LI_ABORTED),        "ABORTED" }, \
  66         { (1 << XFS_LI_FAILED),         "FAILED" }, \
  67         { (1 << XFS_LI_DIRTY),          "DIRTY" }
  68
  69 struct xfs_item_ops {
  70         void (*iop_size)(xfs_log_item_t *, int *, int *);
  71         void (*iop_format)(xfs_log_item_t *, struct xfs_log_vec *);
  72         void (*iop_pin)(xfs_log_item_t *);
  73         void (*iop_unpin)(xfs_log_item_t *, int remove);
  74         uint (*iop_push)(struct xfs_log_item *, struct list_head *);
  75         void (*iop_unlock)(xfs_log_item_t *);
  76         xfs_lsn_t (*iop_committed)(xfs_log_item_t *, xfs_lsn_t);
  77         void (*iop_committing)(xfs_log_item_t *, xfs_lsn_t);
  78         void (*iop_error)(xfs_log_item_t *, xfs_buf_t *);
  79 };
  80
  81 void    xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
  82                           int type, const struct xfs_item_ops *ops);
  83
  84 /*
  85  * Return values for the iop_push() routines.
  86  */
  87 #define XFS_ITEM_SUCCESS        0
  88 #define XFS_ITEM_PINNED         1
  89 #define XFS_ITEM_LOCKED         2
  90 #define XFS_ITEM_FLUSHING       3
  91
  92 /*
  93  * Deferred operation item relogging limits.
  94  */
  95 #define XFS_DEFER_OPS_NR_INODES 2       /* join up to two inodes */
  96 #define XFS_DEFER_OPS_NR_BUFS   2       /* join up to two buffers */
  97
  98 /*
  99  * This is the structure maintained for every active transaction.
 100  */
 101 typedef struct xfs_trans {
 102         unsigned int            t_magic;        /* magic number */
 103         unsigned int            t_log_res;      /* amt of log space resvd */
 104         unsigned int            t_log_count;    /* count for perm log res */
 105         unsigned int            t_blk_res;      /* # of blocks resvd */
 106         unsigned int            t_blk_res_used; /* # of resvd blocks used */
 107         unsigned int            t_rtx_res;      /* # of rt extents resvd */
 108         unsigned int            t_rtx_res_used; /* # of resvd rt extents used */
 109         unsigned int            t_flags;        /* misc flags */
 110         xfs_fsblock_t           t_firstblock;   /* first block allocated */
 111         struct xlog_ticket      *t_ticket;      /* log mgr ticket */
 112         struct xfs_mount        *t_mountp;      /* ptr to fs mount struct */
 113         struct xfs_dquot_acct   *t_dqinfo;      /* acctg info for dquots */
 114         int64_t                 t_icount_delta; /* superblock icount change */
 115         int64_t                 t_ifree_delta;  /* superblock ifree change */
 116         int64_t                 t_fdblocks_delta; /* superblock fdblocks chg */
 117         int64_t                 t_res_fdblocks_delta; /* on-disk only chg */
 118         int64_t                 t_frextents_delta;/* superblock freextents chg*/
 119         int64_t                 t_res_frextents_delta; /* on-disk only chg */
 120 #if defined(DEBUG) || defined(XFS_WARN)
 121         int64_t                 t_ag_freeblks_delta; /* debugging counter */
 122         int64_t                 t_ag_flist_delta; /* debugging counter */
 123         int64_t                 t_ag_btree_delta; /* debugging counter */
 124 #endif
 125         int64_t                 t_dblocks_delta;/* superblock dblocks change */
 126         int64_t                 t_agcount_delta;/* superblock agcount change */
 127         int64_t                 t_imaxpct_delta;/* superblock imaxpct change */
 128         int64_t                 t_rextsize_delta;/* superblock rextsize chg */
 129         int64_t                 t_rbmblocks_delta;/* superblock rbmblocks chg */
 130         int64_t                 t_rblocks_delta;/* superblock rblocks change */
 131         int64_t                 t_rextents_delta;/* superblocks rextents chg */
 132         int64_t                 t_rextslog_delta;/* superblocks rextslog chg */
 133         struct list_head        t_items;        /* log item descriptors */
 134         struct list_head        t_busy;         /* list of busy extents */
 135         struct list_head        t_dfops;        /* deferred operations */
 136         unsigned long           t_pflags;       /* saved process flags state */
 137 } xfs_trans_t;
 138
 139 /*
 140  * XFS transaction mechanism exported interfaces that are
 141  * actually macros.
 142  */
 143 #define xfs_trans_set_sync(tp)          ((tp)->t_flags |= XFS_TRANS_SYNC)
 144
 145 #if defined(DEBUG) || defined(XFS_WARN)
 146 #define xfs_trans_agblocks_delta(tp, d) ((tp)->t_ag_freeblks_delta += (int64_t)d)
 147 #define xfs_trans_agflist_delta(tp, d)  ((tp)->t_ag_flist_delta += (int64_t)d)
 148 #define xfs_trans_agbtree_delta(tp, d)  ((tp)->t_ag_btree_delta += (int64_t)d)
 149 #else
 150 #define xfs_trans_agblocks_delta(tp, d)
 151 #define xfs_trans_agflist_delta(tp, d)
 152 #define xfs_trans_agbtree_delta(tp, d)
 153 #endif
 154
 155 /*
 156  * XFS transaction mechanism exported interfaces.
 157  */
 158 int             xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
 159                         uint blocks, uint rtextents, uint flags,
 160                         struct xfs_trans **tpp);
 161 int             xfs_trans_alloc_empty(struct xfs_mount *mp,
 162                         struct xfs_trans **tpp);
 163 void            xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
 164
 165 struct xfs_buf  *xfs_trans_get_buf_map(struct xfs_trans *tp,
 166                                        struct xfs_buftarg *target,
 167                                        struct xfs_buf_map *map, int nmaps,
 168                                        uint flags);
 169
 170 static inline struct xfs_buf *
 171 xfs_trans_get_buf(
 172         struct xfs_trans        *tp,
 173         struct xfs_buftarg      *target,
 174         xfs_daddr_t             blkno,
 175         int                     numblks,
 176         uint                    flags)
 177 {
 178         DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
 179         return xfs_trans_get_buf_map(tp, target, &map, 1, flags);
 180 }
 181
 182 int             xfs_trans_read_buf_map(struct xfs_mount *mp,
 183                                        struct xfs_trans *tp,
 184                                        struct xfs_buftarg *target,
 185                                        struct xfs_buf_map *map, int nmaps,
 186                                        xfs_buf_flags_t flags,
 187                                        struct xfs_buf **bpp,
 188                                        const struct xfs_buf_ops *ops);
 189
 190 static inline int
 191 xfs_trans_read_buf(
 192         struct xfs_mount        *mp,
 193         struct xfs_trans        *tp,
 194         struct xfs_buftarg      *target,
 195         xfs_daddr_t             blkno,
 196         int                     numblks,
 197         xfs_buf_flags_t         flags,
 198         struct xfs_buf          **bpp,
 199         const struct xfs_buf_ops *ops)
 200 {
 201         DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
 202         return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
 203                                       flags, bpp, ops);
 204 }
 205
 206 struct xfs_buf  *xfs_trans_getsb(xfs_trans_t *, struct xfs_mount *, int);
 207
 208 void            xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
 209 void            xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
 210 void            xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
 211 void            xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
 212 void            xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
 213 void            xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
 214 void            xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
 215 bool            xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
 216 void            xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
 217 void            xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
 218 void            xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
 219 void            xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
 220 void            xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
 221                                   uint);
 222 void            xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
 223 void            xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
 224
 225 void            xfs_extent_free_init_defer_op(void);
 226 struct xfs_efd_log_item *xfs_trans_get_efd(struct xfs_trans *,
 227                                   struct xfs_efi_log_item *,
 228                                   uint);
 229 int             xfs_trans_free_extent(struct xfs_trans *,
 230                                       struct xfs_efd_log_item *, xfs_fsblock_t,
 231                                       xfs_extlen_t, struct xfs_owner_info *,
 232                                       bool);
 233 int             xfs_trans_commit(struct xfs_trans *);
 234 int             xfs_trans_roll(struct xfs_trans **);
 235 int             xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
 236 void            xfs_trans_cancel(xfs_trans_t *);
 237 int             xfs_trans_ail_init(struct xfs_mount *);
 238 void            xfs_trans_ail_destroy(struct xfs_mount *);
 239
 240 void            xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
 241                                        enum xfs_blft);
 242 void            xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
 243                                         struct xfs_buf *src_bp);
 244
 245 extern kmem_zone_t      *xfs_trans_zone;
 246
 247 /* rmap updates */
 248 enum xfs_rmap_intent_type;
 249
 250 void xfs_rmap_update_init_defer_op(void);
 251 struct xfs_rud_log_item *xfs_trans_get_rud(struct xfs_trans *tp,
 252                 struct xfs_rui_log_item *ruip);
 253 int xfs_trans_log_finish_rmap_update(struct xfs_trans *tp,
 254                 struct xfs_rud_log_item *rudp, enum xfs_rmap_intent_type type,
 255                 uint64_t owner, int whichfork, xfs_fileoff_t startoff,
 256                 xfs_fsblock_t startblock, xfs_filblks_t blockcount,
 257                 xfs_exntst_t state, struct xfs_btree_cur **pcur);
 258
 259 /* refcount updates */
 260 enum xfs_refcount_intent_type;
 261
 262 void xfs_refcount_update_init_defer_op(void);
 263 struct xfs_cud_log_item *xfs_trans_get_cud(struct xfs_trans *tp,
 264                 struct xfs_cui_log_item *cuip);
 265 int xfs_trans_log_finish_refcount_update(struct xfs_trans *tp,
 266                 struct xfs_cud_log_item *cudp,
 267                 enum xfs_refcount_intent_type type, xfs_fsblock_t startblock,
 268                 xfs_extlen_t blockcount, xfs_fsblock_t *new_fsb,
 269                 xfs_extlen_t *new_len, struct xfs_btree_cur **pcur);
 270
 271 /* mapping updates */
 272 enum xfs_bmap_intent_type;
 273
 274 void xfs_bmap_update_init_defer_op(void);
 275 struct xfs_bud_log_item *xfs_trans_get_bud(struct xfs_trans *tp,
 276                 struct xfs_bui_log_item *buip);
 277 int xfs_trans_log_finish_bmap_update(struct xfs_trans *tp,
 278                 struct xfs_bud_log_item *rudp, enum xfs_bmap_intent_type type,
 279                 struct xfs_inode *ip, int whichfork, xfs_fileoff_t startoff,
 280                 xfs_fsblock_t startblock, xfs_filblks_t *blockcount,
 281                 xfs_exntst_t state);
 282
 283 #endif  /* __XFS_TRANS_H__ */