xref.hpp

Go to the documentation of this file.

/*
 *      Interactive disassembler (IDA).
 *      Copyright (c) 1990-2025 Hex-Rays
 *      ALL RIGHTS RESERVED.
 *
 */
 
#ifndef _XREF_HPP
#define _XREF_HPP

 
class func_t;   // #include <funcs.hpp>
 
//---------------------------------------------------------------------------
//      C R O S S - R E F E R E N C E   T Y P E S
//---------------------------------------------------------------------------


enum cref_t
{
  fl_U,                         
  fl_CF = 16,                   
  fl_CN,                        
  fl_JF,                        
  fl_JN,                        
  fl_USobsolete,                
  fl_F,                         
};

enum dref_t
{
  dr_U,                         
  dr_O,                         
  dr_W,                         
  dr_R,                         
  dr_T,                         
  dr_I,                         
  dr_S,                         
};
 

#define XREF_USER       0x20    
#define XREF_TAIL       0x40    
#define XREF_BASE       0x80    
#define XREF_MASK       0x1F    
 
#define XREF_PASTEND    0x100   

idaman char ida_export xrefchar(char xrtype);

 
//---------------------------------------------------------------------------
//      A D D / D E L E T E   C R O S S - R E F E R E N C E S
//---------------------------------------------------------------------------

 
idaman bool ida_export add_cref(ea_t from, ea_t to, cref_t type);
 

 
idaman bool ida_export del_cref(ea_t from, ea_t to, bool expand);
 

 
idaman bool ida_export add_dref(ea_t from, ea_t to, dref_t type);
 

 
idaman void ida_export del_dref(ea_t from, ea_t to);
 
 
//-------------------------------------------------------------------------
//      E N U M E R A T E   ( G E T )   C R O S S - R E F E R E N C E S
//-------------------------------------------------------------------------
 
struct xrefblk_t;
idaman bool ida_export xrefblk_t_first_from(xrefblk_t *, ea_t from, int flags);
idaman bool ida_export xrefblk_t_next_from(xrefblk_t *);
idaman bool ida_export xrefblk_t_first_to(xrefblk_t *, ea_t to, int flags);
idaman bool ida_export xrefblk_t_next_to(xrefblk_t *);

struct xrefblk_t
{
  ea_t from;            
  ea_t to;              
  bool iscode;          
  uchar type;           
  bool user;            
  uchar _flags;

#define XREF_FLOW       0x00            
#define XREF_NOFLOW     0x01            
#define XREF_DATA       0x02            
#define XREF_CODE       0x04            
#define XREF_EA         0x08            
#define XREF_TID        0x10            


  bool first_from(ea_t _from, int flags=XREF_FLOW)
    { return xrefblk_t_first_from(this, _from, flags); }

  bool next_from()
    { return xrefblk_t_next_from(this); }

  bool first_to(ea_t _to, int flags=XREF_FLOW)
    { return xrefblk_t_first_to(this, _to, flags); }

  bool next_to()
    { return xrefblk_t_next_to(this); }

  bool next_from(ea_t _from, ea_t _to, int flags)
  {
    if ( first_from(_from, flags) )
    {
      to = _to;
      return next_from();
    }
    return false;
  }

  bool next_to(ea_t _from, ea_t _to, int flags)
  {
    if ( first_to(_to, flags) )
    {
      from = _from;
      return next_to();
    }
    return false;
  }

};
 
//-------------------------------------------------------------------------
 
idaman ea_t ida_export get_first_dref_from(ea_t from);
 

 
idaman ea_t ida_export get_next_dref_from(ea_t from, ea_t current);
 

 
idaman ea_t ida_export get_first_dref_to(ea_t to);
 

 
idaman ea_t ida_export get_next_dref_to(ea_t to, ea_t current);
 

 
idaman ea_t ida_export get_first_cref_from(ea_t from);
 

 
idaman ea_t ida_export get_next_cref_from(ea_t from, ea_t current);
 

 
idaman ea_t ida_export get_first_cref_to(ea_t to);
 

 
idaman ea_t ida_export get_next_cref_to(ea_t to, ea_t current);
 

idaman ea_t ida_export get_first_fcref_from(ea_t from);
idaman ea_t ida_export get_next_fcref_from(ea_t from, ea_t current);
idaman ea_t ida_export get_first_fcref_to(ea_t to);
idaman ea_t ida_export get_next_fcref_to(ea_t to, ea_t current);
 

 
idaman bool ida_export has_external_refs(func_t *pfn, ea_t ea);
 

 
idaman bool ida_export has_jump_or_flow_xref(ea_t ea);
 
 
//-------------------------------------------------------------------------
//      S W I T C H   T A B L E   F U N C T I O N S
//-------------------------------------------------------------------------
#ifdef NALT_HPP

 
idaman bool ida_export create_switch_table(
        ea_t insn_ea,
        const switch_info_t &si);
 

 
idaman void ida_export create_switch_xrefs(
        ea_t insn_ea,
        const switch_info_t &si);
 

typedef qvector<svalvec_t> casevec_t;
 

 
idaman bool ida_export calc_switch_cases(
        casevec_t *casevec,
        eavec_t *targets,
        ea_t insn_ea,
        const switch_info_t &si);

idaman void ida_export delete_switch_table(
        ea_t jump_ea,
        const switch_info_t &si);
 
#endif
 
//-------------------------------------------------------------------------
//      F U N C T I O N S   F O R   T H E   K E R N E L
//-------------------------------------------------------------------------

idaman bool ida_export create_xrefs_from(ea_t ea);  // returns false: no item at ea
idaman void ida_export delete_all_xrefs_from(ea_t ea, bool expand);
 
 
#if !defined(NO_OBSOLETE_FUNCS)
#define XREF_ALL XREF_FLOW
#define XREF_FAR XREF_NOFLOW
#endif
 
#endif // _XREF_HPP