Documentation/core-api/mm-api.rst

   1 ======================
   2 Memory Management APIs
   3 ======================
   4
   5 User Space Memory Access
   6 ========================
   7
   8 .. kernel-doc:: arch/x86/include/asm/uaccess.h
   9    :internal:
  10
  11 .. kernel-doc:: arch/x86/lib/usercopy_32.c
  12    :export:
  13
  14 .. kernel-doc:: mm/gup.c
  15    :functions: get_user_pages_fast
  16
  17 .. _mm-api-gfp-flags:
  18
  19 Memory Allocation Controls
  20 ==========================
  21
  22 Functions which need to allocate memory often use GFP flags to express
  23 how that memory should be allocated. The GFP acronym stands for "get
  24 free pages", the underlying memory allocation function. Not every GFP
  25 flag is allowed to every function which may allocate memory. Most
  26 users will want to use a plain ``GFP_KERNEL``.
  27
  28 .. kernel-doc:: include/linux/gfp.h
  29    :doc: Page mobility and placement hints
  30
  31 .. kernel-doc:: include/linux/gfp.h
  32    :doc: Watermark modifiers
  33
  34 .. kernel-doc:: include/linux/gfp.h
  35    :doc: Reclaim modifiers
  36
  37 .. kernel-doc:: include/linux/gfp.h
  38    :doc: Useful GFP flag combinations
  39
  40 The Slab Cache
  41 ==============
  42
  43 .. kernel-doc:: include/linux/slab.h
  44    :internal:
  45
  46 .. kernel-doc:: mm/slab.c
  47    :export:
  48
  49 .. kernel-doc:: mm/slab_common.c
  50    :export:
  51
  52 .. kernel-doc:: mm/util.c
  53    :functions: kfree_const kvmalloc_node kvfree
  54
  55 Virtually Contiguous Mappings
  56 =============================
  57
  58 .. kernel-doc:: mm/vmalloc.c
  59    :export:
  60
  61 File Mapping and Page Cache
  62 ===========================
  63
  64 .. kernel-doc:: mm/readahead.c
  65    :export:
  66
  67 .. kernel-doc:: mm/filemap.c
  68    :export:
  69
  70 .. kernel-doc:: mm/page-writeback.c
  71    :export:
  72
  73 .. kernel-doc:: mm/truncate.c
  74    :export:
  75
  76 .. kernel-doc:: include/linux/pagemap.h
  77    :internal:
  78
  79 Memory pools
  80 ============
  81
  82 .. kernel-doc:: mm/mempool.c
  83    :export:
  84
  85 DMA pools
  86 =========
  87
  88 .. kernel-doc:: mm/dmapool.c
  89    :export:
  90
  91 More Memory Management Functions
  92 ================================
  93
  94 .. kernel-doc:: mm/memory.c
  95    :export:
  96
  97 .. kernel-doc:: mm/page_alloc.c