Clang transpiler integration #756

vyast-softserveinc · 2024-05-13T07:04:18Z

Description

This pull request is aimed for integration occa-transpiler library for providing full C++ support under the OCCA

Added:

option for switching between old & new transpiler transpiler-version

… was used

…tegy

… buildIncludes implementation

examples/cpp/31_oklt_v3_moving_avg/main.cpp

deukhyun-cha · 2024-05-22T14:03:55Z

cmake -DOCCA_CLANG_BASED_TRANSPILER=ON worked for me to get the new transpiler source and generate the build.

README.md

cmake/GitSubmodules.cmake

examples/cpp/31_oklt_v3_moving_avg/main.cpp

src/occa/internal/bin/occa.cpp

…occa.cpp as local function

deukhyun-cha

@kris-rowe, with this initial pass I think it's ready for you and others to take a look. I have tested a successful compilation of OCCA with this cmake option turned on, and without the option enabled it should have no effect. Please let us know if you can think of any other tests or changes to have, otherwise having this in would help us proceed with our new okl kernel development. Thanks!

amikstcyr · 2024-07-04T11:28:55Z

Hi - Any hope that this gets merged?

kris-rowe · 2024-07-26T17:52:15Z

Please take a look at this issue.

YuraCobain · 2024-08-02T10:03:21Z

@kris-rowe the issue is addressed, please take a look and try the fix.

amikstcyr · 2024-08-27T09:05:18Z

@kris-rowe all issues were addressed, can we please have a conclusion on this?

IuriiKobein · 2024-09-20T08:57:19Z

Hi @kris-rowe
If you have any additional comments, questions or concerns I am glad to resolve to merge the PR.

thilinarmtb · 2024-09-20T13:17:17Z

Hi @IuriiKobein, I am planning to test this branch soon. I will let you know if I run into any issues.

thilinarmtb · 2024-09-23T15:54:48Z

I started testing this branch on Frontier at OLCF and I am running into a segmentation
fault when I run 31_oklt_v3_moving_avg test.

I had to make the following changes in occa-transpiler since the CMake 3.26
was not available on Frontier (hope this is not the reason for the segfault).

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2d9cc30..659d44f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.26)
+cmake_minimum_required(VERSION 3.23)
 
 project(occa-transpiler VERSION 0.0.1 LANGUAGES C CXX)
 
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
index 182f1e0..dd8b545 100644
--- a/lib/CMakeLists.txt
+++ b/lib/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.26)
+cmake_minimum_required(VERSION 3.23)
 project (occa-transpiler VERSION 0.0.1 LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 17)
diff --git a/tool/CMakeLists.txt b/tool/CMakeLists.txt
index 543d898..98cdb5c 100644
--- a/tool/CMakeLists.txt
+++ b/tool/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.26)
+cmake_minimum_required(VERSION 3.23)
 project (occa-tool VERSION 0.0.1 LANGUAGES CXX)

Then I followed the build instructions and everything built fine.
When I tried to run the test, I get the following:

[[email protected] 31_oklt_v3_moving_avg]$ export OKLT_LOG_LEVEL=trace
[[email protected] 31_oklt_v3_moving_avg]$ ./examples_cpp_oklt_v3_moving_avg                                                                                                                                                                            
[11:50:40.179] [I] start: OKL_DIRECTIVE_EXPANSION_STAGE [stage_action_runner.cpp:32]                                                                                                                                                                           
[11:50:40.179] [T] input source:                                                                                                                                                                                                                               
                                                                                                                                                                                                                                                               
#include "constants.h"                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                               
template<class T,                                                                                                                                                                                                                                              
         int THREADS,                                                                                                                                                                                                                                          
         int WINDOW>                                                                                                                                                                                                                                           
