Skip to content

Commit a4fa357

Browse files
committed
Merge branch 'asawall2-cicd241' into 'linux-6.6.y-memorizer-dev'
Kconfig variable docs See merge request ring0/memorizer!44
2 parents c118e4b + 7ba4b81 commit a4fa357

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

Documentation/memorizer/reference.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,33 @@ Using the Grub syntax, here is a working example of a Memorizer kernel command l
142142

143143
GRUB_CMDLINE_LINUX="memorizer_enabled_boot=no maxcpus=1 split_lock_detect=off no_hash_pointers nokaslr audit=0 loglevel=8 memalloc_size=4”
144144

145+
Memorizer Kernel Config Variables
146+
=================================
147+
Memorizer kernel config variable definitions can be found in ``/lib/Kconfig.debug`` and ``/lib/Kconfig``.
148+
These values are set at build-time.
149+
150+
Config Variables
151+
~~~~~~~~~~~~~~~~
152+
``MEMORIZER``
153+
Boolean, enables/disables the Memorizer tool. Memorizer traces the memory allocations of kernel objects to track patterns across an object's lifetime.
154+
155+
``MEMORIZER_STATS``
156+
Boolean, enables/disables the Memorizer statistics summary. The statistics summary includes the number of accesses and shadow objects allocated for Memorizer which will slow down the performance of the system.
157+
158+
``MEMORIZER_TRACKPIDS``
159+
Boolean, enables/disables the segregation of memory access counts by process id (PID) within Memorizer data.
160+
161+
``MEMORIZER_DEBUGFS_RAM``
162+
Boolean, enables/disables the exposure of Memorizer's buffer via a debugfs file.
163+
164+
``INLINE_LIBS``
165+
Boolean, forces gcc to use inline calls for some library functions. This must be enabled to run Memorizer.
166+
167+
Dependencies
168+
~~~~~~~~~~~~
169+
``KASAN``
170+
Boolean, enables/disables Kernel Address Sanitizer (KASAN). This is an error detector designed to find out-of-bounds and use-after-free bugs in dynamic memory. This must be enabled to run Memorizer.
171+
145172
.. _`debugfs-files`:
146173

147174
Memorizer ``debugfs`` files

0 commit comments

Comments
 (0)