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