This is an archive of the discontinued LLVM Phabricator instance.

Paths

Table of Contentst

-
polly/www/
-
www/
10/11
get_started.html
-
polly.sh

Differential D111685

[Polly][NFC] Clean up Polly's getting started docs
ClosedPublic

Authored by InnovativeInventor on Oct 12 2021, 4:07 PM.

Download Raw Diff

Details

Reviewers

Meinersbur
bollu
InnovativeInventor

Commits

rG5f668bba5574: [Polly] Clean up Polly's getting started docs.

Summary

This patch removes the broken bash scipt (polly.sh) and fixes the broken setup
instructions in get_started.html. It also adds instructions for using Ninja and
links to the LLVM getting started page.

Diff Detail

Repository: rG LLVM Github Monorepo

Event Timeline

InnovativeInventor created this revision.Oct 12 2021, 4:07 PM

Herald added a reviewer: bollu. · View Herald TranscriptOct 12 2021, 4:07 PM

InnovativeInventor requested review of this revision.Oct 12 2021, 4:07 PM

Herald added a project: Restricted Project. · View Herald TranscriptOct 12 2021, 4:07 PM

Herald added a subscriber: llvm-commits. · View Herald Transcript

InnovativeInventor added a project: Restricted Project.Oct 12 2021, 4:09 PM

InnovativeInventor retitled this revision from [polly][NFC] Clean up Polly's getting started docs to [Polly][NFC] Clean up Polly's getting started docs.

InnovativeInventor edited reviewers, added: Meinersbur; removed: bollu.

InnovativeInventor added a subscriber: pollydev.

Herald added a reviewer: bollu. · View Herald TranscriptOct 12 2021, 4:10 PM

Harbormaster completed remote builds in B128498: Diff 379218.Oct 12 2021, 4:25 PM

Thanks for the patch!

Could also add an example invocation on how to use Polly after compiling, such as bin/clang -O3 -mllvm -polly hello.c?

For consistency with the rest of the documentation (from the doc/), it would be nicer to have it generated with Sphinx, but I don't require it.

polly/www/get_started.html
18	Ninja and CMake are not alternatives of each other. Your can build LLVM with either CMake and ninja (`cmake -GNinja`), CMake and make (`cmake -G"Unix Makefiles"`), or most other generators supported by CMake, such as XCode, Visual Studio.
19	I myself am using Visual Studio
29	Did you try this? How much disk space does it save?
36	This will create a debug build which may use a lot of memory to build and is slow. For starters, I'd recommend a Release+Assert build unless one starts using a debugger (or wants accurate line numbers in crash traces). I.e. `-DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON`. What do you think?
51	Why this line again? Once configured with CMake, there is no need to configure again.
53–59	If we want to be generator-agnostic, we can also use `cmake --build . --target check-polly`

Add Polly invocation instructions and resolve cmake/ninja confusion

Harbormaster completed remote builds in B128513: Diff 379243.Oct 12 2021, 6:29 PM

InnovativeInventor marked 2 inline comments as done.Oct 12 2021, 6:30 PM

InnovativeInventor added inline comments.

polly/www/get_started.html
18	Oh, whoops. Just fixed this -- thanks for clarifiying!
29	It saves a non-trivial amount. A full clone takes about 3.2 GB, whereas a shallow clone takes about 1.5 GB (so ~53% reduction).
36	Sounds good -- just added it.

You uploaded a diff to your previous diff. Please upload a diff to LLVM's top-of-tree.

polly/www/get_started.html
13	Why remove the menu?
63	This is already out-of date. Latest release note is https://polly.llvm.org/docs/ReleaseNotes.html, but I don't think this is relevant for a getting_started.

This revision now requires changes to proceed.Oct 12 2021, 7:40 PM

I added a proper diff (I think) and added back the mistakenly removed menu that I didn't intend to commit.

Harbormaster completed remote builds in B128701: Diff 379498.Oct 13 2021, 1:09 PM

LGTM. Thanks for the patch.

Would you like me to land the patch for you?

This revision is now accepted and ready to land.Oct 13 2021, 1:22 PM

Yes, thanks!

Closed by commit rG5f668bba5574: [Polly] Clean up Polly's getting started docs. (authored by Meinersbur). · Explain WhyOct 14 2021, 10:28 AM

