Add FFI bindings for LLVM's Module::getInstructionCount()#65720

icefoxen · 2019-10-23T13:13:10Z

Just to make it usable for profiling and such inside
rustc itself. It was vaguely useful in
https://wiki.alopex.li/WhereRustcSpendsItsTime and I figured
I might as well upstream it; I may or may not ever get around
to doing more with it (hopefully I will), but it may be useful
for others.

rust-highfive · 2019-10-23T13:13:21Z

r? @nikomatsakis

(rust_highfive has picked a reviewer for you, use r? to override)

Centril · 2019-10-23T13:19:25Z

r? @eddyb

rust-highfive · 2019-10-23T13:43:38Z

The job x86_64-gnu-llvm-6.0 of your PR failed (pretty log, raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.

2019-10-23T13:13:48.2384409Z ##[command]git remote add origin https://github.com/rust-lang/rust
2019-10-23T13:13:48.2580527Z ##[command]git config gc.auto 0
2019-10-23T13:13:48.2649719Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2019-10-23T13:13:48.2713918Z ##[command]git config --get-all http.proxy
2019-10-23T13:13:48.2848909Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/65720/merge:refs/remotes/pull/65720/merge
---
2019-10-23T13:43:08.7645068Z    Compiling rustc_llvm v0.0.0 (/checkout/src/librustc_llvm)
2019-10-23T13:43:14.7373326Z error: failed to run custom build command for `rustc_llvm v0.0.0 (/checkout/src/librustc_llvm)`
2019-10-23T13:43:14.7377900Z 
2019-10-23T13:43:14.7378266Z Caused by:
2019-10-23T13:43:14.7379049Z   process didn't exit successfully: `/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-codegen/release/build/rustc_llvm-ed5e716ea7a9979f/build-script-build` (exit code: 101)
2019-10-23T13:43:14.7379617Z --- stdout
2019-10-23T13:43:14.7380174Z cargo:rerun-if-env-changed=REAL_LIBRARY_PATH_VAR
2019-10-23T13:43:14.7380748Z cargo:rerun-if-env-changed=REAL_LIBRARY_PATH
2019-10-23T13:43:14.7382817Z cargo:rerun-if-changed=/usr/lib/llvm-6.0/bin/llvm-config
2019-10-23T13:43:14.7383517Z cargo:rerun-if-env-changed=LLVM_CONFIG
2019-10-23T13:43:14.7384078Z cargo:rustc-cfg=llvm_component="aarch64"
2019-10-23T13:43:14.7384608Z cargo:rustc-cfg=llvm_component="amdgpu"
2019-10-23T13:43:14.7385159Z cargo:rustc-cfg=llvm_component="arm"
2019-10-23T13:43:14.7385693Z cargo:rustc-cfg=llvm_component="asmparser"
2019-10-23T13:43:14.7386246Z cargo:rustc-cfg=llvm_component="bitreader"
2019-10-23T13:43:14.7386818Z cargo:rustc-cfg=llvm_component="bitwriter"
2019-10-23T13:43:14.7387354Z cargo:rustc-cfg=llvm_component="hexagon"
2019-10-23T13:43:14.7387889Z cargo:rustc-cfg=llvm_component="instrumentation"
2019-10-23T13:43:14.7388440Z cargo:rustc-cfg=llvm_component="ipo"
2019-10-23T13:43:14.7388972Z cargo:rustc-cfg=llvm_component="linker"
2019-10-23T13:43:14.7389511Z cargo:rustc-cfg=llvm_component="lto"
2019-10-23T13:43:14.7390042Z cargo:rustc-cfg=llvm_component="mips"
2019-10-23T13:43:14.7390575Z cargo:rustc-cfg=llvm_component="msp430"
2019-10-23T13:43:14.7391453Z cargo:rustc-cfg=llvm_component="nvptx"
2019-10-23T13:43:14.7392522Z cargo:rustc-cfg=llvm_component="powerpc"
2019-10-23T13:43:14.7393117Z cargo:rustc-cfg=llvm_component="sparc"
2019-10-23T13:43:14.7393685Z cargo:rustc-cfg=llvm_component="systemz"
2019-10-23T13:43:14.7394210Z cargo:rustc-cfg=llvm_component="x86"
2019-10-23T13:43:14.7394740Z cargo:rerun-if-changed-env=LLVM_RUSTLLVM
2019-10-23T13:43:14.7395550Z cargo:rerun-if-changed=../rustllvm/ArchiveWrapper.cpp
2019-10-23T13:43:14.7396163Z cargo:rerun-if-changed=../rustllvm/Linker.cpp
2019-10-23T13:43:14.7397494Z cargo:rerun-if-changed=../rustllvm/.editorconfig
2019-10-23T13:43:14.7398091Z cargo:rerun-if-changed=../rustllvm/PassWrapper.cpp
2019-10-23T13:43:14.7398594Z cargo:rerun-if-changed=../rustllvm/RustWrapper.cpp
2019-10-23T13:43:14.7399085Z cargo:rerun-if-changed=../rustllvm/README
2019-10-23T13:43:14.7399526Z cargo:rerun-if-changed=../rustllvm/rustllvm.h
2019-10-23T13:43:14.7399957Z TARGET = Some("x86_64-unknown-linux-gnu")
2019-10-23T13:43:14.7400183Z OPT_LEVEL = Some("2")
2019-10-23T13:43:14.7400576Z HOST = Some("x86_64-unknown-linux-gnu")
2019-10-23T13:43:14.7401013Z CXX_x86_64-unknown-linux-gnu = Some("sccache c++")
2019-10-23T13:43:14.7402119Z CXXFLAGS_x86_64-unknown-linux-gnu = Some("-ffunction-sections -fdata-sections -fPIC -m64")
2019-10-23T13:43:14.7402350Z CRATE_CC_NO_DEFAULTS = None
2019-10-23T13:43:14.7402760Z DEBUG = Some("false")
2019-10-23T13:43:14.7402930Z CARGO_CFG_TARGET_FEATURE = Some("fxsr,mmx,sse,sse2")
2019-10-23T13:43:14.7404695Z running: "sccache" "c++" "-O2" "-ffunction-sections" "-fdata-sections" "-fPIC" "-m64" "-ffunction-sections" "-fdata-sections" "-fPIC" "-m64" "-I/usr/lib/llvm-6.0/include" "-std=c++0x" "-fuse-ld=gold" "-Wl,--no-keep-files-mapped" "-Wl,--no-map-whole-files" "-fPIC" "-fvisibility-inlines-hidden" "-Werror=date-time" "-std=c++11" "-Wall" "-W" "-Wno-unused-parameter" "-Wwrite-strings" "-Wcast-qual" "-Wno-missing-field-initializers" "-pedantic" "-Wno-long-long" "-Wno-maybe-uninitialized" "-Wdelete-non-virtual-dtor" "-Wno-comment" "-ffunction-sections" "-fdata-sections" "-O2" "-DNDEBUG" "-fno-exceptions" "-D_GNU_SOURCE" "-D__STDC_CONSTANT_MACROS" "-D__STDC_FORMAT_MACROS" "-D__STDC_LIMIT_MACROS" "-DLLVM_COMPONENT_AARCH64" "-DLLVM_COMPONENT_AMDGPU" "-DLLVM_COMPONENT_ARM" "-DLLVM_COMPONENT_ASMPARSER" "-DLLVM_COMPONENT_BITREADER" "-DLLVM_COMPONENT_BITWRITER" "-DLLVM_COMPONENT_HEXAGON" "-DLLVM_COMPONENT_INSTRUMENTATION" "-DLLVM_COMPONENT_IPO" "-DLLVM_COMPONENT_LINKER" "-DLLVM_COMPONENT_LTO" "-DLLVM_COMPONENT_MIPS" "-DLLVM_COMPONENT_MSP430" "-DLLVM_COMPONENT_NVPTX" "-DLLVM_COMPONENT_POWERPC" "-DLLVM_COMPONENT_SPARC" "-DLLVM_COMPONENT_SYSTEMZ" "-DLLVM_COMPONENT_X86" "-DNDEBUG" "-o" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-codegen/x86_64-unknown-linux-gnu/release/build/rustc_llvm-3a1e09189d25ee92/out/../rustllvm/PassWrapper.o" "-c" "../rustllvm/PassWrapper.cpp"
2019-10-23T13:43:14.7405083Z exit code: 0
2019-10-23T13:43:14.7406920Z running: "sccache" "c++" "-O2" "-ffunction-sections" "-fdata-sections" "-fPIC" "-m64" "-ffunction-sections" "-fdata-sections" "-fPIC" "-m64" "-I/usr/lib/llvm-6.0/include" "-std=c++0x" "-fuse-ld=gold" "-Wl,--no-keep-files-mapped" "-Wl,--no-map-whole-files" "-fPIC" "-fvisibility-inlines-hidden" "-Werror=date-time" "-std=c++11" "-Wall" "-W" "-Wno-unused-parameter" "-Wwrite-strings" "-Wcast-qual" "-Wno-missing-field-initializers" "-pedantic" "-Wno-long-long" "-Wno-maybe-uninitialized" "-Wdelete-non-virtual-dtor" "-Wno-comment" "-ffunction-sections" "-fdata-sections" "-O2" "-DNDEBUG" "-fno-exceptions" "-D_GNU_SOURCE" "-D__STDC_CONSTANT_MACROS" "-D__STDC_FORMAT_MACROS" "-D__STDC_LIMIT_MACROS" "-DLLVM_COMPONENT_AARCH64" "-DLLVM_COMPONENT_AMDGPU" "-DLLVM_COMPONENT_ARM" "-DLLVM_COMPONENT_ASMPARSER" "-DLLVM_COMPONENT_BITREADER" "-DLLVM_COMPONENT_BITWRITER" "-DLLVM_COMPONENT_HEXAGON" "-DLLVM_COMPONENT_INSTRUMENTATION" "-DLLVM_COMPONENT_IPO" "-DLLVM_COMPONENT_LINKER" "-DLLVM_COMPONENT_LTO" "-DLLVM_COMPONENT_MIPS" "-DLLVM_COMPONENT_MSP430" "-DLLVM_COMPONENT_NVPTX" "-DLLVM_COMPONENT_POWERPC" "-DLLVM_COMPONENT_SPARC" "-DLLVM_COMPONENT_SYSTEMZ" "-DLLVM_COMPONENT_X86" "-DNDEBUG" "-o" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-codegen/x86_64-unknown-linux-gnu/release/build/rustc_llvm-3a1e09189d25ee92/out/../rustllvm/RustWrapper.o" "-c" "../rustllvm/RustWrapper.cpp"
2019-10-23T13:43:14.7407611Z cargo:warning=../rustllvm/RustWrapper.cpp: In function 'unsigned int LLVMRustGetInstructionCount(LLVMModuleRef)':
2019-10-23T13:43:14.7408251Z cargo:warning=../rustllvm/RustWrapper.cpp:91:21: error: 'class llvm::Module' has no member named 'getInstructionCount'
2019-10-23T13:43:14.7408760Z cargo:warning=   return unwrap(M)->getInstructionCount();
2019-10-23T13:43:14.7408982Z cargo:warning=                     ^
2019-10-23T13:43:14.7409258Z 
2019-10-23T13:43:14.7409611Z --- stderr
2019-10-23T13:43:14.7409999Z thread 'main' panicked at '
2019-10-23T13:43:14.7410167Z 
2019-10-23T13:43:14.7410167Z 
2019-10-23T13:43:14.7429630Z Internal error occurred: Command "sccache" "c++" "-O2" "-ffunction-sections" "-fdata-sections" "-fPIC" "-m64" "-ffunction-sections" "-fdata-sections" "-fPIC" "-m64" "-I/usr/lib/llvm-6.0/include" "-std=c++0x" "-fuse-ld=gold" "-Wl,--no-keep-files-mapped" "-Wl,--no-map-whole-files" "-fPIC" "-fvisibility-inlines-hidden" "-Werror=date-time" "-std=c++11" "-Wall" "-W" "-Wno-unused-parameter" "-Wwrite-strings" "-Wcast-qual" "-Wno-missing-field-initializers" "-pedantic" "-Wno-long-long" "-Wno-maybe-uninitialized" "-Wdelete-non-virtual-dtor" "-Wno-comment" "-ffunction-sections" "-fdata-sections" "-O2" "-DNDEBUG" "-fno-exceptions" "-D_GNU_SOURCE" "-D__STDC_CONSTANT_MACROS" "-D__STDC_FORMAT_MACROS" "-D__STDC_LIMIT_MACROS" "-DLLVM_COMPONENT_AARCH64" "-DLLVM_COMPONENT_AMDGPU" "-DLLVM_COMPONENT_ARM" "-DLLVM_COMPONENT_ASMPARSER" "-DLLVM_COMPONENT_BITREADER" "-DLLVM_COMPONENT_BITWRITER" "-DLLVM_COMPONENT_HEXAGON" "-DLLVM_COMPONENT_INSTRUMENTATION" "-DLLVM_COMPONENT_IPO" "-DLLVM_COMPONENT_LINKER" "-DLLVM_COMPONENT_LTO" "-DLLVM_COMPONENT_MIPS" "-DLLVM_COMPONENT_MSP430" "-DLLVM_COMPONENT_NVPTX" "-DLLVM_COMPONENT_POWERPC" "-DLLVM_COMPONENT_SPARC" "-DLLVM_COMPONENT_SYSTEMZ" "-DLLVM_COMPONENT_X86" "-DNDEBUG" "-o" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-codegen/x86_64-unknown-linux-gnu/release/build/rustc_llvm-3a1e09189d25ee92/out/../rustllvm/RustWrapper.o" "-c" "../rustllvm/RustWrapper.cpp" with args "c++" did not execute successfully (status code exit code: 1).
2019-10-23T13:43:14.7439048Z ', /cargo/registry/src/github.com-1ecc6299db9ec823/cc-1.0.35/src/lib.rs:2398:5
2019-10-23T13:43:14.7439413Z note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.
2019-10-23T13:43:14.7439568Z 
2019-10-23T13:43:14.7440404Z command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/cargo" "build" "-Zconfig-profile" "--target" "x86_64-unknown-linux-gnu" "-Zbinary-dep-depinfo" "-j" "2" "--release" "--locked" "--color" "always" "--manifest-path" "/checkout/src/librustc_codegen_llvm/Cargo.toml" "--features" "" "--message-format" "json-render-diagnostics"
---
2019-10-23T13:43:14.7477741Z   local time: Wed Oct 23 13:43:14 UTC 2019
2019-10-23T13:43:14.8903367Z   network time: Wed, 23 Oct 2019 13:43:14 GMT
2019-10-23T13:43:14.8903533Z == end clock drift check ==
2019-10-23T13:43:17.1689774Z 
2019-10-23T13:43:17.1795224Z ##[error]Bash exited with code '1'.
2019-10-23T13:43:17.1831074Z ##[section]Starting: Checkout
2019-10-23T13:43:17.1833677Z ==============================================================================
2019-10-23T13:43:17.1833734Z Task         : Get sources
2019-10-23T13:43:17.1833795Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

src/rustllvm/RustWrapper.cpp

eddyb · 2019-10-23T13:44:43Z

It doesn't even seem to work on CI, so it might be a new addition?

hanna-kruppe · 2019-10-23T13:51:33Z

This API was added in llvm/llvm-project@e49374d which is in LLVM 7.

JohnCSimon · 2019-10-26T03:30:11Z

Ping from triage:
@eddyb @rkruppe @icefoxen FYI - This PR has sat idle for three days. Thanks.

hanna-kruppe · 2019-10-26T08:49:33Z

So, we can't merge this PR as is because of our LLVM version requirements. This could be solved by adding a version check (LLVM_VERSION_GE, there's many instances of this in src/rustllvm) and calling report_fatal_error on LLVM 6. The only question is whether @icefoxen cares enough to get this patch upstream to do that.

