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         struct node_info ni;    /* in-memory node information */
  46 };
  47
  48 #define nat_get_nid(nat)                (nat->ni.nid)
  49 #define nat_set_nid(nat, n)             (nat->ni.nid = n)
  50 #define nat_get_blkaddr(nat)            (nat->ni.blk_addr)
  51 #define nat_set_blkaddr(nat, b)         (nat->ni.blk_addr = b)
  52 #define nat_get_ino(nat)                (nat->ni.ino)
  53 #define nat_set_ino(nat, i)             (nat->ni.ino = i)
  54 #define nat_get_version(nat)            (nat->ni.version)
  55 #define nat_set_version(nat, v)         (nat->ni.version = v)
  56
  57 #define __set_nat_cache_dirty(nm_i, ne)                                 \
  58         do {                                                            \
  59                 ne->checkpointed = false;                               \
  60                 list_move_tail(&ne->list, &nm_i->dirty_nat_entries);    \
  61         } while (0);
  62 #define __clear_nat_cache_dirty(nm_i, ne)                               \
  63         do {                                                            \
  64                 ne->checkpointed = true;                                \
  65                 list_move_tail(&ne->list, &nm_i->nat_entries);          \
  66         } while (0);
  67 #define inc_node_version(version)       (++version)
  68
  69 static inline void node_info_from_raw_nat(struct node_info *ni,
  70                                                 struct f2fs_nat_entry *raw_ne)
  71 {
  72         ni->ino = le32_to_cpu(raw_ne->ino);
  73         ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
  74         ni->version = raw_ne->version;
  75 }
  76
  77 enum nid_type {
  78         FREE_NIDS,      /* indicates the free nid list */
  79         NAT_ENTRIES     /* indicates the cached nat entry */
  80 };
  81
  82 /*
  83  * For free nid mangement
  84  */
  85 enum nid_state {
  86         NID_NEW,        /* newly added to free nid list */
  87         NID_ALLOC       /* it is allocated */
  88 };
  89
  90 struct free_nid {
  91         struct list_head list;  /* for free node id list */
  92         nid_t nid;              /* node id */
  93         int state;              /* in use or not: NID_NEW or NID_ALLOC */
  94 };
  95
  96 static inline int next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid)
  97 {
  98         struct f2fs_nm_info *nm_i = NM_I(sbi);
  99         struct free_nid *fnid;
 100
 101         if (nm_i->fcnt <= 0)
 102                 return -1;
 103         spin_lock(&nm_i->free_nid_list_lock);
 104         fnid = list_entry(nm_i->free_nid_list.next, struct free_nid, list);
 105         *nid = fnid->nid;
 106         spin_unlock(&nm_i->free_nid_list_lock);
 107         return 0;
 108 }
 109
 110 /*
 111  * inline functions
 112  */
 113 static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr)
 114 {
 115         struct f2fs_nm_info *nm_i = NM_I(sbi);
 116         memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
 117 }
 118
 119 static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
 120 {
 121         struct f2fs_nm_info *nm_i = NM_I(sbi);
 122         pgoff_t block_off;
 123         pgoff_t block_addr;
 124         int seg_off;
 125
 126         block_off = NAT_BLOCK_OFFSET(start);
 127         seg_off = block_off >> sbi->log_blocks_per_seg;
 128
 129         block_addr = (pgoff_t)(nm_i->nat_blkaddr +
 130                 (seg_off << sbi->log_blocks_per_seg << 1) +
 131                 (block_off & ((1 << sbi->log_blocks_per_seg) - 1)));
 132
 133         if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
 134                 block_addr += sbi->blocks_per_seg;
 135
 136         return block_addr;
 137 }
 138
 139 static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
 140                                                 pgoff_t block_addr)
 141 {
 142         struct f2fs_nm_info *nm_i = NM_I(sbi);
 143
 144         block_addr -= nm_i->nat_blkaddr;
 145         if ((block_addr >> sbi->log_blocks_per_seg) % 2)
 146                 block_addr -= sbi->blocks_per_seg;
 147         else
 148                 block_addr += sbi->blocks_per_seg;
 149
 150         return block_addr + nm_i->nat_blkaddr;
 151 }
 152
 153 static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
 154 {
 155         unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);
 156
 157         if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
 158                 f2fs_clear_bit(block_off, nm_i->nat_bitmap);
 159         else
 160                 f2fs_set_bit(block_off, nm_i->nat_bitmap);
 161 }
 162
 163 static inline void fill_node_footer(struct page *page, nid_t nid,
 164                                 nid_t ino, unsigned int ofs, bool reset)
 165 {
 166         struct f2fs_node *rn = F2FS_NODE(page);
 167         if (reset)
 168                 memset(rn, 0, sizeof(*rn));
 169         rn->footer.nid = cpu_to_le32(nid);
 170         rn->footer.ino = cpu_to_le32(ino);
 171         rn->footer.flag = cpu_to_le32(ofs << OFFSET_BIT_SHIFT);
 172 }
 173
 174 static inline void copy_node_footer(struct page *dst, struct page *src)
 175 {
 176         struct f2fs_node *src_rn = F2FS_NODE(src);
 177         struct f2fs_node *dst_rn = F2FS_NODE(dst);
 178         memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
 179 }
 180
 181 static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
 182 {
 183         struct f2fs_sb_info *sbi = F2FS_SB(page->mapping->host->i_sb);
 184         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 185         struct f2fs_node *rn = F2FS_NODE(page);
 186
 187         rn->footer.cp_ver = ckpt->checkpoint_ver;
 188         rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
 189 }
 190
 191 static inline nid_t ino_of_node(struct page *node_page)
 192 {
 193         struct f2fs_node *rn = F2FS_NODE(node_page);
 194         return le32_to_cpu(rn->footer.ino);
 195 }
 196
 197 static inline nid_t nid_of_node(struct page *node_page)
 198 {
 199         struct f2fs_node *rn = F2FS_NODE(node_page);
 200         return le32_to_cpu(rn->footer.nid);
 201 }
 202
 203 static inline unsigned int ofs_of_node(struct page *node_page)
 204 {
 205         struct f2fs_node *rn = F2FS_NODE(node_page);
 206         unsigned flag = le32_to_cpu(rn->footer.flag);
 207         return flag >> OFFSET_BIT_SHIFT;
 208 }
 209
 210 static inline unsigned long long cpver_of_node(struct page *node_page)
 211 {
 212         struct f2fs_node *rn = F2FS_NODE(node_page);
 213         return le64_to_cpu(rn->footer.cp_ver);
 214 }
 215
 216 static inline block_t next_blkaddr_of_node(struct page *node_page)
 217 {
 218         struct f2fs_node *rn = F2FS_NODE(node_page);
 219         return le32_to_cpu(rn->footer.next_blkaddr);
 220 }
 221
 222 /*
 223  * f2fs assigns the following node offsets described as (num).
 224  * N = NIDS_PER_BLOCK
 225  *
 226  *  Inode block (0)
 227  *    |- direct node (1)
 228  *    |- direct node (2)
 229  *    |- indirect node (3)
 230  *    |            `- direct node (4 => 4 + N - 1)
 231  *    |- indirect node (4 + N)
 232  *    |            `- direct node (5 + N => 5 + 2N - 1)
 233  *    `- double indirect node (5 + 2N)
 234  *                 `- indirect node (6 + 2N)
 235  *                       `- direct node
 236  *                 ......
 237  *                 `- indirect node ((6 + 2N) + x(N + 1))
 238  *                       `- direct node
 239  *                 ......
 240  *                 `- indirect node ((6 + 2N) + (N - 1)(N + 1))
 241  *                       `- direct node
 242  */
 243 static inline bool IS_DNODE(struct page *node_page)
 244 {
 245         unsigned int ofs = ofs_of_node(node_page);
 246
 247         if (f2fs_has_xattr_block(ofs))
 248                 return false;
 249
 250         if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK ||
 251                         ofs == 5 + 2 * NIDS_PER_BLOCK)
 252                 return false;
 253         if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
 254                 ofs -= 6 + 2 * NIDS_PER_BLOCK;
 255                 if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
 256                         return false;
 257         }
 258         return true;
 259 }
 260
 261 static inline void set_nid(struct page *p, int off, nid_t nid, bool i)
 262 {
 263         struct f2fs_node *rn = F2FS_NODE(p);
 264
 265         wait_on_page_writeback(p);
 266
 267         if (i)
 268                 rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
 269         else
 270                 rn->in.nid[off] = cpu_to_le32(nid);
 271         set_page_dirty(p);
 272 }
 273
 274 static inline nid_t get_nid(struct page *p, int off, bool i)
 275 {
 276         struct f2fs_node *rn = F2FS_NODE(p);
 277
 278         if (i)
 279                 return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
 280         return le32_to_cpu(rn->in.nid[off]);
 281 }
 282
 283 /*
 284  * Coldness identification:
 285  *  - Mark cold files in f2fs_inode_info
 286  *  - Mark cold node blocks in their node footer
 287  *  - Mark cold data pages in page cache
 288  */
 289 static inline int is_file(struct inode *inode, int type)
 290 {
 291         return F2FS_I(inode)->i_advise & type;
 292 }
 293
 294 static inline void set_file(struct inode *inode, int type)
 295 {
 296         F2FS_I(inode)->i_advise |= type;
 297 }
 298
 299 static inline void clear_file(struct inode *inode, int type)
 300 {
 301         F2FS_I(inode)->i_advise &= ~type;
 302 }
 303
 304 #define file_is_cold(inode)     is_file(inode, FADVISE_COLD_BIT)
 305 #define file_wrong_pino(inode)  is_file(inode, FADVISE_LOST_PINO_BIT)
 306 #define file_set_cold(inode)    set_file(inode, FADVISE_COLD_BIT)
 307 #define file_lost_pino(inode)   set_file(inode, FADVISE_LOST_PINO_BIT)
 308 #define file_clear_cold(inode)  clear_file(inode, FADVISE_COLD_BIT)
 309 #define file_got_pino(inode)    clear_file(inode, FADVISE_LOST_PINO_BIT)
 310
 311 static inline int is_cold_data(struct page *page)
 312 {
 313         return PageChecked(page);
 314 }
 315
 316 static inline void set_cold_data(struct page *page)
 317 {
 318         SetPageChecked(page);
 319 }
 320
 321 static inline void clear_cold_data(struct page *page)
 322 {
 323         ClearPageChecked(page);
 324 }
 325
 326 static inline int is_node(struct page *page, int type)
 327 {
 328         struct f2fs_node *rn = F2FS_NODE(page);
 329         return le32_to_cpu(rn->footer.flag) & (1 << type);
 330 }
 331
 332 #define is_cold_node(page)      is_node(page, COLD_BIT_SHIFT)
 333 #define is_fsync_dnode(page)    is_node(page, FSYNC_BIT_SHIFT)
 334 #define is_dent_dnode(page)     is_node(page, DENT_BIT_SHIFT)
 335
 336 static inline void set_cold_node(struct inode *inode, struct page *page)
 337 {
 338         struct f2fs_node *rn = F2FS_NODE(page);
 339         unsigned int flag = le32_to_cpu(rn->footer.flag);
 340
 341         if (S_ISDIR(inode->i_mode))
 342                 flag &= ~(0x1 << COLD_BIT_SHIFT);
 343         else
 344                 flag |= (0x1 << COLD_BIT_SHIFT);
 345         rn->footer.flag = cpu_to_le32(flag);
 346 }
 347
 348 static inline void set_mark(struct page *page, int mark, int type)
 349 {
 350         struct f2fs_node *rn = F2FS_NODE(page);
 351         unsigned int flag = le32_to_cpu(rn->footer.flag);
 352         if (mark)
 353                 flag |= (0x1 << type);
 354         else
 355                 flag &= ~(0x1 << type);
 356         rn->footer.flag = cpu_to_le32(flag);
 357 }
 358 #define set_dentry_mark(page, mark)     set_mark(page, mark, DENT_BIT_SHIFT)
 359 #define set_fsync_mark(page, mark)      set_mark(page, mark, FSYNC_BIT_SHIFT)