Dylib Derivation & Scanning

CMakeLists.txt

@@ -92,6 +92,8 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_XCODE_GENERATE_SCHEME OFF)
+# This does not appear to be set via `CMAKE_CXX_STANDARD`; not sure why.
+set(CMAKE_XCODE_ATTRIBUTE_CLANG_CXX_LANGUAGE_STANDARD "c++20")
 
 file(GLOB SRC_FILES CONFIGURE_DEPENDS ${PROJECT_SOURCE_DIR}/src/*.cpp)
 file(GLOB HEADER_FILES CONFIGURE_DEPENDS ${PROJECT_SOURCE_DIR}/include/orc/*.hpp)

_orc-config

@@ -49,6 +49,14 @@ log_level = 'warning'
 
 standalone_mode = false
 
+# Scan the binary passed in to the command line for its Mach-O dependencies, specifically any
+# dylibs it depends on (and rpaths where they might be found.) Then perform a scan over that
+# collection as if it were runtime-linked.
+#
+# The default value is `false`.
+
+dylib_scan_mode = false
+
 # If defined, ORC will log output to the specified file. (Normal stream output 
 # is unaffected by the `output_file`.) 
 # 

include/orc/ar.hpp

@@ -18,6 +18,6 @@ void read_ar(object_ancestry&& ancestry,
              freader& s,
              std::istream::pos_type end_pos,
              file_details details,
-             callbacks callbacks);
+             macho_params params);
 
 /**************************************************************************************************/

include/orc/async.hpp

@@ -0,0 +1,30 @@
+// Copyright 2024 Adobe
+// All Rights Reserved.
+//
+// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
+// of the Adobe license agreement accompanying it.
+
+#pragma once
+
+#include <functional>
+
+//======================================================================================================================
+
+namespace orc {
+
+//======================================================================================================================
+
+// Enqueue a task for (possibly asynchronous) execution. If the `parallel_processing` setting in the
+// ORC config file is true, the task will be enqueued for processing on a background thread pool.
+// Otherwise, the task will be executed immediately in the current thread.
+void do_work(std::function<void()>);
+
+// blocks the calling thread until all enqueued work items have completed. If the
+// `parallel_processing` setting in the ORC config file is `false`, this will return immediately.
+void block_on_work();
+
+//======================================================================================================================
+
+} // namespace orc
+
+//======================================================================================================================

include/orc/dwarf.hpp

@@ -20,8 +20,7 @@ using die_pair = std::tuple<die, attribute_sequence>;
 struct dwarf {
     dwarf(std::uint32_t ofd_index,
           freader&& s,
-          file_details&& details,
-          register_dies_callback&& callback);
+          file_details&& details);
 
     void register_section(std::string name, std::size_t offset, std::size_t size);
 

include/orc/fat.hpp

@@ -18,6 +18,6 @@ void read_fat(object_ancestry&& ancestry,
               freader& s,
               std::istream::pos_type end_pos,
               file_details details,
-              callbacks callbacks);
+              macho_params params);
 
 /**************************************************************************************************/

include/orc/macho.hpp

@@ -18,10 +18,14 @@ void read_macho(object_ancestry&& ancestry,
                 freader s,
                 std::istream::pos_type end_pos,
                 file_details details,
-                callbacks callbacks);
+                macho_params params);
 
 /**************************************************************************************************/
 
-struct dwarf dwarf_from_macho(std::uint32_t ofd_index, register_dies_callback&& callback);
+struct dwarf dwarf_from_macho(std::uint32_t ofd_index, macho_params params);
+
+/**************************************************************************************************/
+
+std::vector<std::filesystem::path> macho_derive_dylibs(const std::vector<std::filesystem::path>& root_binaries);
 
 /**************************************************************************************************/

include/orc/orc.hpp

@@ -55,7 +55,13 @@ bool emit_report(const odrv_report& report);
 
 /**************************************************************************************************/
 
-std::vector<odrv_report> orc_process(const std::vector<std::filesystem::path>&);
+std::vector<odrv_report> orc_process(std::vector<std::filesystem::path>&&);
+
+namespace orc {
+
+void register_dies(dies die_vector);
+
+} // namespace orc
 
 void orc_reset();
 
@@ -93,3 +99,5 @@ template <class F>
 void cerr_safe(F&& f) {
     ostream_safe(std::cerr, std::forward<F>(f));
 }
+
+/**************************************************************************************************/

include/orc/parse_file.hpp

