25217128016

Committed 01 May 2026 02:00PM UTC coverage: 89.27% (-1.0%) from 90.246%

Build # 25217128016

Build Type

Pull #188

github

Committed by

web-flow

Commit Message

Merge c465c8fb5 into 278119205

Pull Request Pull Request #188: GPU memory allocation support

Coverage Stats

214 of 298 new or added lines in 20 files covered. (71.81%)

1 existing line in 1 file now uncovered.

5075 of 5685 relevant lines covered (89.27%)

43483.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.25

/lib/passes/TypeARTPass.cpp

// TypeART library
//
// Copyright (c) 2017-2026 TypeART Authors
// Distributed under the BSD 3-Clause license.
// (See accompanying file LICENSE.txt or copy at
// https://opensource.org/licenses/BSD-3-Clause)
//
// Project home: https://github.com/tudasc/TypeART
//
// SPDX-License-Identifier: BSD-3-Clause
//

#include "Commandline.h"
#include "TypeARTConfiguration.h"
#include "analysis/MemInstFinder.h"
#include "configuration/Configuration.h"
#include "configuration/EnvironmentConfiguration.h"
#include "configuration/FileConfiguration.h"
#include "configuration/PassBuilderUtil.h"
#include "configuration/PassConfiguration.h"
#include "configuration/TypeARTOptions.h"
#include "instrumentation/CallBackFunctionInserter.h"
#include "instrumentation/MemOpArgCollector.h"
#include "instrumentation/MemOpInstrumentation.h"
#include "instrumentation/TypeARTFunctions.h"
#include "instrumentation/TypeIDProvider.h"
#include "support/ConfigurationBase.h"
#include "support/CudaUtil.h"
#include "support/GpuUtil.h"
#include "support/Logger.h"
#include "support/ModuleDumper.h"
#include "support/Table.h"
#include "support/Util.h"
#include "typegen/TypeGenerator.h"

#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/PassManager.h"
#include "llvm/Pass.h"
#include "llvm/Passes/PassBuilder.h"
#if LLVM_VERSION_MAJOR < 22
#include "llvm/Passes/PassPlugin.h"
#else
#include "llvm/Plugins/PassPlugin.h"
#endif
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/raw_ostream.h"

#include <cassert>
#include <cstddef>
#include <llvm/ADT/DenseSet.h>
#include <llvm/Config/llvm-config.h>
#include <llvm/IR/Constant.h>
#include <llvm/Support/Error.h>
#include <memory>
#include <optional>
#include <sstream>
#include <string>
#include <utility>

namespace llvm {
class BasicBlock;
}  // namespace llvm

using namespace llvm;

extern llvm::cl::OptionCategory typeart_category;

static cl::opt<std::string> cl_typeart_configuration_file(
    "typeart-config", cl::init(""),
    cl::desc(
        "Location of the configuration file to configure the TypeART pass. Commandline arguments are prioritized."),
    cl::cat(typeart_category));

#define DEBUG_TYPE "typeart"

ALWAYS_ENABLED_STATISTIC(NumInstrumentedMallocs, "Number of instrumented mallocs");
ALWAYS_ENABLED_STATISTIC(NumInstrumentedFrees, "Number of instrumented frees");
ALWAYS_ENABLED_STATISTIC(NumInstrumentedAlloca, "Number of instrumented (stack) allocas");
ALWAYS_ENABLED_STATISTIC(NumInstrumentedGlobal, "Number of instrumented globals");

namespace typeart::pass {

std::optional<std::string> get_configuration_file_path() {
  if (!cl_typeart_configuration_file.empty()) {
    LOG_DEBUG("Using cl::opt for config file " << cl_typeart_configuration_file.getValue());
    return cl_typeart_configuration_file.getValue();
  }
  const char* config_file = std::getenv("TYPEART_CONFIG_FILE");
  if (config_file != nullptr) {
    LOG_DEBUG("Using env var for types file " << config_file)
    return std::string{config_file};
  }
  LOG_INFO("No configuration file set.")
  return {};
}

class TypeArtPass : public llvm::PassInfoMixin<TypeArtPass> {
  std::optional<config::TypeARTConfigOptions> pass_opts{std::nullopt};
  std::unique_ptr<config::Configuration> pass_config;

  std::unique_ptr<analysis::MemInstFinder> meminst_finder;
  std::unique_ptr<TypeGenerator> typeManager;
  InstrumentationHelper instrumentation_helper;
  std::unique_ptr<TAFunctionQuery> functions;
  std::unique_ptr<InstrumentationContext> instrumentation_context;

  const config::Configuration& configuration() const {
    return *pass_config;
  }

 public:
  TypeArtPass() = default;
  explicit TypeArtPass(config::TypeARTConfigOptions opts) : pass_opts(opts) {
    // LOG_INFO("Created with \n" << opts)
  }

