Hi all,Can anyone explain me what was the rationale behind putting the sanitizer libraries in compiler-rt?The sanitizers only work properly in x86_64 and I don't see anyone even testing to any other platform, while compiler-rt should be a substitute for libgcc on all platforms, at least that's the goal, and linking the success of the RT library to the success of the sanitizers is a bit of an oversight, IMHO.I'm spending 99% of the time to make compiler-rt compiler on ARM using CMake by fiddling the sanitizers' tests, lit config files and CMake scripts, which is a bit annoying...
Long term, would it be possible / desirable to split them into compiler-rt and sanitizer-rt?cheers,--renato
_______________________________________________
LLVM Developers mailing list
LLV...@cs.uiuc.edu http://llvm.cs.uiuc.edu
http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Hi all,Can anyone explain me what was the rationale behind putting the sanitizer libraries in compiler-rt?
Basically, compiler-rt contains the only runtime libraries we ship with Clang. The sanitizers are runtime libraries shipped with clang (they have some version dependence), so they went in compiler-rt. Now they are starting to feel much larger than compiler-rt, so perhaps they should be split out.
Or we can leave them there and solve your ARM build problems a different way.
I don't see any compelling reason to split the sanitizers out today.
I think the sanitizer guys would probably take a patch to CMakeLists.txt to disable the sanitizer RTLs.
I'm told that ASan supports ARM, but it's maybe not production quality, so I don't think disabling all sanitizers on non-x86 architectures will work.
On 30 January 2014 21:50, Reid Kleckner <r...@google.com> wrote:I don't see any compelling reason to split the sanitizers out today.Clear, next.
> - There is the core runtime library. Historically this was called 'compiler-rt' informally, but perhaps better called 'libclang_rt', which provides the core necessary runtime library facilities to compile C or C++ applications. It's analogous to libgcc but without some of the unwinding code (as I understand it, there may be details I'm wrong about here or glossing over, but it's not relevant to the organization of things).For some reason, the (generic, language-agnostic) unwind code is in libcxxabi. There was some discussion about moving it into the compiler-rt repository, where it would make sense. No one objected, but I'd rather not move it without a 'yes' from someone who is actually working on the code currently (I'd like to start factoring out the #ifdefs into a cleaner platform / architecture layer).
Just as a side note, I had some thoughts about the organization of this stuff a while back that I wanted to replay here.On Thu, Jan 30, 2014 at 1:54 PM, Renato Golin <renato...@linaro.org> wrote:
On 30 January 2014 21:50, Reid Kleckner <r...@google.com> wrote:I don't see any compelling reason to split the sanitizers out today.Clear, next.Fundamentally, I feel like we're in particular getting a few things conflated. Maybe separating them out helps:- There is the repository "compiler-rt" that holds all of the runtime libraries that (if desired) need to be shipped along side the compiler. They're separated so that they can be omitted when they aren't needed, and potentially to isolate an unusual desired property: we would really like to (eventually) build them with the just-built compiler rather than the host compiler (where possible, clearly this requires the target compiler to be executable on the host).- There is the core runtime library. Historically this was called 'compiler-rt' informally, but perhaps better called 'libclang_rt', which provides the core necessary runtime library facilities to compile C or C++ applications. It's analogous to libgcc but without some of the unwinding code (as I understand it, there may be details I'm wrong about here or glossing over, but it's not relevant to the organization of things).- There are several optional runtime libraries to support specific compiler / toolchain features. These include the sanitizers and profiling libraries.I think all of the libraries here make sense in the same repository because of the shared concerns of building runtime libraries. For example, it would be useful to compile them with the just-built-clang when target is executable on the host, and it would be useful to automatically cross compile versions of them for as many targets as are possible on the given host and supported by the host compiler (if used) and the just-built-clang.However, the organization of the tree is ... very hard to understand. originally, there was only the one 'libclang_rt' library that had its generic C99 implementation in 'lib', and architecture-specific assembly routines when desirable in architecture subdirectories of lib. When we added new libraries, we put them in subdirectories of lib, making the whole thing kind of a mess. My suggestion to fix this was to create a "core" subdirectory of lib to contain the code used for 'libclang_rt'. "core" is a terrible name, but i've no better. suggestions welcome there. Then we would have a more sensible organization of the 'lib' tree.
I also think it might be useful to have a single large test tree (much like with llvm or clang) that has subdirectories for the various tests rather than test directories under lib/asan/ and friends, but maybe the sanitizer folks have objections to that. consistency seems a compelling reason here, but there might be other compelling concerns.
Now, the build system has always been problematic because the build system for this tree is *hard* and no one who has worked on it has really had the time to do an extremely thorough job and finish all aspects. It's a huge project. Right now, the makefile system does a good job of using the just-built-clang and can do a limited amount of cross-building runtimes for other targets. But the makefile system of compiler-rt is also terribly, terribly complex, doesn't follow the conventions of LLVM's makefiles, and is generally painful to maintain and update, so folks have been reluctant to flesh out its support for new libraries and other new things.
The CMake system is much cleaner in some respects (a bit less opaque to the folks trying to maintain it), but CMake makes it much harder to use the just-built-clang, especially for the C++ runtime code. The consequence is that we've never finished either the cross-building or just-built-clang-hosting features that are desirable.
Any work toward these would be really awesome to see, but is a huge pile of work. Finally, when I was originally doing the CMake build for this I didn't understand what really needed to be done to build and use the core 'libclang_rt' library, and so I don't think I got it right. Some folks have sent patches to improve it, but I suspect it still really needs more work to be a solid system to use instead of libgcc. So I'm really excited about your emails. =] Having a more self-contained stack would be a significant improvement.I think the obvious incremental steps are to disable building any parts of compiler-rt that don't build cleanly.
There should never be a requirement for you to port an optional runtime library unless you need it. =] I think having good ports is important, but that should never block progress getting other thinsg ported and working well.If it helps to reorganize things, I'm happy to even help there as much as I can. I agree that the organization isn't great, but I *really* didn't want to fight the makefile build system to do the reorganization myself, so its something that has lingered too long.Sorry for the long ramble, but hopefully this gives you some of tho context.
_______________________________________________
cfe-dev mailing list
cfe...@cs.uiuc.edu
http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev
Yes, I don't like the way testing is organized either. Originally it made sense to put sanitizer lit tests under lib/xsan/, but now we've got a lot of sanitizers, and a lot of duplicating configuration code. As Renato mentioned, browsingthrough lit configs is a bit painful. I would like to proceed with re-organizing the tests for sanitizers, unless anyone objects. Kostya?
Certainly, one can expect to test the runtime on the host?
likewise, any pointers to where you see wrong dependencies would be appreciated.
At present, config & make appears to build a sensible lib using the just-built compiler [and in the general case, that's the only sensible solution, since the host might not have cross-tools for the set of archs you want to support with llvm/clang]
In some future ideal world, we might cook up a cross-testing environment - of course, it's a given that that would require testers to have access to the target hardware they wanted to test on.
Iain
>
>
> The CMake system is much cleaner in some respects (a bit less opaque to the folks trying to maintain it), but CMake makes it much harder to use the just-built-clang, especially for the C++ runtime code. The consequence is that we've never finished either the cross-building or just-built-clang-hosting features that are desirable.
>
> I once tried to implement a pseudo-build-system for compiler-rt on top of CMake, so that we use "just-built" Clang instead of a host compiler, but failed miserably. Maybe I was doing wrong things, but I got the impression
> that CMake isn't suited for switching the compiler on the fly :)
>
> Any work toward these would be really awesome to see, but is a huge pile of work. Finally, when I was originally doing the CMake build for this I didn't understand what really needed to be done to build and use the core 'libclang_rt' library, and so I don't think I got it right. Some folks have sent patches to improve it, but I suspect it still really needs more work to be a solid system to use instead of libgcc. So I'm really excited about your emails. =] Having a more self-contained stack would be a significant improvement.
>
>
> I think the obvious incremental steps are to disable building any parts of compiler-rt that don't build cleanly.
>
> As I mentioned above, currently in CMake build system we try to avoid building anything if we're not sure we can produce a working and correct library on the host platform. That is, I still don't see what the problem is - it's relatively easy to enable building just the compiler-rt library on ARM and not enable building sanitizers on ARM.
>
> There should never be a requirement for you to port an optional runtime library unless you need it. =] I think having good ports is important, but that should never block progress getting other thinsg ported and working well.
>
> If it helps to reorganize things, I'm happy to even help there as much as I can. I agree that the organization isn't great, but I *really* didn't want to fight the makefile build system to do the reorganization myself, so its something that has lingered too long.
>
>
> Sorry for the long ramble, but hopefully this gives you some of tho context.
>
> _______________________________________________
> cfe-dev mailing list
> cfe...@cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev
>
>
>
>
> --
> Alexey Samsonov, MSK
> _______________________________________________
> LLVM Developers mailing list
> LLV...@cs.uiuc.edu http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
1) If ASan runtime has changed, re-build it, and re-run tests.
2) If FileCheck or lit sources have changed, I should re-build them (but not ASan runtime) and re-run tests.3) If Clang sources have changed, I should re-build Clang, re-build ASan runtime (*) and re-run tests.
IIRC, "make check-all" in configure+make build tree doesn't re-build the necessary libraries automatically.
On 31 January 2014 09:22, Alexey Samsonov <sams...@google.com> wrote:
1) If ASan runtime has changed, re-build it, and re-run tests.
2) If FileCheck or lit sources have changed, I should re-build them (but not ASan runtime) and re-run tests.3) If Clang sources have changed, I should re-build Clang, re-build ASan runtime (*) and re-run tests.Yeah, this is the major pain I'm having right now, as there isn't a target that I can make to re-compile the rt dependencies, not even check-all does that. (I have no idea how it gets compiled in the first place!).
Maybe anyone knows of a way I can force it to re-compile, like removing the build directory just for the rt or something.
IIRC, "make check-all" in configure+make build tree doesn't re-build the necessary libraries automatically.Correct.--renato
That is, I still don't see what the problem is - it's relatively easy to enable building just the compiler-rt library on ARM and not enable building sanitizers on ARM.
In CMake build system you can just run "make compiler-rt".Not sure how to do this in configure+make w/o "make clean"...
On 31 January 2014 08:50, Alexey Samsonov <sams...@google.com> wrote:
That is, I still don't see what the problem is - it's relatively easy to enable building just the compiler-rt library on ARM and not enable building sanitizers on ARM.
For some reason, when I added the compiler-rt directory (even before my CMake changes), the Clang tests *required* the Asan libraries in lib/clang/3.5/linux, which is why I added it in the first place. I think this is wrong and should be fixed (though I have no idea how) in the Clang CMake files.
With that fixed, I could just enable the RT libs and worry about the Asan later. Right now, I can't.--renato
cheers,--renato
Right now, in my CMake build tree I've ran "make compiler-rt", then changed compiler-rt/lib/absvsi2.c, then ran "make compiler-rt" again, and saw that lib/clang/3.5/lib/linux/libclang_rt.x86_64.a was indeed rebuilt.
Huh? What tests are you talking about? I thought that tests for Clang driver verifiy that the command "clang++ -fsanitize=address ...." produce a correct linker invocation (with path to /lib/clang/3.5/linux/libclang_rt.asan-arm.a), but don't actually require the libraries to be built there. If it's not the case, we should fix that.
On 31 January 2014 09:59, Alexey Samsonov <sams...@google.com> wrote:
Huh? What tests are you talking about? I thought that tests for Clang driver verifiy that the command "clang++ -fsanitize=address ...." produce a correct linker invocation (with path to /lib/clang/3.5/linux/libclang_rt.asan-arm.a), but don't actually require the libraries to be built there. If it's not the case, we should fix that.I got linker errors, since /lib/clang/3.5/linux/libclang_rt.asan-armv7l.a (or arm for that matter) wasn't there, since "arm" is not a recognized architecture.
My point is that Clang sanitizer tests should *only* run IFF:1. Compiler-rt is present AND2. The architecture is recognized AND3. The Asan/Lsan/UBsan etc libraries were enabled via some build option (individually checked).
I may be wrong, but right now, it seems that they all run once compiler-rt is available.
cheers,--renato
cheers,--renato
* One of the interesting things about compiler-rt is the static library to dynamic library migration (e.g. libgcc.a vs libgcc_s.so, or on Darwin libclang_*.a vs libSystem.dylib). If the shared library ships independently from the compiler, then the compiler may need a .a file that can ship with it that contains any support functions not available in a shared library on the target. Currently, it is a very manual process to figure out which functions are needed where.
* It would be nice if the clang build system could output a list of all possible support functions it might need for compiler being built. That list could drive what parts of compiler-rt need to be built.
So, to me an ideal build system for compiler-rt would not just compile the snippets of code, it would figure out which snippets to build based on what the compiler needs and what the OS needs/provides.
On Jan 30, 2014, at 1:50 PM, Reid Kleckner <r...@google.com> wrote:
On Thu, Jan 30, 2014 at 1:19 PM, Renato Golin <renato...@linaro.org> wrote:
On 30 January 2014 20:33, Reid Kleckner <r...@google.com> wrote:
Basically, compiler-rt contains the only runtime libraries we ship with Clang. The sanitizers are runtime libraries shipped with clang (they have some version dependence), so they went in compiler-rt. Now they are starting to feel much larger than compiler-rt, so perhaps they should be split out.
Or we can leave them there and solve your ARM build problems a different way.Right, I apologise for my lack of specificity... I do remember that thread, what I was referring to was exactly what you said.My premise:1. I want to make Compiler-RT work on ARM and be a drop-in replacement for libgcc, to the point where it'll become the standard compiler library for LLVM in the near future. My bold plans are to have that in 3.5, but I won't be unhappy if we at least get it working until then.2. I don't want to have the huge effort right now, to port a library that was mainly developed by and on x86_64 *just because* I want compiler-rt to work on ARM.This can work in several ways:A. I compile the whole lot, but only grab the compiler-rt library when packaging.B. I change the CMalke files to only compiler RT on ARM, or any other architecture that wants only RTC. We split the librariesIf the consensus is that the sanitizers are a lot bigger than RT and should split for that reason, I'm fine with it. If not, I'm also fine with having a CMake configuration to only build what's needed. I'd be less fine with compiling everything, testing (or ignoring) everything, because that'll strain our native bots (that are still dead slow) and will also increase the signal-to-noise ration on bugs and crashes, but ultimately, I would be ok with it, as a first approach.I don't see any compelling reason to split the sanitizers out today. I think the sanitizer guys would probably take a patch to CMakeLists.txt to disable the sanitizer RTLs.
One organizational thought to add:For us, the sanitizers contain behaviors/syscalls that are not valid on consumer hardware. They perform "debug" functionality and thus can only operate on special developer kits. Additionally, we need to put this type of code into a dynamic library instead of a static library to avoid versioning problems.I agree that this is all part of compiler_rt as a project/repo, but the sanitizers should remain segregated into their own runtime library.
On 1 February 2014 00:44, Nick Kledzik <kle...@apple.com> wrote:* One of the interesting things about compiler-rt is the static library to dynamic library migration (e.g. libgcc.a vs libgcc_s.so, or on Darwin libclang_*.a vs libSystem.dylib). If the shared library ships independently from the compiler, then the compiler may need a .a file that can ship with it that contains any support functions not available in a shared library on the target. Currently, it is a very manual process to figure out which functions are needed where.
* It would be nice if the clang build system could output a list of all possible support functions it might need for compiler being built. That list could drive what parts of compiler-rt need to be built.
So, to me an ideal build system for compiler-rt would not just compile the snippets of code, it would figure out which snippets to build based on what the compiler needs and what the OS needs/provides.Hi Nick,These features would be great, but I think it's too complex to migrate from what we have today to that scenario and people won't buy-in that easily.I think the fact that all sanitizers, profilers and possibly unwinders have their libraries in there is a good reason for us to have separate builds of each library and treat "Compiler-RT" as a repository for run-time libraries, rather than a library in itself.I'm in favour of naming what we call today "compiler-rt" to "libclang" and moving libcxxabi into it as "libunwind" or anything relevant, but to softly migrate the interactions between RT and Clang over time.
A few steps like:1. Move libraries in, rename, compile everything everytime2. Separate libraries' build systems, disable via flags / arch support (on both clang and rt)3. Get Clang to list *libraries* needed, and make RT's make system to only build those4. Get Clang to list *functions* needed, and update RT's make system accordinglyI think having step 3 would be amazing, but 2 is already good for all practical purposes. Step 4 is way past *my* needs, but I don't think it's a bad thing to have.cheers,--renato
FYI the name "libclang" is already in use <http://clang.llvm.org/docs/Tooling.html#libclang>, so a different name would need to be chosen.