Out-Of-Process Interpreter for CppInterOp #717
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| inline std::unique_ptr<clang::Interpreter> | ||
| createClangInterpreter(std::vector<const char*>& args) { | ||
| createClangInterpreter(std::vector<const char*>& args, int stdin_fd = 0, |
There was a problem hiding this comment.
warning: no header providing "std::vector" is directly included [misc-include-cleaner]
lib/CppInterOp/Compatibility.h:14:
+ #include <vector>| m_FD = fileno(m_TempFile); | ||
| m_OwnsFile = false; | ||
| } else { | ||
| m_TempFile = tmpfile(); |
There was a problem hiding this comment.
warning: assigning newly created 'gsl::owner<>' to non-owner 'FILE *' (aka '_IO_FILE *') [cppcoreguidelines-owning-memory]
m_TempFile = tmpfile();
^| ~StreamCaptureInfo() { | ||
| assert(m_DupFD == -1 && "Captured output not used?"); | ||
| if (m_TempFile && m_OwnsFile) { | ||
| fclose(m_TempFile); |
There was a problem hiding this comment.
warning: calling legacy resource function without passing a 'gsl::owner<>' [cppcoreguidelines-owning-memory]
fclose(m_TempFile);
^| size_t newLen = | ||
| fread(content.get(), sizeof(char), bufsize, m_TempFile.get()); | ||
| if (ferror(m_TempFile.get()) != 0) | ||
| size_t newLen = fread(content.get(), sizeof(char), bufsize, m_TempFile); |
There was a problem hiding this comment.
warning: The 1st argument to 'fread' is a buffer with size 0 but should be a buffer with size equal to or greater than the value of the 2nd argument (which is 1) times the 3rd argument (which is 18446744073709551615) [clang-analyzer-unix.StdCLibraryFunctions]
size_t newLen = fread(content.get(), sizeof(char), bufsize, m_TempFile);
^Additional context
lib/CppInterOp/CppInterOp.cpp:4409: Calling 'StreamCaptureInfo::GetCapturedString'
std::string result = SCI.GetCapturedString();
^lib/CppInterOp/CppInterOp.cpp:4356: Taking false branch
if (dup2(m_DupFD, m_FD) < 0)
^lib/CppInterOp/CppInterOp.cpp:4359: Taking false branch
if (fseek(m_TempFile, 0L, SEEK_END) != 0)
^lib/CppInterOp/CppInterOp.cpp:4363: Assuming that 'ftell' fails
long bufsize = ftell(m_TempFile);
^lib/CppInterOp/CppInterOp.cpp:4363: 'bufsize' initialized here
long bufsize = ftell(m_TempFile);
^lib/CppInterOp/CppInterOp.cpp:4364: Taking true branch
if (bufsize == -1)
^lib/CppInterOp/CppInterOp.cpp:4368: Storing uninitialized value
std::unique_ptr<char[]> content(new char[bufsize + 1]);
^lib/CppInterOp/CppInterOp.cpp:4368: Passing value via 1st parameter '__p'
std::unique_ptr<char[]> content(new char[bufsize + 1]);
^lib/CppInterOp/CppInterOp.cpp:4368: Calling constructor for 'unique_ptr<char[], std::default_delete<char[]>>'
std::unique_ptr<char[]> content(new char[bufsize + 1]);
^/usr/include/c++/13/bits/unique_ptr.h:603: Calling constructor for '__uniq_ptr_data<char, std::default_delete<char[]>, true, true>'
: _M_t(__p)
^/usr/include/c++/13/bits/unique_ptr.h:603: Passing '' via 1st parameter '__p'
: _M_t(__p)
^/usr/include/c++/13/bits/unique_ptr.h:603: Calling constructor for '__uniq_ptr_impl<char, std::default_delete<char[]>>'
: _M_t(__p)
^/usr/include/c++/13/bits/unique_ptr.h:175: Calling '__uniq_ptr_impl::_M_ptr'
__uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; }
^/usr/include/c++/13/bits/unique_ptr.h:196: Calling 'get<0UL, char *, std::default_delete<char[]>>'
pointer& _M_ptr() noexcept { return std::get<0>(_M_t); }
^/usr/include/c++/13/tuple:1803: Calling '__get_helper<0UL, char *, std::default_delete<char[]>>'
{ return std::__get_helper<__i>(__t); }
^/usr/include/c++/13/tuple:1787: Calling '_Tuple_impl::_M_head'
{ return _Tuple_impl<__i, _Head, _Tail...>::_M_head(__t); }
^/usr/include/c++/13/tuple:268: Calling '_Head_base::_M_head'
_M_head(_Tuple_impl& __t) noexcept { return _Base::_M_head(__t); }
^/usr/include/c++/13/tuple:268: Returning from '_Head_base::_M_head'
_M_head(_Tuple_impl& __t) noexcept { return _Base::_M_head(__t); }
^/usr/include/c++/13/tuple:1787: Returning from '_Tuple_impl::_M_head'
{ return _Tuple_impl<__i, _Head, _Tail...>::_M_head(__t); }
^/usr/include/c++/13/tuple:1803: Returning from '__get_helper<0UL, char *, std::default_delete<char[]>>'
{ return std::__get_helper<__i>(__t); }
^/usr/include/c++/13/bits/unique_ptr.h:196: Returning from 'get<0UL, char *, std::default_delete<char[]>>'
pointer& _M_ptr() noexcept { return std::get<0>(_M_t); }
^/usr/include/c++/13/bits/unique_ptr.h:175: Returning from '__uniq_ptr_impl::_M_ptr'
__uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; }
^/usr/include/c++/13/bits/unique_ptr.h:175: The value of '__p' is assigned to 'content._M_t._M_t._M_head_impl'
__uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; }
^/usr/include/c++/13/bits/unique_ptr.h:603: Returning from constructor for '__uniq_ptr_impl<char, std::default_delete<char[]>>'
: _M_t(__p)
^/usr/include/c++/13/bits/unique_ptr.h:603: Returning from constructor for '__uniq_ptr_data<char, std::default_delete<char[]>, true, true>'
: _M_t(__p)
^lib/CppInterOp/CppInterOp.cpp:4368: Returning from constructor for 'unique_ptr<char[], std::default_delete<char[]>>'
std::unique_ptr<char[]> content(new char[bufsize + 1]);
^lib/CppInterOp/CppInterOp.cpp:4371: Taking false branch
if (fseek(m_TempFile, 0L, SEEK_SET) != 0)
^lib/CppInterOp/CppInterOp.cpp:4375: The 1st argument to 'fread' is a buffer with size 0 but should be a buffer with size equal to or greater than the value of the 2nd argument (which is 1) times the 3rd argument (which is 18446744073709551615)
size_t newLen = fread(content.get(), sizeof(char), bufsize, m_TempFile);
^| struct FileDeleter { | ||
| void operator()(FILE* f /* owns */) { | ||
| if (f) | ||
| fclose(f); |
There was a problem hiding this comment.
warning: calling legacy resource function without passing a 'gsl::owner<>' [cppcoreguidelines-owning-memory]
fclose(f);
^| "with in-process JIT execution.\n"; | ||
| io_ctx->outOfProcess = false; | ||
| } else { | ||
| stdin_fd = fileno(io_ctx->stdin_file.get()); |
There was a problem hiding this comment.
warning: no header providing "fileno" is directly included [misc-include-cleaner]
lib/CppInterOp/CppInterOpInterpreter.h:25:
- #if CLANG_VERSION_MAJOR >= 19
+ #include <stdio.h>
+ #if CLANG_VERSION_MAJOR >= 19|
|
||
| return std::unique_ptr<Interpreter>(new Interpreter(std::move(CI))); | ||
| return std::unique_ptr<Interpreter>( | ||
| new Interpreter(std::move(CI), std::move(io_ctx))); |
There was a problem hiding this comment.
warning: use std::make_unique instead [modernize-make-unique]
| new Interpreter(std::move(CI), std::move(io_ctx))); | |
| return std::make_unique<Interpreter>( | |
| std::move(CI), std::move(io_ctx)); |
| operator const clang::Interpreter&() const { return *inner; } | ||
| operator clang::Interpreter&() { return *inner; } | ||
|
|
||
| bool isOutOfProcess() const { |
There was a problem hiding this comment.
warning: function 'isOutOfProcess' should be marked [[nodiscard]] [modernize-use-nodiscard]
| bool isOutOfProcess() const { | |
| [[nodiscard]] bool isOutOfProcess() const { |
| return llvm::orc::ExecutorAddr(*AddrOrErr); | ||
| } | ||
|
|
||
| pid_t getOutOfProcessExecutorPID() const { |
There was a problem hiding this comment.
warning: function 'getOutOfProcessExecutorPID' should be marked [[nodiscard]] [modernize-use-nodiscard]
| pid_t getOutOfProcessExecutorPID() const { | |
| [[nodiscard]] pid_t getOutOfProcessExecutorPID() const { |
| return llvm::orc::ExecutorAddr(*AddrOrErr); | ||
| } | ||
|
|
||
| pid_t getOutOfProcessExecutorPID() const { |
There was a problem hiding this comment.
warning: method 'getOutOfProcessExecutorPID' can be made static [readability-convert-member-functions-to-static]
| pid_t getOutOfProcessExecutorPID() const { | |
| static pid_t getOutOfProcessExecutorPID() { |
| return llvm::orc::ExecutorAddr(*AddrOrErr); | ||
| } | ||
|
|
||
| pid_t getOutOfProcessExecutorPID() const { |
There was a problem hiding this comment.
warning: no header providing "pid_t" is directly included [misc-include-cleaner]
lib/CppInterOp/CppInterOpInterpreter.h:25:
- #if CLANG_VERSION_MAJOR >= 19
+ #include <sched.h>
+ #if CLANG_VERSION_MAJOR >= 19| if (llvm::sys::RunningOnValgrind()) | ||
| GTEST_SKIP() << "XFAIL due to Valgrind report"; | ||
| TestUtils::CreateInterpreter(); | ||
| pid_t pid = Cpp::GetExecutorPID(); |
There was a problem hiding this comment.
warning: no header providing "pid_t" is directly included [misc-include-cleaner]
unittests/CppInterOp/FunctionReflectionTest.cpp:15:
- #include <string>
+ #include <sched.h>
+ #include <string>| testing::internal::CaptureStderr(); | ||
| Cpp::Process("int c = 12;"); | ||
| cerrs = testing::internal::GetCapturedStderr(); | ||
| std::cout << cerrs << std::endl; |
There was a problem hiding this comment.
warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]
| std::cout << cerrs << std::endl; | |
| std::cout << cerrs << '\n'; |
| testing::internal::CaptureStderr(); | ||
| Cpp::Process("int c = 12;"); | ||
| cerrs = testing::internal::GetCapturedStderr(); | ||
| std::cout << cerrs << std::endl; |
There was a problem hiding this comment.
warning: no header providing "std::cout" is directly included [misc-include-cleaner]
unittests/CppInterOp/InterpreterTest.cpp:2:
+ #include <iostream>| testing::internal::CaptureStderr(); | ||
| Cpp::Process("int c = 12;"); | ||
| cerrs = testing::internal::GetCapturedStderr(); | ||
| std::cout << cerrs << std::endl; |
There was a problem hiding this comment.
warning: no header providing "std::endl" is directly included [misc-include-cleaner]
unittests/CppInterOp/InterpreterTest.cpp:2:
+ #include <ostream>| } | ||
| } | ||
|
|
||
| TInterp_t |
There was a problem hiding this comment.
warning: no header providing "TInterp_t" is directly included [misc-include-cleaner]
unittests/CppInterOp/Utils.cpp:13:
- #include <string>
+ #include <clang-c/CXCppInterOp.h>
+ #include <string>
| GTEST_SKIP() << "XFAIL due to Valgrind report"; | ||
| std::vector<const char*> interpreter_args = { "-include", "new" }; | ||
| auto* I = Cpp::CreateInterpreter(interpreter_args); | ||
| std::vector<const char*> interpreter_args = {"-include", "new"}; |
There was a problem hiding this comment.
warning: no header providing "std::vector" is directly included [misc-include-cleaner]
unittests/CppInterOp/InterpreterTest.cpp:2:
+ #include <vector>| TEST(InterpreterTest, CreateInterpreterCAPI) { | ||
| const char* argv[] = {"-std=c++17"}; | ||
| auto *CXI = clang_createInterpreter(argv, 1); | ||
| auto* CXI = clang_createInterpreter(argv, 1); |
There was a problem hiding this comment.
warning: do not implicitly decay an array into a pointer; consider using gsl::array_view or an explicit cast instead [cppcoreguidelines-pro-bounds-array-to-pointer-decay]
auto* CXI = clang_createInterpreter(argv, 1);
^| #endif | ||
| const char* argv[] = {"-fsyntax-only", "-Xclang", "-invalid-plugin"}; | ||
| auto *CXI = clang_createInterpreter(argv, 3); | ||
| auto* CXI = clang_createInterpreter(argv, 3); |
There was a problem hiding this comment.
warning: do not implicitly decay an array into a pointer; consider using gsl::array_view or an explicit cast instead [cppcoreguidelines-pro-bounds-array-to-pointer-decay]
auto* CXI = clang_createInterpreter(argv, 3);
^| Cpp::GetIncludePaths(includes); | ||
| EXPECT_NE(std::find(includes.begin(), includes.end(), "/non/existent/"), | ||
| std::end(includes)); | ||
| std::end(includes)); |
There was a problem hiding this comment.
warning: no header providing "std::end" is directly included [misc-include-cleaner]
unittests/CppInterOp/InterpreterTest.cpp:2:
+ #include <iterator>
Vipul-Cariappa
force-pushed
the
cppinterop-out
branch
from
c56d565 to
7217df9
Compare
|
Before pushing commits to this PR please either ping me, or delete caches as they are made. This PR has caused a large number of llvm cached builds to be deleted on main, which in turn has required multiple PRs workflow runs to be stopped while the cache is rebuilt. |
| valgrind --show-error-list=yes --track-origins=yes --error-exitcode=1 unittests/CppInterOp/CppInterOpTests/unittests/bin/${{ env.BUILD_TYPE }}/CppInterOpTests | ||
| fi | ||
| if [[ "${{ matrix.oop-jit }}" == "On" ]]; then | ||
| ./unittests/CppInterOp/CppInterOpTests/unittests/bin/${{ env.BUILD_TYPE }}/CppInterOpTests --use-oop-jit |
There was a problem hiding this comment.
This --use-oop-jit option should be taken care of in the cmakelists.txt
CppInterOp/unittests/CMakeLists.txt
Line 48 in 0aa859b
There was a problem hiding this comment.
when LLVM_BUILT_WITH_OOP_JIT is on, the tests need to be run two times. First in-process and second time out-of-process. It does make easy for the users to run tests explicitly by just passing a flag.
There was a problem hiding this comment.
There is no reason for the user to need to run the tests manually with this flag. You can make the cmake execute two commands (once with the flag and once without), when LLVM_BUILT_WITH_OOP_JIT is on. @vgvassilev What is your opinion on this?
There was a problem hiding this comment.
I thought we resolved the static compilation flag already. It should be a runtime flag that we pass to the interpreter and in this way we can make this a test thing.
| separate_arguments(LLVM_DEFINITIONS_LIST NATIVE_COMMAND ${LLVM_DEFINITIONS}) | ||
| add_definitions(${LLVM_DEFINITIONS_LIST}) | ||
|
|
||
| string(REGEX REPLACE "/build/lib/cmake/llvm$" "" LLVM_SOURCE_DIR "${LLVM_DIR}") |
There was a problem hiding this comment.
Although it is convention to name the build folder build, it doesn't necessarily have to be.
| } | ||
|
|
||
| #ifndef _WIN32 | ||
| pid_t getOutOfProcessExecutorPID() const { |
There was a problem hiding this comment.
warning: function 'getOutOfProcessExecutorPID' should be marked [[nodiscard]] [modernize-use-nodiscard]
| pid_t getOutOfProcessExecutorPID() const { | |
| [[nodiscard]] pid_t getOutOfProcessExecutorPID() const { |
| } | ||
|
|
||
| #ifndef _WIN32 | ||
| pid_t getOutOfProcessExecutorPID() const { |
There was a problem hiding this comment.
warning: method 'getOutOfProcessExecutorPID' can be made static [readability-convert-member-functions-to-static]
| pid_t getOutOfProcessExecutorPID() const { | |
| static pid_t getOutOfProcessExecutorPID() { |
| } | ||
|
|
||
| #ifndef _WIN32 | ||
| pid_t getOutOfProcessExecutorPID() const { |
There was a problem hiding this comment.
warning: no header providing "pid_t" is directly included [misc-include-cleaner]
lib/CppInterOp/CppInterOpInterpreter.h:25:
- #if CLANG_VERSION_MAJOR >= 19
+ #include <sched.h>
+ #if CLANG_VERSION_MAJOR >= 19
No description provided.