1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2018 Red Hat, Inc. 4 * All rights reserved. 5 */ 6 7 #ifndef __LIBXFS_AG_H 8 #define __LIBXFS_AG_H 1 9 10 struct xfs_mount; 11 struct xfs_trans; 12 struct xfs_perag; 13 14 /* 15 * Per-ag infrastructure 16 */ 17 18 /* per-AG block reservation data structures*/ 19 struct xfs_ag_resv { 20 /* number of blocks originally reserved here */ 21 xfs_extlen_t ar_orig_reserved; 22 /* number of blocks reserved here */ 23 xfs_extlen_t ar_reserved; 24 /* number of blocks originally asked for */ 25 xfs_extlen_t ar_asked; 26 }; 27 28 /* 29 * Per-ag incore structure, copies of information in agf and agi, to improve the 30 * performance of allocation group selection. 31 */ 32 struct xfs_perag { 33 struct xfs_mount *pag_mount; /* owner filesystem */ 34 xfs_agnumber_t pag_agno; /* AG this structure belongs to */ 35 atomic_t pag_ref; /* passive reference count */ 36 atomic_t pag_active_ref; /* active reference count */ 37 wait_queue_head_t pag_active_wq;/* woken active_ref falls to zero */ 38 unsigned long pag_opstate; 39 uint8_t pagf_levels[XFS_BTNUM_AGF]; 40 /* # of levels in bno & cnt btree */ 41 uint32_t pagf_flcount; /* count of blocks in freelist */ 42 xfs_extlen_t pagf_freeblks; /* total free blocks */ 43 xfs_extlen_t pagf_longest; /* longest free space */ 44 uint32_t pagf_btreeblks; /* # of blocks held in AGF btrees */ 45 xfs_agino_t pagi_freecount; /* number of free inodes */ 46 xfs_agino_t pagi_count; /* number of allocated inodes */ 47 48 /* 49 * Inode allocation search lookup optimisation. 50 * If the pagino matches, the search for new inodes 51 * doesn't need to search the near ones again straight away 52 */ 53 xfs_agino_t pagl_pagino; 54 xfs_agino_t pagl_leftrec; 55 xfs_agino_t pagl_rightrec; 56 57 int pagb_count; /* pagb slots in use */ 58 uint8_t pagf_refcount_level; /* recount btree height */ 59 60 /* Blocks reserved for all kinds of metadata. */ 61 struct xfs_ag_resv pag_meta_resv; 62 /* Blocks reserved for the reverse mapping btree. */ 63 struct xfs_ag_resv pag_rmapbt_resv; 64 65 /* for rcu-safe freeing */ 66 struct rcu_head rcu_head; 67 68 /* Precalculated geometry info */ 69 xfs_agblock_t block_count; 70 xfs_agblock_t min_block; 71 xfs_agino_t agino_min; 72 xfs_agino_t agino_max; 73 74 #ifdef __KERNEL__ 75 /* -- kernel only structures below this line -- */ 76 77 /* 78 * Bitsets of per-ag metadata that have been checked and/or are sick. 79 * Callers should hold pag_state_lock before accessing this field. 80 */ 81 uint16_t pag_checked; 82 uint16_t pag_sick; 83 spinlock_t pag_state_lock; 84 85 spinlock_t pagb_lock; /* lock for pagb_tree */ 86 struct rb_root pagb_tree; /* ordered tree of busy extents */ 87 unsigned int pagb_gen; /* generation count for pagb_tree */ 88 wait_queue_head_t pagb_wait; /* woken when pagb_gen changes */ 89 90 atomic_t pagf_fstrms; /* # of filestreams active in this AG */ 91 92 spinlock_t pag_ici_lock; /* incore inode cache lock */ 93 struct radix_tree_root pag_ici_root; /* incore inode cache root */ 94 int pag_ici_reclaimable; /* reclaimable inodes */ 95 unsigned long pag_ici_reclaim_cursor; /* reclaim restart point */ 96 97 /* buffer cache index */ 98 spinlock_t pag_buf_lock; /* lock for pag_buf_hash */ 99 struct rhashtable pag_buf_hash; 100 101 /* background prealloc block trimming */ 102 struct delayed_work pag_blockgc_work; 103 104 /* 105 * We use xfs_drain to track the number of deferred log intent items 106 * that have been queued (but not yet processed) so that waiters (e.g. 107 * scrub) will not lock resources when other threads are in the middle 108 * of processing a chain of intent items only to find momentary 109 * inconsistencies. 110 */ 111 struct xfs_defer_drain pag_intents_drain; 112 #endif /* __KERNEL__ */ 113 }; 114 115 /* 116 * Per-AG operational state. These are atomic flag bits. 117 */ 118 #define XFS_AGSTATE_AGF_INIT 0 119 #define XFS_AGSTATE_AGI_INIT 1 120 #define XFS_AGSTATE_PREFERS_METADATA 2 121 #define XFS_AGSTATE_ALLOWS_INODES 3 122 #define XFS_AGSTATE_AGFL_NEEDS_RESET 4 123 124 #define __XFS_AG_OPSTATE(name, NAME) \ 125 static inline bool xfs_perag_ ## name (struct xfs_perag *pag) \ 126 { \ 127 return test_bit(XFS_AGSTATE_ ## NAME, &pag->pag_opstate); \ 128 } 129 130 __XFS_AG_OPSTATE(initialised_agf, AGF_INIT) 131 __XFS_AG_OPSTATE(initialised_agi, AGI_INIT) 132 __XFS_AG_OPSTATE(prefers_metadata, PREFERS_METADATA) 133 __XFS_AG_OPSTATE(allows_inodes, ALLOWS_INODES) 134 __XFS_AG_OPSTATE(agfl_needs_reset, AGFL_NEEDS_RESET) 135 136 void xfs_free_unused_perag_range(struct xfs_mount *mp, xfs_agnumber_t agstart, 137 xfs_agnumber_t agend); 138 int xfs_initialize_perag(struct xfs_mount *mp, xfs_agnumber_t old_agcount, 139 xfs_agnumber_t agcount, xfs_rfsblock_t dcount, 140 xfs_agnumber_t *maxagi); 141 int xfs_initialize_perag_data(struct xfs_mount *mp, xfs_agnumber_t agno); 142 void xfs_free_perag(struct xfs_mount *mp); 143 int xfs_update_last_ag_size(struct xfs_mount *mp, xfs_agnumber_t prev_agcount); 144 145 /* Passive AG references */ 146 struct xfs_perag *xfs_perag_get(struct xfs_mount *mp, xfs_agnumber_t agno); 147 struct xfs_perag *xfs_perag_get_tag(struct xfs_mount *mp, xfs_agnumber_t agno, 148 unsigned int tag); 149 struct xfs_perag *xfs_perag_hold(struct xfs_perag *pag); 150 void xfs_perag_put(struct xfs_perag *pag); 151 152 /* Active AG references */ 153 struct xfs_perag *xfs_perag_grab(struct xfs_mount *, xfs_agnumber_t); 154 struct xfs_perag *xfs_perag_grab_tag(struct xfs_mount *, xfs_agnumber_t, 155 int tag); 156 void xfs_perag_rele(struct xfs_perag *pag); 157 158 /* 159 * Per-ag geometry infomation and validation 160 */ 161 xfs_agblock_t xfs_ag_block_count(struct xfs_mount *mp, xfs_agnumber_t agno); 162 void xfs_agino_range(struct xfs_mount *mp, xfs_agnumber_t agno, 163 xfs_agino_t *first, xfs_agino_t *last); 164 165 static inline bool 166 xfs_verify_agbno(struct xfs_perag *pag, xfs_agblock_t agbno) 167 { 168 if (agbno >= pag->block_count) 169 return false; 170 if (agbno <= pag->min_block) 171 return false; 172 return true; 173 } 174 175 static inline bool 176 xfs_verify_agbext( 177 struct xfs_perag *pag, 178 xfs_agblock_t agbno, 179 xfs_agblock_t len) 180 { 181 if (agbno + len <= agbno) 182 return false; 183 184 if (!xfs_verify_agbno(pag, agbno)) 185 return false; 186 187 return xfs_verify_agbno(pag, agbno + len - 1); 188 } 189 190 /* 191 * Verify that an AG inode number pointer neither points outside the AG 192 * nor points at static metadata. 193 */ 194 static inline bool 195 xfs_verify_agino(struct xfs_perag *pag, xfs_agino_t agino) 196 { 197 if (agino < pag->agino_min) 198 return false; 199 if (agino > pag->agino_max) 200 return false; 201 return true; 202 } 203 204 /* 205 * Verify that an AG inode number pointer neither points outside the AG 206 * nor points at static metadata, or is NULLAGINO. 207 */ 208 static inline bool 209 xfs_verify_agino_or_null(struct xfs_perag *pag, xfs_agino_t agino) 210 { 211 if (agino == NULLAGINO) 212 return true; 213 return xfs_verify_agino(pag, agino); 214 } 215 216 static inline bool 217 xfs_ag_contains_log(struct xfs_mount *mp, xfs_agnumber_t agno) 218 { 219 return mp->m_sb.sb_logstart > 0 && 220 agno == XFS_FSB_TO_AGNO(mp, mp->m_sb.sb_logstart); 221 } 222 223 /* 224 * Perag iteration APIs 225 */ 226 static inline struct xfs_perag * 227 xfs_perag_next( 228 struct xfs_perag *pag, 229 xfs_agnumber_t *agno, 230 xfs_agnumber_t end_agno) 231 { 232 struct xfs_mount *mp = pag->pag_mount; 233 234 *agno = pag->pag_agno + 1; 235 xfs_perag_rele(pag); 236 while (*agno <= end_agno) { 237 pag = xfs_perag_grab(mp, *agno); 238 if (pag) 239 return pag; 240 (*agno)++; 241 } 242 return NULL; 243 } 244 245 #define for_each_perag_range(mp, agno, end_agno, pag) \ 246 for ((pag) = xfs_perag_grab((mp), (agno)); \ 247 (pag) != NULL; \ 248 (pag) = xfs_perag_next((pag), &(agno), (end_agno))) 249 250 #define for_each_perag_from(mp, agno, pag) \ 251 for_each_perag_range((mp), (agno), (mp)->m_sb.sb_agcount - 1, (pag)) 252 253 #define for_each_perag(mp, agno, pag) \ 254 (agno) = 0; \ 255 for_each_perag_from((mp), (agno), (pag)) 256 257 #define for_each_perag_tag(mp, agno, pag, tag) \ 258 for ((agno) = 0, (pag) = xfs_perag_grab_tag((mp), 0, (tag)); \ 259 (pag) != NULL; \ 260 (agno) = (pag)->pag_agno + 1, \ 261 xfs_perag_rele(pag), \ 262 (pag) = xfs_perag_grab_tag((mp), (agno), (tag))) 263 264 static inline struct xfs_perag * 265 xfs_perag_next_wrap( 266 struct xfs_perag *pag, 267 xfs_agnumber_t *agno, 268 xfs_agnumber_t stop_agno, 269 xfs_agnumber_t restart_agno, 270 xfs_agnumber_t wrap_agno) 271 { 272 struct xfs_mount *mp = pag->pag_mount; 273 274 *agno = pag->pag_agno + 1; 275 xfs_perag_rele(pag); 276 while (*agno != stop_agno) { 277 if (*agno >= wrap_agno) { 278 if (restart_agno >= stop_agno) 279 break; 280 *agno = restart_agno; 281 } 282 283 pag = xfs_perag_grab(mp, *agno); 284 if (pag) 285 return pag; 286 (*agno)++; 287 } 288 return NULL; 289 } 290 291 /* 292 * Iterate all AGs from start_agno through wrap_agno, then restart_agno through 293 * (start_agno - 1). 294 */ 295 #define for_each_perag_wrap_range(mp, start_agno, restart_agno, wrap_agno, agno, pag) \ 296 for ((agno) = (start_agno), (pag) = xfs_perag_grab((mp), (agno)); \ 297 (pag) != NULL; \ 298 (pag) = xfs_perag_next_wrap((pag), &(agno), (start_agno), \ 299 (restart_agno), (wrap_agno))) 300 /* 301 * Iterate all AGs from start_agno through wrap_agno, then 0 through 302 * (start_agno - 1). 303 */ 304 #define for_each_perag_wrap_at(mp, start_agno, wrap_agno, agno, pag) \ 305 for_each_perag_wrap_range((mp), (start_agno), 0, (wrap_agno), (agno), (pag)) 306 307 /* 308 * Iterate all AGs from start_agno through to the end of the filesystem, then 0 309 * through (start_agno - 1). 310 */ 311 #define for_each_perag_wrap(mp, start_agno, agno, pag) \ 312 for_each_perag_wrap_at((mp), (start_agno), (mp)->m_sb.sb_agcount, \ 313 (agno), (pag)) 314 315 316 struct aghdr_init_data { 317 /* per ag data */ 318 xfs_agblock_t agno; /* ag to init */ 319 xfs_extlen_t agsize; /* new AG size */ 320 struct list_head buffer_list; /* buffer writeback list */ 321 xfs_rfsblock_t nfree; /* cumulative new free space */ 322 323 /* per header data */ 324 xfs_daddr_t daddr; /* header location */ 325 size_t numblks; /* size of header */ 326 xfs_btnum_t type; /* type of btree root block */ 327 }; 328 329 int xfs_ag_init_headers(struct xfs_mount *mp, struct aghdr_init_data *id); 330 int xfs_ag_shrink_space(struct xfs_perag *pag, struct xfs_trans **tpp, 331 xfs_extlen_t delta); 332 int xfs_ag_extend_space(struct xfs_perag *pag, struct xfs_trans *tp, 333 xfs_extlen_t len); 334 int xfs_ag_get_geometry(struct xfs_perag *pag, struct xfs_ag_geometry *ageo); 335 336 #endif /* __LIBXFS_AG_H */ 337