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

82 lines
2.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 __PARAMID_HH__
#define __PARAMID_HH__
#include "funcdata.hh"
namespace ghidra {
extern ElementId ELEM_PARAMMEASURES; ///< Marshaling element \<parammeasures>
extern ElementId ELEM_PROTO; ///< Marshaling element \<proto>
extern ElementId ELEM_RANK; ///< Marshaling element \<rank>
class ParamMeasure {
public:
enum ParamIDIO {
INPUT = 0,
OUTPUT = 1
};
enum ParamRank {
BESTRANK = 1,
DIRECTWRITEWITHOUTREAD = 1, //Output
DIRECTREAD = 2, //Input. Must be same as DIRECTWRITEWITHREAD so that walkforward as part of walkbackward works
// for detecting(not that DIRECTREAD is lower rank that DIRECTWRITEWITHOUTREAD)
DIRECTWRITEWITHREAD = 2, //Output
DIRECTWRITEUNKNOWNREAD = 3, //Output
SUBFNPARAM = 4, //Input
THISFNPARAM = 4, //Output
SUBFNRETURN = 5, //Output
THISFNRETURN = 5, //Input
INDIRECT = 6, //Input or Output
WORSTRANK = 7
};
struct WalkState {
bool best;
int4 depth;
ParamRank terminalrank;
};
private:
VarnodeData vndata;
Datatype *vntype;
ParamRank rank;
ParamIDIO io;
int4 numcalls;
void walkforward( WalkState &state, PcodeOp *ignoreop, Varnode *vn );
void walkbackward( WalkState &state, PcodeOp *ignoreop,Varnode *vn );
void updaterank( ParamRank rank_in,bool best ) { rank = (best==true) ? min( rank, rank_in ) : max( rank, rank_in ); }
public:
ParamMeasure( const Address &addr, int4 sz, Datatype *dt, ParamIDIO io_in) {
vndata.space=addr.getSpace(); vndata.offset=addr.getOffset(); vndata.size = sz; vntype=dt; io = io_in; rank=WORSTRANK; }
void calculateRank(bool best,Varnode *basevn,PcodeOp *ignoreop);
void encode( Encoder &encoder,ElementId &tag,bool moredetail ) const;
void savePretty( ostream &s,bool moredetail ) const;
int4 getMeasure(void) const { return (int4) rank; }
};
class ParamIDAnalysis
{
Funcdata *fd;
list<ParamMeasure> InputParamMeasures;
list<ParamMeasure> OutputParamMeasures;
public:
ParamIDAnalysis( Funcdata *fd_in, bool justproto );
void encode( Encoder &encoder, bool moredetail ) const;
void savePretty( ostream &s, bool moredetail ) const;
};
} // End namespace ghidra
#endif //ifndef __PARAMID_HH__