struct MovingAverage {                                                                                                                                                                                                                                         
    MovingAverage(int inputSize,                                                                                                                                                                                                                               
                  int outputSize,                                                                                                                                                                                                                              
                  T *shared_input,                                                                                                                                                                                                                             
                  T *shared_output)                                                                                                                                                                                                                            
        :_inputSize(inputSize)                                                                                                                                                                                                                                 
        ,_outputSize(outputSize)                                                                                                                                                                                                                               
        ,_shared_data(shared_input)                                                                                                                                                                                                                            
        ,_result_data(shared_output)                                                                                                                                                                                                                           
    {}                                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                               
    void syncCopyFrom(const T *input, int block_idx, int thread_idx) {
        int linearIdx = block_idx * THREADS + thread_idx;
        //INFO: copy base chunk
        if(linearIdx < _inputSize) {
            _shared_data[thread_idx] = input[linearIdx];
        }
        //INFO: copy WINDOW chunk
        int tailIdx = (block_idx + 1) * THREADS + thread_idx;
        if(tailIdx < _inputSize && thread_idx < WINDOW) {
            _shared_data[THREADS + thread_idx] = input[tailIdx];
        }
        @barrier;
    }

    void process(int thread_idx) {
        T sum = T();
        for(int i = 0; i < WINDOW; ++i) {
            sum += _shared_data[thread_idx + i];
        }
        _result_data[thread_idx] = sum / WINDOW;
        @barrier;
    }

    void syncCopyTo(T *output, int block_idx, int thread_idx) { 
        int linearIdx = block_idx * THREADS + thread_idx;
        if(linearIdx < _outputSize) {
            output[linearIdx] = _result_data[thread_idx];
        }
        @barrier;
    }
private:
    int _inputSize;
    int _outputSize;

    //INFO: not supported
    // @shared T _data[THREADS_PER_BLOCK + WINDOW_SIZE];
    // @shared T _result[THREADS_PER_BLOCK];

    T *_shared_data;
    T *_result_data;
};

@kernel void movingAverage32f(@restrict const float *inputData, 
                              int inputSize,
                              @restrict float *outputData,
                              int outputSize)
{
    @outer(0) for (int block_idx = 0; block_idx < outputSize / THREADS_PER_BLOCK + 1; ++block_idx) {
        @shared float blockInput[THREADS_PER_BLOCK + WINDOW_SIZE];
        @shared float blockResult[THREADS_PER_BLOCK];
        MovingAverage<float, THREADS_PER_BLOCK, WINDOW_SIZE> ma{
                inputSize,
                outputSize,
                blockInput,
                blockResult
        };
        @inner(0) for(int thread_idx = 0; thread_idx < THREADS_PER_BLOCK; ++thread_idx) {
            ma.syncCopyFrom(inputData, block_idx, thread_idx);
            ma.process(thread_idx);
            ma.syncCopyTo(outputData, block_idx, thread_idx);
        }
    }
}

 [stage_action_runner.cpp:33]
Segmentation fault

This is the backtrace I get with gdb:

#0  0x00007fffe78bf121 in llvm::vfs::InMemoryFileSystem::addFile(llvm::Twine const&, long, std::unique_ptr<llvm::MemoryBuffer, std::default_delete<llvm::MemoryBuffer> >, std::optional<unsigned int>, std::optional<unsigned int>, std::optional<llvm::sys::fs::file_type>, std::optional<llvm::sys::fs::perms>) () from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#1  0x00007fffe77df5aa in oklt::addInstrinsicStub (session=..., compiler=...) at /ccs/home/thilina/fus166/.local/occa-transpiler/clang/include/llvm/ADT/Twine.h:285
#2  0x00007fffe782dd43 in oklt::StageAction::PrepareToExecuteAction (this=0x4c1a00, compiler=...) at /usr/include/c++/12/bits/shared_ptr_base.h:1665
#3  0x00007fffe973b398 in clang::CompilerInstance::ExecuteAction(clang::FrontendAction&) () from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#4  0x00007fffe7949f0e in clang::tooling::FrontendActionFactory::runInvocation(std::shared_ptr<clang::CompilerInvocation>, clang::FileManager*, std::shared_ptr<clang::PCHContainerOperations>, clang::DiagnosticConsumer*) ()
   from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#5  0x00007fffe79415ac in clang::tooling::ToolInvocation::runInvocation(char const*, clang::driver::Compilation*, std::shared_ptr<clang::CompilerInvocation>, std::shared_ptr<clang::PCHContainerOperations>) ()
   from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#6  0x00007fffe79452d8 in clang::tooling::ToolInvocation::run() () from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#7  0x00007fffe7949456 in clang::tooling::runToolOnCodeWithArgs(std::unique_ptr<clang::FrontendAction, std::default_delete<clang::FrontendAction> >, llvm::Twine const&, llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem>, std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&, llvm::Twine const&, llvm::Twine const&, std::shared_ptr<clang::PCHContainerOperations>) ()
   from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#8  0x00007fffe794993d in clang::tooling::runToolOnCodeWithArgs(std::unique_ptr<clang::FrontendAction, std::default_delete<clang::FrontendAction> >, llvm::Twine const&, std::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > const&, llvm::Twine const&, llvm::Twine const&, std::shared_ptr<clang::PCHContainerOperations>, std::vector<std::pair<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >, std::allocator<std::pair<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > > const&) () from /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/build/lib/libocca-transpiler.so.17
