1 //===-- RenderScriptRuntime.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_RenderScriptRuntime_h_
11 #define liblldb_RenderScriptRuntime_h_
12 
13 // C Includes
14 // C++ Includes
15 // Other libraries and framework includes
16 // Project includes
17 #include "lldb/lldb-private.h"
18 #include "lldb/Target/LanguageRuntime.h"
19 #include "lldb/Target/CPPLanguageRuntime.h"
20 #include "lldb/Core/Module.h"
21 
22 namespace lldb_private
23 {
24 
25 namespace lldb_renderscript
26 {
27 
28 typedef uint32_t RSSlot;
29 class RSModuleDescriptor;
30 struct RSGlobalDescriptor;
31 struct RSKernelDescriptor;
32 
33 typedef std::shared_ptr<RSModuleDescriptor> RSModuleDescriptorSP;
34 typedef std::shared_ptr<RSGlobalDescriptor> RSGlobalDescriptorSP;
35 typedef std::shared_ptr<RSKernelDescriptor> RSKernelDescriptorSP;
36 
37 // Breakpoint Resolvers decide where a breakpoint is placed,
38 // so having our own allows us to limit the search scope to RS kernel modules.
39 // As well as check for .expand kernels as a fallback.
40 class RSBreakpointResolver : public BreakpointResolver
41 {
42   public:
43 
44     RSBreakpointResolver(Breakpoint *bkpt, ConstString name):
45                          BreakpointResolver (bkpt, BreakpointResolver::NameResolver),
46                          m_kernel_name(name)
47     {
48     }
49 
50     void
51     GetDescription(Stream *strm) override
52     {
53         if (strm)
54             strm->Printf("RenderScript kernel breakpoint for '%s'", m_kernel_name.AsCString());
55     }
56 
57     void
58     Dump(Stream *s) const override
59     {
60     }
61 
62     Searcher::CallbackReturn
63     SearchCallback(SearchFilter &filter,
64                    SymbolContext &context,
65                    Address *addr,
66                    bool containing) override;
67 
68     Searcher::Depth
69     GetDepth() override
70     {
71         return Searcher::eDepthModule;
72     }
73 
74     lldb::BreakpointResolverSP
75     CopyForBreakpoint(Breakpoint &breakpoint) override
76     {
77         lldb::BreakpointResolverSP ret_sp(new RSBreakpointResolver(&breakpoint, m_kernel_name));
78         return ret_sp;
79     }
80 
81   protected:
82     ConstString m_kernel_name;
83 };
84 
85 struct RSKernelDescriptor
86 {
87   public:
88     RSKernelDescriptor(const RSModuleDescriptor *module, const char *name, uint32_t slot)
89         : m_module(module)
90         , m_name(name)
91         , m_slot(slot)
92     {
93     }
94 
95     void Dump(Stream &strm) const;
96 
97     const RSModuleDescriptor *m_module;
98     ConstString m_name;
99     RSSlot m_slot;
100 };
101 
102 struct RSGlobalDescriptor
103 {
104   public:
105     RSGlobalDescriptor(const RSModuleDescriptor *module, const char *name )
106         : m_module(module)
107         , m_name(name)
108     {
109     }
110 
111     void Dump(Stream &strm) const;
112 
113     const RSModuleDescriptor *m_module;
114     ConstString m_name;
115 };
116 
117 class RSModuleDescriptor
118 {
119   public:
120     RSModuleDescriptor(const lldb::ModuleSP &module)
121         : m_module(module)
122     {
123     }
124 
125     ~RSModuleDescriptor() {}
126 
127     bool ParseRSInfo();
128 
129     void Dump(Stream &strm) const;
130 
131     const lldb::ModuleSP m_module;
132     std::vector<RSKernelDescriptor> m_kernels;
133     std::vector<RSGlobalDescriptor> m_globals;
134     std::map<std::string, std::string> m_pragmas;
135     std::string m_resname;
136 };
137 
138 } // end lldb_renderscript namespace
139 
140 class RenderScriptRuntime : public lldb_private::CPPLanguageRuntime
141 {
142   public:
143 
144     enum ModuleKind
145     {
146         eModuleKindIgnored,
147         eModuleKindLibRS,
148         eModuleKindDriver,
149         eModuleKindImpl,
150         eModuleKindKernelObj
151     };
152 
153 
154     ~RenderScriptRuntime() {}
155 
156     //------------------------------------------------------------------
157     // Static Functions
158     //------------------------------------------------------------------
159     static void Initialize();
160 
161     static void Terminate();
162 
163     static lldb_private::LanguageRuntime *CreateInstance(Process *process, lldb::LanguageType language);
164 
165     static lldb::CommandObjectSP GetCommandObject(CommandInterpreter& interpreter);
166 
167     static lldb_private::ConstString GetPluginNameStatic();
168 
169     static bool IsRenderScriptModule(const lldb::ModuleSP &module_sp);
170 
171     static ModuleKind GetModuleKind(const lldb::ModuleSP &module_sp);
172 
173     static void ModulesDidLoad(const lldb::ProcessSP& process_sp, const ModuleList &module_list );
174 
175     //------------------------------------------------------------------
176     // PluginInterface protocol
177     //------------------------------------------------------------------
178     virtual lldb_private::ConstString GetPluginName();
179 
180     virtual uint32_t GetPluginVersion();
181 
182     virtual bool IsVTableName(const char *name);
183 
184     virtual bool GetDynamicTypeAndAddress(ValueObject &in_value, lldb::DynamicValueType use_dynamic,
185                                           TypeAndOrName &class_type_or_name, Address &address,
186                                           Value::ValueType &value_type);
187 
188     virtual bool CouldHaveDynamicValue(ValueObject &in_value);
189 
190     virtual lldb::BreakpointResolverSP CreateExceptionResolver(Breakpoint *bkpt, bool catch_bp, bool throw_bp);
191 
192     bool LoadModule(const lldb::ModuleSP &module_sp);
193 
194     bool ProbeModules(const ModuleList module_list);
195 
196     void DumpModules(Stream &strm) const;
197 
198     void DumpContexts(Stream &strm) const;
199 
200     void DumpKernels(Stream &strm) const;
201 
202     void AttemptBreakpointAtKernelName(Stream &strm, const char *name, Error &error, lldb::TargetSP target);
203 
204     void SetBreakAllKernels(bool do_break, lldb::TargetSP target);
205 
206     void Status(Stream &strm) const;
207 
208     virtual size_t GetAlternateManglings(const ConstString &mangled, std::vector<ConstString> &alternates) {
209         return static_cast<size_t>(0);
210     }
211 
212     virtual void ModulesDidLoad(const ModuleList &module_list );
213 
214     void Update();
215 
216     void Initiate();
217 
218   protected:
219 
220     void InitSearchFilter(lldb::TargetSP target)
221     {
222         if (!m_filtersp)
223             m_filtersp.reset(new SearchFilterForUnconstrainedSearches(target));
224     }
225 
226     void FixupScriptDetails(lldb_renderscript::RSModuleDescriptorSP rsmodule_sp);
227 
228     void LoadRuntimeHooks(lldb::ModuleSP module, ModuleKind kind);
229 
230     lldb::BreakpointSP CreateKernelBreakpoint(const ConstString& name);
231 
232     void BreakOnModuleKernels(const lldb_renderscript::RSModuleDescriptorSP rsmodule_sp);
233 
234     struct RuntimeHook;
235     typedef void (RenderScriptRuntime::*CaptureStateFn)(RuntimeHook* hook_info, ExecutionContext &context);  // Please do this!
236 
237     struct HookDefn
238     {
239         const char * name;
240         const char * symbol_name_m32; // mangled name for the 32 bit architectures
241         const char * symbol_name_m64; // mangled name for the 64 bit archs
242         uint32_t version;
243         ModuleKind kind;
244         CaptureStateFn grabber;
245     };
246 
247     struct RuntimeHook
248     {
249         lldb::addr_t address;
250         const HookDefn  *defn;
251         lldb::BreakpointSP bp_sp;
252     };
253 
254     typedef std::shared_ptr<RuntimeHook> RuntimeHookSP;
255 
256     struct ScriptDetails
257     {
258         std::string resname;
259         std::string scriptDyLib;
260         std::string cachedir;
261         lldb::addr_t context;
262         lldb::addr_t script;
263     };
264 
265     lldb::ModuleSP m_libRS;
266     lldb::ModuleSP m_libRSDriver;
267     lldb::ModuleSP m_libRSCpuRef;
268     std::vector<lldb_renderscript::RSModuleDescriptorSP> m_rsmodules;
269     std::vector<ScriptDetails> m_scripts;
270 
271     std::map<lldb::addr_t, lldb_renderscript::RSModuleDescriptorSP> m_scriptMappings;
272     std::map<lldb::addr_t, RuntimeHookSP> m_runtimeHooks;
273 
274     lldb::SearchFilterSP m_filtersp; // Needed to create breakpoints through Target API
275 
276     bool m_initiated;
277     bool m_debuggerPresentFlagged;
278     bool m_breakAllKernels;
279     static const HookDefn s_runtimeHookDefns[];
280     static const size_t s_runtimeHookCount;
281 
282   private:
283     RenderScriptRuntime(Process *process); // Call CreateInstance instead.
284 
285     static bool HookCallback(void *baton, StoppointCallbackContext *ctx, lldb::user_id_t break_id,
286                              lldb::user_id_t break_loc_id);
287 
288     void HookCallback(RuntimeHook* hook_info, ExecutionContext& context);
289 
290     bool GetArgSimple(ExecutionContext& context, uint32_t arg, uint64_t* data);
291 
292     void CaptureScriptInit1(RuntimeHook* hook_info, ExecutionContext& context);
293     void CaptureAllocationInit1(RuntimeHook* hook_info, ExecutionContext& context);
294     void CaptureSetGlobalVar1(RuntimeHook* hook_info, ExecutionContext& context);
295 
296 };
297 
298 } // namespace lldb_private
299 
300 #endif // liblldb_RenderScriptRuntime_h_
301