include/linux/hugetlb.h

   1 #ifndef _LINUX_HUGETLB_H
   2 #define _LINUX_HUGETLB_H
   3
   4 #include <linux/mm_types.h>
   5 #include <linux/mmdebug.h>
   6 #include <linux/fs.h>
   7 #include <linux/hugetlb_inline.h>
   8 #include <linux/cgroup.h>
   9 #include <linux/list.h>
  10 #include <linux/kref.h>
  11 #include <asm/pgtable.h>
  12
  13 struct ctl_table;
  14 struct user_struct;
  15 struct mmu_gather;
  16
  17 #ifdef CONFIG_HUGETLB_PAGE
  18
  19 #include <linux/mempolicy.h>
  20 #include <linux/shm.h>
  21 #include <asm/tlbflush.h>
  22
  23 struct hugepage_subpool {
  24         spinlock_t lock;
  25         long count;
  26         long max_hpages;        /* Maximum huge pages or -1 if no maximum. */
  27         long used_hpages;       /* Used count against maximum, includes */
  28                                 /* both alloced and reserved pages. */
  29         struct hstate *hstate;
  30         long min_hpages;        /* Minimum huge pages or -1 if no minimum. */
  31         long rsv_hpages;        /* Pages reserved against global pool to */
  32                                 /* sasitfy minimum size. */
  33 };
  34
  35 struct resv_map {
  36         struct kref refs;
  37         spinlock_t lock;
  38         struct list_head regions;
  39         long adds_in_progress;
  40         struct list_head region_cache;
  41         long region_cache_count;
  42 };
  43 extern struct resv_map *resv_map_alloc(void);
  44 void resv_map_release(struct kref *ref);
  45
  46 extern spinlock_t hugetlb_lock;
  47 extern int hugetlb_max_hstate __read_mostly;
  48 #define for_each_hstate(h) \
  49         for ((h) = hstates; (h) < &hstates[hugetlb_max_hstate]; (h)++)
  50
  51 struct hugepage_subpool *hugepage_new_subpool(struct hstate *h, long max_hpages,
  52                                                 long min_hpages);
  53 void hugepage_put_subpool(struct hugepage_subpool *spool);
  54
  55 void reset_vma_resv_huge_pages(struct vm_area_struct *vma);
  56 int hugetlb_sysctl_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
  57 int hugetlb_overcommit_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
  58 int hugetlb_treat_movable_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
  59
  60 #ifdef CONFIG_NUMA
  61 int hugetlb_mempolicy_sysctl_handler(struct ctl_table *, int,
  62                                         void __user *, size_t *, loff_t *);
  63 #endif
  64
  65 int copy_hugetlb_page_range(struct mm_struct *, struct mm_struct *, struct vm_area_struct *);
  66 long follow_hugetlb_page(struct mm_struct *, struct vm_area_struct *,
  67                          struct page **, struct vm_area_struct **,
  68                          unsigned long *, unsigned long *, long, unsigned int,
  69                          int *);
  70 void unmap_hugepage_range(struct vm_area_struct *,
  71                           unsigned long, unsigned long, struct page *);
  72 void __unmap_hugepage_range_final(struct mmu_gather *tlb,
  73                           struct vm_area_struct *vma,
  74                           unsigned long start, unsigned long end,
  75                           struct page *ref_page);
  76 void __unmap_hugepage_range(struct mmu_gather *tlb, struct vm_area_struct *vma,
  77                                 unsigned long start, unsigned long end,
  78                                 struct page *ref_page);
  79 void hugetlb_report_meminfo(struct seq_file *);
  80 int hugetlb_report_node_meminfo(int, char *);
  81 void hugetlb_show_meminfo(void);
  82 unsigned long hugetlb_total_pages(void);
  83 int hugetlb_fault(struct mm_struct *mm, struct vm_area_struct *vma,
  84                         unsigned long address, unsigned int flags);
  85 int hugetlb_mcopy_atomic_pte(struct mm_struct *dst_mm, pte_t *dst_pte,
  86                                 struct vm_area_struct *dst_vma,
  87                                 unsigned long dst_addr,
  88                                 unsigned long src_addr,
  89                                 struct page **pagep);
  90 int hugetlb_reserve_pages(struct inode *inode, long from, long to,
  91                                                 struct vm_area_struct *vma,
  92                                                 vm_flags_t vm_flags);
  93 long hugetlb_unreserve_pages(struct inode *inode, long start, long end,
  94                                                 long freed);
  95 int dequeue_hwpoisoned_huge_page(struct page *page);
  96 bool isolate_huge_page(struct page *page, struct list_head *list);
  97 void putback_active_hugepage(struct page *page);
  98 void free_huge_page(struct page *page);
  99 void hugetlb_fix_reserve_counts(struct inode *inode);
 100 extern struct mutex *hugetlb_fault_mutex_table;
 101 u32 hugetlb_fault_mutex_hash(struct hstate *h, struct mm_struct *mm,
 102                                 struct vm_area_struct *vma,
 103                                 struct address_space *mapping,
 104                                 pgoff_t idx, unsigned long address);
 105
 106 pte_t *huge_pmd_share(struct mm_struct *mm, unsigned long addr, pud_t *pud);
 107
 108 extern int hugepages_treat_as_movable;
 109 extern int sysctl_hugetlb_shm_group;
 110 extern struct list_head huge_boot_pages;
 111
 112 /* arch callbacks */
 113
 114 pte_t *huge_pte_alloc(struct mm_struct *mm,
 115                         unsigned long addr, unsigned long sz);
 116 pte_t *huge_pte_offset(struct mm_struct *mm, unsigned long addr);
 117 int huge_pmd_unshare(struct mm_struct *mm, unsigned long *addr, pte_t *ptep);
 118 struct page *follow_huge_addr(struct mm_struct *mm, unsigned long address,
 119                               int write);
 120 struct page *follow_huge_pmd(struct mm_struct *mm, unsigned long address,
 121                                 pmd_t *pmd, int flags);
 122 struct page *follow_huge_pud(struct mm_struct *mm, unsigned long address,
 123                                 pud_t *pud, int flags);
 124 struct page *follow_huge_pgd(struct mm_struct *mm, unsigned long address,
 125                              pgd_t *pgd, int flags);
 126
 127 int pmd_huge(pmd_t pmd);
 128 int pud_huge(pud_t pud);
 129 unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
 130                 unsigned long address, unsigned long end, pgprot_t newprot);
 131
 132 bool is_hugetlb_entry_migration(pte_t pte);
 133 #else /* !CONFIG_HUGETLB_PAGE */
 134
 135 static inline void reset_vma_resv_huge_pages(struct vm_area_struct *vma)
 136 {
 137 }
 138
 139 static inline unsigned long hugetlb_total_pages(void)
 140 {
 141         return 0;
 142 }
 143
 144 #define follow_hugetlb_page(m,v,p,vs,a,b,i,w,n) ({ BUG(); 0; })
 145 #define follow_huge_addr(mm, addr, write)       ERR_PTR(-EINVAL)
 146 #define copy_hugetlb_page_range(src, dst, vma)  ({ BUG(); 0; })
 147 static inline void hugetlb_report_meminfo(struct seq_file *m)
 148 {
 149 }
 150 #define hugetlb_report_node_meminfo(n, buf)     0
 151 static inline void hugetlb_show_meminfo(void)
 152 {
 153 }
 154 #define follow_huge_pmd(mm, addr, pmd, flags)   NULL
 155 #define follow_huge_pud(mm, addr, pud, flags)   NULL
 156 #define follow_huge_pgd(mm, addr, pgd, flags)   NULL
 157 #define prepare_hugepage_range(file, addr, len) (-EINVAL)
 158 #define pmd_huge(x)     0
 159 #define pud_huge(x)     0
 160 #define is_hugepage_only_range(mm, addr, len)   0
 161 #define hugetlb_free_pgd_range(tlb, addr, end, floor, ceiling) ({BUG(); 0; })
 162 #define hugetlb_fault(mm, vma, addr, flags)     ({ BUG(); 0; })
 163 #define hugetlb_mcopy_atomic_pte(dst_mm, dst_pte, dst_vma, dst_addr, \
 164                                 src_addr, pagep)        ({ BUG(); 0; })
 165 #define huge_pte_offset(mm, address)    0
 166 static inline int dequeue_hwpoisoned_huge_page(struct page *page)
 167 {
 168         return 0;
 169 }
 170
 171 static inline bool isolate_huge_page(struct page *page, struct list_head *list)
 172 {
 173         return false;
 174 }
 175 #define putback_active_hugepage(p)      do {} while (0)
 176
 177 static inline unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
 178                 unsigned long address, unsigned long end, pgprot_t newprot)
 179 {
 180         return 0;
 181 }
 182
 183 static inline void __unmap_hugepage_range_final(struct mmu_gather *tlb,
 184                         struct vm_area_struct *vma, unsigned long start,
 185                         unsigned long end, struct page *ref_page)
 186 {
 187         BUG();
 188 }
 189
 190 static inline void __unmap_hugepage_range(struct mmu_gather *tlb,
 191                         struct vm_area_struct *vma, unsigned long start,
 192                         unsigned long end, struct page *ref_page)
 193 {
 194         BUG();
 195 }
 196
 197 #endif /* !CONFIG_HUGETLB_PAGE */
 198 /*
 199  * hugepages at page global directory. If arch support
 200  * hugepages at pgd level, they need to define this.
 201  */
 202 #ifndef pgd_huge
 203 #define pgd_huge(x)     0
 204 #endif
 205 #ifndef p4d_huge
 206 #define p4d_huge(x)     0
 207 #endif
 208
 209 #ifndef pgd_write
 210 static inline int pgd_write(pgd_t pgd)
 211 {
 212         BUG();
 213         return 0;
 214 }
 215 #endif
 216
 217 #ifndef pud_write
 218 static inline int pud_write(pud_t pud)
 219 {
 220         BUG();
 221         return 0;
 222 }
 223 #endif
 224
 225 #ifndef is_hugepd
 226 /*
 227  * Some architectures requires a hugepage directory format that is
 228  * required to support multiple hugepage sizes. For example
 229  * a4fe3ce76 "powerpc/mm: Allow more flexible layouts for hugepage pagetables"
 230  * introduced the same on powerpc. This allows for a more flexible hugepage
 231  * pagetable layout.
 232  */
 233 typedef struct { unsigned long pd; } hugepd_t;
 234 #define is_hugepd(hugepd) (0)
 235 #define __hugepd(x) ((hugepd_t) { (x) })
 236 static inline int gup_huge_pd(hugepd_t hugepd, unsigned long addr,
 237                               unsigned pdshift, unsigned long end,
 238                               int write, struct page **pages, int *nr)
 239 {
 240         return 0;
 241 }
 242 #else
 243 extern int gup_huge_pd(hugepd_t hugepd, unsigned long addr,
 244                        unsigned pdshift, unsigned long end,
 245                        int write, struct page **pages, int *nr);
 246 #endif
 247
 248 #define HUGETLB_ANON_FILE "anon_hugepage"
 249
 250 enum {
 251         /*
 252          * The file will be used as an shm file so shmfs accounting rules
 253          * apply
 254          */
 255         HUGETLB_SHMFS_INODE     = 1,
 256         /*
 257          * The file is being created on the internal vfs mount and shmfs
 258          * accounting rules do not apply
 259          */
 260         HUGETLB_ANONHUGE_INODE  = 2,
 261 };
 262
 263 #ifdef CONFIG_HUGETLBFS
 264 struct hugetlbfs_sb_info {
 265         long    max_inodes;   /* inodes allowed */
 266         long    free_inodes;  /* inodes free */
 267         spinlock_t      stat_lock;
 268         struct hstate *hstate;
 269         struct hugepage_subpool *spool;
 270 };
 271
 272 static inline struct hugetlbfs_sb_info *HUGETLBFS_SB(struct super_block *sb)
 273 {
 274         return sb->s_fs_info;
 275 }
 276
 277 extern const struct file_operations hugetlbfs_file_operations;
 278 extern const struct vm_operations_struct hugetlb_vm_ops;
 279 struct file *hugetlb_file_setup(const char *name, size_t size, vm_flags_t acct,
 280                                 struct user_struct **user, int creat_flags,
 281                                 int page_size_log);
 282
 283 static inline bool is_file_hugepages(struct file *file)
 284 {
 285         if (file->f_op == &hugetlbfs_file_operations)
 286                 return true;
 287
 288         return is_file_shm_hugepages(file);
 289 }
 290
 291
 292 #else /* !CONFIG_HUGETLBFS */
 293
 294 #define is_file_hugepages(file)                 false
 295 static inline struct file *
 296 hugetlb_file_setup(const char *name, size_t size, vm_flags_t acctflag,
 297                 struct user_struct **user, int creat_flags,
 298                 int page_size_log)
 299 {
 300         return ERR_PTR(-ENOSYS);
 301 }
 302
 303 #endif /* !CONFIG_HUGETLBFS */
 304
 305 #ifdef HAVE_ARCH_HUGETLB_UNMAPPED_AREA
 306 unsigned long hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
 307                                         unsigned long len, unsigned long pgoff,
 308                                         unsigned long flags);
 309 #endif /* HAVE_ARCH_HUGETLB_UNMAPPED_AREA */
 310
 311 #ifdef CONFIG_HUGETLB_PAGE
 312
 313 #define HSTATE_NAME_LEN 32
 314 /* Defines one hugetlb page size */
 315 struct hstate {
 316         int next_nid_to_alloc;
 317         int next_nid_to_free;
 318         unsigned int order;
 319         unsigned long mask;
 320         unsigned long max_huge_pages;
 321         unsigned long nr_huge_pages;
 322         unsigned long free_huge_pages;
 323         unsigned long resv_huge_pages;
 324         unsigned long surplus_huge_pages;
 325         unsigned long nr_overcommit_huge_pages;
 326         struct list_head hugepage_activelist;
 327         struct list_head hugepage_freelists[MAX_NUMNODES];
 328         unsigned int nr_huge_pages_node[MAX_NUMNODES];
 329         unsigned int free_huge_pages_node[MAX_NUMNODES];
 330         unsigned int surplus_huge_pages_node[MAX_NUMNODES];
 331 #ifdef CONFIG_CGROUP_HUGETLB
 332         /* cgroup control files */
 333         struct cftype cgroup_files[5];
 334 #endif
 335         char name[HSTATE_NAME_LEN];
 336 };
 337
 338 struct huge_bootmem_page {
 339         struct list_head list;
 340         struct hstate *hstate;
 341 #ifdef CONFIG_HIGHMEM
 342         phys_addr_t phys;
 343 #endif
 344 };
 345
 346 struct page *alloc_huge_page(struct vm_area_struct *vma,
 347                                 unsigned long addr, int avoid_reserve);
 348 struct page *alloc_huge_page_node(struct hstate *h, int nid);
 349 struct page *alloc_huge_page_noerr(struct vm_area_struct *vma,
 350                                 unsigned long addr, int avoid_reserve);
 351 int huge_add_to_page_cache(struct page *page, struct address_space *mapping,
 352                         pgoff_t idx);
 353
 354 /* arch callback */
 355 int __init alloc_bootmem_huge_page(struct hstate *h);
 356
 357 void __init hugetlb_bad_size(void);
 358 void __init hugetlb_add_hstate(unsigned order);
 359 struct hstate *size_to_hstate(unsigned long size);
 360
 361 #ifndef HUGE_MAX_HSTATE
 362 #define HUGE_MAX_HSTATE 1
 363 #endif
 364
 365 extern struct hstate hstates[HUGE_MAX_HSTATE];
 366 extern unsigned int default_hstate_idx;
 367
 368 #define default_hstate (hstates[default_hstate_idx])
 369
 370 static inline struct hstate *hstate_inode(struct inode *i)
 371 {
 372         return HUGETLBFS_SB(i->i_sb)->hstate;
 373 }
 374
 375 static inline struct hstate *hstate_file(struct file *f)
 376 {
 377         return hstate_inode(file_inode(f));
 378 }
 379
 380 static inline struct hstate *hstate_sizelog(int page_size_log)
 381 {
 382         if (!page_size_log)
 383                 return &default_hstate;
 384
 385         return size_to_hstate(1UL << page_size_log);
 386 }
 387
 388 static inline struct hstate *hstate_vma(struct vm_area_struct *vma)
 389 {
 390         return hstate_file(vma->vm_file);
 391 }
 392
 393 static inline unsigned long huge_page_size(struct hstate *h)
 394 {
 395         return (unsigned long)PAGE_SIZE << h->order;
 396 }
 397
 398 extern unsigned long vma_kernel_pagesize(struct vm_area_struct *vma);
 399
 400 extern unsigned long vma_mmu_pagesize(struct vm_area_struct *vma);
 401
 402 static inline unsigned long huge_page_mask(struct hstate *h)
 403 {
 404         return h->mask;
 405 }
 406
 407 static inline unsigned int huge_page_order(struct hstate *h)
 408 {
 409         return h->order;
 410 }
 411
 412 static inline unsigned huge_page_shift(struct hstate *h)
 413 {
 414         return h->order + PAGE_SHIFT;
 415 }
 416
 417 static inline bool hstate_is_gigantic(struct hstate *h)
 418 {
 419         return huge_page_order(h) >= MAX_ORDER;
 420 }
 421
 422 static inline unsigned int pages_per_huge_page(struct hstate *h)
 423 {
 424         return 1 << h->order;
 425 }
 426
 427 static inline unsigned int blocks_per_huge_page(struct hstate *h)
 428 {
 429         return huge_page_size(h) / 512;
 430 }
 431
 432 #include <asm/hugetlb.h>
 433
 434 #ifndef arch_make_huge_pte
 435 static inline pte_t arch_make_huge_pte(pte_t entry, struct vm_area_struct *vma,
 436                                        struct page *page, int writable)
 437 {
 438         return entry;
 439 }
 440 #endif
 441
 442 static inline struct hstate *page_hstate(struct page *page)
 443 {
 444         VM_BUG_ON_PAGE(!PageHuge(page), page);
 445         return size_to_hstate(PAGE_SIZE << compound_order(page));
 446 }
 447
 448 static inline unsigned hstate_index_to_shift(unsigned index)
 449 {
 450         return hstates[index].order + PAGE_SHIFT;
 451 }
 452
 453 static inline int hstate_index(struct hstate *h)
 454 {
 455         return h - hstates;
 456 }
 457
 458 pgoff_t __basepage_index(struct page *page);
 459
 460 /* Return page->index in PAGE_SIZE units */
 461 static inline pgoff_t basepage_index(struct page *page)
 462 {
 463         if (!PageCompound(page))
 464                 return page->index;
 465
 466         return __basepage_index(page);
 467 }
 468
 469 extern int dissolve_free_huge_pages(unsigned long start_pfn,
 470                                     unsigned long end_pfn);
 471 static inline bool hugepage_migration_supported(struct hstate *h)
 472 {
 473 #ifdef CONFIG_ARCH_ENABLE_HUGEPAGE_MIGRATION
 474         if ((huge_page_shift(h) == PMD_SHIFT) ||
 475                 (huge_page_shift(h) == PGDIR_SHIFT))
 476                 return true;
 477         else
 478                 return false;
 479 #else
 480         return false;
 481 #endif
 482 }
 483
 484 static inline spinlock_t *huge_pte_lockptr(struct hstate *h,
 485                                            struct mm_struct *mm, pte_t *pte)
 486 {
 487         if (huge_page_size(h) == PMD_SIZE)
 488                 return pmd_lockptr(mm, (pmd_t *) pte);
 489         VM_BUG_ON(huge_page_size(h) == PAGE_SIZE);
 490         return &mm->page_table_lock;
 491 }
 492
 493 #ifndef hugepages_supported
 494 /*
 495  * Some platform decide whether they support huge pages at boot
 496  * time. Some of them, such as powerpc, set HPAGE_SHIFT to 0
 497  * when there is no such support
 498  */
 499 #define hugepages_supported() (HPAGE_SHIFT != 0)
 500 #endif
 501
 502 void hugetlb_report_usage(struct seq_file *m, struct mm_struct *mm);
 503
 504 static inline void hugetlb_count_add(long l, struct mm_struct *mm)
 505 {
 506         atomic_long_add(l, &mm->hugetlb_usage);
 507 }
 508
 509 static inline void hugetlb_count_sub(long l, struct mm_struct *mm)
 510 {
 511         atomic_long_sub(l, &mm->hugetlb_usage);
 512 }
 513 #else   /* CONFIG_HUGETLB_PAGE */
 514 struct hstate {};
 515 #define alloc_huge_page(v, a, r) NULL
 516 #define alloc_huge_page_node(h, nid) NULL
 517 #define alloc_huge_page_noerr(v, a, r) NULL
 518 #define alloc_bootmem_huge_page(h) NULL
 519 #define hstate_file(f) NULL
 520 #define hstate_sizelog(s) NULL
 521 #define hstate_vma(v) NULL
 522 #define hstate_inode(i) NULL
 523 #define page_hstate(page) NULL
 524 #define huge_page_size(h) PAGE_SIZE
 525 #define huge_page_mask(h) PAGE_MASK
 526 #define vma_kernel_pagesize(v) PAGE_SIZE
 527 #define vma_mmu_pagesize(v) PAGE_SIZE
 528 #define huge_page_order(h) 0
 529 #define huge_page_shift(h) PAGE_SHIFT
 530 static inline bool hstate_is_gigantic(struct hstate *h)
 531 {
 532         return false;
 533 }
 534
 535 static inline unsigned int pages_per_huge_page(struct hstate *h)
 536 {
 537         return 1;
 538 }
 539 #define hstate_index_to_shift(index) 0
 540 #define hstate_index(h) 0
 541
 542 static inline pgoff_t basepage_index(struct page *page)
 543 {
 544         return page->index;
 545 }
 546 #define dissolve_free_huge_pages(s, e)  0
 547 #define hugepage_migration_supported(h) false
 548
 549 static inline spinlock_t *huge_pte_lockptr(struct hstate *h,
 550                                            struct mm_struct *mm, pte_t *pte)
 551 {
 552         return &mm->page_table_lock;
 553 }
 554
 555 static inline void hugetlb_report_usage(struct seq_file *f, struct mm_struct *m)
 556 {
 557 }
 558
 559 static inline void hugetlb_count_sub(long l, struct mm_struct *mm)
 560 {
 561 }
 562 #endif  /* CONFIG_HUGETLB_PAGE */
 563
 564 static inline spinlock_t *huge_pte_lock(struct hstate *h,
 565                                         struct mm_struct *mm, pte_t *pte)
 566 {
 567         spinlock_t *ptl;
 568
 569         ptl = huge_pte_lockptr(h, mm, pte);
 570         spin_lock(ptl);
 571         return ptl;
 572 }
 573
 574 #endif /* _LINUX_HUGETLB_H */