fold/third_party/ghidra-decompiler/cpp/loadimage_bfd.hh
trvon 5152d0c9f7
feat(binary): vendor Ghidra 12.1 decompiler + validate P-Code lifting (Phase 0-1)
Foundation for replacing fold's dead/abstract binary encoder with a real
SSA P-Code frontend. Verified root-cause gap: serializeBinaryIR() emits only
data-discovery nodes (sections/strings/imports/exports); the control-flow
BinaryExprKind values (BasicBlock/CallSite/...) are never constructed, so the
Z3-BB encoder's encodable filter is always empty and encodeBinaryBBs never
runs — hence 0 binary Z3 findings. The P-Code pipeline supersedes that path.

Phase 0 — docs/internal/ghidra-pcode-integration-research.md: P-Code opcode
core, the decompiler C++ embedding API (LoadImage/SleighArchitecture/Funcdata),
the CORE+DECCORE+SLEIGH source sets, no-bison finding, and pypcode as build
reference.

Phase 1 — vendored Ghidra decompiler at pinned commit (Ghidra_12.1_build,
7e89d94e34...) under third_party/ghidra-decompiler/ (cpp + AArch64 specs +
Apache-2.0 LICENSE + VENDOR.md + .gitignore for build artifacts). Validated by
hand on this clang-21/macOS toolchain:
  - full SSA engine (CORE+DECCORE+SLEIGH, 80 files incl. heritage/funcdata/
    action) compiles clean, -std=c++11 -O2, NO BFD, NO bison (generated
    parsers are committed upstream; ruleparse isn't in the lib set);
  - sleigh compiler builds; AArch64 .slaspec -> .sla compiles;
  - tools/pcode_dump.cpp (custom LoadImage, no BFD) lifts the real arm64
    sym._div_by_zero_direct to correct P-Code: `mov w9,#0 -> COPY(const 0)`,
    `sdiv -> INT_SDIV(w8,w9)` — divisor zero-ness explicit in the data flow,
    so the Phase-3 encoder proves div-by-zero trivially, multi-arch.

Not yet meson-wired (next step) and no fold-side IR/encoder yet (Phase 2-3);
this commit is the validated vendor + smoke tool.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-05-31 17:32:47 -04:00

94 lines
3 KiB
C++

/* ###
* IP: GHIDRA
* NOTE: Interface to GNU BFD library which is GPL 3
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Use the GNU bfd library to manipulate a load image
#ifndef __LOADIMAGE_BFD_HH__
#define __LOADIMAGE_BFD_HH__
#include "loadimage.hh"
// bfd.h requires PACKAGE/PACKAGE_VERSION to be defined
// https://sourceware.org/bugzilla/show_bug.cgi?id=14243
#ifndef PACKAGE
#define PACKAGE
#define __LOADIMAGE_BFD__DEFINED_PACKAGE
#endif
#ifndef PACKAGE_VERSION
#define PACKAGE_VERSION
#define __LOADIMAGE_BFD__DEFINED_PACKAGE_VERSION
#endif
#include <bfd.h>
#ifdef __LOADIMAGE_BFD__DEFINED_PACKAGE
#undef PACKAGE
#undef __LOADIMAGE_BFD__DEFINED_PACKAGE
#endif
#ifdef __LOADIMAGE_BFD__DEFINED_PACKAGE_VERSION
#undef PACKAGE_VERSION
#undef __LOADIMAGE_BFD__DEFINED_PACKAGE_VERSION
#endif
namespace ghidra {
struct ImportRecord {
string dllname;
string funcname;
int ordinal;
Address address;
Address thunkaddress;
};
class LoadImageBfd : public LoadImage {
static int4 bfdinit; // Is the library (globally) initialized
string target; // File format (supported by BFD)
bfd *thebfd;
AddrSpace *spaceid; // We need to map space id to segments but since
// we are currently ignoring segments anyway...
uintb bufoffset; // Starting offset of byte buffer
uint4 bufsize; // Number of bytes in the buffer
uint1 *buffer; // The actual buffer
mutable asymbol **symbol_table;
mutable long number_of_symbols;
mutable long cursymbol;
mutable asection *secinfoptr;
asection *findSection(uintb offset,uintb &ssize) const; // Find section containing given offset
void advanceToNextSymbol(void) const;
public:
LoadImageBfd(const string &f,const string &t);
void attachToSpace(AddrSpace *id) { spaceid = id; }
void open(void); // Open any descriptors
void close(void); // Close any descriptor
void getImportTable(vector<ImportRecord> &irec) { throw LowlevelError("Not implemented"); }
virtual ~LoadImageBfd(void);
virtual void loadFill(uint1 *ptr,int4 size,const Address &addr); // Load a chunk of image
virtual void openSymbols(void) const;
virtual void closeSymbols(void) const;
virtual bool getNextSymbol(LoadImageFunc &record) const;
virtual void openSectionInfo(void) const;
virtual void closeSectionInfo(void) const;
virtual bool getNextSection(LoadImageSection &sec) const;
virtual void getReadonly(RangeList &list) const;
virtual string getArchType(void) const;
virtual void adjustVma(long adjust);
};
} // End namespace ghidra
#endif