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 .. kernel-doc:: include/linux/gfp.h
  23    :internal:
  24
  25 .. kernel-doc:: include/linux/gfp.h
  26    :doc: Page mobility and placement hints
  27
  28 .. kernel-doc:: include/linux/gfp.h
  29    :doc: Watermark modifiers
  30
  31 .. kernel-doc:: include/linux/gfp.h
  32    :doc: Reclaim modifiers
  33
  34 .. kernel-doc:: include/linux/gfp.h
  35    :doc: Useful GFP flag combinations
  36
  37 The Slab Cache
  38 ==============
  39
  40 .. kernel-doc:: include/linux/slab.h
  41    :internal:
  42
  43 .. kernel-doc:: mm/slab.c
  44    :export:
  45
  46 .. kernel-doc:: mm/slab_common.c
  47    :export:
  48
  49 .. kernel-doc:: mm/util.c
  50    :functions: kfree_const kvmalloc_node kvfree
  51
  52 Virtually Contiguous Mappings
  53 =============================
  54
  55 .. kernel-doc:: mm/vmalloc.c
  56    :export:
  57
  58 File Mapping and Page Cache
  59 ===========================
  60
  61 Filemap
  62 -------
  63
  64 .. kernel-doc:: mm/filemap.c
  65    :export:
  66
  67 Readahead
  68 ---------
  69
  70 .. kernel-doc:: mm/readahead.c
  71    :doc: Readahead Overview
  72
  73 .. kernel-doc:: mm/readahead.c
  74    :export:
  75
  76 Writeback
  77 ---------
  78
  79 .. kernel-doc:: mm/page-writeback.c
  80    :export:
  81
  82 Truncate
  83 --------
  84
  85 .. kernel-doc:: mm/truncate.c
  86    :export:
  87
  88 .. kernel-doc:: include/linux/pagemap.h
  89    :internal:
  90
  91 Memory pools
  92 ============
  93
  94 .. kernel-doc:: mm/mempool.c
  95    :export:
  96
  97 DMA pools
  98 =========
  99
 100 .. kernel-doc:: mm/dmapool.c
 101    :export:
 102
 103 More Memory Management Functions
 104 ================================
 105
 106 .. kernel-doc:: mm/memory.c
 107    :export:
 108
 109 .. kernel-doc:: mm/page_alloc.c
 110 .. kernel-doc:: mm/mempolicy.c
 111 .. kernel-doc:: include/linux/mm_types.h
 112    :internal:
 113 .. kernel-doc:: include/linux/mm_inline.h
 114 .. kernel-doc:: include/linux/page-flags.h
 115 .. kernel-doc:: include/linux/mm.h
 116    :internal:
 117 .. kernel-doc:: include/linux/page_ref.h
 118 .. kernel-doc:: include/linux/mmzone.h
 119 .. kernel-doc:: mm/util.c
 120    :functions: folio_mapping