icefoxen · 2019-10-26T21:30:57Z

Sure, I can add it. It's not a huge deal either way but it doesn't look like a lot of work either. Thanks!

icefoxen · 2019-10-27T14:59:40Z

Added a version check. Is there anything more useful this can do besides just returning 0 if the LLVM version < 7, though?

hanna-kruppe · 2019-10-27T15:05:16Z

It's a bit subjective but for this use case (interactive, optional) I personally would crash with an error message to avoid silently producing misleading results. Something like report_fatal_error("Module::getInstructionCount not available before LLVM 7").

icefoxen · 2019-10-27T23:21:23Z

Done, thanks!

hanna-kruppe · 2019-10-28T11:00:57Z

r=me but please squash the commits

JohnCSimon · 2019-11-02T04:16:24Z

Ping from triage
@icefoxen can you please squash the commits?
cc: @rkruppe @eddyb

thanks!

Just to make it useable for profiling and such inside rustc itself. It was vaguely useful in https://wiki.alopex.li/WhereRustcSpendsItsTime and I figured I might as well upstream it; I may or may not ever get around to doing more with it (hopefully I will), but it may be useful for others.

icefoxen · 2019-11-02T14:29:27Z

Thank you triage, commits squashed.

hanna-kruppe · 2019-11-02T14:36:51Z

