This is an archive of the discontinued LLVM Phabricator instance.

Differential D117062

[BOLT] Update README build instructions
ClosedPublic

Authored by Amir on Jan 11 2022, 3:51 PM.

Details

Reviewers
maksfb
Commits
rG65d39942dce1: [BOLT] Update README build instructions
Summary

Mehdi spotted that our build instructions don't make sense in a monorepo:
https://github.com/facebookincubator/BOLT/pull/269.

Diff Detail

Event Timeline

Amir requested review of this revision.Jan 11 2022, 3:51 PM
Amir created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptJan 11 2022, 3:51 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Amir added a reviewer: maksfb.Jan 11 2022, 3:56 PM
Amir updated this revision to Diff 399108.Jan 11 2022, 4:04 PM

Removed clang and lld build from instructions (only needed for check-bolt)

Amir retitled this revision from [BOLT] Updated README build instructions assuming BOLT is in monorepo to [BOLT] Updated README build instructions.Jan 11 2022, 4:07 PM
Amir edited the summary of this revision. (Show Details)
Amir retitled this revision from [BOLT] Updated README build instructions to [BOLT] Update README build instructions.Jan 11 2022, 4:35 PM
Amir edited the summary of this revision. (Show Details)
Harbormaster completed remote builds in B142766: Diff 399108.Jan 11 2022, 4:56 PM
maksfb accepted this revision.Jan 11 2022, 4:58 PM

LGTM

This revision is now accepted and ready to land.Jan 11 2022, 4:58 PM
This revision was landed with ongoing or failed builds.Jan 11 2022, 9:26 PM
Closed by commit rG65d39942dce1: [BOLT] Update README build instructions (authored by Amir). · Explain Why
This revision was automatically updated to reflect the committed changes.
Amir Aupov <amir.aupov@gmail.com> added a commit: rG65d39942dce1: [BOLT] Update README build instructions.

Revision Contents

PathSize
bolt/
11 lines

Diff 399198

bolt/README.md

Show All 40 Lines
Alternatively, you can build BOLT manually using the steps below. Alternatively, you can build BOLT manually using the steps below.
### Manual Build ### Manual Build
BOLT heavily uses LLVM libraries, and by design, it is built as one of LLVM BOLT heavily uses LLVM libraries, and by design, it is built as one of LLVM
tools. The build process is not much different from a regular LLVM build. tools. The build process is not much different from a regular LLVM build.
The following instructions are assuming that you are running under Linux. The following instructions are assuming that you are running under Linux.
Start with cloning LLVM and BOLT repos: Start with cloning LLVM repo:
``` ```
> git clone https://github.com/facebookincubator/BOLT llvm-bolt > git clone https://github.com/llvm/llvm-project.git
> mkdir build > mkdir build
> cd build > cd build
> cmake -G Ninja ../llvm-bolt/llvm -DLLVM_TARGETS_TO_BUILD="X86;AArch64" -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON -DLLVM_ENABLE_PROJECTS="clang;lld;bolt" > cmake -G Ninja ../llvm-project/llvm -DLLVM_TARGETS_TO_BUILD="X86;AArch64" -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON -DLLVM_ENABLE_PROJECTS="bolt"
> ninja > ninja bolt
``` ```
`llvm-bolt` will be available under `bin/`. Add this directory to your path to `llvm-bolt` will be available under `bin/`. Add this directory to your path to
ensure the rest of the commands in this tutorial work. ensure the rest of the commands in this tutorial work.
Note that we use a specific snapshot of LLVM monorepo as we currently
rely on a set of patches that are not yet upstreamed.
## Optimizing BOLT's Performance ## Optimizing BOLT's Performance
BOLT runs many internal passes in parallel. If you foresee heavy usage of BOLT runs many internal passes in parallel. If you foresee heavy usage of
BOLT, you can improve the processing time by linking against one of memory BOLT, you can improve the processing time by linking against one of memory
allocation libraries with good support for concurrency. E.g. to use jemalloc: allocation libraries with good support for concurrency. E.g. to use jemalloc:
``` ```
> sudo yum install jemalloc-devel > sudo yum install jemalloc-devel
▲ Show 20 Lines • Show All 137 Lines • Show Last 20 Lines