Binary instrumentation: more robust exclusion of functions used internally

[jrmadsen]

Overview

This PR attempts to increase the stability of binary rewrite and runtime instrumentation.

Improved protection against self-instrumentation

Using the binary analysis capabilities added from #229 the Dyninst SymtabAPI, OmniTrace now does a much better job of avoiding instrumentation of functions which are internally called by OmniTrace:

• The omnitrace executable searches for and parses the symbols of various libraries which are known to cause problems when instrumented
  • GNU libraries which are common to nearly every library, e.g., "libc.so.6", "libdl.so.2", etc., and thus are outside the scope of the users optimizations efforts
  • Libraries which OmniTrace depends on for functionality, e.g. "libunwind.so", "libgotcha.so", "libroctracer64.so", etc.
    • OmniTrace skips instrumenting any module_function instance when it's member module_name or function_name variable matches the library name, source file, or function name found for that symbol (unless the user explicitly requests that it be eligible for instrumentation)
• Note: the parsing of the "internal" libraries may result in longer instrumentation time and higher memory usage. Please file an issue if either of these is found to be excessive.

Function filters based on linkage and visibility

Added options to restrict instrumentation to certain linkage types (e.g. avoid instrumenting weak symbols) and visibility types (e.g. avoid instrumenting hidden symbols).

Function filters based on instructions

In the past, after instrumentation, some applications instrumented by Dyninst would fail with a trap signal (e.g. #147). In several cases, it was found that this occurred whenever certain instructions were present in the function so an option was added to exclude functions based on one or more regex patterns was added.

Details

• generates list of "internal" libraries and attempts to find the first match via:
  • the library is already open, e.g. dlopen(<libname>, RTLD_LAZY | RTLD_NOLOAD)
  • searching for the library in LD_LIBRARY_PATH
  • searching for the library in OMNITRACE_ROCM_PATH, ROCM_PATH
  • searching the folders from /sbin/ldconfig -p
  • searching for the library in common places such as /usr/local/lib
• provides new --linkage command line option to restrict instrumentation to functions with particular type(s) of linkage
  • Linkage types: unknown, global, local, weak, unique
• provides new --visibility command line option to restrict instrumentation to functions with particular type(s) of visibility
  • Visibility types: unknown, default, hidden, protected, internal
• provides new --internal-module-include and --internal-function-include command line regex options to bypass automatic exclusion from instrumentation
• provides new --internal-library-append command line option to specify a library should be considered internal
• provides new --internal-library-remove command line option to specify a library should not be considered internal
• provides new --instruction-exclude command line regex option to exclude functions which contain matching instructions
• provides new --internal-library-deps command line option to treat libraries linked to internal libraries as internal libraries
  • generally, this will only be helpful during runtime instrumentation when OmniTrace is built with an external dyninst library which is dynamically linked to boost libraries and the application is using the same boost libraries
• relaxed restrictions in module_function::is_module_constrained()
• relaxed restrictions in module_function::is_routine_constrained()
• added a few miscellaneous nullptr checks

Miscellaneous

• Fix LD_PRELOAD + OMNITRACE_DL_VERBOSE=3 issue
• Adds a sampling offload verbose message
• Improves MPI send-recv.cpp example error message
• Minor tweaks to binary library
  • binary::get_linked_path returns std::optional<string>
  • renamed binary::symbol::read_bfd to binary::symbol::read_bfd_line_info
  • binary::get_binary_info has param options for reading line info and included undefined symbols
• fixed another edge case instance of resource deadlock during first call to configure_settings
• improved the error log printing in omnitrace (does not print repeated messages)