Thanks!

@bors r+ rollup

bors · 2019-11-02T14:36:52Z

📌 Commit 567962d has been approved by rkruppe

…=rkruppe Add FFI bindings for LLVM's Module::getInstructionCount() Just to make it usable for profiling and such inside rustc itself. It was vaguely useful in https://wiki.alopex.li/WhereRustcSpendsItsTime and I figured I might as well upstream it; I may or may not ever get around to doing more with it (hopefully I will), but it may be useful for others.

@ghost

Rollup of 10 pull requests Successful merges: - #65136 (Update codegen option documentation.) - #65574 (docs: improve disclaimer regarding LinkedList) - #65720 (Add FFI bindings for LLVM's Module::getInstructionCount()) - #65905 ([doc] fixes for unix/vxworks `OpenOptionsExt::mode`) - #65962 (Fix logic in example.) - #66019 (Improved std::iter::Chain documentation) - #66038 (doc(str): show example of chars().count() under len()) - #66042 (Suggest correct code when encountering an incorrect trait bound referencing the current trait) - #66073 (Do not needlessly write-lock) - #66096 (Add a failing UI test for multiple loops of all kinds in a `const`) Failed merges: r? @ghost

rust-highfive assigned nikomatsakis Oct 23, 2019

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 23, 2019

