mm/util.c

   1 #include <linux/mm.h>
   2 #include <linux/slab.h>
   3 #include <linux/string.h>
   4 #include <linux/compiler.h>
   5 #include <linux/export.h>
   6 #include <linux/ctype.h>
   7 #include <linux/err.h>
   8 #include <linux/sched.h>
   9 #include <linux/security.h>
  10 #include <linux/swap.h>
  11 #include <linux/swapops.h>
  12 #include <linux/mman.h>
  13 #include <linux/hugetlb.h>
  14 #include <linux/vmalloc.h>
  15
  16 #include <asm/sections.h>
  17 #include <asm/uaccess.h>
  18
  19 #include "internal.h"
  20
  21 static inline int is_kernel_rodata(unsigned long addr)
  22 {
  23         return addr >= (unsigned long)__start_rodata &&
  24                 addr < (unsigned long)__end_rodata;
  25 }
  26
  27 /**
  28  * kfree_const - conditionally free memory
  29  * @x: pointer to the memory
  30  *
  31  * Function calls kfree only if @x is not in .rodata section.
  32  */
  33 void kfree_const(const void *x)
  34 {
  35         if (!is_kernel_rodata((unsigned long)x))
  36                 kfree(x);
  37 }
  38 EXPORT_SYMBOL(kfree_const);
  39
  40 /**
  41  * kstrdup - allocate space for and copy an existing string
  42  * @s: the string to duplicate
  43  * @gfp: the GFP mask used in the kmalloc() call when allocating memory
  44  */
  45 char *kstrdup(const char *s, gfp_t gfp)
  46 {
  47         size_t len;
  48         char *buf;
  49
  50         if (!s)
  51                 return NULL;
  52
  53         len = strlen(s) + 1;
  54         buf = kmalloc_track_caller(len, gfp);
  55         if (buf)
  56                 memcpy(buf, s, len);
  57         return buf;
  58 }
  59 EXPORT_SYMBOL(kstrdup);
  60
  61 /**
  62  * kstrdup_const - conditionally duplicate an existing const string
  63  * @s: the string to duplicate
  64  * @gfp: the GFP mask used in the kmalloc() call when allocating memory
  65  *
  66  * Function returns source string if it is in .rodata section otherwise it
  67  * fallbacks to kstrdup.
  68  * Strings allocated by kstrdup_const should be freed by kfree_const.
  69  */
  70 const char *kstrdup_const(const char *s, gfp_t gfp)
  71 {
  72         if (is_kernel_rodata((unsigned long)s))
  73                 return s;
  74
  75         return kstrdup(s, gfp);
  76 }
  77 EXPORT_SYMBOL(kstrdup_const);
  78
  79 /**
  80  * kstrndup - allocate space for and copy an existing string
  81  * @s: the string to duplicate
  82  * @max: read at most @max chars from @s
  83  * @gfp: the GFP mask used in the kmalloc() call when allocating memory
  84  */
  85 char *kstrndup(const char *s, size_t max, gfp_t gfp)
  86 {
  87         size_t len;
  88         char *buf;
  89
  90         if (!s)
  91                 return NULL;
  92
  93         len = strnlen(s, max);
  94         buf = kmalloc_track_caller(len+1, gfp);
  95         if (buf) {
  96                 memcpy(buf, s, len);
  97                 buf[len] = '\0';
  98         }
  99         return buf;
 100 }
 101 EXPORT_SYMBOL(kstrndup);
 102
 103 /**
 104  * kstrimdup - Trim and copy a %NUL terminated string.
 105  * @s: the string to trim and duplicate
 106  * @gfp: the GFP mask used in the kmalloc() call when allocating memory
 107  *
 108  * Returns an address, which the caller must kfree, containing
 109  * a duplicate of the passed string with leading and/or trailing
 110  * whitespace (as defined by isspace) removed.
 111  */
 112 char *kstrimdup(const char *s, gfp_t gfp)
 113 {
 114         char *buf;
 115         char *begin = skip_spaces(s);
 116         size_t len = strlen(begin);
 117
 118         while (len && isspace(begin[len - 1]))
 119                 len--;
 120
 121         buf = kmalloc_track_caller(len + 1, gfp);
 122         if (!buf)
 123                 return NULL;
 124
 125         memcpy(buf, begin, len);
 126         buf[len] = '\0';
 127
 128         return buf;
 129 }
 130 EXPORT_SYMBOL(kstrimdup);
 131
 132 /**
 133  * kmemdup - duplicate region of memory
 134  *
 135  * @src: memory region to duplicate
 136  * @len: memory region length
 137  * @gfp: GFP mask to use
 138  */
 139 void *kmemdup(const void *src, size_t len, gfp_t gfp)
 140 {
 141         void *p;
 142
 143         p = kmalloc_track_caller(len, gfp);
 144         if (p)
 145                 memcpy(p, src, len);
 146         return p;
 147 }
 148 EXPORT_SYMBOL(kmemdup);
 149
 150 /**
 151  * memdup_user - duplicate memory region from user space
 152  *
 153  * @src: source address in user space
 154  * @len: number of bytes to copy
 155  *
 156  * Returns an ERR_PTR() on failure.
 157  */
 158 void *memdup_user(const void __user *src, size_t len)
 159 {
 160         void *p;
 161
 162         /*
 163          * Always use GFP_KERNEL, since copy_from_user() can sleep and
 164          * cause pagefault, which makes it pointless to use GFP_NOFS
 165          * or GFP_ATOMIC.
 166          */
 167         p = kmalloc_track_caller(len, GFP_KERNEL);
 168         if (!p)
 169                 return ERR_PTR(-ENOMEM);
 170
 171         if (copy_from_user(p, src, len)) {
 172                 kfree(p);
 173                 return ERR_PTR(-EFAULT);
 174         }
 175
 176         return p;
 177 }
 178 EXPORT_SYMBOL(memdup_user);
 179
 180 /*
 181  * strndup_user - duplicate an existing string from user space
 182  * @s: The string to duplicate
 183  * @n: Maximum number of bytes to copy, including the trailing NUL.
 184  */
 185 char *strndup_user(const char __user *s, long n)
 186 {
 187         char *p;
 188         long length;
 189
 190         length = strnlen_user(s, n);
 191
 192         if (!length)
 193                 return ERR_PTR(-EFAULT);
 194
 195         if (length > n)
 196                 return ERR_PTR(-EINVAL);
 197
 198         p = memdup_user(s, length);
 199
 200         if (IS_ERR(p))
 201                 return p;
 202
 203         p[length - 1] = '\0';
 204
 205         return p;
 206 }
 207 EXPORT_SYMBOL(strndup_user);
 208
 209 /**
 210  * memdup_user_nul - duplicate memory region from user space and NUL-terminate
 211  *
 212  * @src: source address in user space
 213  * @len: number of bytes to copy
 214  *
 215  * Returns an ERR_PTR() on failure.
 216  */
 217 void *memdup_user_nul(const void __user *src, size_t len)
 218 {
 219         char *p;
 220
 221         /*
 222          * Always use GFP_KERNEL, since copy_from_user() can sleep and
 223          * cause pagefault, which makes it pointless to use GFP_NOFS
 224          * or GFP_ATOMIC.
 225          */
 226         p = kmalloc_track_caller(len + 1, GFP_KERNEL);
 227         if (!p)
 228                 return ERR_PTR(-ENOMEM);
 229
 230         if (copy_from_user(p, src, len)) {
 231                 kfree(p);
 232                 return ERR_PTR(-EFAULT);
 233         }
 234         p[len] = '\0';
 235
 236         return p;
 237 }
 238 EXPORT_SYMBOL(memdup_user_nul);
 239
 240 void __vma_link_list(struct mm_struct *mm, struct vm_area_struct *vma,
 241                 struct vm_area_struct *prev, struct rb_node *rb_parent)
 242 {
 243         struct vm_area_struct *next;
 244
 245         vma->vm_prev = prev;
 246         if (prev) {
 247                 next = prev->vm_next;
 248                 prev->vm_next = vma;
 249         } else {
 250                 mm->mmap = vma;
 251                 if (rb_parent)
 252                         next = rb_entry(rb_parent,
 253                                         struct vm_area_struct, vm_rb);
 254                 else
 255                         next = NULL;
 256         }
 257         vma->vm_next = next;
 258         if (next)
 259                 next->vm_prev = vma;
 260 }
 261
 262 /* Check if the vma is being used as a stack by this task */
 263 int vma_is_stack_for_task(struct vm_area_struct *vma, struct task_struct *t)
 264 {
 265         return (vma->vm_start <= KSTK_ESP(t) && vma->vm_end >= KSTK_ESP(t));
 266 }
 267
 268 #if defined(CONFIG_MMU) && !defined(HAVE_ARCH_PICK_MMAP_LAYOUT)
 269 void arch_pick_mmap_layout(struct mm_struct *mm)
 270 {
 271         mm->mmap_base = TASK_UNMAPPED_BASE;
 272         mm->get_unmapped_area = arch_get_unmapped_area;
 273 }
 274 #endif
 275
 276 /*
 277  * Like get_user_pages_fast() except its IRQ-safe in that it won't fall
 278  * back to the regular GUP.
 279  * If the architecture not support this function, simply return with no
 280  * page pinned
 281  */
 282 int __weak __get_user_pages_fast(unsigned long start,
 283                                  int nr_pages, int write, struct page **pages)
 284 {
 285         return 0;
 286 }
 287 EXPORT_SYMBOL_GPL(__get_user_pages_fast);
 288
 289 /**
 290  * get_user_pages_fast() - pin user pages in memory
 291  * @start:      starting user address
 292  * @nr_pages:   number of pages from start to pin
 293  * @write:      whether pages will be written to
 294  * @pages:      array that receives pointers to the pages pinned.
 295  *              Should be at least nr_pages long.
 296  *
 297  * Returns number of pages pinned. This may be fewer than the number
 298  * requested. If nr_pages is 0 or negative, returns 0. If no pages
 299  * were pinned, returns -errno.
 300  *
 301  * get_user_pages_fast provides equivalent functionality to get_user_pages,
 302  * operating on current and current->mm, with force=0 and vma=NULL. However
 303  * unlike get_user_pages, it must be called without mmap_sem held.
 304  *
 305  * get_user_pages_fast may take mmap_sem and page table locks, so no
 306  * assumptions can be made about lack of locking. get_user_pages_fast is to be
 307  * implemented in a way that is advantageous (vs get_user_pages()) when the
 308  * user memory area is already faulted in and present in ptes. However if the
 309  * pages have to be faulted in, it may turn out to be slightly slower so
 310  * callers need to carefully consider what to use. On many architectures,
 311  * get_user_pages_fast simply falls back to get_user_pages.
 312  */
 313 int __weak get_user_pages_fast(unsigned long start,
 314                                 int nr_pages, int write, struct page **pages)
 315 {
 316         return get_user_pages_unlocked(start, nr_pages, write, 0, pages);
 317 }
 318 EXPORT_SYMBOL_GPL(get_user_pages_fast);
 319
 320 unsigned long vm_mmap_pgoff(struct file *file, unsigned long addr,
 321         unsigned long len, unsigned long prot,
 322         unsigned long flag, unsigned long pgoff)
 323 {
 324         unsigned long ret;
 325         struct mm_struct *mm = current->mm;
 326         unsigned long populate;
 327
 328         ret = security_mmap_file(file, prot, flag);
 329         if (!ret) {
 330                 down_write(&mm->mmap_sem);
 331                 ret = do_mmap_pgoff(file, addr, len, prot, flag, pgoff,
 332                                     &populate);
 333                 up_write(&mm->mmap_sem);
 334                 if (populate)
 335                         mm_populate(ret, populate);
 336         }
 337         return ret;
 338 }
 339
 340 unsigned long vm_mmap(struct file *file, unsigned long addr,
 341         unsigned long len, unsigned long prot,
 342         unsigned long flag, unsigned long offset)
 343 {
 344         if (unlikely(offset + PAGE_ALIGN(len) < offset))
 345                 return -EINVAL;
 346         if (unlikely(offset_in_page(offset)))
 347                 return -EINVAL;
 348
 349         return vm_mmap_pgoff(file, addr, len, prot, flag, offset >> PAGE_SHIFT);
 350 }
 351 EXPORT_SYMBOL(vm_mmap);
 352
 353 void kvfree(const void *addr)
 354 {
 355         if (is_vmalloc_addr(addr))
 356                 vfree(addr);
 357         else
 358                 kfree(addr);
 359 }
 360 EXPORT_SYMBOL(kvfree);
 361
 362 static inline void *__page_rmapping(struct page *page)
 363 {
 364         unsigned long mapping;
 365
 366         mapping = (unsigned long)page->mapping;
 367         mapping &= ~PAGE_MAPPING_FLAGS;
 368
 369         return (void *)mapping;
 370 }
 371
 372 /* Neutral page->mapping pointer to address_space or anon_vma or other */
 373 void *page_rmapping(struct page *page)
 374 {
 375         page = compound_head(page);
 376         return __page_rmapping(page);
 377 }
 378
 379 struct anon_vma *page_anon_vma(struct page *page)
 380 {
 381         unsigned long mapping;
 382
 383         page = compound_head(page);
 384         mapping = (unsigned long)page->mapping;
 385         if ((mapping & PAGE_MAPPING_FLAGS) != PAGE_MAPPING_ANON)
 386                 return NULL;
 387         return __page_rmapping(page);
 388 }
 389
 390 struct address_space *page_mapping(struct page *page)
 391 {
 392         struct address_space *mapping;
 393
 394         page = compound_head(page);
 395
 396         /* This happens if someone calls flush_dcache_page on slab page */
 397         if (unlikely(PageSlab(page)))
 398                 return NULL;
 399
 400         if (unlikely(PageSwapCache(page))) {
 401                 swp_entry_t entry;
 402
 403                 entry.val = page_private(page);
 404                 return swap_address_space(entry);
 405         }
 406
 407         mapping = page->mapping;
 408         if ((unsigned long)mapping & PAGE_MAPPING_FLAGS)
 409                 return NULL;
 410         return mapping;
 411 }
 412
 413 /* Slow path of page_mapcount() for compound pages */
 414 int __page_mapcount(struct page *page)
 415 {
 416         int ret;
 417
 418         ret = atomic_read(&page->_mapcount) + 1;
 419         page = compound_head(page);
 420         ret += atomic_read(compound_mapcount_ptr(page)) + 1;
 421         if (PageDoubleMap(page))
 422                 ret--;
 423         return ret;
 424 }
 425 EXPORT_SYMBOL_GPL(__page_mapcount);
 426
 427 int sysctl_overcommit_memory __read_mostly = OVERCOMMIT_GUESS;
 428 int sysctl_overcommit_ratio __read_mostly = 50;
 429 unsigned long sysctl_overcommit_kbytes __read_mostly;
 430 int sysctl_max_map_count __read_mostly = DEFAULT_MAX_MAP_COUNT;
 431 unsigned long sysctl_user_reserve_kbytes __read_mostly = 1UL << 17; /* 128MB */
 432 unsigned long sysctl_admin_reserve_kbytes __read_mostly = 1UL << 13; /* 8MB */
 433
 434 int overcommit_ratio_handler(struct ctl_table *table, int write,
 435                              void __user *buffer, size_t *lenp,
 436                              loff_t *ppos)
 437 {
 438         int ret;
 439
 440         ret = proc_dointvec(table, write, buffer, lenp, ppos);
 441         if (ret == 0 && write)
 442                 sysctl_overcommit_kbytes = 0;
 443         return ret;
 444 }
 445
 446 int overcommit_kbytes_handler(struct ctl_table *table, int write,
 447                              void __user *buffer, size_t *lenp,
 448                              loff_t *ppos)
 449 {
 450         int ret;
 451
 452         ret = proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
 453         if (ret == 0 && write)
 454                 sysctl_overcommit_ratio = 0;
 455         return ret;
 456 }
 457
 458 /*
 459  * Committed memory limit enforced when OVERCOMMIT_NEVER policy is used
 460  */
 461 unsigned long vm_commit_limit(void)
 462 {
 463         unsigned long allowed;
 464
 465         if (sysctl_overcommit_kbytes)
 466                 allowed = sysctl_overcommit_kbytes >> (PAGE_SHIFT - 10);
 467         else
 468                 allowed = ((totalram_pages - hugetlb_total_pages())
 469                            * sysctl_overcommit_ratio / 100);
 470         allowed += total_swap_pages;
 471
 472         return allowed;
 473 }
 474
 475 /*
 476  * Make sure vm_committed_as in one cacheline and not cacheline shared with
 477  * other variables. It can be updated by several CPUs frequently.
 478  */
 479 struct percpu_counter vm_committed_as ____cacheline_aligned_in_smp;
 480
 481 /*
 482  * The global memory commitment made in the system can be a metric
 483  * that can be used to drive ballooning decisions when Linux is hosted
 484  * as a guest. On Hyper-V, the host implements a policy engine for dynamically
 485  * balancing memory across competing virtual machines that are hosted.
 486  * Several metrics drive this policy engine including the guest reported
 487  * memory commitment.
 488  */
 489 unsigned long vm_memory_committed(void)
 490 {
 491         return percpu_counter_read_positive(&vm_committed_as);
 492 }
 493 EXPORT_SYMBOL_GPL(vm_memory_committed);
 494
 495 /*
 496  * Check that a process has enough memory to allocate a new virtual
 497  * mapping. 0 means there is enough memory for the allocation to
 498  * succeed and -ENOMEM implies there is not.
 499  *
 500  * We currently support three overcommit policies, which are set via the
 501  * vm.overcommit_memory sysctl.  See Documentation/vm/overcommit-accounting
 502  *
 503  * Strict overcommit modes added 2002 Feb 26 by Alan Cox.
 504  * Additional code 2002 Jul 20 by Robert Love.
 505  *
 506  * cap_sys_admin is 1 if the process has admin privileges, 0 otherwise.
 507  *
 508  * Note this is a helper function intended to be used by LSMs which
 509  * wish to use this logic.
 510  */
 511 int __vm_enough_memory(struct mm_struct *mm, long pages, int cap_sys_admin)
 512 {
 513         long free, allowed, reserve;
 514
 515         VM_WARN_ONCE(percpu_counter_read(&vm_committed_as) <
 516                         -(s64)vm_committed_as_batch * num_online_cpus(),
 517                         "memory commitment underflow");
 518
 519         vm_acct_memory(pages);
 520
 521         /*
 522          * Sometimes we want to use more memory than we have
 523          */
 524         if (sysctl_overcommit_memory == OVERCOMMIT_ALWAYS)
 525                 return 0;
 526
 527         if (sysctl_overcommit_memory == OVERCOMMIT_GUESS) {
 528                 free = global_page_state(NR_FREE_PAGES);
 529                 free += global_page_state(NR_FILE_PAGES);
 530
 531                 /*
 532                  * shmem pages shouldn't be counted as free in this
 533                  * case, they can't be purged, only swapped out, and
 534                  * that won't affect the overall amount of available
 535                  * memory in the system.
 536                  */
 537                 free -= global_page_state(NR_SHMEM);
 538
 539                 free += get_nr_swap_pages();
 540
 541                 /*
 542                  * Any slabs which are created with the
 543                  * SLAB_RECLAIM_ACCOUNT flag claim to have contents
 544                  * which are reclaimable, under pressure.  The dentry
 545                  * cache and most inode caches should fall into this
 546                  */
 547                 free += global_page_state(NR_SLAB_RECLAIMABLE);
 548
 549                 /*
 550                  * Leave reserved pages. The pages are not for anonymous pages.
 551                  */
 552                 if (free <= totalreserve_pages)
 553                         goto error;
 554                 else
 555                         free -= totalreserve_pages;
 556
 557                 /*
 558                  * Reserve some for root
 559                  */
 560                 if (!cap_sys_admin)
 561                         free -= sysctl_admin_reserve_kbytes >> (PAGE_SHIFT - 10);
 562
 563                 if (free > pages)
 564                         return 0;
 565
 566                 goto error;
 567         }
 568
 569         allowed = vm_commit_limit();
 570         /*
 571          * Reserve some for root
 572          */
 573         if (!cap_sys_admin)
 574                 allowed -= sysctl_admin_reserve_kbytes >> (PAGE_SHIFT - 10);
 575
 576         /*
 577          * Don't let a single process grow so big a user can't recover
 578          */
 579         if (mm) {
 580                 reserve = sysctl_user_reserve_kbytes >> (PAGE_SHIFT - 10);
 581                 allowed -= min_t(long, mm->total_vm / 32, reserve);
 582         }
 583
 584         if (percpu_counter_read_positive(&vm_committed_as) < allowed)
 585                 return 0;
 586 error:
 587         vm_unacct_memory(pages);
 588
 589         return -ENOMEM;
 590 }
 591
 592 /**
 593  * get_cmdline() - copy the cmdline value to a buffer.
 594  * @task:     the task whose cmdline value to copy.
 595  * @buffer:   the buffer to copy to.
 596  * @buflen:   the length of the buffer. Larger cmdline values are truncated
 597  *            to this length.
 598  * Returns the size of the cmdline field copied. Note that the copy does
 599  * not guarantee an ending NULL byte.
 600  */
 601 int get_cmdline(struct task_struct *task, char *buffer, int buflen)
 602 {
 603         int res = 0;
 604         unsigned int len;
 605         struct mm_struct *mm = get_task_mm(task);
 606         unsigned long arg_start, arg_end, env_start, env_end;
 607         if (!mm)
 608                 goto out;
 609         if (!mm->arg_end)
 610                 goto out_mm;    /* Shh! No looking before we're done */
 611
 612         down_read(&mm->mmap_sem);
 613         arg_start = mm->arg_start;
 614         arg_end = mm->arg_end;
 615         env_start = mm->env_start;
 616         env_end = mm->env_end;
 617         up_read(&mm->mmap_sem);
 618
 619         len = arg_end - arg_start;
 620
 621         if (len > buflen)
 622                 len = buflen;
 623
 624         res = access_process_vm(task, arg_start, buffer, len, 0);
 625
 626         /*
 627          * If the nul at the end of args has been overwritten, then
 628          * assume application is using setproctitle(3).
 629          */
 630         if (res > 0 && buffer[res-1] != '\0' && len < buflen) {
 631                 len = strnlen(buffer, res);
 632                 if (len < res) {
 633                         res = len;
 634                 } else {
 635                         len = env_end - env_start;
 636                         if (len > buflen - res)
 637                                 len = buflen - res;
 638                         res += access_process_vm(task, env_start,
 639                                                  buffer+res, len, 0);
 640                         res = strnlen(buffer, res);
 641                 }
 642         }
 643 out_mm:
 644         mmput(mm);
 645 out:
 646         return res;
 647 }