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 xlog;
  12 struct xfs_buf;
  13 struct xfs_buftarg;
  14 struct xfs_efd_log_item;
  15 struct xfs_efi_log_item;
  16 struct xfs_inode;
  17 struct xfs_item_ops;
  18 struct xfs_log_iovec;
  19 struct xfs_mount;
  20 struct xfs_trans;
  21 struct xfs_trans_res;
  22 struct xfs_dquot_acct;
  23 struct xfs_rud_log_item;
  24 struct xfs_rui_log_item;
  25 struct xfs_btree_cur;
  26 struct xfs_cui_log_item;
  27 struct xfs_cud_log_item;
  28 struct xfs_bui_log_item;
  29 struct xfs_bud_log_item;
  30
  31 struct xfs_log_item {
  32         struct list_head                li_ail;         /* AIL pointers */
  33         struct list_head                li_trans;       /* transaction list */
  34         xfs_lsn_t                       li_lsn;         /* last on-disk lsn */
  35         struct xlog                     *li_log;
  36         struct xfs_ail                  *li_ailp;       /* ptr to AIL */
  37         uint                            li_type;        /* item type */
  38         unsigned long                   li_flags;       /* misc flags */
  39         struct xfs_buf                  *li_buf;        /* real buffer pointer */
  40         struct list_head                li_bio_list;    /* buffer item list */
  41         const struct xfs_item_ops       *li_ops;        /* function list */
  42
  43         /* delayed logging */
  44         struct list_head                li_cil;         /* CIL pointers */
  45         struct xfs_log_vec              *li_lv;         /* active log vector */
  46         struct xfs_log_vec              *li_lv_shadow;  /* standby vector */
  47         xfs_csn_t                       li_seq;         /* CIL commit seq */
  48         uint32_t                        li_order_id;    /* CIL commit order */
  49 };
  50
  51 /*
  52  * li_flags use the (set/test/clear)_bit atomic interfaces because updates can
  53  * race with each other and we don't want to have to use the AIL lock to
  54  * serialise all updates.
  55  */
  56 #define XFS_LI_IN_AIL   0
  57 #define XFS_LI_ABORTED  1
  58 #define XFS_LI_FAILED   2
  59 #define XFS_LI_DIRTY    3
  60 #define XFS_LI_WHITEOUT 4
  61
  62 #define XFS_LI_FLAGS \
  63         { (1u << XFS_LI_IN_AIL),        "IN_AIL" }, \
  64         { (1u << XFS_LI_ABORTED),       "ABORTED" }, \
  65         { (1u << XFS_LI_FAILED),        "FAILED" }, \
  66         { (1u << XFS_LI_DIRTY),         "DIRTY" }, \
  67         { (1u << XFS_LI_WHITEOUT),      "WHITEOUT" }
  68
  69 struct xfs_item_ops {
  70         unsigned flags;
  71         void (*iop_size)(struct xfs_log_item *, int *, int *);
  72         void (*iop_format)(struct xfs_log_item *, struct xfs_log_vec *);
  73         void (*iop_pin)(struct xfs_log_item *);
  74         void (*iop_unpin)(struct xfs_log_item *, int remove);
  75         uint64_t (*iop_sort)(struct xfs_log_item *lip);
  76         int (*iop_precommit)(struct xfs_trans *tp, struct xfs_log_item *lip);
  77         void (*iop_committing)(struct xfs_log_item *lip, xfs_csn_t seq);
  78         xfs_lsn_t (*iop_committed)(struct xfs_log_item *, xfs_lsn_t);
  79         uint (*iop_push)(struct xfs_log_item *, struct list_head *);
  80         void (*iop_release)(struct xfs_log_item *);
  81         int (*iop_recover)(struct xfs_log_item *lip,
  82                            struct list_head *capture_list);
  83         bool (*iop_match)(struct xfs_log_item *item, uint64_t id);
  84         struct xfs_log_item *(*iop_relog)(struct xfs_log_item *intent,
  85                         struct xfs_trans *tp);
  86         struct xfs_log_item *(*iop_intent)(struct xfs_log_item *intent_done);
  87 };
  88
  89 /*
  90  * Log item ops flags
  91  */
  92 /*
  93  * Release the log item when the journal commits instead of inserting into the
  94  * AIL for writeback tracking and/or log tail pinning.
  95  */
  96 #define XFS_ITEM_RELEASE_WHEN_COMMITTED (1 << 0)
  97 #define XFS_ITEM_INTENT                 (1 << 1)
  98 #define XFS_ITEM_INTENT_DONE            (1 << 2)
  99
 100 static inline bool
 101 xlog_item_is_intent(struct xfs_log_item *lip)
 102 {
 103         return lip->li_ops->flags & XFS_ITEM_INTENT;
 104 }
 105
 106 static inline bool
 107 xlog_item_is_intent_done(struct xfs_log_item *lip)
 108 {
 109         return lip->li_ops->flags & XFS_ITEM_INTENT_DONE;
 110 }
 111
 112 void    xfs_log_item_init(struct xfs_mount *mp, struct xfs_log_item *item,
 113                           int type, const struct xfs_item_ops *ops);
 114
 115 /*
 116  * Return values for the iop_push() routines.
 117  */
 118 #define XFS_ITEM_SUCCESS        0
 119 #define XFS_ITEM_PINNED         1
 120 #define XFS_ITEM_LOCKED         2
 121 #define XFS_ITEM_FLUSHING       3
 122
 123 /*
 124  * This is the structure maintained for every active transaction.
 125  */
 126 typedef struct xfs_trans {
 127         unsigned int            t_magic;        /* magic number */
 128         unsigned int            t_log_res;      /* amt of log space resvd */
 129         unsigned int            t_log_count;    /* count for perm log res */
 130         unsigned int            t_blk_res;      /* # of blocks resvd */
 131         unsigned int            t_blk_res_used; /* # of resvd blocks used */
 132         unsigned int            t_rtx_res;      /* # of rt extents resvd */
 133         unsigned int            t_rtx_res_used; /* # of resvd rt extents used */
 134         unsigned int            t_flags;        /* misc flags */
 135         xfs_fsblock_t           t_firstblock;   /* first block allocated */
 136         struct xlog_ticket      *t_ticket;      /* log mgr ticket */
 137         struct xfs_mount        *t_mountp;      /* ptr to fs mount struct */
 138         struct xfs_dquot_acct   *t_dqinfo;      /* acctg info for dquots */
 139         int64_t                 t_icount_delta; /* superblock icount change */
 140         int64_t                 t_ifree_delta;  /* superblock ifree change */
 141         int64_t                 t_fdblocks_delta; /* superblock fdblocks chg */
 142         int64_t                 t_res_fdblocks_delta; /* on-disk only chg */
 143         int64_t                 t_frextents_delta;/* superblock freextents chg*/
 144         int64_t                 t_res_frextents_delta; /* on-disk only chg */
 145         int64_t                 t_dblocks_delta;/* superblock dblocks change */
 146         int64_t                 t_agcount_delta;/* superblock agcount change */
 147         int64_t                 t_imaxpct_delta;/* superblock imaxpct change */
 148         int64_t                 t_rextsize_delta;/* superblock rextsize chg */
 149         int64_t                 t_rbmblocks_delta;/* superblock rbmblocks chg */
 150         int64_t                 t_rblocks_delta;/* superblock rblocks change */
 151         int64_t                 t_rextents_delta;/* superblocks rextents chg */
 152         int64_t                 t_rextslog_delta;/* superblocks rextslog chg */
 153         struct list_head        t_items;        /* log item descriptors */
 154         struct list_head        t_busy;         /* list of busy extents */
 155         struct list_head        t_dfops;        /* deferred operations */
 156         unsigned long           t_pflags;       /* saved process flags state */
 157 } xfs_trans_t;
 158
 159 /*
 160  * XFS transaction mechanism exported interfaces that are
 161  * actually macros.
 162  */
 163 #define xfs_trans_set_sync(tp)          ((tp)->t_flags |= XFS_TRANS_SYNC)
 164
 165 /*
 166  * XFS transaction mechanism exported interfaces.
 167  */
 168 int             xfs_trans_alloc(struct xfs_mount *mp, struct xfs_trans_res *resp,
 169                         uint blocks, uint rtextents, uint flags,
 170                         struct xfs_trans **tpp);
 171 int             xfs_trans_alloc_empty(struct xfs_mount *mp,
 172                         struct xfs_trans **tpp);
 173 void            xfs_trans_mod_sb(xfs_trans_t *, uint, int64_t);
 174
 175 int xfs_trans_get_buf_map(struct xfs_trans *tp, struct xfs_buftarg *target,
 176                 struct xfs_buf_map *map, int nmaps, xfs_buf_flags_t flags,
 177                 struct xfs_buf **bpp);
 178
 179 static inline int
 180 xfs_trans_get_buf(
 181         struct xfs_trans        *tp,
 182         struct xfs_buftarg      *target,
 183         xfs_daddr_t             blkno,
 184         int                     numblks,
 185         xfs_buf_flags_t         flags,
 186         struct xfs_buf          **bpp)
 187 {
 188         DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
 189         return xfs_trans_get_buf_map(tp, target, &map, 1, flags, bpp);
 190 }
 191
 192 int             xfs_trans_read_buf_map(struct xfs_mount *mp,
 193                                        struct xfs_trans *tp,
 194                                        struct xfs_buftarg *target,
 195                                        struct xfs_buf_map *map, int nmaps,
 196                                        xfs_buf_flags_t flags,
 197                                        struct xfs_buf **bpp,
 198                                        const struct xfs_buf_ops *ops);
 199
 200 static inline int
 201 xfs_trans_read_buf(
 202         struct xfs_mount        *mp,
 203         struct xfs_trans        *tp,
 204         struct xfs_buftarg      *target,
 205         xfs_daddr_t             blkno,
 206         int                     numblks,
 207         xfs_buf_flags_t         flags,
 208         struct xfs_buf          **bpp,
 209         const struct xfs_buf_ops *ops)
 210 {
 211         DEFINE_SINGLE_BUF_MAP(map, blkno, numblks);
 212         return xfs_trans_read_buf_map(mp, tp, target, &map, 1,
 213                                       flags, bpp, ops);
 214 }
 215
 216 struct xfs_buf  *xfs_trans_getsb(struct xfs_trans *);
 217
 218 void            xfs_trans_brelse(xfs_trans_t *, struct xfs_buf *);
 219 void            xfs_trans_bjoin(xfs_trans_t *, struct xfs_buf *);
 220 void            xfs_trans_bhold(xfs_trans_t *, struct xfs_buf *);
 221 void            xfs_trans_bhold_release(xfs_trans_t *, struct xfs_buf *);
 222 void            xfs_trans_binval(xfs_trans_t *, struct xfs_buf *);
 223 void            xfs_trans_inode_buf(xfs_trans_t *, struct xfs_buf *);
 224 void            xfs_trans_stale_inode_buf(xfs_trans_t *, struct xfs_buf *);
 225 bool            xfs_trans_ordered_buf(xfs_trans_t *, struct xfs_buf *);
 226 void            xfs_trans_dquot_buf(xfs_trans_t *, struct xfs_buf *, uint);
 227 void            xfs_trans_inode_alloc_buf(xfs_trans_t *, struct xfs_buf *);
 228 void            xfs_trans_ichgtime(struct xfs_trans *, struct xfs_inode *, int);
 229 void            xfs_trans_ijoin(struct xfs_trans *, struct xfs_inode *, uint);
 230 void            xfs_trans_log_buf(struct xfs_trans *, struct xfs_buf *, uint,
 231                                   uint);
 232 void            xfs_trans_dirty_buf(struct xfs_trans *, struct xfs_buf *);
 233 bool            xfs_trans_buf_is_dirty(struct xfs_buf *bp);
 234 void            xfs_trans_log_inode(xfs_trans_t *, struct xfs_inode *, uint);
 235
 236 int             xfs_trans_commit(struct xfs_trans *);
 237 int             xfs_trans_roll(struct xfs_trans **);
 238 int             xfs_trans_roll_inode(struct xfs_trans **, struct xfs_inode *);
 239 void            xfs_trans_cancel(xfs_trans_t *);
 240 int             xfs_trans_ail_init(struct xfs_mount *);
 241 void            xfs_trans_ail_destroy(struct xfs_mount *);
 242
 243 void            xfs_trans_buf_set_type(struct xfs_trans *, struct xfs_buf *,
 244                                        enum xfs_blft);
 245 void            xfs_trans_buf_copy_type(struct xfs_buf *dst_bp,
 246                                         struct xfs_buf *src_bp);
 247
 248 extern struct kmem_cache        *xfs_trans_cache;
 249
 250 static inline struct xfs_log_item *
 251 xfs_trans_item_relog(
 252         struct xfs_log_item     *lip,
 253         struct xfs_trans        *tp)
 254 {
 255         return lip->li_ops->iop_relog(lip, tp);
 256 }
 257
 258 struct xfs_dquot;
 259
 260 int xfs_trans_alloc_inode(struct xfs_inode *ip, struct xfs_trans_res *resv,
 261                 unsigned int dblocks, unsigned int rblocks, bool force,
 262                 struct xfs_trans **tpp);
 263 int xfs_trans_alloc_icreate(struct xfs_mount *mp, struct xfs_trans_res *resv,
 264                 struct xfs_dquot *udqp, struct xfs_dquot *gdqp,
 265                 struct xfs_dquot *pdqp, unsigned int dblocks,
 266                 struct xfs_trans **tpp);
 267 int xfs_trans_alloc_ichange(struct xfs_inode *ip, struct xfs_dquot *udqp,
 268                 struct xfs_dquot *gdqp, struct xfs_dquot *pdqp, bool force,
 269                 struct xfs_trans **tpp);
 270 int xfs_trans_alloc_dir(struct xfs_inode *dp, struct xfs_trans_res *resv,
 271                 struct xfs_inode *ip, unsigned int *dblocks,
 272                 struct xfs_trans **tpp, int *nospace_error);
 273
 274 static inline void
 275 xfs_trans_set_context(
 276         struct xfs_trans        *tp)
 277 {
 278         ASSERT(current->journal_info == NULL);
 279         tp->t_pflags = memalloc_nofs_save();
 280         current->journal_info = tp;
 281 }
 282
 283 static inline void
 284 xfs_trans_clear_context(
 285         struct xfs_trans        *tp)
 286 {
 287         if (current->journal_info == tp) {
 288                 memalloc_nofs_restore(tp->t_pflags);
 289                 current->journal_info = NULL;
 290         }
 291 }
 292
 293 static inline void
 294 xfs_trans_switch_context(
 295         struct xfs_trans        *old_tp,
 296         struct xfs_trans        *new_tp)
 297 {
 298         ASSERT(current->journal_info == old_tp);
 299         new_tp->t_pflags = old_tp->t_pflags;
 300         old_tp->t_pflags = 0;
 301         current->journal_info = new_tp;
 302 }
 303
 304 #endif  /* __XFS_TRANS_H__ */