Skip to content

Commit 262e086

Browse files
Matthew Wilcox (Oracle)tehcaster
authored andcommitted
doc: Move SLUB documentation to the admin guide
This section is supposed to be for internal documentation, while the document is advice for sysadmins. Move it to the appropriate place. Signed-off-by: Matthew Wilcox (Oracle) <[email protected]> Acked-by: Harry Yoo <[email protected]> Link: https://patch.msgid.link/[email protected] Signed-off-by: Vlastimil Babka <[email protected]>
1 parent 5660ee5 commit 262e086

File tree

5 files changed

+20
-18
lines changed

5 files changed

+20
-18
lines changed

Documentation/ABI/testing/sysfs-kernel-slab

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Description:
3737
The alloc_calls file is read-only and lists the kernel code
3838
locations from which allocations for this cache were performed.
3939
The alloc_calls file only contains information if debugging is
40-
enabled for that cache (see Documentation/mm/slub.rst).
40+
enabled for that cache (see
41+
Documentation/admin-guide/mm/slab.rst).
4142

4243
What: /sys/kernel/slab/<cache>/alloc_fastpath
4344
Date: February 2008
@@ -219,7 +220,7 @@ Contact: Pekka Enberg <[email protected]>,
219220
Description:
220221
The free_calls file is read-only and lists the locations of
221222
object frees if slab debugging is enabled (see
222-
Documentation/mm/slub.rst).
223+
Documentation/admin-guide/mm/slab.rst).
223224

224225
What: /sys/kernel/slab/<cache>/free_fastpath
225226
Date: February 2008

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6558,14 +6558,14 @@
65586558
slab_debug can create guard zones around objects and
65596559
may poison objects when not in use. Also tracks the
65606560
last alloc / free. For more information see
6561-
Documentation/mm/slub.rst.
6561+
Documentation/admin-guide/mm/slab.rst.
65626562
(slub_debug legacy name also accepted for now)
65636563

65646564
slab_max_order= [MM]
65656565
Determines the maximum allowed order for slabs.
65666566
A high setting may cause OOMs due to memory
65676567
fragmentation. For more information see
6568-
Documentation/mm/slub.rst.
6568+
Documentation/admin-guide/mm/slab.rst.
65696569
(slub_max_order legacy name also accepted for now)
65706570

65716571
slab_merge [MM]
@@ -6580,13 +6580,14 @@
65806580
the number of objects indicated. The higher the number
65816581
of objects the smaller the overhead of tracking slabs
65826582
and the less frequently locks need to be acquired.
6583-
For more information see Documentation/mm/slub.rst.
6583+
For more information see
6584+
Documentation/admin-guide/mm/slab.rst.
65846585
(slub_min_objects legacy name also accepted for now)
65856586

65866587
slab_min_order= [MM]
65876588
Determines the minimum page order for slabs. Must be
65886589
lower or equal to slab_max_order. For more information see
6589-
Documentation/mm/slub.rst.
6590+
Documentation/admin-guide/mm/slab.rst.
65906591
(slub_min_order legacy name also accepted for now)
65916592

65926593
slab_nomerge [MM]
@@ -6600,7 +6601,8 @@
66006601
cache (risks via metadata attacks are mostly
66016602
unchanged). Debug options disable merging on their
66026603
own.
6603-
For more information see Documentation/mm/slub.rst.
6604+
For more information see
6605+
Documentation/admin-guide/mm/slab.rst.
66046606
(slub_nomerge legacy name also accepted for now)
66056607

66066608
slab_strict_numa [MM]

Documentation/admin-guide/mm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ the Linux memory management.
3737
numaperf
3838
pagemap
3939
shrinker_debugfs
40+
slab
4041
soft-dirty
4142
swap_numa
4243
transhuge

Documentation/mm/slub.rst renamed to Documentation/admin-guide/mm/slab.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
==========================
2-
Short users guide for SLUB
3-
==========================
4-
5-
The basic philosophy of SLUB is very different from SLAB. SLAB
6-
requires rebuilding the kernel to activate debug options for all
7-
slab caches. SLUB always includes full debugging but it is off by default.
8-
SLUB can enable debugging only for selected slabs in order to avoid
9-
an impact on overall system performance which may make a bug more
10-
difficult to find.
1+
========================================
2+
Short users guide for the slab allocator
3+
========================================
4+
5+
The slab allocator includes full debugging support (when built with
6+
CONFIG_SLUB_DEBUG=y) but it is off by default (unless built with
7+
CONFIG_SLUB_DEBUG_ON=y). You can enable debugging only for selected
8+
slabs in order to avoid an impact on overall system performance which
9+
may make a bug more difficult to find.
1110

1211
In order to switch debugging on one can add an option ``slab_debug``
1312
to the kernel command line. That will enable full debugging for

Documentation/mm/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ documentation, or deleted if it has served its purpose.
5656
page_owner
5757
page_table_check
5858
remap_file_pages
59-
slub
6059
split_page_table_lock
6160
transhuge
6261
unevictable-lru

0 commit comments

Comments
 (0)