Merge pull request #9 from flopsreallygotit/dev

Add different LLVM versions compatibility

Author: flopsreallygotit

CMakeLists.txt

@@ -1,14 +1,17 @@
-set(LLVM_VERSION 14)
-
-set(CMAKE_C_COMPILER clang-${LLVM_VERSION})
-set(CMAKE_CXX_COMPILER clang++-${LLVM_VERSION})
-
 cmake_minimum_required(VERSION 3.22)
-project(log-pass)
+project(LogPass)
 
 set(CMAKE_CXX_STANDARD 23)
 
 find_package(LLVM ${LLVM_VERSION} REQUIRED CONFIG)
+find_package(Clang ${LLVM_VERSION} REQUIRED)
+
+# Check for Clang compiler
+if(NOT CMAKE_C_COMPILER_ID STREQUAL "Clang" OR NOT CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+    message(FATAL_ERROR "This project requires Clang for compilation.\n"
+        "Detected C compiler: ${CMAKE_C_COMPILER_ID}\n"
+        "Detected C++ compiler: ${CMAKE_CXX_COMPILER_ID}")
+endif()
 
 include(FetchContent)
 FetchContent_Declare(
@@ -18,8 +21,10 @@ FetchContent_Declare(
 FetchContent_MakeAvailable(googletest)
 
 add_definitions(${LLVM_DEFINITIONS})
+add_definitions(${CLANG_DEFINITIONS})
 
 include_directories(${LLVM_INCLUDE_DIRS})
+include_directories(${CLANG_INCLUDE_DIRS})
 link_directories(${LLVM_LIBRARY_DIRS})
 
 add_subdirectory(lib)

README.md

@@ -1,13 +1,13 @@
 # LogPass
 
-LLVM Pass that logs all IR info and collects code coverage. The project is under development.
+LogPass provides compiler wrapper and pass library that logs function traces
 
 # Dependencies
 
 You can install dependencies on Debian/Ubuntu with following command:
 
 ```bash
-sudo apt install clang-14 llvm-14-dev cmake make
+sudo apt install clang-16 llvm-16-dev cmake make
 ```
 
 ## Quick Start
@@ -17,7 +17,7 @@ To build pass library write:
 ```bash
 mkdir build
 cd build
-cmake ..
+cmake .. -DCMAKE_C_COMPILER=clang-16 -DCMAKE_CXX_COMPILER=clang++-16
 make -j
 ```
 
@@ -30,4 +30,7 @@ CC=/path/to/loggercc
 CXX=/path/to/loggercxx
 
 cmake / make / ninja / ...
+./a.out
 ```
+
+You'll receive `logger.log` file with function trace.

lib/log_pass.cpp

@@ -9,14 +9,17 @@
 #include "llvm/IR/PassManager.h"
 #include "llvm/IR/Instruction.h"
 #include "llvm/IR/Instructions.h"
-#include "llvm/Support/Casting.h"
 #include "llvm/IR/DerivedTypes.h"
 
 #include "llvm/Passes/PassPlugin.h"
 #include "llvm/Passes/PassBuilder.h"
 
 #include "llvm/Transforms/Utils/ModuleUtils.h"
 
+#if LLVM_VERSION_MAJOR < 17
+    #include "llvm/InitializePasses.h"
+#endif
+
 namespace {
     using namespace llvm;
 
@@ -71,13 +74,14 @@ namespace {
             IRBuilder<>  builder(llvm_context);
 
             Type *llvm_void_t = Type::getVoidTy(llvm_context);
-            Type *llvm_str_t  = Type::getInt8PtrTy(llvm_context);
-
-            FunctionType  *log_init_function_t = FunctionType::get(llvm_void_t, false);
-            FunctionCallee log_init_function   = module.getOrInsertFunction(log_init_function_name, log_init_function_t);
+#if LLVM_VERSION_MAJOR < 16
+            Type *llvm_str_t = Type::getInt8PtrTy(llvm_context);
+#else
+            Type *llvm_str_t = builder.getPtrTy();
+#endif
 
-            FunctionType  *log_call_function_t = FunctionType::get(llvm_void_t, {llvm_str_t}, false);
-            FunctionCallee log_call_function   = module.getOrInsertFunction(log_call_function_name, log_call_function_t);
+            FunctionCallee log_init_function = module.getOrInsertFunction(log_init_function_name, llvm_void_t);
+            FunctionCallee log_call_function = module.getOrInsertFunction(log_call_function_name, llvm_void_t, llvm_str_t);
 
             FunctionType *log_deinit_function_t = FunctionType::get(llvm_void_t, false);
             Function     *log_deinit_function =
@@ -116,9 +120,11 @@ namespace {
     };
 }  // end of anonymous namespace
 
-extern "C" PassPluginLibraryInfo LLVM_ATTRIBUTE_WEAK llvmGetPassPluginInfo() {
+extern "C" ::llvm::PassPluginLibraryInfo LLVM_ATTRIBUTE_WEAK llvmGetPassPluginInfo() {
     return {
-        LLVM_PLUGIN_API_VERSION, "Log-Pass", "v1.0", [](PassBuilder &PB) {
+        LLVM_PLUGIN_API_VERSION, "LogPass", "v0.3",
+        /* lambda to insert our pass into the pass pipeline. */
+        [](PassBuilder &PB) {
             PB.registerOptimizerLastEPCallback([](ModulePassManager &MPM, OptimizationLevel OL) { MPM.addPass(LogPass()); });
         }};
 }