rust-highfive assigned eddyb and unassigned nikomatsakis Oct 23, 2019

eddyb reviewed Oct 23, 2019

View reviewed changes

src/rustllvm/RustWrapper.cpp Outdated Show resolved Hide resolved

icefoxen force-pushed the LLVMgetInstructionCount branch from b79efa8 to 567962d Compare November 2, 2019 14:28

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 2, 2019

emilyalbini mentioned this pull request Nov 5, 2019

Rollup of 10 pull requests #66109

Merged

bors merged commit 567962d into rust-lang:master Nov 5, 2019

Uh oh!

Conversation

icefoxen commented Oct 23, 2019

Uh oh!

rust-highfive commented Oct 23, 2019

Uh oh!

Centril commented Oct 23, 2019

Uh oh!

rust-highfive commented Oct 23, 2019

Uh oh!

Uh oh!

eddyb commented Oct 23, 2019

Uh oh!

hanna-kruppe commented Oct 23, 2019

Uh oh!

JohnCSimon commented Oct 26, 2019

Uh oh!

hanna-kruppe commented Oct 26, 2019

Uh oh!

icefoxen commented Oct 26, 2019

Uh oh!

icefoxen commented Oct 27, 2019

Uh oh!

hanna-kruppe commented Oct 27, 2019

Uh oh!

icefoxen commented Oct 27, 2019

Uh oh!

hanna-kruppe commented Oct 28, 2019

Uh oh!

JohnCSimon commented Nov 2, 2019

Uh oh!

icefoxen commented Nov 2, 2019

Uh oh!

hanna-kruppe commented Nov 2, 2019

Uh oh!

bors commented Nov 2, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants