core.base.binutils

Binary file processing utility module.

binutils.bin2c

Generate C/C++ code from binary file.

Function Prototype

API

binutils.bin2c(binaryfile: <string>, outputfile: <string>, opt: <table>)

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
outputfile	Required. Output C/C++ source file path
opt	Optional. Options: - linewidth: line width (default: 32) - nozeroend: do not append null terminator (default: false)

binutils.bin2obj

Generate object file from binary file.

Function Prototype

API

binutils.bin2obj(binaryfile: <string>, outputfile: <string>, opt: <table>)

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path
outputfile	Required. Output object file path
opt	Optional. Options: - format: object format (coff, elf, macho) - symbol_prefix: symbol prefix (default: _binary_) - arch: architecture (default: x86_64) - plat: platform (default: macosx, only for macho) - basename: base name for symbols - target_minver: target minimum version (only for macho) - xcode_sdkver: Xcode SDK version (only for macho) - zeroend: append null terminator (default: false)

NOTE

The builtin rule util.bin2obj automatically detects the arch and platform, but when calling binutils.bin2obj, these options should be configured manually. In most scenarios, use target:arch() and target:plat() to easily acquire and fill in the parameters.

Symbol Name

Similar to the rule util.bin2obj, binutils.bin2obj provides two symbols in the generated object file: <symbol_prefix><basename>_start and <symbol_prefix><basename>_end. The _start symbol marks the start of the binary data, and _end marks the end.

Example: (with symbol_prefix = "_foo_", basename = "bar", C++20)

#include <span>

extern "C"
{
    extern const std::byte _foo_bar_start[];
    extern const std::byte _foo_bar_end[];
}

void example()
{
    const auto data = std::span<const std::byte>(_foo_bar_start, _foo_bar_end);
}

binutils.readsyms

Read symbols from object file (auto-detect format: COFF, ELF, or Mach-O).

Function Prototype

API

binutils.readsyms(binaryfile: <string>)

Parameter Description

Parameter	Description
binaryfile	Required. Input object file path

Return Value

Return Value	Description
<table>	Symbols list

binutils.deplibs

Get dependent libraries.

Function Prototype

API

binutils.deplibs(binaryfile: <string>)

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path

Return Value

Return Value	Description
<table>	Dependent libraries list

binutils.rpath_list

Get rpath list from binary file (auto-detect format: ELF or Mach-O).

Function Prototype

API

binutils.rpath_list(binaryfile: <string>)

Parameter Description

Parameter	Description
binaryfile	Required. Input binary file path

Return Value

Return Value	Description
<table>	Rpath list

binutils.extractlib

Extract static library to directory.

Function Prototype

API

binutils.extractlib(libraryfile: <string>, outputdir: <string>, opt: <table>)

Parameter Description

Parameter	Description
libraryfile	Required. Input static library file path
outputdir	Required. Output directory path
opt	Optional. Options (reserved)