This is an archive of the discontinued LLVM Phabricator instance.

[ASan] Minor documentation fix: clarify static linking limitation.
ClosedPublic

Authored by Dor1s on Nov 29 2018, 10:49 AM.

Download Raw Diff

Details

Reviewers

eugenis
kcc

Commits

rGc5c28ff4ae7d: [ASan] Minor documentation fix: clarify static linking limitation.
rL348863: [ASan] Minor documentation fix: clarify static linking limitation.
rC348863: [ASan] Minor documentation fix: clarify static linking limitation.

Summary

ASan does not support statically linked binaries, but ASan runtime itself can
be statically linked into a target binary executable.

Diff Detail

Repository: rC Clang

Event Timeline

Dor1s created this revision.Nov 29 2018, 10:49 AM

Herald added a subscriber: cfe-commits. · View Herald TranscriptNov 29 2018, 10:49 AM

Harbormaster completed remote builds in B25495: Diff 175904.Nov 29 2018, 10:49 AM

PTAL, it's a single line change, I just need someone to confirm that I'm not mistaken :)

Sorry for the delay.
This is wrong, static linking is NOT supported.
You could be confusing it with static linking of asan runtime library to an executable - that is and has always been the default.

This revision now requires changes to proceed.Nov 30 2018, 3:56 PM

In D55066#1315365, @eugenis wrote:

Sorry for the delay.
This is wrong, static linking is NOT supported.
You could be confusing it with static linking of asan runtime library to an executable - that is and has always been the default.

Thanks, @eugenis! Should I change the message to something like "ASan runtime cannot be built with static linking."? Does it sound correct and perhaps less confusing?

How about "Static linking of executables is not supported"?

Restore the message with a couple clarifying words.

Harbormaster completed remote builds in B25692: Diff 176712.Dec 4 2018, 2:30 PM

Thanks @eugenis for explaining the issue to me over chat. I've updated the CL and the description. I can abandon it though, if you find it useless.

LGTM

This revision is now accepted and ready to land.Dec 10 2018, 5:07 PM

Closed by commit rC348863: [ASan] Minor documentation fix: clarify static linking limitation. (authored by Dor1s). · Explain WhyDec 11 2018, 8:50 AM

This revision was automatically updated to reflect the committed changes.

Revision Contents

Path

Size

docs/

AddressSanitizer.rst

2 lines

Diff 177724

docs/AddressSanitizer.rst

	Show First 20 Lines • Show All 259 Lines • ▼ Show 20 Lines

	* AddressSanitizer uses more real memory than a native run. Exact overhead			* AddressSanitizer uses more real memory than a native run. Exact overhead
	depends on the allocations sizes. The smaller the allocations you make the			depends on the allocations sizes. The smaller the allocations you make the
	bigger the overhead is.			bigger the overhead is.
	* AddressSanitizer uses more stack memory. We have seen up to 3x increase.			* AddressSanitizer uses more stack memory. We have seen up to 3x increase.
	* On 64-bit platforms AddressSanitizer maps (but not reserves) 16+ Terabytes of			* On 64-bit platforms AddressSanitizer maps (but not reserves) 16+ Terabytes of
	virtual address space. This means that tools like ``ulimit`` may not work as			virtual address space. This means that tools like ``ulimit`` may not work as
	usually expected.			usually expected.
	* Static linking is not supported.			* Static linking of executables is not supported.

	Supported Platforms			Supported Platforms
	===================			===================

	AddressSanitizer is supported on:			AddressSanitizer is supported on:

	* Linux i386/x86\_64 (tested on Ubuntu 12.04)			* Linux i386/x86\_64 (tested on Ubuntu 12.04)
	* OS X 10.7 - 10.11 (i386/x86\_64)			* OS X 10.7 - 10.11 (i386/x86\_64)
	Show All 22 Lines