oil: remove fields in options

Author: JakeHillion

include/ObjectIntrospection.h

@@ -84,7 +84,6 @@ enum Response : int {
 struct options {
   std::string configFilePath{};
   std::string debugFilePath{};
-  std::string cacheDirPath{};
 
   int debugLevel = 0;
   std::string sourceFileDumpPath{};
@@ -93,11 +92,6 @@ struct options {
   bool chaseRawPointers = false;
   bool generateJitDebugInfo = false;
 
-  bool enableUpload = false;
-  bool enableDownload = false;
-  bool abortOnLoadFail = false;
-  bool forceJIT = true;
-
   friend bool operator==(const options &lhs, const options &rhs);
   friend bool operator!=(const options &lhs, const options &rhs);
 };

src/OILibrary.cpp

@@ -21,7 +21,6 @@ namespace ObjectIntrospection {
 
 bool operator==(const options& lhs, const options& rhs) {
   return lhs.configFilePath == rhs.configFilePath &&
-         lhs.cacheDirPath == rhs.cacheDirPath &&
          lhs.debugFilePath == rhs.debugFilePath &&
          lhs.debugLevel == rhs.debugLevel &&
          lhs.chaseRawPointers == rhs.chaseRawPointers;

src/OILibraryImpl.cpp

@@ -34,19 +34,6 @@ extern "C" {
 
 namespace ObjectIntrospection {
 
-/**
- * We need a way to identify the BLOB/Object file, but we don't have access
- * to the function's name or the introspected type's name without
- * initialising drgn.
- * Exclusively to OIL, we won't use the type's name, but the templated
- * function address. We assume the address of the templated function
- * changes at every compilation, so we don't re-use object files that
- * are for an older version of the binary.
- */
-const std::string function_identifier(uintptr_t functionAddress) {
-  return (boost::format("%x") % (uint32_t)(functionAddress % UINT32_MAX)).str();
-}
-
 OILibraryImpl::OILibraryImpl(OILibrary *self, void *TemplateFunc)
     : _self(self), _TemplateFunc(TemplateFunc) {
   if (_self->opts.debugLevel != 0) {
@@ -122,14 +109,6 @@ void close_file(std::FILE *fp) {
   std::fclose(fp);
 }
 
-static inline void logElfError(const char *message) {
-  const char *elf_error_message = elf_errmsg(0);
-  if (elf_error_message)
-    LOG(ERROR) << message << ": " << elf_error_message;
-  else
-    LOG(ERROR) << message;
-}
-
 int OILibraryImpl::compileCode() {
   OICompiler compiler{symbols, compilerConfig};
 
@@ -152,114 +131,54 @@ int OILibraryImpl::compileCode() {
   auto objectPath =
       fs::path((boost::format("/dev/fd/%1%") % objectMemfd).str());
 
-  if (_self->opts.forceJIT) {
-    struct drgn_program *prog = symbols->getDrgnProgram();
-    if (!prog) {
-      return Response::OIL_COMPILATION_FAILURE;
-    }
-    struct drgn_symbol *sym;
-    if (auto err = drgn_program_find_symbol_by_address(
-            prog, (uintptr_t)_TemplateFunc, &sym)) {
-      LOG(ERROR) << "Error when finding symbol by address " << err->code << " "
-                 << err->message;
-      drgn_error_destroy(err);
-      return Response::OIL_COMPILATION_FAILURE;
-    }
-    const char *name = drgn_symbol_name(sym);
-    drgn_symbol_destroy(sym);
+  struct drgn_program *prog = symbols->getDrgnProgram();
+  if (!prog) {
+    return Response::OIL_COMPILATION_FAILURE;
+  }
+  struct drgn_symbol *sym;
+  if (auto err = drgn_program_find_symbol_by_address(
+          prog, (uintptr_t)_TemplateFunc, &sym)) {
+    LOG(ERROR) << "Error when finding symbol by address " << err->code << " "
+               << err->message;
+    drgn_error_destroy(err);
+    return Response::OIL_COMPILATION_FAILURE;
+  }
+  const char *name = drgn_symbol_name(sym);
+  drgn_symbol_destroy(sym);
 
-    auto rootType = symbols->getRootType(irequest{"entry", name, "arg0"});
-    if (!rootType.has_value()) {
-      LOG(ERROR) << "Failed to get type of probe argument";
-      return Response::OIL_COMPILATION_FAILURE;
-    }
+  // TODO: change this to the new drgn interface from symbol -> type
+  auto rootType = symbols->getRootType(irequest{"entry", name, "arg0"});
+  if (!rootType.has_value()) {
+    LOG(ERROR) << "Failed to get type of probe argument";
+    return Response::OIL_COMPILATION_FAILURE;
+  }
 
-    std::string code =
+  std::string code =
 #include "OITraceCode.cpp"
-        ;
-
-    auto codegen = OICodeGen::buildFromConfig(generatorConfig, *symbols);
-    if (!codegen) {
-      return OIL_COMPILATION_FAILURE;
-    }
+      ;
 
-    codegen->setRootType(rootType->type);
-    if (!codegen->generate(code)) {
-      return Response::OIL_COMPILATION_FAILURE;
-    }
+  auto codegen = OICodeGen::buildFromConfig(generatorConfig, *symbols);
+  if (!codegen) {
+    return OIL_COMPILATION_FAILURE;
+  }
 
-    std::string sourcePath = _self->opts.sourceFileDumpPath;
-    if (_self->opts.sourceFileDumpPath.empty()) {
-      // This is the path Clang acts as if it has compiled from e.g. for debug
-      // information. It does not need to exist.
-      sourcePath = "oil_jit.cpp";
-    } else {
-      std::ofstream outputFile(sourcePath);
-      outputFile << code;
-    }
+  codegen->setRootType(rootType->type);
+  if (!codegen->generate(code)) {
+    return Response::OIL_COMPILATION_FAILURE;
+  }
 
-    if (!compiler.compile(code, sourcePath, objectPath)) {
-      return Response::OIL_COMPILATION_FAILURE;
-    }
+  std::string sourcePath = _self->opts.sourceFileDumpPath;
+  if (_self->opts.sourceFileDumpPath.empty()) {
+    // This is the path Clang acts as if it has compiled from e.g. for debug
+    // information. It does not need to exist.
+    sourcePath = "oil_jit.cpp";
   } else {
-    auto executable =
-        open(fs::read_symlink("/proc/self/exe").c_str(), O_RDONLY);
-    if (executable == -1) {
-      PLOG(ERROR) << "Failed to open executable file";
-      return Response::OIL_COMPILATION_FAILURE;
-    }
-    auto __executable_cleanup = Cleanup(executable, close);
-    elf_version(EV_CURRENT);
-    auto elf = elf_begin(executable, ELF_C_READ, NULL);
-    auto __elf_cleanup = Cleanup(elf, elf_end);
-    GElf_Ehdr ehdr;
-    if (!gelf_getehdr(elf, &ehdr)) {
-      logElfError("Failed to get ELF object file header");
-      return Response::OIL_COMPILATION_FAILURE;
-    }
-    size_t string_table_index;
-    if (elf_getshdrstrndx(elf, &string_table_index) != 0) {
-      logElfError("Failed to get index of the section header string table");
-      return Response::OIL_COMPILATION_FAILURE;
-    }
+    std::ofstream outputFile(sourcePath);
+    outputFile << code;
+  }
 
-    Elf_Scn *section = NULL;
-    bool done = false;
-    const auto identifier = function_identifier((uintptr_t)_TemplateFunc);
-    const auto section_name = OI_SECTION_PREFIX.data() + identifier;
-    while ((section = elf_nextscn(elf, section))) {
-      GElf_Shdr section_header;
-      GElf_Shdr *header = gelf_getshdr(section, &section_header);
-      if (!header)
-        continue;
-      const char *name = elf_strptr(elf, string_table_index, header->sh_name);
-      if (name && strcmp(name, section_name.c_str()) == 0) {
-        Elf_Data *section_data;
-        if (!(section_data = elf_getdata(section, NULL))) {
-          LOG(ERROR) << "Failed to get data from section '" << name
-                     << "': " << elf_errmsg(0);
-          return Response::OIL_COMPILATION_FAILURE;
-        }
-        if (section_data->d_size == 0) {
-          LOG(ERROR) << "Section '" << name << "' is empty";
-          return Response::OIL_COMPILATION_FAILURE;
-        }
-        if (fwrite(section_data->d_buf, 1, section_data->d_size,
-                   objectStream.get()) < section_data->d_size) {
-          PLOG(ERROR)
-              << "Failed to write object file contents to temporary file";
-          return Response::OIL_COMPILATION_FAILURE;
-        }
-        done = true;
-        break;
-      }
-    }
-    if (!done) {
-      LOG(ERROR) << "Did not find section '" << section_name
-                 << "' in the executable";
-      return Response::OIL_COMPILATION_FAILURE;
-    }
-    fflush(objectStream.get());
+  if (!compiler.compile(code, sourcePath, objectPath)) {
+    return Response::OIL_COMPILATION_FAILURE;
   }
 
   auto relocRes = compiler.applyRelocs(
@@ -278,8 +197,9 @@ int OILibraryImpl::compileCode() {
       break;
     }
   }
-  if (!_self->fp)
+  if (!_self->fp) {
     return Response::OIL_RELOCATION_FAILURE;
+  }
 
   // Copy relocated segments in their final destination
   for (const auto &[BaseAddr, RelocAddr, Size] : segments)

src/OILibraryImpl.h

@@ -22,8 +22,6 @@
 
 namespace ObjectIntrospection {
 
-const std::string function_identifier(uintptr_t);
-
 class OILibraryImpl {
  public:
   OILibraryImpl(OILibrary *, void *);

test/integration/gen_tests.py

@@ -134,7 +134,6 @@ def define_traceable_func(name, params, body):
             f'  .configFilePath = std::getenv("CONFIG_FILE_PATH"),\n'
             f"  .debugLevel = 3,\n"
             f'  .sourceFileDumpPath = "oil_jit_code.cpp",\n'
-            f"  .forceJIT = true,\n"
             f"}};"
         )