diff options
| author |   Mike Rapoport <rppt@linux.vnet.ibm.com> | 2018-08-23 17:01:19 -0700 |
|---|---|---|
| committer |   Linus Torvalds <torvalds@linux-foundation.org> | 2018-08-23 18:48:43 -0700 |
| commit | 038a07a5420a59f1291dcf2a506f66335ec1cf9c (patch) | |
| tree | 007f3997e908f780f28501d3a8c2d3356b4394ba /Documentation/core-api | |
| parent | docs/mm: make GFP flags descriptions usable as kernel-doc (diff) | |
| download | linux-dev-038a07a5420a59f1291dcf2a506f66335ec1cf9c.tar.xz linux-dev-038a07a5420a59f1291dcf2a506f66335ec1cf9c.zip | |
docs/core-api: mm-api: add section about GFP flags
Link: http://lkml.kernel.org/r/1532626360-16650-8-git-send-email-rppt@linux.vnet.ibm.com
Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Reviewed-by: Andrew Morton <akpm@linux-foundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Michal Hocko <mhocko@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/core-api')
| -rw-r--r-- | Documentation/core-api/mm-api.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst index b5913aad3ae6..46ae3537fb12 100644 --- a/Documentation/core-api/mm-api.rst +++ b/Documentation/core-api/mm-api.rst @@ -14,6 +14,27 @@ User Space Memory Access .. kernel-doc:: mm/util.c :functions: get_user_pages_fast +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: Common combinations + The Slab Cache ============== |