docs/core-api: memory-allocation: add mention of kmem_cache_create_userspace
diff mbox series

Message ID 1547466454-29457-1-git-send-email-rppt@linux.ibm.com
State Accepted
Commit 98e5f349c9a0253d4a213d54db918f2aab5846ee
Headers show
Series
  • docs/core-api: memory-allocation: add mention of kmem_cache_create_userspace
Related show

Commit Message

Mike Rapoport Jan. 14, 2019, 11:47 a.m. UTC
Mention that when a part of a slab cache might be exported to the
userspace, the cache should be created using kmem_cache_create_usercopy()

Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
---
 Documentation/core-api/memory-allocation.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Jonathan Corbet Jan. 15, 2019, 12:27 a.m. UTC | #1
On Mon, 14 Jan 2019 13:47:34 +0200
Mike Rapoport <rppt@linux.ibm.com> wrote:

> Mention that when a part of a slab cache might be exported to the
> userspace, the cache should be created using kmem_cache_create_usercopy()
> 
> Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>

Hmm...I didn't know that :)

Applied, thanks.

jon

Patch
diff mbox series

diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core-api/memory-allocation.rst
index 8954a88..51a200d 100644
--- a/Documentation/core-api/memory-allocation.rst
+++ b/Documentation/core-api/memory-allocation.rst
@@ -113,9 +113,11 @@  see :c:func:`kvmalloc_node` reference documentation. Note that
 
 If you need to allocate many identical objects you can use the slab
 cache allocator. The cache should be set up with
-:c:func:`kmem_cache_create` before it can be used. Afterwards
-:c:func:`kmem_cache_alloc` and its convenience wrappers can allocate
-memory from that cache.
+:c:func:`kmem_cache_create` or :c:func:`kmem_cache_create_usercopy`
+before it can be used. The second function should be used if a part of
+the cache might be copied to the userspace.  After the cache is
+created :c:func:`kmem_cache_alloc` and its convenience wrappers can
+allocate memory from that cache.
 
 When the allocated memory is no longer needed it must be freed. You
 can use :c:func:`kvfree` for the memory allocated with `kmalloc`,