fs/f2fs/node.h

   1 /*
   2  * fs/f2fs/node.h
   3  *
   4  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   5  *             http://www.samsung.com/
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11 /* start node id of a node block dedicated to the given node id */
  12 #define START_NID(nid) ((nid / NAT_ENTRY_PER_BLOCK) * NAT_ENTRY_PER_BLOCK)
  13
  14 /* node block offset on the NAT area dedicated to the given start node id */
  15 #define NAT_BLOCK_OFFSET(start_nid) (start_nid / NAT_ENTRY_PER_BLOCK)
  16
  17 /* # of pages to perform readahead before building free nids */
  18 #define FREE_NID_PAGES 4
  19
  20 /* maximum readahead size for node during getting data blocks */
  21 #define MAX_RA_NODE             128
  22
  23 /* control the memory footprint threshold (10MB per 1GB ram) */
  24 #define DEF_RAM_THRESHOLD       10
  25
  26 /* vector size for gang look-up from nat cache that consists of radix tree */
  27 #define NATVEC_SIZE     64
  28
  29 /* return value for read_node_page */
  30 #define LOCKED_PAGE     1
  31
  32 /*
  33  * For node information
  34  */
  35 struct node_info {
  36         nid_t nid;              /* node id */
  37         nid_t ino;              /* inode number of the node's owner */
  38         block_t blk_addr;       /* block address of the node */
  39         unsigned char version;  /* version of the node */
  40 };
  41
  42 struct nat_entry {
  43         struct list_head list;  /* for clean or dirty nat list */
  44         bool checkpointed;      /* whether it is checkpointed or not */
  45         bool fsync_done;        /* whether the latest node has fsync mark */
  46         struct node_info ni;    /* in-memory node information */
  47 };
  48
  49 #define nat_get_nid(nat)                (nat->ni.nid)
  50 #define nat_set_nid(nat, n)             (nat->ni.nid = n)
  51 #define nat_get_blkaddr(nat)            (nat->ni.blk_addr)
  52 #define nat_set_blkaddr(nat, b)         (nat->ni.blk_addr = b)
  53 #define nat_get_ino(nat)                (nat->ni.ino)
  54 #define nat_set_ino(nat, i)             (nat->ni.ino = i)
  55 #define nat_get_version(nat)            (nat->ni.version)
  56 #define nat_set_version(nat, v)         (nat->ni.version = v)
  57
  58 #define __set_nat_cache_dirty(nm_i, ne)                                 \
  59         do {                                                            \
  60                 ne->checkpointed = false;                               \
  61                 list_move_tail(&ne->list, &nm_i->dirty_nat_entries);    \
  62         } while (0)
  63 #define __clear_nat_cache_dirty(nm_i, ne)                               \
  64         do {                                                            \
  65                 ne->checkpointed = true;                                \
  66                 list_move_tail(&ne->list, &nm_i->nat_entries);          \
  67         } while (0)
  68 #define inc_node_version(version)       (++version)
  69
  70 static inline void node_info_from_raw_nat(struct node_info *ni,
  71                                                 struct f2fs_nat_entry *raw_ne)
  72 {
  73         ni->ino = le32_to_cpu(raw_ne->ino);
  74         ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
  75         ni->version = raw_ne->version;
  76 }
  77
  78 static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
  79                                                 struct node_info *ni)
  80 {
  81         raw_ne->ino = cpu_to_le32(ni->ino);
  82         raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
  83         raw_ne->version = ni->version;
  84 }
  85
  86 enum mem_type {
  87         FREE_NIDS,      /* indicates the free nid list */
  88         NAT_ENTRIES,    /* indicates the cached nat entry */
  89         DIRTY_DENTS     /* indicates dirty dentry pages */
  90 };
  91
  92 struct nat_entry_set {
  93         struct list_head set_list;      /* link with all nat sets */
  94         struct list_head entry_list;    /* link with dirty nat entries */
  95         nid_t start_nid;                /* start nid of nats in set */
  96         unsigned int entry_cnt;         /* the # of nat entries in set */
  97 };
  98
  99 /*
 100  * For free nid mangement
 101  */
 102 enum nid_state {
 103         NID_NEW,        /* newly added to free nid list */
 104         NID_ALLOC       /* it is allocated */
 105 };
 106
 107 struct free_nid {
 108         struct list_head list;  /* for free node id list */
 109         nid_t nid;              /* node id */
 110         int state;              /* in use or not: NID_NEW or NID_ALLOC */
 111 };
 112
 113 static inline int next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid)
 114 {
 115         struct f2fs_nm_info *nm_i = NM_I(sbi);
 116         struct free_nid *fnid;
 117
 118         spin_lock(&nm_i->free_nid_list_lock);
 119         if (nm_i->fcnt <= 0) {
 120                 spin_unlock(&nm_i->free_nid_list_lock);
 121                 return -1;
 122         }
 123         fnid = list_entry(nm_i->free_nid_list.next, struct free_nid, list);
 124         *nid = fnid->nid;
 125         spin_unlock(&nm_i->free_nid_list_lock);
 126         return 0;
 127 }
 128
 129 /*
 130  * inline functions
 131  */
 132 static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr)
 133 {
 134         struct f2fs_nm_info *nm_i = NM_I(sbi);
 135         memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
 136 }
 137
 138 static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
 139 {
 140         struct f2fs_nm_info *nm_i = NM_I(sbi);
 141         pgoff_t block_off;
 142         pgoff_t block_addr;
 143         int seg_off;
 144
 145         block_off = NAT_BLOCK_OFFSET(start);
 146         seg_off = block_off >> sbi->log_blocks_per_seg;
 147
 148         block_addr = (pgoff_t)(nm_i->nat_blkaddr +
 149                 (seg_off << sbi->log_blocks_per_seg << 1) +
 150                 (block_off & ((1 << sbi->log_blocks_per_seg) - 1)));
 151
 152         if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
 153                 block_addr += sbi->blocks_per_seg;
 154
 155         return block_addr;
 156 }
 157
 158 static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
 159                                                 pgoff_t block_addr)
 160 {
 161         struct f2fs_nm_info *nm_i = NM_I(sbi);
 162
 163         block_addr -= nm_i->nat_blkaddr;
 164         if ((block_addr >> sbi->log_blocks_per_seg) % 2)
 165                 block_addr -= sbi->blocks_per_seg;
 166         else
 167                 block_addr += sbi->blocks_per_seg;
 168
 169         return block_addr + nm_i->nat_blkaddr;
 170 }
 171
 172 static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
 173 {
 174         unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);
 175
 176         if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
 177                 f2fs_clear_bit(block_off, nm_i->nat_bitmap);
 178         else
 179                 f2fs_set_bit(block_off, nm_i->nat_bitmap);
 180 }
 181
 182 static inline void fill_node_footer(struct page *page, nid_t nid,
 183                                 nid_t ino, unsigned int ofs, bool reset)
 184 {
 185         struct f2fs_node *rn = F2FS_NODE(page);
 186         if (reset)
 187                 memset(rn, 0, sizeof(*rn));
 188         rn->footer.nid = cpu_to_le32(nid);
 189         rn->footer.ino = cpu_to_le32(ino);
 190         rn->footer.flag = cpu_to_le32(ofs << OFFSET_BIT_SHIFT);
 191 }
 192
 193 static inline void copy_node_footer(struct page *dst, struct page *src)
 194 {
 195         struct f2fs_node *src_rn = F2FS_NODE(src);
 196         struct f2fs_node *dst_rn = F2FS_NODE(dst);
 197         memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
 198 }
 199
 200 static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
 201 {
 202         struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
 203         struct f2fs_node *rn = F2FS_NODE(page);
 204
 205         rn->footer.cp_ver = ckpt->checkpoint_ver;
 206         rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
 207 }
 208
 209 static inline nid_t ino_of_node(struct page *node_page)
 210 {
 211         struct f2fs_node *rn = F2FS_NODE(node_page);
 212         return le32_to_cpu(rn->footer.ino);
 213 }
 214
 215 static inline nid_t nid_of_node(struct page *node_page)
 216 {
 217         struct f2fs_node *rn = F2FS_NODE(node_page);
 218         return le32_to_cpu(rn->footer.nid);
 219 }
 220
 221 static inline unsigned int ofs_of_node(struct page *node_page)
 222 {
 223         struct f2fs_node *rn = F2FS_NODE(node_page);
 224         unsigned flag = le32_to_cpu(rn->footer.flag);
 225         return flag >> OFFSET_BIT_SHIFT;
 226 }
 227
 228 static inline unsigned long long cpver_of_node(struct page *node_page)
 229 {
 230         struct f2fs_node *rn = F2FS_NODE(node_page);
 231         return le64_to_cpu(rn->footer.cp_ver);
 232 }
 233
 234 static inline block_t next_blkaddr_of_node(struct page *node_page)
 235 {
 236         struct f2fs_node *rn = F2FS_NODE(node_page);
 237         return le32_to_cpu(rn->footer.next_blkaddr);
 238 }
 239
 240 /*
 241  * f2fs assigns the following node offsets described as (num).
 242  * N = NIDS_PER_BLOCK
 243  *
 244  *  Inode block (0)
 245  *    |- direct node (1)
 246  *    |- direct node (2)
 247  *    |- indirect node (3)
 248  *    |            `- direct node (4 => 4 + N - 1)
 249  *    |- indirect node (4 + N)
 250  *    |            `- direct node (5 + N => 5 + 2N - 1)
 251  *    `- double indirect node (5 + 2N)
 252  *                 `- indirect node (6 + 2N)
 253  *                       `- direct node
 254  *                 ......
 255  *                 `- indirect node ((6 + 2N) + x(N + 1))
 256  *                       `- direct node
 257  *                 ......
 258  *                 `- indirect node ((6 + 2N) + (N - 1)(N + 1))
 259  *                       `- direct node
 260  */
 261 static inline bool IS_DNODE(struct page *node_page)
 262 {
 263         unsigned int ofs = ofs_of_node(node_page);
 264
 265         if (f2fs_has_xattr_block(ofs))
 266                 return false;
 267
 268         if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK ||
 269                         ofs == 5 + 2 * NIDS_PER_BLOCK)
 270                 return false;
 271         if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
 272                 ofs -= 6 + 2 * NIDS_PER_BLOCK;
 273                 if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
 274                         return false;
 275         }
 276         return true;
 277 }
 278
 279 static inline void set_nid(struct page *p, int off, nid_t nid, bool i)
 280 {
 281         struct f2fs_node *rn = F2FS_NODE(p);
 282
 283         f2fs_wait_on_page_writeback(p, NODE);
 284
 285         if (i)
 286                 rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
 287         else
 288                 rn->in.nid[off] = cpu_to_le32(nid);
 289         set_page_dirty(p);
 290 }
 291
 292 static inline nid_t get_nid(struct page *p, int off, bool i)
 293 {
 294         struct f2fs_node *rn = F2FS_NODE(p);
 295
 296         if (i)
 297                 return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
 298         return le32_to_cpu(rn->in.nid[off]);
 299 }
 300
 301 /*
 302  * Coldness identification:
 303  *  - Mark cold files in f2fs_inode_info
 304  *  - Mark cold node blocks in their node footer
 305  *  - Mark cold data pages in page cache
 306  */
 307 static inline int is_file(struct inode *inode, int type)
 308 {
 309         return F2FS_I(inode)->i_advise & type;
 310 }
 311
 312 static inline void set_file(struct inode *inode, int type)
 313 {
 314         F2FS_I(inode)->i_advise |= type;
 315 }
 316
 317 static inline void clear_file(struct inode *inode, int type)
 318 {
 319         F2FS_I(inode)->i_advise &= ~type;
 320 }
 321
 322 #define file_is_cold(inode)     is_file(inode, FADVISE_COLD_BIT)
 323 #define file_wrong_pino(inode)  is_file(inode, FADVISE_LOST_PINO_BIT)
 324 #define file_set_cold(inode)    set_file(inode, FADVISE_COLD_BIT)
 325 #define file_lost_pino(inode)   set_file(inode, FADVISE_LOST_PINO_BIT)
 326 #define file_clear_cold(inode)  clear_file(inode, FADVISE_COLD_BIT)
 327 #define file_got_pino(inode)    clear_file(inode, FADVISE_LOST_PINO_BIT)
 328
 329 static inline int is_cold_data(struct page *page)
 330 {
 331         return PageChecked(page);
 332 }
 333
 334 static inline void set_cold_data(struct page *page)
 335 {
 336         SetPageChecked(page);
 337 }
 338
 339 static inline void clear_cold_data(struct page *page)
 340 {
 341         ClearPageChecked(page);
 342 }
 343
 344 static inline int is_node(struct page *page, int type)
 345 {
 346         struct f2fs_node *rn = F2FS_NODE(page);
 347         return le32_to_cpu(rn->footer.flag) & (1 << type);
 348 }
 349
 350 #define is_cold_node(page)      is_node(page, COLD_BIT_SHIFT)
 351 #define is_fsync_dnode(page)    is_node(page, FSYNC_BIT_SHIFT)
 352 #define is_dent_dnode(page)     is_node(page, DENT_BIT_SHIFT)
 353
 354 static inline void set_cold_node(struct inode *inode, struct page *page)
 355 {
 356         struct f2fs_node *rn = F2FS_NODE(page);
 357         unsigned int flag = le32_to_cpu(rn->footer.flag);
 358
 359         if (S_ISDIR(inode->i_mode))
 360                 flag &= ~(0x1 << COLD_BIT_SHIFT);
 361         else
 362                 flag |= (0x1 << COLD_BIT_SHIFT);
 363         rn->footer.flag = cpu_to_le32(flag);
 364 }
 365
 366 static inline void set_mark(struct page *page, int mark, int type)
 367 {
 368         struct f2fs_node *rn = F2FS_NODE(page);
 369         unsigned int flag = le32_to_cpu(rn->footer.flag);
 370         if (mark)
 371                 flag |= (0x1 << type);
 372         else
 373                 flag &= ~(0x1 << type);
 374         rn->footer.flag = cpu_to_le32(flag);
 375 }
 376 #define set_dentry_mark(page, mark)     set_mark(page, mark, DENT_BIT_SHIFT)
 377 #define set_fsync_mark(page, mark)      set_mark(page, mark, FSYNC_BIT_SHIFT)