Tau clang plugin - Revision history

Nic-wiki: Added misc issue/solution for building LLVM 7 on Aarch64 machines

2021-02-24T00:31:41Z

Added misc issue/solution for building LLVM 7 on Aarch64 machines

← Older revision		Revision as of 00:31, 24 February 2021
Line 50:		Line 50:
	* On PowerPC architectures, all LLVM versions prior to LLVM 9 (included) need to update the file <code>llvm-project/clang/lib/Lex/Lex.cpp</code> from <code>!vec_any_eq((const vector unsigned char)CurPtr, Slashes))</code> to <code> !vec_any_eq((const __vector unsigned char)CurPtr, Slashes)) </code>		* On PowerPC architectures, all LLVM versions prior to LLVM 9 (included) need to update the file <code>llvm-project/clang/lib/Lex/Lex.cpp</code> from <code>!vec_any_eq((const vector unsigned char)CurPtr, Slashes))</code> to <code> !vec_any_eq((const __vector unsigned char)CurPtr, Slashes)) </code>

	== Plugin installation ==		* On Aarch64 architectures, to build LLVM 7, it is needed to replace <code>#ifdef __FLT16_MANT_DIG__</code> by <code>#ifdef __STDC_WANT_IEC_60559_TYPES_EXT__</code> in the the following files: <code>llvm-project/libcxx/include/type_traits</code> and <code>llvm-project/libcxx/test/libcxx/type_traits/is_floating_point.pass.cpp</code>

			== Plugin installation ==

	With LLVM installed, the plugin can be built upon it:		With LLVM installed, the plugin can be built upon it:

2021-02-17T02:16:23Z

Added misc issue solution for building LLVM =<9 on PowerPC machines

← Older revision		Revision as of 02:16, 17 February 2021
Line 39:		Line 39:
	</code>		</code>

	Miscellaneous issues and solutions		<h4>Miscellaneous issues and solutions</h4>

	~~On x86 architectures, LLVM 8 needs the following lines to be added to <code> llvm-project/llvm/include/llvm/Demangle/MicrosoftDemangleNodes.h~~ </~~code~~> :


			* On x86 architectures, LLVM 8 needs the following lines to be added to <code> llvm-project/llvm/include/llvm/Demangle/MicrosoftDemangleNodes.h </code> :
	<code>		<code>
	#include <cstdint>		#include <cstdint>
Line 49:		Line 47:
	#include <string>		#include <string>
	</code>		</code>

			* On PowerPC architectures, all LLVM versions prior to LLVM 9 (included) need to update the file <code>llvm-project/clang/lib/Lex/Lex.cpp</code> from <code>!vec_any_eq((const vector unsigned char)CurPtr, Slashes))</code> to <code> !vec_any_eq((const __vector unsigned char)CurPtr, Slashes)) </code>

	== Plugin installation ==		== Plugin installation ==

2021-02-10T22:09:45Z

Added misc issue solution for building LLVM 8 on x86 machines

← Older revision		Revision as of 22:09, 10 February 2021
Line 37:		Line 37:

	make -j install		make -j install
			</code>

			Miscellaneous issues and solutions

			On x86 architectures, LLVM 8 needs the following lines to be added to <code> llvm-project/llvm/include/llvm/Demangle/MicrosoftDemangleNodes.h </code> :


			<code>
			#include <cstdint>

			#include <string>
	</code>		</code>

2021-01-08T18:38:56Z

← Older revision		Revision as of 18:38, 8 January 2021
Line 6:		Line 6:

	As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. That means an LLVM install is needed, as well as a TAU install.		As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. That means an LLVM install is needed, as well as a TAU install.

			Note: LLVM and the TAU plugin must be compiled using the same compilers.

	== TAU installation ==		== TAU installation ==

2021-01-07T22:46:04Z

@@ Line 5: / Line 5: @@
 = Compilation and installation =
-As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. If no installation is currently accessible, LLVM's installation can be done by following these commands:
+As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. That means an LLVM install is needed, as well as a TAU install.
 <code>
@@ Line 19: / Line 37: @@
 </code>
-That being done the plugin can be built upon LLVM:
+== Plugin installation ==
 <code>

2021-01-07T19:28:55Z

← Older revision		Revision as of 19:28, 7 January 2021
Line 5:		Line 5:
	= Compilation and installation =		= Compilation and installation =

	As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. If no installation is currently accessible LLVM's installation can be done by following these commands:		As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. If no installation is currently accessible, LLVM's installation can be done by following these commands:

	<code>		<code>
Line 11:		Line 11:

	cd llvm-project/llvm		cd llvm-project/llvm

	mkdir build; cd build		mkdir build; cd build

Line 34:		Line 35:
	= Running it =		= Running it =

	The TAU plugin is a function pass, meaning it takes effect during the compilation of the executable to be instrumented. To do so, the compiling command resembles to this:		The TAU plugin is a function pass, meaning it takes effect during the compilation of the executable to be instrumented. To do so, the compiling command resembles this:

	<code>		<code>

2021-01-07T19:23:44Z

2021-01-07T19:13:58Z

← Older revision		Revision as of 19:13, 7 January 2021
Line 33:		Line 33:

	= Running it =		= Running it =

			The TAU plugin is a function pass, meaning it takes effect during the compilation of the executable to be instrumented. To do so, the compiling command resembles to this:

			<code>
			/PATH/TO/LLVM/INSTALLATION/install/bin/clang -fplugin=/PATH/TO/PLUGIN/INSTALLATION/install/lib/TAU_Profiling.so -mllvm -tau-input-file=/PATH/TO/FUNCTION/LISTING/FILE/select.tau -ldl -L/PATH/TO/TAU/lib/SPECIFIC_TAU_INSTALLATION -lTAU -Wl,-rpath,/PATH/TO/TAU/lib/SPECIFIC_TAU_INSTALLATION -lm [project files]
			</code>

			That being done, execute the code by calling:

			<code>
			tau_exec -T clang,serial ./a.out
			</code>

			Then, to access the instrumentation results, call:

			<code>
			pprof
			</code>



	= Packaging =		= Packaging =

2021-01-07T18:37:14Z

← Older revision		Revision as of 18:37, 7 January 2021
Line 1:		Line 1:
			= Use =

			The aim of this plugin is to facilitate the use of TAU. Parsing a function-listing file, the TAU plugin runs a function pass on each function from the original source, adding them to be instrumented if the function-listing file specifies it.

	= Compilation and installation =		= Compilation and installation =

			As TAU relies on LLVM's Intermediate Representation, the TAU plugin is built upon an LLVM installation. If no installation is currently accessible LLVM's installation can be done by following these commands:

			<code>
			git clone https://github.com/llvm/llvm-project.git

			cd llvm-project/llvm
			mkdir build; cd build

			cmake ../../llvm -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$PWD/../install -DLLVM_ENABLE_PROJECTS="clang;mlir;polly;flang;libcxx;libcxxabi"

			make -j install
			</code>

			That being done the plugin can be built upon LLVM:

			<code>
			git clone https://github.com/coti/tau-llvm-plugin.git

			cd tau-llvm-plugin

			mkdir build; cd build

			cmake .. -DCMAKE_INSTALL_PREFIX=$PWD/../install -DLLVM_ROOT=/PATH/TO/LLVM/INSTALLATION/install

			make -j install
			</code>

	= Running it =		= Running it =

2021-01-07T02:42:04Z

Mac OS

← Older revision		Revision as of 02:42, 7 January 2021
Line 7:		Line 7:
	== Linux ==		== Linux ==
	== Mac OS ==		== Mac OS ==

			<code>
			brew install --build-from-source llvm
			</code>