  bool doInitialization(Module& m) {
    auto config_file_path = get_configuration_file_path();

    const auto init = config_file_path.has_value()
                          ? config::TypeARTConfigInit{config_file_path.value()}
                          : config::TypeARTConfigInit{{}, config::TypeARTConfigInit::FileConfigurationMode::Empty};

    auto typeart_config = [&](const auto& init_value) {
      if (init_value.mode == config::TypeARTConfigInit::FileConfigurationMode::Empty) {
        return config::make_typeart_configuration_from_opts(pass_opts.value_or(config::TypeARTConfigOptions{}));
      }
      return config::make_typeart_configuration(init_value);
    }(init);

    if (typeart_config) {
      LOG_INFO("Emitting TypeART configuration content\n" << typeart_config.get()->getOptions())
      pass_config = std::move(*typeart_config);
    } else {
      LOG_FATAL("Could not load TypeART configuration.")
      std::exit(EXIT_FAILURE);
    }

    meminst_finder = analysis::create_finder(configuration());

    const std::string types_file =
        configuration().getValueOr(config::ConfigStdArgs::types, {config::ConfigStdArgValues::types});

    const TypegenImplementation typesgen_parser =
        configuration().getValueOr(config::ConfigStdArgs::typegen, {config::ConfigStdArgValues::typegen});
    typeManager = make_typegen(types_file, typesgen_parser);

    LOG_DEBUG("Propagating type infos.");
    const auto [loaded, error] = typeManager->load();
    if (loaded) {
      LOG_DEBUG("Existing type configuration successfully loaded from " << types_file);
    } else {
      LOG_DEBUG("No valid existing type configuration found: " << types_file << ". Reason: " << error.message());
    }

    instrumentation_helper.setModule(m);
    ModuleData mdata{&m};
    const auto has_cu_types = typeManager->registerModule(mdata);

    declareInstrumentationFunctions(m);
    {
      auto type_id_handler = get_type_id_handler(m, &typeManager->getTypeDatabase(), configuration(), functions.get());
      // const bool heap   = configuration()[config::ConfigStdArgs::heap];
      if (has_cu_types) {
        LOG_DEBUG("Registering compilation unit types list")
        type_id_handler->registerModule(mdata);
      }

      auto arg_collector =
          std::make_unique<MemOpArgCollector>(configuration(), typeManager.get(), instrumentation_helper);
      // const bool instrument_stack_lifetime = configuration()[config::ConfigStdArgs::stack_lifetime];
      auto cb_provider    = make_callback_inserter(configuration(), std::move(type_id_handler), functions.get());
      auto mem_instrument = std::make_unique<MemOpInstrumentation>(configuration(), functions.get(),
                                                                   instrumentation_helper, std::move(cb_provider));

      instrumentation_context =
          std::make_unique<InstrumentationContext>(std::move(arg_collector), std::move(mem_instrument));
    }
    return true;
  }

  bool doFinalization() {
    /*
     * Persist the accumulated type definition information for this module.
     */
    // TODO: inline/hybrid types not supported in non-opaque mode
    const bool emit_type_file_always     = bool(LLVM_VERSION_MAJOR < 15);
    TypeSerializationImplementation mode = configuration()[config::ConfigStdArgs::type_serialization];
    if (emit_type_file_always || mode == TypeSerializationImplementation::FILE) {
      const std::string types_file = configuration()[config::ConfigStdArgs::types];
      LOG_DEBUG("Writing type file to " << types_file);

      const auto [stored, error] = typeManager->store();
      if (stored) {
        LOG_DEBUG("Success!");
      } else {
        LOG_FATAL("Failed writing type config to " << types_file << ". Reason: " << error.message());
      }
    }
    const bool print_stats = configuration()[config::ConfigStdArgs::stats];
    if (print_stats) {
      auto& out = llvm::errs();
      printStats(out);
    }
    return false;
  }

  void declareInstrumentationFunctions(Module& m) {
    functions = declare_instrumentation_functions(m, configuration());
  }

