fold/third_party/ghidra-decompiler/cpp/ghidra_context.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

78 lines
3.8 KiB
C++

/* ###
* IP: GHIDRA
*
* 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.
*/
#ifndef __GHIDRA_CONTEXT_HH__
#define __GHIDRA_CONTEXT_HH__
/// \file ghidra_context.hh
/// \brief Obtaining context information from a Ghidra client
#include "globalcontext.hh"
#include "ghidra_arch.hh"
namespace ghidra {
/// \brief An implementation of a ContextDatabase obtaining context information via a Ghidra client
///
/// This only implements the tracked register parts of the interface. In fact, this only implements
/// the single method getTrackedSet(). Other methods that get or set the low-level (disassembly)
/// context variables will throw an exception. The low-level context is only needed by the
/// Sleigh disassembly engine, which is being provided by the Ghidra client in this use case.
class ContextGhidra : public ContextDatabase {
ArchitectureGhidra *glb; ///< Architecture and connection to the Ghidra client
mutable TrackedSet cache; ///< A cache of previously fetched tracked registers.
virtual ContextBitRange &getVariable(const string &nm) {
throw LowlevelError("getVariable should not be called for GHIDRA"); }
virtual const ContextBitRange &getVariable(const string &nm) const {
throw LowlevelError("getVariable should not be called for GHIDRA"); }
virtual void getRegionForSet(vector<uintm *> &res,const Address &addr1,const Address &addr2,int4 num,uintm mask) {
throw LowlevelError("getRegionForSet should not be called for GHIDRA"); }
virtual void getRegionToChangePoint(vector<uintm *> &res,const Address &addr,int4 num,uintm mask) {
throw LowlevelError("getRegionToChangePoint should not be called for GHIDRA"); }
virtual const uintm *getDefaultValue(void) const {
throw LowlevelError("getDefaultValue should not be called for GHIDRA"); }
virtual uintm *getDefaultValue(void) {
throw LowlevelError("getDefaultValue should not be called for GHIDRA"); }
public:
ContextGhidra(ArchitectureGhidra *g) { glb = g; } ///< Construct with a specific client
virtual ~ContextGhidra(void) {}
// Routines that are actually implemented
virtual const TrackedSet &getTrackedSet(const Address &addr) const;
// Ignored routines (taken care of by GHIDRA)
virtual void decode(Decoder &decoder);
virtual void decodeFromSpec(Decoder &decoder);
// Unimplemented routines (should never be called)
virtual int getContextSize(void) const {
throw LowlevelError("getContextSize should not be called for GHIDRA"); }
virtual const uintm *getContext(const Address &addr) const {
throw LowlevelError("getContext should not be called for GHIDRA"); }
virtual const uintm *getContext(const Address &addr,uintb &first,uintb &last) const {
throw LowlevelError("getContext should not be called for GHIDRA"); }
virtual void registerVariable(const string &nm,int4 sbit,int4 ebit) {
throw LowlevelError("registerVariable should not be called for GHIDRA"); }
virtual void encode(Encoder &encoder) const {
throw LowlevelError("context::encode should not be called for GHIDRA"); }
virtual TrackedSet &createSet(const Address &addr1,const Address &addr2) {
throw LowlevelError("createSet should not be called for GHIDRA"); }
virtual TrackedSet &getTrackedDefault(void) {
throw LowlevelError("getTrackedDefault should not be called for GHIDRA"); }
};
} // End namespace ghidra
#endif