This revision was automatically updated to reflect the committed changes.

Meinersbur added a commit: rG5f668bba5574: [Polly] Clean up Polly's getting started docs..

Thanks for your contribution! I removed the [NFC] tag before committing since there isn't really behavioral change for documentation.

Revision Contents

Path

Size

polly/

www/

get_started.html

65 lines

polly.sh

Diff 379761

polly/www/get_started.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"

"http://www.w3.org/TR/html4/strict.dtd"> "http://www.w3.org/TR/html4/strict.dtd">

<title>Polly - Getting Started</title> <title>Polly - Getting Started</title>

</head> </head>

MeinersburUnsubmitted

Not Done

Why remove the menu?

Meinersbur: Why remove the menu?

<h1>Building and Installing Polly</h1> <h1>Building and Installing Polly</h1>

You can build Polly with <a href="https://cmake.org/">cmake</a> and your preferred geneator (e.g. Ninja, make, Visual Studio, etc.).

MeinersburUnsubmitted

Done

Ninja and CMake are not alternatives of each other. Your can build LLVM with either CMake and ninja (cmake -GNinja), CMake and make (cmake -G"Unix Makefiles"), or most other generators supported by CMake, such as XCode, Visual Studio.

Meinersbur: Ninja and CMake are not alternatives of each other. Your can build LLVM with either CMake and…

InnovativeInventorAuthorUnsubmitted

Done

Oh, whoops. Just fixed this -- thanks for clarifiying!

InnovativeInventor: Oh, whoops. Just fixed this -- thanks for clarifiying!

MeinersburUnsubmitted

Done

I myself am using Visual Studio

Meinersbur: I myself am using Visual Studio

<h2> Automatic </h2> <h3 id="source">Get the code</h3>

There is a <a href="polly.sh">script</a> available to automatically checkout,

update, build, and test Polly. This script contains all the commands that are

subsequently described on this webpage. The automatic installation consists

of four simple steps:

mkdir polly && cd polly git clone https://github.com/llvm/llvm-project.git

wget https://polly.llvm.org/polly.sh

chmod +x polly.sh

./polly.sh

</pre> </pre>

<h2> Manual </h2> You can also get a shallow clone by running:

git clone https://github.com/llvm/llvm-project.git llvm_git git clone --depth 1 https://github.com/llvm/llvm-project.git

MeinersburUnsubmitted

Done

Did you try this? How much disk space does it save?

Meinersbur: Did you try this? How much disk space does it save?

InnovativeInventorAuthorUnsubmitted

Done

It saves a non-trivial amount. A full clone takes about 3.2 GB, whereas a shallow clone takes about 1.5 GB (so ~53% reduction).

InnovativeInventor: It saves a non-trivial amount. A full clone takes about 3.2 GB, whereas a shallow clone takes…

</pre> </pre>

<h3 id="build">Build Polly</h3> <h3 id="build">Build Polly</h3>

mkdir llvm_build && cd llvm_build mkdir build && cd build

cmake -DLLVM_ENABLE_PROJECTS='polly;clang' ../llvm_git/llvm && make cmake '-DLLVM_ENABLE_PROJECTS=clang;polly' ../llvm

MeinersburUnsubmitted

Done

This will create a debug build which may use a lot of memory to build and is slow. For starters, I'd recommend a Release+Assert build unless one starts using a debugger (or wants accurate line numbers in crash traces). I.e. -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON.

What do you think?

Meinersbur: This will create a debug build which may use a lot of memory to build and is slow. For starters…

InnovativeInventorAuthorUnsubmitted

Done

Sounds good -- just added it.

InnovativeInventor: Sounds good -- just added it.

cmake --build .

</pre> </pre>

You can also pass arguments to cmake to specify a particular generator (e.g. <code>-G Ninja</code>) or the build type (<code>-DCMAKE_BUILD_TYPE=Release</code>).

If you just want to play around with Polly, it is recommended to do a Release+Assert build by passing

<code>-DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON</code>.

<h3> Test Polly</h3> <h3>Test Polly</h3>

<pre>make check-polly</pre> To test Polly, you can run

<h3>Building Polly Without LLVM</h3> <pre>cmake --build . --target check-polly</pre>

