diff options
author | Mike Rapoport <rppt@linux.ibm.com> | 2019-01-14 14:47:34 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2019-01-15 03:27:05 +0300 |
commit | 98e5f349c9a0253d4a213d54db918f2aab5846ee (patch) | |
tree | 7e63495a856c10a252bc281aff4e1ade003c455b | |
parent | 58f4df3c1bde999574d3e66b20eb7ee796a2647e (diff) | |
download | linux-98e5f349c9a0253d4a213d54db918f2aab5846ee.tar.xz |
docs/core-api: memory-allocation: add mention of kmem_cache_create_userspace
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r-- | Documentation/core-api/memory-allocation.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core-api/memory-allocation.rst index 8954a88ff5b7..51a200d59f51 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`, |