#9  0x00007fffe783266d in oklt::runStageAction (stageName=..., session=...) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/deps/occa-transpiler/lib/pipeline/core/stage_action_runner.cpp:68
#10 0x00007fffe7833144 in oklt::runPipeline (pipeline=..., session=...) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/deps/occa-transpiler/lib/pipeline/core/stage_action_runner.cpp:97
#11 0x00007fffe7829a21 in oklt::normalizeAndTranspile (input=...) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/deps/occa-transpiler/lib/pipeline/normalizer_and_transpiler.cpp:16
#12 0x00007fffed8eaad4 in occa::transpiler::Transpiler::run (this=this@entry=0x7fffffff5140, filename=..., mode=..., kernelProps=...) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/src/occa/internal/utils/transpiler_utils.cpp:135
#13 0x00007fffed8b3ee4 in occa::serial::v3::transpileFile (filename=..., outputFile=..., kernelProps=..., metadata=..., mode=...) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/src/occa/internal/modes/serial/device.cpp:69
#14 0x00007fffed8b7147 in occa::serial::device::buildKernel (this=this@entry=0x478460, filename=..., kernelName=..., kernelHash=..., kernelProps=..., isLauncherKernel=<optimized out>, isLauncherKernel@entry=false)
    at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/src/occa/internal/modes/serial/device.cpp:353
#15 0x00007fffed8b778d in occa::serial::device::buildKernel (this=this@entry=0x478460, filename=..., kernelName=..., kernelHash=..., kernelProps=...)
    at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/src/occa/internal/modes/serial/device.cpp:168
#16 0x00007fffed7010c6 in occa::device::buildKernel (this=this@entry=0x7fffffff5a40, filename=..., kernelName=..., props=...) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/src/core/device.cpp:394
#17 0x0000000000401ea2 in main (argc=<optimized out>, argv=<optimized out>) at /ccs/home/thilina/fus166/Workspace/anl/occa-transpiler/occa/examples/cpp/31_oklt_v3_moving_avg/main.cpp:67

I am using gcc=12.3.0 to build OCCA and doing a release build. I will try a debug build and
see if it gives me more information.

PS: I was actually doing a release build with debug info.

IuriiKobein · 2024-09-23T16:42:32Z

Thanks for report.
At this moment I have a quick question that help us to proceed with a potential fix.

Did clang was installed according to the https://github.com/libocca/occa-transpiler?tab=readme-ov-file#setup-clang-17 section?
If yes which exactly variant was used?

thilinarmtb · 2024-09-23T16:54:14Z

Thanks for report. At this moment I have a quick question that help us to proceed with a potential fix.

Did clang was installed according to the https://github.com/libocca/occa-transpiler?tab=readme-ov-file#setup-clang-17 section? If yes which exactly variant was used?

I installed clang from the source checking out the llvmorg-17.0.6 tag.
Below is the commit:

commit 6009708b4367171ccdbf4b5905cb6a803753fe18 (grafted, HEAD, tag: llvmorg-17.0.6)
Author: Tobias Hieta <[email protected]>
Date:   Tue Nov 28 09:52:28 2023 +0100

    Revert "[runtimes] Add missing test dependencies to check-all (#72955)"
    
    This reverts commit e957e6dcb29d94e4e1678da9829b77009be88926.
    
    The commit was reverted on main because of issues. We will not carry
    this in the release branch for 17.x

These are the configure and build commands I used:

cmake -S llvm -B build -G "Unix Makefiles" \
  -DCMAKE_C_COMPILER=`which gcc` \
  -DCMAKE_CXX_COMPILER=`which g++` \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_INSTALL_PREFIX=~/fus166/.local/occa-transpiler/clang \
  -DLLVM_ENABLE_WERROR=OFF \
  -DLLVM_TARGETS_TO_BUILD='X86' \
  -DLLVM_PARALLEL_LINK_JOBS=1 \
  -DLLVM_ENABLE_RTTI=ON \
  -DCMAKE_POLICY_DEFAULT_CMP0094=NEW \
  -DCMAKE_VERBOSE_MAKEFILE=ON \
  -DCMAKE_FIND_USE_PACKAGE_REGISTRY=OFF \
  -DLLVM_ENABLE_PROJECTS="polly;lld;lldb;clang-tools-extra;llvm;clang" \
  -DLLVM_ENABLE_RUNTIMES="libunwind;libcxx;libcxxabi;compiler-rt" \
  -DLLVM_REQUIRES_RTTI=ON \
  -DLLVM_ENABLE_RTTI=ON \
  -DLLVM_ENABLE_EH=ON \
  -DLLVM_POLLY_LINK_INTO_TOOLS=ON \
  -DLLVM_Z3_INSTALL_DIR=${Z3_INSTALL_DIR} \
  -DLLVM_ENABLE_Z3_SOLVER=OFF

make -C build install -j12

I think the only thing different to the configure command in the instructions
is that I turned-off Z3-solver.

YuraCobain · 2024-09-23T17:44:38Z

So far we couldn't reproduce the issue on our local machines with already setup configuration. The next use the same CMake version and clang build options as yours to catch the issue.

thilinarmtb · 2024-09-23T19:32:44Z

Seems like the reason for the segfault was that I used two different versions
of gcc: one version to build clang and another version to build occa.

Once I used the same gcc version for both, I don't see a segfault anymore.
Now I can run the test but it still fails:

[[email protected] 31_oklt_v3_moving_avg]$ ./examples_cpp_oklt_v3_moving_avg 
Comparison with gold values has failed

I can attach the full log with trace on if that is helpful.

YuraCobain · 2024-09-23T19:47:56Z

Glad that the root cause of segfault is found.
The test example was tested only for CUDA/HIP backends. You could verify it by following options:

examples_cpp_oklt_v3_moving_avg -d "{mode: 'CUDA', device_id: 0}"

We are working to fix it for Serial mode as well that is the default one if -d option is omitted.

thilinarmtb · 2024-09-23T20:11:05Z

Thanks ! Yes, the example passes with HIP backend. I will try to test this on a few more kernels.

… print

IuriiKobein · 2024-09-23T21:41:50Z

Hi Thilina,

The example "31_oklt_v3_moving_avg" is fixed to support host only backends: Serial, OpenMP.
Please pull the latest change and try to fix.
Looking forward for your feedback.

thilinarmtb · 2024-09-24T14:36:20Z

With your latest fix, the tests pass for HIP, Serial and OpenMP backends. I will test this a bit more.

thilinarmtb · 2024-09-24T19:51:01Z

@IuriiKobein : I added a simple kernel which calculates the dot product between two
vectors here. Seems like it fails with the transpiler. The failure is due to transpiler not
recognizing unsigned int. I think OCCA supports unsigned int (I may be wrong).

YuraCobain · 2024-09-24T20:05:05Z

@thilinarmtb please refer the issue reported above for clarification.

thilinarmtb · 2024-09-24T20:22:21Z

Is transpiler version 2 is the same as regular OCCA? Seems like unsigned

@thilinarmtb please refer the issue reported above for clarification.

We will continue the discussion there till the issue is resolved.

ViktorYastrebov and others added 5 commits May 9, 2024 10:55

development based clang transpiler integration

e3c0d25

added missing GitSubmodules.cmake

0bf0c9d

fixes for code review & OpenMP/Serial bug fix of non-polymorphic call…

5fc800e

… was used

refactoring of integration, use function composition & callbacks stra…

240fed3

…tegy

make unchanged files unchanged

0892ad7

vyast-softserveinc mentioned this pull request May 13, 2024

Intergration of new transpiler with C++ full support #749

Closed

vyast-softserveinc added 7 commits May 14, 2024 13:17

fix hipDeviceProp_t type to be the same as original HIP & revert back…

8e2f4a0

… buildIncludes implementation

fix package build without occa-transpiler

