1 //===-- OperatingSystemPython.cpp --------------------------------*- 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 #include "lldb/lldb-python.h" 11 12 #ifndef LLDB_DISABLE_PYTHON 13 14 #include "OperatingSystemPython.h" 15 // C Includes 16 // C++ Includes 17 // Other libraries and framework includes 18 #include "lldb/Core/ArchSpec.h" 19 #include "lldb/Core/DataBufferHeap.h" 20 #include "lldb/Core/Debugger.h" 21 #include "lldb/Core/Module.h" 22 #include "lldb/Core/PluginManager.h" 23 #include "lldb/Core/RegisterValue.h" 24 #include "lldb/Core/ValueObjectVariable.h" 25 #include "lldb/Interpreter/CommandInterpreter.h" 26 #include "lldb/Interpreter/PythonDataObjects.h" 27 #include "lldb/Symbol/ClangNamespaceDecl.h" 28 #include "lldb/Symbol/ObjectFile.h" 29 #include "lldb/Symbol/VariableList.h" 30 #include "lldb/Target/Process.h" 31 #include "lldb/Target/StopInfo.h" 32 #include "lldb/Target/Target.h" 33 #include "lldb/Target/ThreadList.h" 34 #include "lldb/Target/Thread.h" 35 #include "Plugins/Process/Utility/DynamicRegisterInfo.h" 36 #include "Plugins/Process/Utility/RegisterContextDummy.h" 37 #include "Plugins/Process/Utility/RegisterContextMemory.h" 38 #include "Plugins/Process/Utility/ThreadMemory.h" 39 40 using namespace lldb; 41 using namespace lldb_private; 42 43 void 44 OperatingSystemPython::Initialize() 45 { 46 PluginManager::RegisterPlugin (GetPluginNameStatic(), 47 GetPluginDescriptionStatic(), 48 CreateInstance); 49 } 50 51 void 52 OperatingSystemPython::Terminate() 53 { 54 PluginManager::UnregisterPlugin (CreateInstance); 55 } 56 57 OperatingSystem * 58 OperatingSystemPython::CreateInstance (Process *process, bool force) 59 { 60 // Python OperatingSystem plug-ins must be requested by name, so force must be true 61 FileSpec python_os_plugin_spec (process->GetPythonOSPluginPath()); 62 if (python_os_plugin_spec && python_os_plugin_spec.Exists()) 63 { 64 std::unique_ptr<OperatingSystemPython> os_ap (new OperatingSystemPython (process, python_os_plugin_spec)); 65 if (os_ap.get() && os_ap->IsValid()) 66 return os_ap.release(); 67 } 68 return NULL; 69 } 70 71 72 const char * 73 OperatingSystemPython::GetPluginNameStatic() 74 { 75 return "python"; 76 } 77 78 const char * 79 OperatingSystemPython::GetPluginDescriptionStatic() 80 { 81 return "Operating system plug-in that gathers OS information from a python class that implements the necessary OperatingSystem functionality."; 82 } 83 84 85 OperatingSystemPython::OperatingSystemPython (lldb_private::Process *process, const FileSpec &python_module_path) : 86 OperatingSystem (process), 87 m_thread_list_valobj_sp (), 88 m_register_info_ap (), 89 m_interpreter (NULL), 90 m_python_object_sp () 91 { 92 if (!process) 93 return; 94 TargetSP target_sp = process->CalculateTarget(); 95 if (!target_sp) 96 return; 97 m_interpreter = target_sp->GetDebugger().GetCommandInterpreter().GetScriptInterpreter(); 98 if (m_interpreter) 99 { 100 101 std::string os_plugin_class_name (python_module_path.GetFilename().AsCString("")); 102 if (!os_plugin_class_name.empty()) 103 { 104 const bool init_session = false; 105 const bool allow_reload = true; 106 char python_module_path_cstr[PATH_MAX]; 107 python_module_path.GetPath(python_module_path_cstr, sizeof(python_module_path_cstr)); 108 Error error; 109 if (m_interpreter->LoadScriptingModule (python_module_path_cstr, allow_reload, init_session, error)) 110 { 111 // Strip the ".py" extension if there is one 112 size_t py_extension_pos = os_plugin_class_name.rfind(".py"); 113 if (py_extension_pos != std::string::npos) 114 os_plugin_class_name.erase (py_extension_pos); 115 // Add ".OperatingSystemPlugIn" to the module name to get a string like "modulename.OperatingSystemPlugIn" 116 os_plugin_class_name += ".OperatingSystemPlugIn"; 117 ScriptInterpreterObjectSP object_sp = m_interpreter->OSPlugin_CreatePluginObject(os_plugin_class_name.c_str(), process->CalculateProcess()); 118 if (object_sp && object_sp->GetObject()) 119 m_python_object_sp = object_sp; 120 } 121 } 122 } 123 } 124 125 OperatingSystemPython::~OperatingSystemPython () 126 { 127 } 128 129 DynamicRegisterInfo * 130 OperatingSystemPython::GetDynamicRegisterInfo () 131 { 132 if (m_register_info_ap.get() == NULL) 133 { 134 if (!m_interpreter || !m_python_object_sp) 135 return NULL; 136 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 137 138 if (log) 139 log->Printf ("OperatingSystemPython::GetDynamicRegisterInfo() fetching thread register definitions from python for pid %" PRIu64, m_process->GetID()); 140 141 PythonDictionary dictionary(m_interpreter->OSPlugin_RegisterInfo(m_python_object_sp)); 142 if (!dictionary) 143 return NULL; 144 145 m_register_info_ap.reset (new DynamicRegisterInfo (dictionary)); 146 assert (m_register_info_ap->GetNumRegisters() > 0); 147 assert (m_register_info_ap->GetNumRegisterSets() > 0); 148 } 149 return m_register_info_ap.get(); 150 } 151 152 //------------------------------------------------------------------ 153 // PluginInterface protocol 154 //------------------------------------------------------------------ 155 const char * 156 OperatingSystemPython::GetPluginName() 157 { 158 return "OperatingSystemPython"; 159 } 160 161 const char * 162 OperatingSystemPython::GetShortPluginName() 163 { 164 return GetPluginNameStatic(); 165 } 166 167 uint32_t 168 OperatingSystemPython::GetPluginVersion() 169 { 170 return 1; 171 } 172 173 bool 174 OperatingSystemPython::UpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list) 175 { 176 if (!m_interpreter || !m_python_object_sp) 177 return false; 178 179 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 180 181 // First thing we have to do is get the API lock, and the run lock. We're going to change the thread 182 // content of the process, and we're going to use python, which requires the API lock to do it. 183 // So get & hold that. This is a recursive lock so we can grant it to any Python code called on the stack below us. 184 Target &target = m_process->GetTarget(); 185 Mutex::Locker api_locker (target.GetAPIMutex()); 186 187 if (log) 188 log->Printf ("OperatingSystemPython::UpdateThreadList() fetching thread data from python for pid %" PRIu64, m_process->GetID()); 189 190 // The threads that are in "new_thread_list" upon entry are the threads from the 191 // lldb_private::Process subclass, no memory threads will be in this list. 192 193 auto lock = m_interpreter->AcquireInterpreterLock(); // to make sure threads_list stays alive 194 PythonList threads_list(m_interpreter->OSPlugin_ThreadsInfo(m_python_object_sp)); 195 if (threads_list) 196 { 197 ThreadList core_thread_list(new_thread_list); 198 199 uint32_t i; 200 const uint32_t num_threads = threads_list.GetSize(); 201 for (i=0; i<num_threads; ++i) 202 { 203 PythonDictionary thread_dict(threads_list.GetItemAtIndex(i)); 204 if (thread_dict) 205 { 206 if (thread_dict.GetItemForKey("core")) 207 { 208 // We have some threads that are saying they are on a "core", which means 209 // they map the threads that are gotten from the lldb_private::Process subclass 210 // so clear the new threads list so the core threads don't show up 211 new_thread_list.Clear(); 212 break; 213 } 214 } 215 } 216 for (i=0; i<num_threads; ++i) 217 { 218 PythonDictionary thread_dict(threads_list.GetItemAtIndex(i)); 219 if (thread_dict) 220 { 221 ThreadSP thread_sp (CreateThreadFromThreadInfo (thread_dict, core_thread_list, old_thread_list, NULL)); 222 if (thread_sp) 223 new_thread_list.AddThread(thread_sp); 224 } 225 } 226 } 227 else 228 { 229 new_thread_list = old_thread_list; 230 } 231 return new_thread_list.GetSize(false) > 0; 232 } 233 234 ThreadSP 235 OperatingSystemPython::CreateThreadFromThreadInfo (PythonDictionary &thread_dict, 236 ThreadList &core_thread_list, 237 ThreadList &old_thread_list, 238 bool *did_create_ptr) 239 { 240 ThreadSP thread_sp; 241 if (thread_dict) 242 { 243 PythonString tid_pystr("tid"); 244 const tid_t tid = thread_dict.GetItemForKeyAsInteger (tid_pystr, LLDB_INVALID_THREAD_ID); 245 if (tid != LLDB_INVALID_THREAD_ID) 246 { 247 PythonString core_pystr("core"); 248 PythonString name_pystr("name"); 249 PythonString queue_pystr("queue"); 250 PythonString state_pystr("state"); 251 PythonString stop_reason_pystr("stop_reason"); 252 PythonString reg_data_addr_pystr ("register_data_addr"); 253 254 const uint32_t core_number = thread_dict.GetItemForKeyAsInteger (core_pystr, UINT32_MAX); 255 const addr_t reg_data_addr = thread_dict.GetItemForKeyAsInteger (reg_data_addr_pystr, LLDB_INVALID_ADDRESS); 256 const char *name = thread_dict.GetItemForKeyAsString (name_pystr); 257 const char *queue = thread_dict.GetItemForKeyAsString (queue_pystr); 258 //const char *state = thread_dict.GetItemForKeyAsString (state_pystr); 259 //const char *stop_reason = thread_dict.GetItemForKeyAsString (stop_reason_pystr); 260 261 thread_sp = old_thread_list.FindThreadByID (tid, false); 262 if (!thread_sp) 263 { 264 if (did_create_ptr) 265 *did_create_ptr = true; 266 thread_sp.reset (new ThreadMemory (*m_process, 267 tid, 268 name, 269 queue, 270 reg_data_addr)); 271 272 } 273 274 if (core_number < core_thread_list.GetSize(false)) 275 { 276 thread_sp->SetBackingThread(core_thread_list.GetThreadAtIndex(core_number, false)); 277 } 278 } 279 } 280 return thread_sp; 281 } 282 283 284 285 void 286 OperatingSystemPython::ThreadWasSelected (Thread *thread) 287 { 288 } 289 290 RegisterContextSP 291 OperatingSystemPython::CreateRegisterContextForThread (Thread *thread, addr_t reg_data_addr) 292 { 293 RegisterContextSP reg_ctx_sp; 294 if (!m_interpreter || !m_python_object_sp || !thread) 295 return RegisterContextSP(); 296 297 // First thing we have to do is get the API lock, and the run lock. We're going to change the thread 298 // content of the process, and we're going to use python, which requires the API lock to do it. 299 // So get & hold that. This is a recursive lock so we can grant it to any Python code called on the stack below us. 300 Target &target = m_process->GetTarget(); 301 Mutex::Locker api_locker (target.GetAPIMutex()); 302 303 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_THREAD)); 304 305 auto lock = m_interpreter->AcquireInterpreterLock(); // to make sure python objects stays alive 306 if (reg_data_addr != LLDB_INVALID_ADDRESS) 307 { 308 // The registers data is in contiguous memory, just create the register 309 // context using the address provided 310 if (log) 311 log->Printf ("OperatingSystemPython::CreateRegisterContextForThread (tid = 0x%" PRIx64 ", reg_data_addr = 0x%" PRIx64 ") creating memory register context", thread->GetID(), reg_data_addr); 312 reg_ctx_sp.reset (new RegisterContextMemory (*thread, 0, *GetDynamicRegisterInfo (), reg_data_addr)); 313 } 314 else 315 { 316 // No register data address is provided, query the python plug-in to let 317 // it make up the data as it sees fit 318 if (log) 319 log->Printf ("OperatingSystemPython::CreateRegisterContextForThread (tid = 0x%" PRIx64 ") fetching register data from python", thread->GetID()); 320 321 PythonString reg_context_data(m_interpreter->OSPlugin_RegisterContextData (m_python_object_sp, thread->GetID())); 322 if (reg_context_data) 323 { 324 DataBufferSP data_sp (new DataBufferHeap (reg_context_data.GetString(), 325 reg_context_data.GetSize())); 326 if (data_sp->GetByteSize()) 327 { 328 RegisterContextMemory *reg_ctx_memory = new RegisterContextMemory (*thread, 0, *GetDynamicRegisterInfo (), LLDB_INVALID_ADDRESS); 329 if (reg_ctx_memory) 330 { 331 reg_ctx_sp.reset(reg_ctx_memory); 332 reg_ctx_memory->SetAllRegisterData (data_sp); 333 } 334 } 335 } 336 } 337 // if we still have no register data, fallback on a dummy context to avoid crashing 338 if (!reg_ctx_sp) 339 { 340 if (log) 341 log->Printf ("OperatingSystemPython::CreateRegisterContextForThread (tid = 0x%" PRIx64 ") forcing a dummy register context", thread->GetID()); 342 reg_ctx_sp.reset(new RegisterContextDummy(*thread,0,target.GetArchitecture().GetAddressByteSize())); 343 } 344 return reg_ctx_sp; 345 } 346 347 StopInfoSP 348 OperatingSystemPython::CreateThreadStopReason (lldb_private::Thread *thread) 349 { 350 // We should have gotten the thread stop info from the dictionary of data for 351 // the thread in the initial call to get_thread_info(), this should have been 352 // cached so we can return it here 353 StopInfoSP stop_info_sp; //(StopInfo::CreateStopReasonWithSignal (*thread, SIGSTOP)); 354 return stop_info_sp; 355 } 356 357 lldb::ThreadSP 358 OperatingSystemPython::CreateThread (lldb::tid_t tid, addr_t context) 359 { 360 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_THREAD)); 361 362 if (log) 363 log->Printf ("OperatingSystemPython::CreateThread (tid = 0x%" PRIx64 ", context = 0x%" PRIx64 ") fetching register data from python", tid, context); 364 365 if (m_interpreter && m_python_object_sp) 366 { 367 // First thing we have to do is get the API lock, and the run lock. We're going to change the thread 368 // content of the process, and we're going to use python, which requires the API lock to do it. 369 // So get & hold that. This is a recursive lock so we can grant it to any Python code called on the stack below us. 370 Target &target = m_process->GetTarget(); 371 Mutex::Locker api_locker (target.GetAPIMutex()); 372 373 auto lock = m_interpreter->AcquireInterpreterLock(); // to make sure thread_info_dict stays alive 374 PythonDictionary thread_info_dict (m_interpreter->OSPlugin_CreateThread(m_python_object_sp, tid, context)); 375 if (thread_info_dict) 376 { 377 ThreadList core_threads(m_process); 378 ThreadList &thread_list = m_process->GetThreadList(); 379 bool did_create = false; 380 ThreadSP thread_sp (CreateThreadFromThreadInfo (thread_info_dict, core_threads, thread_list, &did_create)); 381 if (did_create) 382 thread_list.AddThread(thread_sp); 383 return thread_sp; 384 } 385 } 386 return ThreadSP(); 387 } 388 389 390 391 #endif // #ifndef LLDB_DISABLE_PYTHON 392