fs/ocfs2/suballoc.h

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