767e5ee54e
The documentation currently does not include the deathless prose written to describe functions in pagemap.h because it's not included in any rst file. Fix up the mismatches between parameter names and the documentation and add the file to mm-api. Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Reviewed-by: Zi Yan <ziy@nvidia.com> Reviewed-by: John Hubbard <jhubbard@nvidia.com> Cc: Jonathan Corbet <corbet@lwn.net> Link: http://lkml.kernel.org/r/20200221220045.24989-1-willy@infradead.org Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
98 lines
1.9 KiB
ReStructuredText
98 lines
1.9 KiB
ReStructuredText
======================
|
|
Memory Management APIs
|
|
======================
|
|
|
|
User Space Memory Access
|
|
========================
|
|
|
|
.. kernel-doc:: arch/x86/include/asm/uaccess.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: arch/x86/lib/usercopy_32.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/gup.c
|
|
:functions: get_user_pages_fast
|
|
|
|
.. _mm-api-gfp-flags:
|
|
|
|
Memory Allocation Controls
|
|
==========================
|
|
|
|
Functions which need to allocate memory often use GFP flags to express
|
|
how that memory should be allocated. The GFP acronym stands for "get
|
|
free pages", the underlying memory allocation function. Not every GFP
|
|
flag is allowed to every function which may allocate memory. Most
|
|
users will want to use a plain ``GFP_KERNEL``.
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Page mobility and placement hints
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Watermark modifiers
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Reclaim modifiers
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Useful GFP flag combinations
|
|
|
|
The Slab Cache
|
|
==============
|
|
|
|
.. kernel-doc:: include/linux/slab.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: mm/slab.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/slab_common.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/util.c
|
|
:functions: kfree_const kvmalloc_node kvfree
|
|
|
|
Virtually Contiguous Mappings
|
|
=============================
|
|
|
|
.. kernel-doc:: mm/vmalloc.c
|
|
:export:
|
|
|
|
File Mapping and Page Cache
|
|
===========================
|
|
|
|
.. kernel-doc:: mm/readahead.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/filemap.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/page-writeback.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/truncate.c
|
|
:export:
|
|
|
|
.. kernel-doc:: include/linux/pagemap.h
|
|
:internal:
|
|
|
|
Memory pools
|
|
============
|
|
|
|
.. kernel-doc:: mm/mempool.c
|
|
:export:
|
|
|
|
DMA pools
|
|
=========
|
|
|
|
.. kernel-doc:: mm/dmapool.c
|
|
:export:
|
|
|
|
More Memory Management Functions
|
|
================================
|
|
|
|
.. kernel-doc:: mm/memory.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/page_alloc.c
|