It is also possible to build Polly without

also building LLVM. All you need is an installed version of LLVM or a previous

build. To configure Polly to use a pre-built LLVM, set the

<code>-DCMAKE_PREFIX_PATH</code> option:

<pre>cmake -DCMAKE_PREFIX_PATH=${LLVM_PREFIX}/lib/cmake/llvm ../llvm_git/polly</pre>

To run unittests, however, you need to have the LLVM source directory around.

Polly will use the <code>llvm-config</code> of the LLVM you're building against

to guess the location of the source directory. You may override autodetected

location by setting the <code>-DLLVM_SOURCE_ROOT</code> option.

<h3> Troubleshooting</h3> <h3>Using Polly</h3>

MeinersburUnsubmitted

Done

Why this line again? Once configured with CMake, there is no need to configure again.

Meinersbur: Why this line again? Once configured with CMake, there is no need to configure again.

<p>If you get an error in one of the python files, your system probably uses python3 Suppose that you want to compile a program hello.c using Polly.

as default python interpreter. This is the case, for instance, under Arch Linux.

To solve this issue, run <code>cmake</code> again, but with the added argument: To compile it with Polly (in the build folder), you can run:

<code>-DPYTHON_EXECUTABLE=/usr/bin/python2</code> (replace <code>/usr/bin/python2</code>

with the location of the python2 interpreter under your system). <pre>

bin/clang -O3 -mllvm -polly hello.c

</pre>

MeinersburUnsubmitted

Done

<h3> Test Polly (with Ninja)</h3>

- <pre>ninja check Polly</pre>

+ <pre>ninja check-polly</pre>

<h3> Troubleshooting</h3>

If we want to be generator-agnostic, we can also use cmake --build . --target check-polly

Meinersbur: If we want to be generator-agnostic, we can also use `cmake --build . --target check-polly`

<h3> Troubleshooting</h3>

<pre>cmake -DCMAKE_PREFIX_PATH=${ISL_INSTALL} -DPYTHON_EXECUTABLE=/usr/bin/python2 ${LLVM_SRC}</pre> <p>

MeinersburUnsubmitted

Done

This is already out-of date. Latest release note is https://polly.llvm.org/docs/ReleaseNotes.html, but I don't think this is relevant for a getting_started.

Meinersbur: This is already out-of date. Latest release note is https://polly.llvm.org/docs/ReleaseNotes.

If you run out of memory when building with Ninja, try lowering the concurrency of Ninja (e.g. <code> ninja -j 2 </code>).

More tips and tricks to building and using LLVM can be found <a href="https://llvm.org/docs/GettingStarted.html#common-problems">here</a>.

</p>

<p>

For more information on getting started with Polly and LLVM in general, see LLVM's <a href = "https://llvm.org/docs/GettingStarted.html">getting started docs</a>.

</p>

</div> </div>

</body> </body>

</html> </html>

polly/www/polly.sh

This file was deleted.

	#!/bin/bash -xe

	export BASE=`pwd`
	export LLVM_SRC=${BASE}/llvm
	export POLLY_SRC=${LLVM_SRC}/tools/polly
	export CLANG_SRC=${LLVM_SRC}/tools/clang
	export LLVM_BUILD=${BASE}/llvm_build

	if [ -e /proc/cpuinfo ]; then
	procs=`cat /proc/cpuinfo \| grep processor \| wc -l`
	else
	procs=1
	fi

	if ! test -d ${LLVM_SRC}; then
	git clone http://llvm.org/git/llvm.git ${LLVM_SRC}
	fi

	if ! test -d ${POLLY_SRC}; then
	git clone http://llvm.org/git/polly.git ${POLLY_SRC}
	fi

	if ! test -d ${CLANG_SRC}; then
	git clone http://llvm.org/git/clang.git ${CLANG_SRC}
	fi

	mkdir -p ${LLVM_BUILD}
	cd ${LLVM_BUILD}

	cmake ${LLVM_SRC}
	make -j$procs -l$procs
	make check-polly

This is an archive of the discontinued LLVM Phabricator instance.

[Polly][NFC] Clean up Polly's getting started docsClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 379761

polly/www/get_started.html

polly/www/polly.sh

[Polly][NFC] Clean up Polly's getting started docs
ClosedPublic