@@ -226,19 +226,25 @@ constexpr std::decay_t<T> copy(T&& value) noexcept(noexcept(std::decay_t<T>{
 
 /**************************************************************************************************/
 
-using register_dies_callback = std::function<void(dies)>;
-using do_work_callback = std::function<void(std::function<void()>)>;
-using empool_callback = std::function<pool_string(std::string_view)>;
+enum class macho_reader_mode {
+    invalid,
+    register_dies,
+    derive_dylibs,
+    odrv_reporting,
+};
+
+struct macho_params {
+    using register_dependencies_callback = std::function<void(std::vector<std::filesystem::path>&&)>;
 
-struct callbacks {
-    register_dies_callback _register_die;
-    do_work_callback _do_work;
+    macho_reader_mode _mode{macho_reader_mode::invalid};
+    std::filesystem::path _executable_path; // only required if mode == derive_dylibs
+    register_dependencies_callback _register_dependencies; // only required if mode == derive_dylibs
 };
 
 void parse_file(std::string_view object_name,
                 const object_ancestry& ancestry,
                 freader& s,
                 std::istream::pos_type end_pos,
-                callbacks callbacks);
+                macho_params params);
 
 /**************************************************************************************************/

include/orc/settings.hpp

@@ -33,6 +33,7 @@ struct settings {
     bool _forward_to_linker{true};
     log_level _log_level{log_level::silent};
     bool _standalone_mode{false};
+    bool _dylib_scan_mode{false};
     bool _print_object_file_list{false};
     std::vector<std::string> _symbol_ignore;
     std::vector<std::string> _violation_report;

include/orc/tracy.hpp

@@ -32,8 +32,10 @@
 #endif
 
 //==================================================================================================
-
-namespace orc::tracy {
+// This used to be orc::tracy, but then the compiler would complain about some of the Tracy macros
+// failing to resolve to symbols in this nested namespace. It failed to find the global ::tracy
+// namespace where they actually live. This has been renamed `profiler` to avoid the collision.
+namespace orc::profiler {
 
 //==================================================================================================
 // returns a unique `const char*` per thread for the lifetime of the application. A _brief_ name,
@@ -57,6 +59,6 @@ void initialize();
 
 //==================================================================================================
 
-} // namespace orc::tracy
+} // namespace orc::profiler
 
 //==================================================================================================

justfile

@@ -0,0 +1,31 @@
+# For documentation on `just`, see https://github.com/casey/just
+# and the online manual https://just.systems/man/en/
+# This set of recipes have only been tested on macOS.
+
+set shell := ["bash", "-uc"]
+
+# Self-help
+[private] # Don't print `default` as one of the recipes
+default:
+  @just --list --justfile {{justfile()}} --list-heading $'Usage: `just recipe` where `recipe` is one of:\n'
+
+# Make `build/` if it does not exist
+mkdir:
+    #!/usr/bin/env bash
+    set -euxo pipefail
+    if [ ! -d build ]; then
+        mkdir build
+    fi
+
+# Generate the cmake project (Tracy disabled)
+gen: mkdir
+    cd build && cmake .. -GXcode -DTRACY_ENABLE=OFF
+
+# Erase and rebuild `build/` folder
+[confirm("Are you sure you want to delete `build/`? (y/N)")]
+nuke: && mkdir gen
+    rm -rf build/
+
+# Generate the cmake project (Tracy enabled)
+tracy: mkdir
+    cd build && cmake .. -GXcode -DTRACY_ENABLE=ON

src/ar.cpp

@@ -9,6 +9,7 @@
 
 // application
 #include "orc/str.hpp"
+#include "orc/tracy.hpp"
 
 /**************************************************************************************************/
 
@@ -33,11 +34,12 @@ void read_ar(object_ancestry&& ancestry,
              freader& s,
              std::istream::pos_type end_pos,
              file_details details,
-             callbacks callbacks) {
+             macho_params params) {
     std::string magic = read_fixed_string<8>(s);
     assert(magic == "!<arch>\n");
 
-    // REVISIT: (fbrereto) opportunity to parallelize here.
+    // The .o files are stored serially within the ar file, so I am not sure how easily this can be
+    // parallelized (if at all)
     while (s.tellg() < end_pos) {
         std::string identifier = rstrip(read_fixed_string<16>(s));
         std::string timestamp = rstrip(read_fixed_string<12>(s));
@@ -56,7 +58,7 @@ void read_ar(object_ancestry&& ancestry,
 
         if (identifier.rfind(".o") == identifier.size() - 2) {
             auto end_pos = s.tellg() + static_cast<std::streamoff>(file_size);
-            parse_file(identifier, ancestry, s, end_pos, callbacks);
+            parse_file(identifier, ancestry, s, end_pos, params);
             s.seekg(end_pos); // parse_file could leave the read head anywhere.
         } else {
             // skip to next file in the archive.