contrib/llvm/tools/lldb/include/lldb/Expression/Materializer.h

   1 //===-- Materializer.h ------------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef liblldb_Materializer_h
  11 #define liblldb_Materializer_h
  12
  13 // C Includes
  14 // C++ Includes
  15 #include <memory>
  16 #include <vector>
  17
  18 // Other libraries and framework includes
  19 // Project includes
  20 #include "lldb/Expression/IRMemoryMap.h"
  21 #include "lldb/Symbol/TaggedASTType.h"
  22 #include "lldb/Target/StackFrame.h"
  23 #include "lldb/Utility/Status.h"
  24 #include "lldb/lldb-private-types.h"
  25
  26 namespace lldb_private {
  27
  28 class Materializer {
  29 public:
  30   Materializer();
  31   ~Materializer();
  32
  33   class Dematerializer {
  34   public:
  35     Dematerializer()
  36         : m_materializer(nullptr), m_map(nullptr),
  37           m_process_address(LLDB_INVALID_ADDRESS) {}
  38
  39     ~Dematerializer() { Wipe(); }
  40
  41     void Dematerialize(Status &err, lldb::addr_t frame_top,
  42                        lldb::addr_t frame_bottom);
  43
  44     void Wipe();
  45
  46     bool IsValid() {
  47       return m_materializer && m_map &&
  48              (m_process_address != LLDB_INVALID_ADDRESS);
  49     }
  50
  51   private:
  52     friend class Materializer;
  53
  54     Dematerializer(Materializer &materializer, lldb::StackFrameSP &frame_sp,
  55                    IRMemoryMap &map, lldb::addr_t process_address)
  56         : m_materializer(&materializer), m_map(&map),
  57           m_process_address(process_address) {
  58       if (frame_sp) {
  59         m_thread_wp = frame_sp->GetThread();
  60         m_stack_id = frame_sp->GetStackID();
  61       }
  62     }
  63
  64     Materializer *m_materializer;
  65     lldb::ThreadWP m_thread_wp;
  66     StackID m_stack_id;
  67     IRMemoryMap *m_map;
  68     lldb::addr_t m_process_address;
  69   };
  70
  71   typedef std::shared_ptr<Dematerializer> DematerializerSP;
  72   typedef std::weak_ptr<Dematerializer> DematerializerWP;
  73
  74   DematerializerSP Materialize(lldb::StackFrameSP &frame_sp, IRMemoryMap &map,
  75                                lldb::addr_t process_address, Status &err);
  76
  77   class PersistentVariableDelegate {
  78   public:
  79     virtual ~PersistentVariableDelegate();
  80     virtual ConstString GetName() = 0;
  81     virtual void DidDematerialize(lldb::ExpressionVariableSP &variable) = 0;
  82   };
  83
  84   uint32_t
  85   AddPersistentVariable(lldb::ExpressionVariableSP &persistent_variable_sp,
  86                         PersistentVariableDelegate *delegate, Status &err);
  87   uint32_t AddVariable(lldb::VariableSP &variable_sp, Status &err);
  88   uint32_t AddResultVariable(const CompilerType &type, bool is_lvalue,
  89                              bool keep_in_memory,
  90                              PersistentVariableDelegate *delegate, Status &err);
  91   uint32_t AddSymbol(const Symbol &symbol_sp, Status &err);
  92   uint32_t AddRegister(const RegisterInfo &register_info, Status &err);
  93
  94   uint32_t GetStructAlignment() { return m_struct_alignment; }
  95
  96   uint32_t GetStructByteSize() { return m_current_offset; }
  97
  98   class Entity {
  99   public:
 100     Entity() : m_alignment(1), m_size(0), m_offset(0) {}
 101
 102     virtual ~Entity() = default;
 103
 104     virtual void Materialize(lldb::StackFrameSP &frame_sp, IRMemoryMap &map,
 105                              lldb::addr_t process_address, Status &err) = 0;
 106     virtual void Dematerialize(lldb::StackFrameSP &frame_sp, IRMemoryMap &map,
 107                                lldb::addr_t process_address,
 108                                lldb::addr_t frame_top,
 109                                lldb::addr_t frame_bottom, Status &err) = 0;
 110     virtual void DumpToLog(IRMemoryMap &map, lldb::addr_t process_address,
 111                            Log *log) = 0;
 112     virtual void Wipe(IRMemoryMap &map, lldb::addr_t process_address) = 0;
 113
 114     uint32_t GetAlignment() { return m_alignment; }
 115
 116     uint32_t GetSize() { return m_size; }
 117
 118     uint32_t GetOffset() { return m_offset; }
 119
 120     void SetOffset(uint32_t offset) { m_offset = offset; }
 121
 122   protected:
 123     void SetSizeAndAlignmentFromType(CompilerType &type);
 124
 125     uint32_t m_alignment;
 126     uint32_t m_size;
 127     uint32_t m_offset;
 128   };
 129
 130 private:
 131   uint32_t AddStructMember(Entity &entity);
 132
 133   typedef std::unique_ptr<Entity> EntityUP;
 134   typedef std::vector<EntityUP> EntityVector;
 135
 136   DematerializerWP m_dematerializer_wp;
 137   EntityVector m_entities;
 138   uint32_t m_current_offset;
 139   uint32_t m_struct_alignment;
 140 };
 141
 142 } // namespace lldb_private
 143
 144 #endif // liblldb_Materializer_h