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

55 lines
2.2 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.
*/
/// \file xml_arch.hh
/// \brief Extension to read executables based on an XML format
#ifndef __XML_ARCH_HH__
#define __XML_ARCH_HH__
#include "sleigh_arch.hh"
#include "loadimage_xml.hh"
namespace ghidra {
extern ElementId ELEM_XML_SAVEFILE; ///< Marshaling element \<xml_savefile>
/// \brief Extension for building an XML format capable Architecture
class XmlArchitectureCapability : public ArchitectureCapability {
static XmlArchitectureCapability xmlArchitectureCapability; ///< The singleton instance
XmlArchitectureCapability(void); ///< Singleton
XmlArchitectureCapability(const XmlArchitectureCapability &op2); ///< Not implemented
XmlArchitectureCapability &operator=(const XmlArchitectureCapability &op2); ///< Not implemented
public:
virtual ~XmlArchitectureCapability(void);
virtual Architecture *buildArchitecture(const string &filename,const string &target,ostream *estream);
virtual bool isFileMatch(const string &filename) const;
virtual bool isXmlMatch(Document *doc) const;
};
/// \brief An Architecture that loads executables using an XML format
class XmlArchitecture : public SleighArchitecture {
long adjustvma; ///< The amount to adjust the virtual memory address
virtual void buildLoader(DocumentStorage &store);
// virtual void resolveArchitecture(void); ///< Inherit SleighArchitecture's version
virtual void postSpecFile(void);
public:
virtual void encode(Encoder &encoder) const;
virtual void restoreXml(DocumentStorage &store);
XmlArchitecture(const string &fname,const string &targ,ostream *estream); ///< Constructor
virtual ~XmlArchitecture(void) {}
};
} // End namespace ghidra
#endif