Commit 9a460b23 authored by Peng Zhang's avatar Peng Zhang Committed by Peng Zhang
Browse files

maple_tree: update the documentation of maple tree 

mainline inclusion
from mainline-v6.8-rc1
commit 9bc1d3cdb904170214456bca96c4924f28522ab8
category: performance
bugzilla: https://gitee.com/openeuler/kernel/issues/I9AYM3
CVE: NA

Reference: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=9bc1d3cdb904170214456bca96c4924f28522ab8

--------------------------------

Introduce the new interface mtree_dup() in the documentation.

Link: https://lkml.kernel.org/r/20231027033845.90608-7-zhangpeng.00@bytedance.com


Signed-off-by: default avatarPeng Zhang <zhangpeng.00@bytedance.com>
Reviewed-by: default avatarLiam R. Howlett <Liam.Howlett@oracle.com>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mateusz Guzik <mjguzik@gmail.com>
Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Michael S. Tsirkin <mst@redhat.com>
Cc: Mike Christie <michael.christie@oracle.com>
Cc: Nicholas Piggin <npiggin@gmail.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Suren Baghdasaryan <surenb@google.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarZhangPeng <zhangpeng362@huawei.com>
parent 6bb5c8af

Documentation/core-api/maple_tree.rst

+4 −0
Original line number Diff line number Diff line
@@ -81,6 +81,9 @@ section. 
Sometimes it is necessary to ensure the next call to store to a maple tree does

not allocate memory, please see :ref:`maple-tree-advanced-api` for this use case.



You can use mtree_dup() to duplicate an entire maple tree. It is a more

efficient way than inserting all elements one by one into a new tree.



Finally, you can remove all entries from a maple tree by calling

mtree_destroy().  If the maple tree entries are pointers, you may wish to free

the entries first.
@@ -112,6 +115,7 @@ Takes ma_lock internally: 
 * mtree_insert()

 * mtree_insert_range()

 * mtree_erase()

 * mtree_dup()

 * mtree_destroy()

 * mt_set_in_rcu()

 * mt_clear_in_rcu()