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