3e0f167

update occa-transpiler version to v1.1

9484255

update occa-transpiler to latest devel(fix cuda/hip intrinsics)

1728fe7

update occa-transpiler taggeed version

7a98cc1

move to tag v1.1 occa-transpiler

6186901

added example with occa-transpiler and C++ featured okl kernel

85b3c35

deukhyun-cha reviewed May 22, 2024

View reviewed changes

examples/cpp/31_oklt_v3_moving_avg/main.cpp Show resolved Hide resolved

deukhyun-cha reviewed Jun 6, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

cmake/GitSubmodules.cmake Outdated Show resolved Hide resolved

examples/cpp/31_oklt_v3_moving_avg/main.cpp Outdated Show resolved Hide resolved

src/occa/internal/bin/occa.cpp Show resolved Hide resolved

vyast-softserveinc added 2 commits June 7, 2024 17:04

fixes for code review, move getTranspilerVersion from options to bin/…

5767389

…occa.cpp as local function

update INSTALL.md & README.md documentation files

415ef25

vyast-softserveinc requested a review from deukhyun-cha June 26, 2024 11:55

deukhyun-cha approved these changes Jun 26, 2024

View reviewed changes

kris-rowe added parser OKL labels Jul 25, 2024

IuriiKobein added 2 commits August 1, 2024 13:05

update occa-transpiler repo

73f9381

add option to build new transpiler with local installed clang

02d32bf

fix example of new oklt to support serial, openmp modes; remove debug…

7f82ac6

… print

thilinarmtb mentioned this pull request Sep 25, 2024

Add more tests for clang transpiler vyast-softserveinc/occa#7

Open

add unsigned int to OCCA builtin types

388bb47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clang transpiler integration #756

Clang transpiler integration #756

vyast-softserveinc commented May 13, 2024

deukhyun-cha commented May 22, 2024

deukhyun-cha left a comment

amikstcyr commented Jul 4, 2024

kris-rowe commented Jul 26, 2024

YuraCobain commented Aug 2, 2024

amikstcyr commented Aug 27, 2024 •

edited

Loading

IuriiKobein commented Sep 20, 2024

thilinarmtb commented Sep 20, 2024

thilinarmtb commented Sep 23, 2024 •

edited

Loading

IuriiKobein commented Sep 23, 2024

thilinarmtb commented Sep 23, 2024

YuraCobain commented Sep 23, 2024

thilinarmtb commented Sep 23, 2024 •

edited

Loading

YuraCobain commented Sep 23, 2024 •

edited

Loading

thilinarmtb commented Sep 23, 2024

IuriiKobein commented Sep 23, 2024

thilinarmtb commented Sep 24, 2024

thilinarmtb commented Sep 24, 2024

YuraCobain commented Sep 24, 2024

thilinarmtb commented Sep 24, 2024

Clang transpiler integration #756

Are you sure you want to change the base?

Clang transpiler integration #756

Conversation

vyast-softserveinc commented May 13, 2024

Description

deukhyun-cha commented May 22, 2024

deukhyun-cha left a comment

Choose a reason for hiding this comment

amikstcyr commented Jul 4, 2024

kris-rowe commented Jul 26, 2024

YuraCobain commented Aug 2, 2024

amikstcyr commented Aug 27, 2024 • edited Loading

IuriiKobein commented Sep 20, 2024

thilinarmtb commented Sep 20, 2024

thilinarmtb commented Sep 23, 2024 • edited Loading

IuriiKobein commented Sep 23, 2024

thilinarmtb commented Sep 23, 2024

YuraCobain commented Sep 23, 2024

thilinarmtb commented Sep 23, 2024 • edited Loading

YuraCobain commented Sep 23, 2024 • edited Loading

thilinarmtb commented Sep 23, 2024

IuriiKobein commented Sep 23, 2024

thilinarmtb commented Sep 24, 2024

thilinarmtb commented Sep 24, 2024

YuraCobain commented Sep 24, 2024

thilinarmtb commented Sep 24, 2024

amikstcyr commented Aug 27, 2024 •

edited

Loading

thilinarmtb commented Sep 23, 2024 •

edited

Loading

thilinarmtb commented Sep 23, 2024 •

edited

Loading

YuraCobain commented Sep 23, 2024 •

edited

Loading