fs/ocfs2/suballoc.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * suballoc.h
   4  *
   5  * Defines sub allocator api
   6  *
   7  * Copyright (C) 2003, 2004 Oracle.  All rights reserved.
   8  */
   9
  10 #ifndef _CHAINALLOC_H_
  11 #define _CHAINALLOC_H_
  12
  13 struct ocfs2_suballoc_result;
  14 typedef int (group_search_t)(struct inode *,
  15                              struct buffer_head *,
  16                              u32,                       /* bits_wanted */
  17                              u32,                       /* min_bits */
  18                              u64,                       /* max_block */
  19                              struct ocfs2_suballoc_result *);
  20                                                         /* found bits */
  21
  22 struct ocfs2_alloc_context {
  23         struct inode *ac_inode;    /* which bitmap are we allocating from? */
  24         struct buffer_head *ac_bh; /* file entry bh */
  25         u32    ac_alloc_slot;   /* which slot are we allocating from? */
  26         u32    ac_bits_wanted;
  27         u32    ac_bits_given;
  28 #define OCFS2_AC_USE_LOCAL 1
  29 #define OCFS2_AC_USE_MAIN  2
  30 #define OCFS2_AC_USE_INODE 3
  31 #define OCFS2_AC_USE_META  4
  32         u32    ac_which;
  33
  34         /* these are used by the chain search */
  35         u16    ac_chain;
  36         int    ac_disable_chain_relink;
  37         group_search_t *ac_group_search;
  38
  39         u64    ac_last_group;
  40         u64    ac_max_block;  /* Highest block number to allocate. 0 is
  41                                  the same as ~0 - unlimited */
  42
  43         int    ac_find_loc_only;  /* hack for reflink operation ordering */
  44         struct ocfs2_suballoc_result *ac_find_loc_priv; /* */
  45
  46         struct ocfs2_alloc_reservation  *ac_resv;
  47 };
  48
  49 void ocfs2_init_steal_slots(struct ocfs2_super *osb);
  50 void ocfs2_free_alloc_context(struct ocfs2_alloc_context *ac);
  51 static inline int ocfs2_alloc_context_bits_left(struct ocfs2_alloc_context *ac)
  52 {
  53         return ac->ac_bits_wanted - ac->ac_bits_given;
  54 }
  55
  56 /*
  57  * Please note that the caller must make sure that root_el is the root
  58  * of extent tree. So for an inode, it should be &fe->id2.i_list. Otherwise
  59  * the result may be wrong.
  60  */
  61 int ocfs2_reserve_new_metadata(struct ocfs2_super *osb,
  62                                struct ocfs2_extent_list *root_el,
  63                                struct ocfs2_alloc_context **ac);
  64 int ocfs2_reserve_new_metadata_blocks(struct ocfs2_super *osb,
  65                                       int blocks,
  66                                       struct ocfs2_alloc_context **ac);
  67 int ocfs2_reserve_new_inode(struct ocfs2_super *osb,
  68                             struct ocfs2_alloc_context **ac);
  69 int ocfs2_reserve_clusters(struct ocfs2_super *osb,
  70                            u32 bits_wanted,
  71                            struct ocfs2_alloc_context **ac);
  72
  73 int ocfs2_alloc_dinode_update_counts(struct inode *inode,
  74                          handle_t *handle,
  75                          struct buffer_head *di_bh,
  76                          u32 num_bits,
  77                          u16 chain);
  78 void ocfs2_rollback_alloc_dinode_counts(struct inode *inode,
  79                          struct buffer_head *di_bh,
  80                          u32 num_bits,
  81                          u16 chain);
  82 int ocfs2_block_group_set_bits(handle_t *handle,
  83                          struct inode *alloc_inode,
  84                          struct ocfs2_group_desc *bg,
  85                          struct buffer_head *group_bh,
  86                          unsigned int bit_off,
  87                          unsigned int num_bits);
  88
  89 int ocfs2_claim_metadata(handle_t *handle,
  90                          struct ocfs2_alloc_context *ac,
  91                          u32 bits_wanted,
  92                          u64 *suballoc_loc,
  93                          u16 *suballoc_bit_start,
  94                          u32 *num_bits,
  95                          u64 *blkno_start);
  96 int ocfs2_claim_new_inode(handle_t *handle,
  97                           struct inode *dir,
  98                           struct buffer_head *parent_fe_bh,
  99                           struct ocfs2_alloc_context *ac,
 100                           u64 *suballoc_loc,
 101                           u16 *suballoc_bit,
 102                           u64 *fe_blkno);
 103 int ocfs2_claim_clusters(handle_t *handle,
 104                          struct ocfs2_alloc_context *ac,
 105                          u32 min_clusters,
 106                          u32 *cluster_start,
 107                          u32 *num_clusters);
 108 /*
 109  * Use this variant of ocfs2_claim_clusters to specify a maximum
 110  * number of clusters smaller than the allocation reserved.
 111  */
 112 int __ocfs2_claim_clusters(handle_t *handle,
 113                            struct ocfs2_alloc_context *ac,
 114                            u32 min_clusters,
 115                            u32 max_clusters,
 116                            u32 *cluster_start,
 117                            u32 *num_clusters);
 118
 119 int ocfs2_free_suballoc_bits(handle_t *handle,
 120                              struct inode *alloc_inode,
 121                              struct buffer_head *alloc_bh,
 122                              unsigned int start_bit,
 123                              u64 bg_blkno,
 124                              unsigned int count);
 125 int ocfs2_free_dinode(handle_t *handle,
 126                       struct inode *inode_alloc_inode,
 127                       struct buffer_head *inode_alloc_bh,
 128                       struct ocfs2_dinode *di);
 129 int ocfs2_free_clusters(handle_t *handle,
 130                         struct inode *bitmap_inode,
 131                         struct buffer_head *bitmap_bh,
 132                         u64 start_blk,
 133                         unsigned int num_clusters);
 134 int ocfs2_release_clusters(handle_t *handle,
 135                            struct inode *bitmap_inode,
 136                            struct buffer_head *bitmap_bh,
 137                            u64 start_blk,
 138                            unsigned int num_clusters);
 139
 140 static inline u64 ocfs2_which_suballoc_group(u64 block, unsigned int bit)
 141 {
 142         u64 group = block - (u64) bit;
 143
 144         return group;
 145 }
 146
 147 static inline u32 ocfs2_cluster_from_desc(struct ocfs2_super *osb,
 148                                           u64 bg_blkno)
 149 {
 150         /* This should work for all block group descriptors as only
 151          * the 1st group descriptor of the cluster bitmap is
 152          * different. */
 153
 154         if (bg_blkno == osb->first_cluster_group_blkno)
 155                 return 0;
 156
 157         /* the rest of the block groups are located at the beginning
 158          * of their 1st cluster, so a direct translation just
 159          * works. */
 160         return ocfs2_blocks_to_clusters(osb->sb, bg_blkno);
 161 }
 162
 163 static inline int ocfs2_is_cluster_bitmap(struct inode *inode)
 164 {
 165         struct ocfs2_super *osb = OCFS2_SB(inode->i_sb);
 166         return osb->bitmap_blkno == OCFS2_I(inode)->ip_blkno;
 167 }
 168
 169 /* This is for local alloc ONLY. Others should use the task-specific
 170  * apis above. */
 171 int ocfs2_reserve_cluster_bitmap_bits(struct ocfs2_super *osb,
 172                                       struct ocfs2_alloc_context *ac);
 173 void ocfs2_free_ac_resource(struct ocfs2_alloc_context *ac);
 174
 175 /* given a cluster offset, calculate which block group it belongs to
 176  * and return that block offset. */
 177 u64 ocfs2_which_cluster_group(struct inode *inode, u32 cluster);
 178
 179 /*
 180  * By default, ocfs2_read_group_descriptor() calls ocfs2_error() when it
 181  * finds a problem.  A caller that wants to check a group descriptor
 182  * without going readonly should read the block with ocfs2_read_block[s]()
 183  * and then checking it with this function.  This is only resize, really.
 184  * Everyone else should be using ocfs2_read_group_descriptor().
 185  */
 186 int ocfs2_check_group_descriptor(struct super_block *sb,
 187                                  struct ocfs2_dinode *di,
 188                                  struct buffer_head *bh);
 189 /*
 190  * Read a group descriptor block into *bh.  If *bh is NULL, a bh will be
 191  * allocated.  This is a cached read.  The descriptor will be validated with
 192  * ocfs2_validate_group_descriptor().
 193  */
 194 int ocfs2_read_group_descriptor(struct inode *inode, struct ocfs2_dinode *di,
 195                                 u64 gd_blkno, struct buffer_head **bh);
 196
 197 int ocfs2_lock_allocators(struct inode *inode, struct ocfs2_extent_tree *et,
 198                           u32 clusters_to_add, u32 extents_to_split,
 199                           struct ocfs2_alloc_context **data_ac,
 200                           struct ocfs2_alloc_context **meta_ac);
 201
 202 int ocfs2_test_inode_bit(struct ocfs2_super *osb, u64 blkno, int *res);
 203
 204
 205
 206 /*
 207  * The following two interfaces are for ocfs2_create_inode_in_orphan().
 208  */
 209 int ocfs2_find_new_inode_loc(struct inode *dir,
 210                              struct buffer_head *parent_fe_bh,
 211                              struct ocfs2_alloc_context *ac,
 212                              u64 *fe_blkno);
 213
 214 int ocfs2_claim_new_inode_at_loc(handle_t *handle,
 215                                  struct inode *dir,
 216                                  struct ocfs2_alloc_context *ac,
 217                                  u64 *suballoc_loc,
 218                                  u16 *suballoc_bit,
 219                                  u64 di_blkno);
 220
 221 #endif /* _CHAINALLOC_H_ */