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