include/linux/hugetlb.h

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