This is an archive of the discontinued LLVM Phabricator instance.

Differential D43975

[scudo] Update Scudo docs with configuration options.
AbandonedPublic

Authored by cryptoad on Mar 1 2018, 3:01 PM.

Download Raw Diff

Details

Reviewers

flowerhack

Summary

Make it clear how to disable the quarantine.

Diff Detail

Event Timeline

flowerhack created this revision.Mar 1 2018, 3:01 PM

cryptoad accepted this revision.Mar 2 2018, 7:18 AM

This revision is now accepted and ready to land.Mar 2 2018, 7:18 AM

can you hit merge? :)

alekseyshl removed a reviewer: alekseyshl.May 17 2018, 1:53 PM

cryptoad commandeered this revision.May 18 2018, 8:04 AM

cryptoad edited reviewers, added: flowerhack; removed: cryptoad.

This revision now requires review to proceed.May 18 2018, 8:04 AM

This will be included in an upcoming documentation change I am making.

Revision Contents

Path

Size

llvm/

docs/

ScudoHardenedAllocator.rst

8 lines

Diff 136616

llvm/docs/ScudoHardenedAllocator.rst

	Show First 20 Lines • Show All 161 Lines • ▼ Show 20 Lines

	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| Option \| 64-bit default \| 32-bit default \| Description \|			\| Option \| 64-bit default \| 32-bit default \| Description \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| QuarantineSizeKb \| 256 \| 64 \| The size (in Kb) of quarantine used to delay \|			\| QuarantineSizeKb \| 256 \| 64 \| The size (in Kb) of quarantine used to delay \|
	\| \| \| \| the actual deallocation of chunks. Lower value \|			\| \| \| \| the actual deallocation of chunks. Lower value \|
	\| \| \| \| may reduce memory usage but decrease the \|			\| \| \| \| may reduce memory usage but decrease the \|
	\| \| \| \| effectiveness of the mitigation; a negative \|			\| \| \| \| effectiveness of the mitigation; a negative \|
	\| \| \| \| value will fallback to the defaults. \|			\| \| \| \| value will fallback to the defaults. Setting \|
				\| \| \| \| both this and ThreadLocalQuarantineSizeKb to \|
				\| \| \| \| zero will disable the quarantine entirely. \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| QuarantineChunksUpToSize \| 2048 \| 512 \| Size (in bytes) up to which chunks can be \|			\| QuarantineChunksUpToSize \| 2048 \| 512 \| Size (in bytes) up to which chunks can be \|
	\| \| \| \| quarantined. \|			\| \| \| \| quarantined. \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| ThreadLocalQuarantineSizeKb \| 1024 \| 256 \| The size (in Kb) of per-thread cache use to \|			\| ThreadLocalQuarantineSizeKb \| 1024 \| 256 \| The size (in Kb) of per-thread cache use to \|
	\| \| \| \| offload the global quarantine. Lower value may \|			\| \| \| \| offload the global quarantine. Lower value may \|
	\| \| \| \| reduce memory usage but might increase \|			\| \| \| \| reduce memory usage but might increase \|
	\| \| \| \| contention on the global quarantine. \|			\| \| \| \| contention on the global quarantine. Setting \|
				\| \| \| \| both this and QuarantineSizeKb to zero will \|
				\| \| \| \| disable the quarantine entirely. \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| DeallocationTypeMismatch \| true \| true \| Whether or not we report errors on \|			\| DeallocationTypeMismatch \| true \| true \| Whether or not we report errors on \|
	\| \| \| \| malloc/delete, new/free, new/delete[], etc. \|			\| \| \| \| malloc/delete, new/free, new/delete[], etc. \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| DeleteSizeMismatch \| true \| true \| Whether or not we report errors on mismatch \|			\| DeleteSizeMismatch \| true \| true \| Whether or not we report errors on mismatch \|
	\| \| \| \| between sizes of new and delete. \|			\| \| \| \| between sizes of new and delete. \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+
	\| ZeroContents \| false \| false \| Whether or not we zero chunk contents on \|			\| ZeroContents \| false \| false \| Whether or not we zero chunk contents on \|
	\| \| \| \| allocation and deallocation. \|			\| \| \| \| allocation and deallocation. \|
	+-----------------------------+----------------+----------------+------------------------------------------------+			+-----------------------------+----------------+----------------+------------------------------------------------+

	Allocator related common Sanitizer options can also be passed through Scudo			Allocator related common Sanitizer options can also be passed through Scudo
	options, such as ``allocator_may_return_null``. A detailed list including those			options, such as ``allocator_may_return_null``. A detailed list including those
	can be found here:			can be found here:
	https://github.com/google/sanitizers/wiki/SanitizerCommonFlags.			https://github.com/google/sanitizers/wiki/SanitizerCommonFlags.