Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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) <willy@infradead.org>
Acked-by: Harry Yoo <harry.yoo@oracle.com>
Link: https://patch.msgid.link/20250611155916.2579160-2-willy@infradead.org
Signed-off-by: Vlastimil Babka <vbabka@suse.cz>

authored by

Matthew Wilcox (Oracle) and committed by
Vlastimil Babka
262e086f 5660ee54

+19 -17
+3 -2
Documentation/ABI/testing/sysfs-kernel-slab
··· 37 37 The alloc_calls file is read-only and lists the kernel code 38 38 locations from which allocations for this cache were performed. 39 39 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). 41 42 42 43 What: /sys/kernel/slab/<cache>/alloc_fastpath 43 44 Date: February 2008 ··· 220 219 Description: 221 220 The free_calls file is read-only and lists the locations of 222 221 object frees if slab debugging is enabled (see 223 - Documentation/mm/slub.rst). 222 + Documentation/admin-guide/mm/slab.rst). 224 223 225 224 What: /sys/kernel/slab/<cache>/free_fastpath 226 225 Date: February 2008
+7 -5
Documentation/admin-guide/kernel-parameters.txt
··· 6558 6558 slab_debug can create guard zones around objects and 6559 6559 may poison objects when not in use. Also tracks the 6560 6560 last alloc / free. For more information see 6561 - Documentation/mm/slub.rst. 6561 + Documentation/admin-guide/mm/slab.rst. 6562 6562 (slub_debug legacy name also accepted for now) 6563 6563 6564 6564 slab_max_order= [MM] 6565 6565 Determines the maximum allowed order for slabs. 6566 6566 A high setting may cause OOMs due to memory 6567 6567 fragmentation. For more information see 6568 - Documentation/mm/slub.rst. 6568 + Documentation/admin-guide/mm/slab.rst. 6569 6569 (slub_max_order legacy name also accepted for now) 6570 6570 6571 6571 slab_merge [MM] ··· 6580 6580 the number of objects indicated. The higher the number 6581 6581 of objects the smaller the overhead of tracking slabs 6582 6582 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. 6584 6585 (slub_min_objects legacy name also accepted for now) 6585 6586 6586 6587 slab_min_order= [MM] 6587 6588 Determines the minimum page order for slabs. Must be 6588 6589 lower or equal to slab_max_order. For more information see 6589 - Documentation/mm/slub.rst. 6590 + Documentation/admin-guide/mm/slab.rst. 6590 6591 (slub_min_order legacy name also accepted for now) 6591 6592 6592 6593 slab_nomerge [MM] ··· 6601 6600 cache (risks via metadata attacks are mostly 6602 6601 unchanged). Debug options disable merging on their 6603 6602 own. 6604 - For more information see Documentation/mm/slub.rst. 6603 + For more information see 6604 + Documentation/admin-guide/mm/slab.rst. 6605 6605 (slub_nomerge legacy name also accepted for now) 6606 6606 6607 6607 slab_strict_numa [MM]
+1
Documentation/admin-guide/mm/index.rst
··· 37 37 numaperf 38 38 pagemap 39 39 shrinker_debugfs 40 + slab 40 41 soft-dirty 41 42 swap_numa 42 43 transhuge
-1
Documentation/mm/index.rst
··· 56 56 page_owner 57 57 page_table_check 58 58 remap_file_pages 59 - slub 60 59 split_page_table_lock 61 60 transhuge 62 61 unevictable-lru
+8 -9
Documentation/mm/slub.rst Documentation/admin-guide/mm/slab.rst
··· 1 - ========================== 2 - Short users guide for SLUB 3 - ========================== 1 + ======================================== 2 + Short users guide for the slab allocator 3 + ======================================== 4 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. 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. 11 10 12 11 In order to switch debugging on one can add an option ``slab_debug`` 13 12 to the kernel command line. That will enable full debugging for