  void printStats(llvm::raw_ostream& out){
#if LLVM_VERSION_MAJOR < 22
      const auto scope_exit_cleanup_counter = llvm::make_scope_exit([&]() {
#else
      llvm::scope_exit scope_exit_cleanup_counter([&]() {
#endif
        NumInstrumentedAlloca  = 0;
        NumInstrumentedFrees   = 0;
        NumInstrumentedGlobal  = 0;
        NumInstrumentedMallocs = 0;
      });
  meminst_finder->printStats(out);

  const auto get_ta_mode = [&]() {
    const bool heap   = configuration()[config::ConfigStdArgs::heap];
    const bool stack  = configuration()[config::ConfigStdArgs::stack];
    const bool global = configuration()[config::ConfigStdArgs::global];

    if (heap) {
      if (stack) {
        return " [Heap & Stack]";
      }
      return " [Heap]";
    }

    if (stack) {
      return " [Stack]";
    }

    if (global) {
      return " [Global]";
    }

    LOG_ERROR("Did not find heap or stack, or combination thereof!");
    assert((heap || stack || global) && "Needs stack, heap, global or combination thereof");
    return " [Unknown]";
  };

  Table stats("TypeArtPass");
  stats.wrap_header_ = true;
  stats.title_ += get_ta_mode();
  stats.put(Row::make("Malloc", NumInstrumentedMallocs.getValue()));
  stats.put(Row::make("Free", NumInstrumentedFrees.getValue()));
  stats.put(Row::make("Alloca", NumInstrumentedAlloca.getValue()));
  stats.put(Row::make("Global", NumInstrumentedGlobal.getValue()));

  std::ostringstream stream;
  stats.print(stream);
  out << stream.str();
}

llvm::PreservedAnalyses
run(llvm::Module& m, llvm::ModuleAnalysisManager&) {
  if (gpu::is_device_module(m)) {
    LOG_DEBUG("Skipping GPU device module: " << m.getName());
    return llvm::PreservedAnalyses::all();
  }
  bool changed{false};
  changed |= doInitialization(m);
  const bool heap = configuration()[config::ConfigStdArgs::heap];  // Must happen after doInit
  dump_module(m, heap ? util::module::ModulePhase::kBase : util::module::ModulePhase::kOpt);
  changed |= runOnModule(m);
  dump_module(m, heap ? util::module::ModulePhase::kHeap : util::module::ModulePhase::kStack);
  changed |= doFinalization();
  return changed ? llvm::PreservedAnalyses::none() : llvm::PreservedAnalyses::all();
}

bool runOnModule(llvm::Module& m) {
  meminst_finder->runOnModule(m);
  const bool instrument_global = configuration()[config::ConfigStdArgs::global];
  bool globals_were_instrumented{false};
  if (instrument_global) {
    // declareInstrumentationFunctions(m);

    const auto& globalsList = meminst_finder->getModuleGlobals();
    if (!globalsList.empty()) {
      const auto global_count = instrumentation_context->handleGlobal(globalsList);
      NumInstrumentedGlobal += global_count;
      globals_were_instrumented = global_count > 0;
    }
  }

  llvm::DenseSet<const llvm::Constant*> tor_funcs;
  {
    const auto collect_funcs = [&tor_funcs](const auto* constant) -> bool {
      if (llvm::isa<llvm::Function>(constant)) {
        tor_funcs.insert(constant);
      }
      return false;
    };

    util::for_each_cdtor("llvm.global_ctors", m, collect_funcs);
    util::for_each_cdtor("llvm.global_dtors", m, collect_funcs);
  }

  const auto instrumented_function = llvm::count_if(m.functions(), [&](auto& f) {
                                       if (tor_funcs.contains(&f)) {
                                         LOG_DEBUG("Function is in LLVM global ctor or dtor " << f.getName())
                                         return false;
                                       }
                                       return runOnFunc(f);
                                     }) > 0;
  return instrumented_function || globals_were_instrumented;
}

bool runOnFunc(llvm::Function& f) {
  using namespace typeart;

  if (f.isDeclaration() || util::starts_with_any_of(f.getName(), "__typeart", "typeart", "__sanitizer", "__tysan")) {
    return false;
  }

  if (cuda::is_cuda_helper_function(f)) {
    return false;
  }

  if (!meminst_finder->hasFunctionData(f)) {
    LOG_WARNING("No allocation data could be retrieved for function: " << f.getName());
    return false;
  }

  LOG_DEBUG("Running on function: " << f.getName())

  // FIXME this is required when "PassManagerBuilder::EP_OptimizerLast" is used as the function (constant) pointer are
  // nullpointer/invalidated
  // declareInstrumentationFunctions(*f.getParent());

  bool mod{false};
//  auto& c = f.getContext();
#if LLVM_VERSION_MAJOR > 19
  DataLayout dl(f.getParent()->getDataLayout());
#else
  DataLayout dl(f.getParent());
#endif

  const auto& fData   = meminst_finder->getFunctionData(f);
  const auto& mallocs = fData.mallocs;
  const auto& allocas = fData.allocas;
  const auto& frees   = fData.frees;

  const bool instrument_heap  = configuration()[config::ConfigStdArgs::heap];
  const bool instrument_stack = configuration()[config::ConfigStdArgs::stack];

  if (instrument_heap) {
    // instrument collected calls of bb:
    const auto heap_count = instrumentation_context->handleHeap(mallocs);
    const auto free_count = instrumentation_context->handleFree(frees);

    NumInstrumentedMallocs += heap_count;
    NumInstrumentedFrees += free_count;

    mod |= heap_count > 0 || free_count > 0;
  }

  if (instrument_stack) {
    const auto stack_count = instrumentation_context->handleStack(allocas);
    NumInstrumentedAlloca += stack_count;
    mod |= stack_count > 0;
  }

  return mod;
}
};  // namespace typeart::pass

class LegacyTypeArtPass : public llvm::ModulePass {
 private:
  TypeArtPass pass_impl_;

 public:
  static char ID;  // NOLINT

  LegacyTypeArtPass() : ModulePass(ID) {};

  bool doInitialization(llvm::Module&) override;

  bool runOnModule(llvm::Module& module) override;

  bool doFinalization(llvm::Module&) override;

  ~LegacyTypeArtPass() override = default;
};

bool LegacyTypeArtPass::doInitialization(llvm::Module& m) {
  return pass_impl_.doInitialization(m);
}

bool LegacyTypeArtPass::runOnModule(llvm::Module& module) {
  bool changed{false};
  changed |= pass_impl_.runOnModule(module);
  return changed;
}

bool LegacyTypeArtPass::doFinalization(llvm::Module&) {
  return pass_impl_.doFinalization();
  ;
}

}  // namespace typeart::pass

//.....................
// New PM
//.....................
llvm::PassPluginLibraryInfo getTypeartPassPluginInfo() {
  using namespace llvm;
  return {
    LLVM_PLUGIN_API_VERSION, "TypeART", LLVM_VERSION_STRING, [](PassBuilder& pass_builder) {
      pass_builder.registerPipelineStartEPCallback([](auto& MPM, OptimizationLevel) {
        auto parameters = typeart::util::pass::parsePassParameters(
            typeart::config::pass::parse_typeart_config, "typeart<heap;stats;type-serialization=hybrid>", "typeart");
        if (!parameters) {
          LOG_FATAL("Error parsing heap params: " << parameters.takeError())
          return;
        }
        MPM.addPass(typeart::pass::TypeArtPass(typeart::pass::TypeArtPass(parameters.get())));
      });
#if LLVM_VERSION_MAJOR > 19
      pass_builder.registerOptimizerLastEPCallback([](auto& MPM, OptimizationLevel, ThinOrFullLTOPhase) {
#else
      pass_builder.registerOptimizerLastEPCallback([](auto& MPM, OptimizationLevel) {
#endif
        auto parameters = typeart::util::pass::parsePassParameters(
            typeart::config::pass::parse_typeart_config, "typeart<no-heap;stack;stats;type-serialization=hybrid>",
            "typeart");
        if (!parameters) {
          LOG_FATAL("Error parsing stack params: " << parameters.takeError())
          return;
        }
        MPM.addPass(typeart::pass::TypeArtPass(typeart::pass::TypeArtPass(parameters.get())));
      });
      pass_builder.registerPipelineParsingCallback([](StringRef name, ModulePassManager& module_pm,
                                                      ArrayRef<PassBuilder::PipelineElement>) {
        if (typeart::util::pass::checkParametrizedPassName(name, "typeart")) {
          auto parameters =
              typeart::util::pass::parsePassParameters(typeart::config::pass::parse_typeart_config, name, "typeart");
          if (!parameters) {
            LOG_FATAL("Error parsing params: " << parameters.takeError())
            return false;
          }
          module_pm.addPass(typeart::pass::TypeArtPass(parameters.get()));
          return true;
        }
        LOG_FATAL("Not a valid parametrized pass name: " << name)
        return false;
      });
    }
  };
}

extern "C" LLVM_ATTRIBUTE_WEAK ::llvm::PassPluginLibraryInfo llvmGetPassPluginInfo() {
  return getTypeartPassPluginInfo();
}

//.....................
// Old PM
//.....................
char typeart::pass::LegacyTypeArtPass::ID = 0;  // NOLINT

static RegisterPass<typeart::pass::LegacyTypeArtPass> x("typeart", "TypeArt Pass");  // NOLINT

ModulePass* createTypeArtPass() {
  return new typeart::pass::LegacyTypeArtPass();
}

extern "C" void AddTypeArtPass(LLVMPassManagerRef pass_manager) {
  unwrap(pass_manager)->add(createTypeArtPass());
}

1	// TypeART library
2	//
3	// Copyright (c) 2017-2026 TypeART Authors
4	// Distributed under the BSD 3-Clause license.
5	// (See accompanying file LICENSE.txt or copy at
6	// https://opensource.org/licenses/BSD-3-Clause)
7	//
8	// Project home: https://github.com/tudasc/TypeART
9	//
10	// SPDX-License-Identifier: BSD-3-Clause
11	//
12
13	#include "Commandline.h"
14	#include "TypeARTConfiguration.h"
15	#include "analysis/MemInstFinder.h"
16	#include "configuration/Configuration.h"
17	#include "configuration/EnvironmentConfiguration.h"
18	#include "configuration/FileConfiguration.h"
19	#include "configuration/PassBuilderUtil.h"
20	#include "configuration/PassConfiguration.h"
21	#include "configuration/TypeARTOptions.h"
22	#include "instrumentation/CallBackFunctionInserter.h"
23	#include "instrumentation/MemOpArgCollector.h"
24	#include "instrumentation/MemOpInstrumentation.h"
25	#include "instrumentation/TypeARTFunctions.h"
26	#include "instrumentation/TypeIDProvider.h"
27	#include "support/ConfigurationBase.h"
28	#include "support/CudaUtil.h"
29	#include "support/GpuUtil.h"
30	#include "support/Logger.h"
31	#include "support/ModuleDumper.h"
32	#include "support/Table.h"
33	#include "support/Util.h"
34	#include "typegen/TypeGenerator.h"	1,971✔
35		1,971✔
36	#include "llvm/ADT/DenseMap.h"	1,971✔
37	#include "llvm/ADT/STLExtras.h"
38	#include "llvm/ADT/ScopeExit.h"
39	#include "llvm/ADT/SmallVector.h"
40	#include "llvm/ADT/Statistic.h"
41	#include "llvm/ADT/StringRef.h"
42	#include "llvm/IR/DataLayout.h"
43	#include "llvm/IR/Function.h"
44	#include "llvm/IR/LegacyPassManager.h"
45	#include "llvm/IR/Module.h"
46	#include "llvm/IR/PassManager.h"
47	#include "llvm/Pass.h"	1,971✔
48	#include "llvm/Passes/PassBuilder.h"	1,999✔
49	#if LLVM_VERSION_MAJOR < 22
50	#include "llvm/Passes/PassPlugin.h"
51	#else
52	#include "llvm/Plugins/PassPlugin.h"
53	#endif
54	#include "llvm/Support/CommandLine.h"
55	#include "llvm/Support/raw_ostream.h"
56
57	#include <cassert>
58	#include <cstddef>
59	#include <llvm/ADT/DenseSet.h>
60	#include <llvm/Config/llvm-config.h>
61	#include <llvm/IR/Constant.h>
62	#include <llvm/Support/Error.h>	5,913✔
63	#include <memory>	1,971✔
64	#include <optional>
65	#include <sstream>
66	#include <string>
67	#include <utility>
68
69	namespace llvm {
70	class BasicBlock;
71	} // namespace llvm
72
73	using namespace llvm;
74
75	extern llvm::cl::OptionCategory typeart_category;
76
77	static cl::opt<std::string> cl_typeart_configuration_file(	5,694✔
78	"typeart-config", cl::init(""),	5,694✔
79	cl::desc(	5,694✔
80	"Location of the configuration file to configure the TypeART pass. Commandline arguments are prioritized."),	5,694✔
81	cl::cat(typeart_category));	11,388✔
82
83	#define DEBUG_TYPE "typeart"
84
85	ALWAYS_ENABLED_STATISTIC(NumInstrumentedMallocs, "Number of instrumented mallocs");
86	ALWAYS_ENABLED_STATISTIC(NumInstrumentedFrees, "Number of instrumented frees");
87	ALWAYS_ENABLED_STATISTIC(NumInstrumentedAlloca, "Number of instrumented (stack) allocas");
88	ALWAYS_ENABLED_STATISTIC(NumInstrumentedGlobal, "Number of instrumented globals");
89
90	namespace typeart::pass {
91
92	std::optional<std::string> get_configuration_file_path() {	6,351✔
93	if (!cl_typeart_configuration_file.empty()) {	6,351✔
94	LOG_DEBUG("Using cl::opt for config file " << cl_typeart_configuration_file.getValue());
95	return cl_typeart_configuration_file.getValue();	×
96	}
97	const char* config_file = std::getenv("TYPEART_CONFIG_FILE");	6,351✔
98	if (config_file != nullptr) {	6,351✔
99	LOG_DEBUG("Using env var for types file " << config_file)
100	return std::string{config_file};	35✔
101	}
102	LOG_INFO("No configuration file set.")	6,316✔
103	return {};	6,316✔
104	}	6,351✔
105
106	class TypeArtPass : public llvm::PassInfoMixin<TypeArtPass> {
107	std::optional<config::TypeARTConfigOptions> pass_opts{std::nullopt};	×
108	std::unique_ptr<config::Configuration> pass_config;
109
110	std::unique_ptr<analysis::MemInstFinder> meminst_finder;
111	std::unique_ptr<TypeGenerator> typeManager;
112	InstrumentationHelper instrumentation_helper;
113	std::unique_ptr<TAFunctionQuery> functions;
114	std::unique_ptr<InstrumentationContext> instrumentation_context;
115
116	const config::Configuration& configuration() const {	179,328✔
117	return *pass_config;	179,328✔
118	}
119
120	public:
121	TypeArtPass() = default;	×
122	explicit TypeArtPass(config::TypeARTConfigOptions opts) : pass_opts(opts) {	11,388✔
123	// LOG_INFO("Created with \n" << opts)
124	}	11,388✔
125
126	bool doInitialization(Module& m) {	6,344✔
127	auto config_file_path = get_configuration_file_path();	6,344✔
128
129	const auto init = config_file_path.has_value()	6,344✔
130	? config::TypeARTConfigInit{config_file_path.value()}	35✔
131	: config::TypeARTConfigInit{{}, config::TypeARTConfigInit::FileConfigurationMode::Empty};	3,885✔
132
133	auto typeart_config = [&](const auto& init_value) {	10,264✔
134	if (init_value.mode == config::TypeARTConfigInit::FileConfigurationMode::Empty) {	6,344✔
135	return config::make_typeart_configuration_from_opts(pass_opts.value_or(config::TypeARTConfigOptions{}));	25,236✔
136	}
137	return config::make_typeart_configuration(init_value);	35✔
138	}(init);	6,344✔
139
140	if (typeart_config) {	6,344✔
141	LOG_INFO("Emitting TypeART configuration content\n" << typeart_config.get()->getOptions())	6,337✔
142	pass_config = std::move(*typeart_config);	6,337✔
143	} else {	6,337✔
144	LOG_FATAL("Could not load TypeART configuration.")	7✔
145	std::exit(EXIT_FAILURE);	7✔
146	}
147
148	meminst_finder = analysis::create_finder(configuration());	3,913✔
149
150	const std::string types_file =
151	configuration().getValueOr(config::ConfigStdArgs::types, {config::ConfigStdArgValues::types});	3,913✔
152
153	const TypegenImplementation typesgen_parser =	3,913✔
154	configuration().getValueOr(config::ConfigStdArgs::typegen, {config::ConfigStdArgValues::typegen});	3,913✔
155	typeManager = make_typegen(types_file, typesgen_parser);	3,913✔
156
157	LOG_DEBUG("Propagating type infos.");
158	const auto [loaded, error] = typeManager->load();	3,913✔
159	if (loaded) {	6,337✔
160	LOG_DEBUG("Existing type configuration successfully loaded from " << types_file);
161	} else {	1,483✔
162	LOG_DEBUG("No valid existing type configuration found: " << types_file << ". Reason: " << error.message());
163	}
164
165	instrumentation_helper.setModule(m);	3,913✔
166	ModuleData mdata{&m};	3,913✔
167	const auto has_cu_types = typeManager->registerModule(mdata);	3,913✔
168
169	declareInstrumentationFunctions(m);	3,913✔
170	{
171	auto type_id_handler = get_type_id_handler(m, &typeManager->getTypeDatabase(), configuration(), functions.get());	6,337✔
172	// const bool heap = configuration()[config::ConfigStdArgs::heap];
173	if (has_cu_types) {	6,337✔
174	LOG_DEBUG("Registering compilation unit types list")
175	type_id_handler->registerModule(mdata);	2,219✔
176	}	2,219✔
177
178	auto arg_collector =
179	std::make_unique<MemOpArgCollector>(configuration(), typeManager.get(), instrumentation_helper);	6,337✔
180	// const bool instrument_stack_lifetime = configuration()[config::ConfigStdArgs::stack_lifetime];
181	auto cb_provider = make_callback_inserter(configuration(), std::move(type_id_handler), functions.get());	6,337✔
182	auto mem_instrument = std::make_unique<MemOpInstrumentation>(configuration(), functions.get(),	12,674✔
183	instrumentation_helper, std::move(cb_provider));	6,337✔
184
185	instrumentation_context =	6,337✔
186	std::make_unique<InstrumentationContext>(std::move(arg_collector), std::move(mem_instrument));	6,337✔
187	}	3,913✔
188	return true;
189	}	3,913✔
190
191	bool doFinalization() {	6,337✔
192	/*
193	* Persist the accumulated type definition information for this module.
194	*/
195	// TODO: inline/hybrid types not supported in non-opaque mode
196	const bool emit_type_file_always = bool(LLVM_VERSION_MAJOR < 15);	6,337✔
197	TypeSerializationImplementation mode = configuration()[config::ConfigStdArgs::type_serialization];	6,337✔
198	if (emit_type_file_always \|\| mode == TypeSerializationImplementation::FILE) {	4,338✔
199	const std::string types_file = configuration()[config::ConfigStdArgs::types];	2,608✔
200	LOG_DEBUG("Writing type file to " << types_file);
201
202	const auto [stored, error] = typeManager->store();	2,608✔
203	if (stored) {	2,608✔
204	LOG_DEBUG("Success!");
205	} else {	2,608✔
206	LOG_FATAL("Failed writing type config to " << types_file << ". Reason: " << error.message());	×
207	}
208	}	2,608✔
209	const bool print_stats = configuration()[config::ConfigStdArgs::stats];	6,337✔
210	if (print_stats) {	6,337✔
211	auto& out = llvm::errs();	6,268✔
212	printStats(out);	6,268✔
213	}	6,268✔
214	return false;	6,337✔
215	}
216
217	void declareInstrumentationFunctions(Module& m) {	6,337✔
218	functions = declare_instrumentation_functions(m, configuration());	6,337✔
219	}	6,337✔
220
221	void printStats(llvm::raw_ostream& out){	6,268✔
222	#if LLVM_VERSION_MAJOR < 22
223	const auto scope_exit_cleanup_counter = llvm::make_scope_exit([&]() {	10,356✔
224	#else
225	llvm::scope_exit scope_exit_cleanup_counter([&]() {	2,180✔
226	#endif
227	NumInstrumentedAlloca = 0;	6,268✔
228	NumInstrumentedFrees = 0;	6,268✔
229	NumInstrumentedGlobal = 0;	6,268✔
230	NumInstrumentedMallocs = 0;	6,268✔
231	});	6,268✔
232	meminst_finder->printStats(out);	6,268✔
233
234	const auto get_ta_mode = [&]() {	12,536✔
235	const bool heap = configuration()[config::ConfigStdArgs::heap];	6,268✔
236	const bool stack = configuration()[config::ConfigStdArgs::stack];	6,268✔
237	const bool global = configuration()[config::ConfigStdArgs::global];	6,268✔
238
239	if (heap) {	6,268✔
240	if (stack) {	4,290✔
241	return " [Heap & Stack]";	1,071✔
242	}
243	return " [Heap]";	3,219✔
244	}
245
246	if (stack) {	1,978✔
247	return " [Stack]";	1,978✔
248	}
249
250	if (global) {	×
251	return " [Global]";	×
252	}
253
254	LOG_ERROR("Did not find heap or stack, or combination thereof!");	×
255	assert((heap \|\| stack \|\| global) && "Needs stack, heap, global or combination thereof");	×
256	return " [Unknown]";	×
257	};	6,268✔
258
259	Table stats("TypeArtPass");	6,268✔
260	stats.wrap_header_ = true;	6,268✔
261	stats.title_ += get_ta_mode();	6,268✔
262	stats.put(Row::make("Malloc", NumInstrumentedMallocs.getValue()));	6,268✔
263	stats.put(Row::make("Free", NumInstrumentedFrees.getValue()));	6,268✔
264	stats.put(Row::make("Alloca", NumInstrumentedAlloca.getValue()));	6,268✔
265	stats.put(Row::make("Global", NumInstrumentedGlobal.getValue()));	6,268✔
266
267	std::ostringstream stream;	6,268✔
268	stats.print(stream);	6,268✔
269	out << stream.str();	6,268✔
270	}	6,268✔
271
272	llvm::PreservedAnalyses
273	run(llvm::Module& m, llvm::ModuleAnalysisManager&) {	6,337✔
274	if (gpu::is_device_module(m)) {	6,337✔
275	LOG_DEBUG("Skipping GPU device module: " << m.getName());
NEW 276	return llvm::PreservedAnalyses::all();	×
277	}
278	bool changed{false};	6,337✔
279	changed \|= doInitialization(m);	6,337✔
280	const bool heap = configuration()[config::ConfigStdArgs::heap]; // Must happen after doInit	6,337✔
281	dump_module(m, heap ? util::module::ModulePhase::kBase : util::module::ModulePhase::kOpt);	6,337✔
282	changed \|= runOnModule(m);	6,337✔
283	dump_module(m, heap ? util::module::ModulePhase::kHeap : util::module::ModulePhase::kStack);	6,337✔
284	changed \|= doFinalization();	6,337✔
285	return changed ? llvm::PreservedAnalyses::none() : llvm::PreservedAnalyses::all();	6,337✔
286	}	6,337✔
287
288	bool runOnModule(llvm::Module& m) {	6,337✔
289	meminst_finder->runOnModule(m);	6,337✔
290	const bool instrument_global = configuration()[config::ConfigStdArgs::global];	6,337✔
291	bool globals_were_instrumented{false};	6,337✔
292	if (instrument_global) {	6,337✔
293	// declareInstrumentationFunctions(m);
294
295	const auto& globalsList = meminst_finder->getModuleGlobals();	3,046✔
296	if (!globalsList.empty()) {	3,046✔
297	const auto global_count = instrumentation_context->handleGlobal(globalsList);	1,195✔
298	NumInstrumentedGlobal += global_count;	1,195✔
299	globals_were_instrumented = global_count > 0;	1,195✔
300	}	1,195✔
301	}	3,046✔
302
303	llvm::DenseSet<const llvm::Constant*> tor_funcs;	6,337✔
304	{
305	const auto collect_funcs = [&tor_funcs](const auto* constant) -> bool {	7,990✔
306	if (llvm::isa<llvm::Function>(constant)) {	1,653✔
307	tor_funcs.insert(constant);	1,653✔
308	}	1,653✔
309	return false;	1,653✔
310	};
311
312	util::for_each_cdtor("llvm.global_ctors", m, collect_funcs);	6,337✔
313	util::for_each_cdtor("llvm.global_dtors", m, collect_funcs);	6,337✔
314	}
315
316	const auto instrumented_function = llvm::count_if(m.functions(), [&](auto& f) {	215,738✔
317	if (tor_funcs.contains(&f)) {	203,064✔
318	LOG_DEBUG("Function is in LLVM global ctor or dtor " << f.getName())
319	return false;	1,653✔
320	}
321	return runOnFunc(f);	201,411✔
322	}) > 0;	209,401✔
323	return instrumented_function \|\| globals_were_instrumented;	6,337✔
324	}	6,337✔
325
326	bool runOnFunc(llvm::Function& f) {	201,411✔
327	using namespace typeart;
328
329	if (f.isDeclaration() \|\| util::starts_with_any_of(f.getName(), "__typeart", "typeart", "__sanitizer", "__tysan")) {	201,411✔
330	return false;	160,475✔
331	}
332
333	if (cuda::is_cuda_helper_function(f)) {	40,936✔
NEW 334	return false;	×
335	}
336
337	if (!meminst_finder->hasFunctionData(f)) {	40,936✔
338	LOG_WARNING("No allocation data could be retrieved for function: " << f.getName());	×
339	return false;	×
340	}
341
342	LOG_DEBUG("Running on function: " << f.getName())
343
344	// FIXME this is required when "PassManagerBuilder::EP_OptimizerLast" is used as the function (constant) pointer are
345	// nullpointer/invalidated
346	// declareInstrumentationFunctions(*f.getParent());
347
348	bool mod{false};	40,936✔
349	// auto& c = f.getContext();
350	#if LLVM_VERSION_MAJOR > 19
351	DataLayout dl(f.getParent()->getDataLayout());	17,201✔
352	#else
353	DataLayout dl(f.getParent());	23,735✔
354	#endif
355
356	const auto& fData = meminst_finder->getFunctionData(f);	40,936✔
357	const auto& mallocs = fData.mallocs;	40,936✔
358	const auto& allocas = fData.allocas;	40,936✔
359	const auto& frees = fData.frees;	40,936✔
360
361	const bool instrument_heap = configuration()[config::ConfigStdArgs::heap];	40,936✔
362	const bool instrument_stack = configuration()[config::ConfigStdArgs::stack];	40,936✔
363
364	if (instrument_heap) {	40,936✔
365	// instrument collected calls of bb:
366	const auto heap_count = instrumentation_context->handleHeap(mallocs);	28,469✔
367	const auto free_count = instrumentation_context->handleFree(frees);	28,469✔
368
369	NumInstrumentedMallocs += heap_count;	28,469✔
370	NumInstrumentedFrees += free_count;	28,469✔
371
372	mod \|= heap_count > 0 \|\| free_count > 0;	28,469✔
373	}	28,469✔
374
375	if (instrument_stack) {	40,936✔
376	const auto stack_count = instrumentation_context->handleStack(allocas);	15,404✔
377	NumInstrumentedAlloca += stack_count;	15,404✔
378	mod \|= stack_count > 0;	15,404✔
379	}	15,404✔
380
381	return mod;	40,936✔
382	}	201,411✔
383	}; // namespace typeart::pass
384
385	class LegacyTypeArtPass : public llvm::ModulePass {
386	private:
387	TypeArtPass pass_impl_;
388
389	public:
390	static char ID; // NOLINT
391
392	LegacyTypeArtPass() : ModulePass(ID) {};	×
393
394	bool doInitialization(llvm::Module&) override;
395
396	bool runOnModule(llvm::Module& module) override;
397
398	bool doFinalization(llvm::Module&) override;
399
400	~LegacyTypeArtPass() override = default;	×
401	};
402
403	bool LegacyTypeArtPass::doInitialization(llvm::Module& m) {	×
404	return pass_impl_.doInitialization(m);	×
405	}
406
407	bool LegacyTypeArtPass::runOnModule(llvm::Module& module) {	×
408	bool changed{false};	×
409	changed \|= pass_impl_.runOnModule(module);	×
410	return changed;	×
411	}
412
413	bool LegacyTypeArtPass::doFinalization(llvm::Module&) {	×
414	return pass_impl_.doFinalization();	×
415	;
416	}
417
418	} // namespace typeart::pass
419
420	//.....................
421	// New PM
422	//.....................
423	llvm::PassPluginLibraryInfo getTypeartPassPluginInfo() {	5,694✔
424	using namespace llvm;
425	return {	11,388✔
426	LLVM_PLUGIN_API_VERSION, "TypeART", LLVM_VERSION_STRING, [](PassBuilder& pass_builder) {	11,388✔
427	pass_builder.registerPipelineStartEPCallback([](auto& MPM, OptimizationLevel) {	6,351✔
428	auto parameters = typeart::util::pass::parsePassParameters(	657✔
429	typeart::config::pass::parse_typeart_config, "typeart<heap;stats;type-serialization=hybrid>", "typeart");	657✔
430	if (!parameters) {	657✔
431	LOG_FATAL("Error parsing heap params: " << parameters.takeError())	×
432	return;	×
433	}
434	MPM.addPass(typeart::pass::TypeArtPass(typeart::pass::TypeArtPass(parameters.get())));	657✔
435	});	657✔
436	#if LLVM_VERSION_MAJOR > 19
437	pass_builder.registerOptimizerLastEPCallback([](auto& MPM, OptimizationLevel, ThinOrFullLTOPhase) {	2,726✔
438	#else
439	pass_builder.registerOptimizerLastEPCallback([](auto& MPM, OptimizationLevel) {	3,625✔
440	#endif
441	auto parameters = typeart::util::pass::parsePassParameters(	657✔
442	typeart::config::pass::parse_typeart_config, "typeart<no-heap;stack;stats;type-serialization=hybrid>",	657✔
443	"typeart");	657✔
444	if (!parameters) {	657✔
445	LOG_FATAL("Error parsing stack params: " << parameters.takeError())	×
446	return;	×
447	}
448	MPM.addPass(typeart::pass::TypeArtPass(typeart::pass::TypeArtPass(parameters.get())));	657✔
449	});	657✔
450	pass_builder.registerPipelineParsingCallback([](StringRef name, ModulePassManager& module_pm,	15,768✔
451	ArrayRef<PassBuilder::PipelineElement>) {
452	if (typeart::util::pass::checkParametrizedPassName(name, "typeart")) {	10,074✔
453	auto parameters =
454	typeart::util::pass::parsePassParameters(typeart::config::pass::parse_typeart_config, name, "typeart");	10,074✔
455	if (!parameters) {	10,074✔
456	LOG_FATAL("Error parsing params: " << parameters.takeError())	×
457	return false;	×
458	}
459	module_pm.addPass(typeart::pass::TypeArtPass(parameters.get()));	10,074✔
460	return true;	10,074✔
461	}	10,074✔
462	LOG_FATAL("Not a valid parametrized pass name: " << name)	×
463	return false;	×
464	});	10,074✔
465	}	5,694✔
466	};
467	}
468
469	extern "C" LLVM_ATTRIBUTE_WEAK ::llvm::PassPluginLibraryInfo llvmGetPassPluginInfo() {	5,694✔
470	return getTypeartPassPluginInfo();	5,694✔
471	}
472
473	//.....................
474	// Old PM
475	//.....................
476	char typeart::pass::LegacyTypeArtPass::ID = 0; // NOLINT
477
478	static RegisterPass<typeart::pass::LegacyTypeArtPass> x("typeart", "TypeArt Pass"); // NOLINT	5,694✔
479
480	ModulePass* createTypeArtPass() {	×
481	return new typeart::pass::LegacyTypeArtPass();	×
482	}
483
484	extern "C" void AddTypeArtPass(LLVMPassManagerRef pass_manager) {	×
485	unwrap(pass_manager)->add(createTypeArtPass());	×
486	}	×

tudasc / TypeART / 25217128016

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous