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 // See if a thread already exists for "tid" 262 thread_sp = old_thread_list.FindThreadByID (tid, false); 263 if (thread_sp) 264 { 265 // A thread already does exist for "tid", make sure it was an operating system 266 // plug-in generated thread. 267 if (!IsOperatingSystemPluginThread(thread_sp)) 268 { 269 // We have thread ID overlap between the protocol threads and the 270 // operating system threads, clear the thread so we create an 271 // operating system thread for this. 272 thread_sp.reset(); 273 } 274 } 275 276 if (!thread_sp) 277 { 278 if (did_create_ptr) 279 *did_create_ptr = true; 280 thread_sp.reset (new ThreadMemory (*m_process, 281 tid, 282 name, 283 queue, 284 reg_data_addr)); 285 286 } 287 288 if (core_number < core_thread_list.GetSize(false)) 289 { 290 ThreadSP core_thread_sp (core_thread_list.GetThreadAtIndex(core_number, false)); 291 if (core_thread_sp) 292 { 293 ThreadSP backing_core_thread_sp (core_thread_sp->GetBackingThread()); 294 if (backing_core_thread_sp) 295 { 296 thread_sp->SetBackingThread(backing_core_thread_sp); 297 } 298 else 299 { 300 thread_sp->SetBackingThread(core_thread_sp); 301 } 302 } 303 } 304 } 305 } 306 return thread_sp; 307 } 308 309 310 311 void 312 OperatingSystemPython::ThreadWasSelected (Thread *thread) 313 { 314 } 315 316 RegisterContextSP 317 OperatingSystemPython::CreateRegisterContextForThread (Thread *thread, addr_t reg_data_addr) 318 { 319 RegisterContextSP reg_ctx_sp; 320 if (!m_interpreter || !m_python_object_sp || !thread) 321 return reg_ctx_sp; 322 323 if (!IsOperatingSystemPluginThread(thread->shared_from_this())) 324 return reg_ctx_sp; 325 326 // First thing we have to do is get the API lock, and the run lock. We're going to change the thread 327 // content of the process, and we're going to use python, which requires the API lock to do it. 328 // So get & hold that. This is a recursive lock so we can grant it to any Python code called on the stack below us. 329 Target &target = m_process->GetTarget(); 330 Mutex::Locker api_locker (target.GetAPIMutex()); 331 332 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_THREAD)); 333 334 auto lock = m_interpreter->AcquireInterpreterLock(); // to make sure python objects stays alive 335 if (reg_data_addr != LLDB_INVALID_ADDRESS) 336 { 337 // The registers data is in contiguous memory, just create the register 338 // context using the address provided 339 if (log) 340 log->Printf ("OperatingSystemPython::CreateRegisterContextForThread (tid = 0x%" PRIx64 ", 0x%" PRIx64 ", reg_data_addr = 0x%" PRIx64 ") creating memory register context", 341 thread->GetID(), 342 thread->GetProtocolID(), 343 reg_data_addr); 344 reg_ctx_sp.reset (new RegisterContextMemory (*thread, 0, *GetDynamicRegisterInfo (), reg_data_addr)); 345 } 346 else 347 { 348 // No register data address is provided, query the python plug-in to let 349 // it make up the data as it sees fit 350 if (log) 351 log->Printf ("OperatingSystemPython::CreateRegisterContextForThread (tid = 0x%" PRIx64 ", 0x%" PRIx64 ") fetching register data from python", 352 thread->GetID(), 353 thread->GetProtocolID()); 354 355 PythonString reg_context_data(m_interpreter->OSPlugin_RegisterContextData (m_python_object_sp, thread->GetID())); 356 if (reg_context_data) 357 { 358 DataBufferSP data_sp (new DataBufferHeap (reg_context_data.GetString(), 359 reg_context_data.GetSize())); 360 if (data_sp->GetByteSize()) 361 { 362 RegisterContextMemory *reg_ctx_memory = new RegisterContextMemory (*thread, 0, *GetDynamicRegisterInfo (), LLDB_INVALID_ADDRESS); 363 if (reg_ctx_memory) 364 { 365 reg_ctx_sp.reset(reg_ctx_memory); 366 reg_ctx_memory->SetAllRegisterData (data_sp); 367 } 368 } 369 } 370 } 371 // if we still have no register data, fallback on a dummy context to avoid crashing 372 if (!reg_ctx_sp) 373 { 374 if (log) 375 log->Printf ("OperatingSystemPython::CreateRegisterContextForThread (tid = 0x%" PRIx64 ") forcing a dummy register context", thread->GetID()); 376 reg_ctx_sp.reset(new RegisterContextDummy(*thread,0,target.GetArchitecture().GetAddressByteSize())); 377 } 378 return reg_ctx_sp; 379 } 380 381 StopInfoSP 382 OperatingSystemPython::CreateThreadStopReason (lldb_private::Thread *thread) 383 { 384 // We should have gotten the thread stop info from the dictionary of data for 385 // the thread in the initial call to get_thread_info(), this should have been 386 // cached so we can return it here 387 StopInfoSP stop_info_sp; //(StopInfo::CreateStopReasonWithSignal (*thread, SIGSTOP)); 388 return stop_info_sp; 389 } 390 391 lldb::ThreadSP 392 OperatingSystemPython::CreateThread (lldb::tid_t tid, addr_t context) 393 { 394 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_THREAD)); 395 396 if (log) 397 log->Printf ("OperatingSystemPython::CreateThread (tid = 0x%" PRIx64 ", context = 0x%" PRIx64 ") fetching register data from python", tid, context); 398 399 if (m_interpreter && m_python_object_sp) 400 { 401 // First thing we have to do is get the API lock, and the run lock. We're going to change the thread 402 // content of the process, and we're going to use python, which requires the API lock to do it. 403 // So get & hold that. This is a recursive lock so we can grant it to any Python code called on the stack below us. 404 Target &target = m_process->GetTarget(); 405 Mutex::Locker api_locker (target.GetAPIMutex()); 406 407 auto lock = m_interpreter->AcquireInterpreterLock(); // to make sure thread_info_dict stays alive 408 PythonDictionary thread_info_dict (m_interpreter->OSPlugin_CreateThread(m_python_object_sp, tid, context)); 409 if (thread_info_dict) 410 { 411 ThreadList core_threads(m_process); 412 ThreadList &thread_list = m_process->GetThreadList(); 413 bool did_create = false; 414 ThreadSP thread_sp (CreateThreadFromThreadInfo (thread_info_dict, core_threads, thread_list, &did_create)); 415 if (did_create) 416 thread_list.AddThread(thread_sp); 417 return thread_sp; 418 } 419 } 420 return ThreadSP(); 421 } 422 423 424 425 #endif // #ifndef LLDB_DISABLE_PYTHON 426