1 //===-- ScriptInterpreterPythonImpl.h ---------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifdef LLDB_DISABLE_PYTHON 10 11 // Python is disabled in this build 12 13 #else 14 15 #include "lldb-python.h" 16 17 #include "PythonDataObjects.h" 18 #include "ScriptInterpreterPython.h" 19 20 #include "lldb/Host/Terminal.h" 21 #include "lldb/Utility/StreamString.h" 22 23 #include "llvm/ADT/STLExtras.h" 24 #include "llvm/ADT/StringRef.h" 25 26 namespace lldb_private { 27 class IOHandlerPythonInterpreter; 28 class ScriptInterpreterPythonImpl : public ScriptInterpreterPython { 29 public: 30 friend class IOHandlerPythonInterpreter; 31 32 ScriptInterpreterPythonImpl(CommandInterpreter &interpreter); 33 34 ~ScriptInterpreterPythonImpl() override; 35 36 bool Interrupt() override; 37 38 bool ExecuteOneLine( 39 llvm::StringRef command, CommandReturnObject *result, 40 const ExecuteScriptOptions &options = ExecuteScriptOptions()) override; 41 42 void ExecuteInterpreterLoop() override; 43 44 bool ExecuteOneLineWithReturn( 45 llvm::StringRef in_string, 46 ScriptInterpreter::ScriptReturnType return_type, void *ret_value, 47 const ExecuteScriptOptions &options = ExecuteScriptOptions()) override; 48 49 lldb_private::Status ExecuteMultipleLines( 50 const char *in_string, 51 const ExecuteScriptOptions &options = ExecuteScriptOptions()) override; 52 53 Status 54 ExportFunctionDefinitionToInterpreter(StringList &function_def) override; 55 56 bool GenerateTypeScriptFunction(StringList &input, std::string &output, 57 const void *name_token = nullptr) override; 58 59 bool GenerateTypeSynthClass(StringList &input, std::string &output, 60 const void *name_token = nullptr) override; 61 62 bool GenerateTypeSynthClass(const char *oneliner, std::string &output, 63 const void *name_token = nullptr) override; 64 65 // use this if the function code is just a one-liner script 66 bool GenerateTypeScriptFunction(const char *oneliner, std::string &output, 67 const void *name_token = nullptr) override; 68 69 bool GenerateScriptAliasFunction(StringList &input, 70 std::string &output) override; 71 72 StructuredData::ObjectSP 73 CreateSyntheticScriptedProvider(const char *class_name, 74 lldb::ValueObjectSP valobj) override; 75 76 StructuredData::GenericSP 77 CreateScriptCommandObject(const char *class_name) override; 78 79 StructuredData::ObjectSP 80 CreateScriptedThreadPlan(const char *class_name, 81 lldb::ThreadPlanSP thread_plan) override; 82 83 bool ScriptedThreadPlanExplainsStop(StructuredData::ObjectSP implementor_sp, 84 Event *event, 85 bool &script_error) override; 86 87 bool ScriptedThreadPlanShouldStop(StructuredData::ObjectSP implementor_sp, 88 Event *event, bool &script_error) override; 89 90 bool ScriptedThreadPlanIsStale(StructuredData::ObjectSP implementor_sp, 91 bool &script_error) override; 92 93 lldb::StateType 94 ScriptedThreadPlanGetRunState(StructuredData::ObjectSP implementor_sp, 95 bool &script_error) override; 96 97 StructuredData::GenericSP 98 CreateScriptedBreakpointResolver(const char *class_name, 99 StructuredDataImpl *args_data, 100 lldb::BreakpointSP &bkpt_sp) override; 101 bool ScriptedBreakpointResolverSearchCallback( 102 StructuredData::GenericSP implementor_sp, 103 SymbolContext *sym_ctx) override; 104 105 lldb::SearchDepth ScriptedBreakpointResolverSearchDepth( 106 StructuredData::GenericSP implementor_sp) override; 107 108 StructuredData::GenericSP 109 CreateFrameRecognizer(const char *class_name) override; 110 111 lldb::ValueObjectListSP 112 GetRecognizedArguments(const StructuredData::ObjectSP &implementor, 113 lldb::StackFrameSP frame_sp) override; 114 115 StructuredData::GenericSP 116 OSPlugin_CreatePluginObject(const char *class_name, 117 lldb::ProcessSP process_sp) override; 118 119 StructuredData::DictionarySP 120 OSPlugin_RegisterInfo(StructuredData::ObjectSP os_plugin_object_sp) override; 121 122 StructuredData::ArraySP 123 OSPlugin_ThreadsInfo(StructuredData::ObjectSP os_plugin_object_sp) override; 124 125 StructuredData::StringSP 126 OSPlugin_RegisterContextData(StructuredData::ObjectSP os_plugin_object_sp, 127 lldb::tid_t thread_id) override; 128 129 StructuredData::DictionarySP 130 OSPlugin_CreateThread(StructuredData::ObjectSP os_plugin_object_sp, 131 lldb::tid_t tid, lldb::addr_t context) override; 132 133 StructuredData::ObjectSP 134 LoadPluginModule(const FileSpec &file_spec, 135 lldb_private::Status &error) override; 136 137 StructuredData::DictionarySP 138 GetDynamicSettings(StructuredData::ObjectSP plugin_module_sp, Target *target, 139 const char *setting_name, 140 lldb_private::Status &error) override; 141 142 size_t CalculateNumChildren(const StructuredData::ObjectSP &implementor, 143 uint32_t max) override; 144 145 lldb::ValueObjectSP 146 GetChildAtIndex(const StructuredData::ObjectSP &implementor, 147 uint32_t idx) override; 148 149 int GetIndexOfChildWithName(const StructuredData::ObjectSP &implementor, 150 const char *child_name) override; 151 152 bool UpdateSynthProviderInstance( 153 const StructuredData::ObjectSP &implementor) override; 154 155 bool MightHaveChildrenSynthProviderInstance( 156 const StructuredData::ObjectSP &implementor) override; 157 158 lldb::ValueObjectSP 159 GetSyntheticValue(const StructuredData::ObjectSP &implementor) override; 160 161 ConstString 162 GetSyntheticTypeName(const StructuredData::ObjectSP &implementor) override; 163 164 bool 165 RunScriptBasedCommand(const char *impl_function, llvm::StringRef args, 166 ScriptedCommandSynchronicity synchronicity, 167 lldb_private::CommandReturnObject &cmd_retobj, 168 Status &error, 169 const lldb_private::ExecutionContext &exe_ctx) override; 170 171 bool RunScriptBasedCommand( 172 StructuredData::GenericSP impl_obj_sp, llvm::StringRef args, 173 ScriptedCommandSynchronicity synchronicity, 174 lldb_private::CommandReturnObject &cmd_retobj, Status &error, 175 const lldb_private::ExecutionContext &exe_ctx) override; 176 177 Status GenerateFunction(const char *signature, 178 const StringList &input) override; 179 180 Status GenerateBreakpointCommandCallbackData(StringList &input, 181 std::string &output) override; 182 183 bool GenerateWatchpointCommandCallbackData(StringList &input, 184 std::string &output) override; 185 186 bool GetScriptedSummary(const char *function_name, lldb::ValueObjectSP valobj, 187 StructuredData::ObjectSP &callee_wrapper_sp, 188 const TypeSummaryOptions &options, 189 std::string &retval) override; 190 191 void Clear() override; 192 193 bool GetDocumentationForItem(const char *item, std::string &dest) override; 194 195 bool GetShortHelpForCommandObject(StructuredData::GenericSP cmd_obj_sp, 196 std::string &dest) override; 197 198 uint32_t 199 GetFlagsForCommandObject(StructuredData::GenericSP cmd_obj_sp) override; 200 201 bool GetLongHelpForCommandObject(StructuredData::GenericSP cmd_obj_sp, 202 std::string &dest) override; 203 204 bool CheckObjectExists(const char *name) override { 205 if (!name || !name[0]) 206 return false; 207 std::string temp; 208 return GetDocumentationForItem(name, temp); 209 } 210 211 bool RunScriptFormatKeyword(const char *impl_function, Process *process, 212 std::string &output, Status &error) override; 213 214 bool RunScriptFormatKeyword(const char *impl_function, Thread *thread, 215 std::string &output, Status &error) override; 216 217 bool RunScriptFormatKeyword(const char *impl_function, Target *target, 218 std::string &output, Status &error) override; 219 220 bool RunScriptFormatKeyword(const char *impl_function, StackFrame *frame, 221 std::string &output, Status &error) override; 222 223 bool RunScriptFormatKeyword(const char *impl_function, ValueObject *value, 224 std::string &output, Status &error) override; 225 226 bool 227 LoadScriptingModule(const char *filename, bool can_reload, bool init_session, 228 lldb_private::Status &error, 229 StructuredData::ObjectSP *module_sp = nullptr) override; 230 231 bool IsReservedWord(const char *word) override; 232 233 std::unique_ptr<ScriptInterpreterLocker> AcquireInterpreterLock() override; 234 235 void CollectDataForBreakpointCommandCallback( 236 std::vector<BreakpointOptions *> &bp_options_vec, 237 CommandReturnObject &result) override; 238 239 void 240 CollectDataForWatchpointCommandCallback(WatchpointOptions *wp_options, 241 CommandReturnObject &result) override; 242 243 /// Set the callback body text into the callback for the breakpoint. 244 Status SetBreakpointCommandCallback(BreakpointOptions *bp_options, 245 const char *callback_body) override; 246 247 void SetBreakpointCommandCallbackFunction(BreakpointOptions *bp_options, 248 const char *function_name) override; 249 250 /// This one is for deserialization: 251 Status SetBreakpointCommandCallback( 252 BreakpointOptions *bp_options, 253 std::unique_ptr<BreakpointOptions::CommandData> &data_up) override; 254 255 /// Set a one-liner as the callback for the watchpoint. 256 void SetWatchpointCommandCallback(WatchpointOptions *wp_options, 257 const char *oneliner) override; 258 259 void ResetOutputFileHandle(FILE *new_fh) override; 260 261 const char *GetDictionaryName() { return m_dictionary_name.c_str(); } 262 263 PyThreadState *GetThreadState() { return m_command_thread_state; } 264 265 void SetThreadState(PyThreadState *s) { 266 if (s) 267 m_command_thread_state = s; 268 } 269 270 // IOHandlerDelegate 271 void IOHandlerActivated(IOHandler &io_handler, bool interactive) override; 272 273 void IOHandlerInputComplete(IOHandler &io_handler, 274 std::string &data) override; 275 276 static lldb::ScriptInterpreterSP 277 CreateInstance(CommandInterpreter &interpreter); 278 279 // PluginInterface protocol 280 lldb_private::ConstString GetPluginName() override; 281 282 uint32_t GetPluginVersion() override; 283 284 class Locker : public ScriptInterpreterLocker { 285 public: 286 enum OnEntry { 287 AcquireLock = 0x0001, 288 InitSession = 0x0002, 289 InitGlobals = 0x0004, 290 NoSTDIN = 0x0008 291 }; 292 293 enum OnLeave { 294 FreeLock = 0x0001, 295 FreeAcquiredLock = 0x0002, // do not free the lock if we already held it 296 // when calling constructor 297 TearDownSession = 0x0004 298 }; 299 300 Locker(ScriptInterpreterPythonImpl *py_interpreter = nullptr, 301 uint16_t on_entry = AcquireLock | InitSession, 302 uint16_t on_leave = FreeLock | TearDownSession, FILE *in = nullptr, 303 FILE *out = nullptr, FILE *err = nullptr); 304 305 ~Locker() override; 306 307 private: 308 bool DoAcquireLock(); 309 310 bool DoInitSession(uint16_t on_entry_flags, FILE *in, FILE *out, FILE *err); 311 312 bool DoFreeLock(); 313 314 bool DoTearDownSession(); 315 316 bool m_teardown_session; 317 ScriptInterpreterPythonImpl *m_python_interpreter; 318 // FILE* m_tmp_fh; 319 PyGILState_STATE m_GILState; 320 }; 321 322 static bool BreakpointCallbackFunction(void *baton, 323 StoppointCallbackContext *context, 324 lldb::user_id_t break_id, 325 lldb::user_id_t break_loc_id); 326 static bool WatchpointCallbackFunction(void *baton, 327 StoppointCallbackContext *context, 328 lldb::user_id_t watch_id); 329 static void InitializePrivate(); 330 331 class SynchronicityHandler { 332 private: 333 lldb::DebuggerSP m_debugger_sp; 334 ScriptedCommandSynchronicity m_synch_wanted; 335 bool m_old_asynch; 336 337 public: 338 SynchronicityHandler(lldb::DebuggerSP, ScriptedCommandSynchronicity); 339 340 ~SynchronicityHandler(); 341 }; 342 343 enum class AddLocation { Beginning, End }; 344 345 static void AddToSysPath(AddLocation location, std::string path); 346 347 bool EnterSession(uint16_t on_entry_flags, FILE *in, FILE *out, FILE *err); 348 349 void LeaveSession(); 350 351 void SaveTerminalState(int fd); 352 353 void RestoreTerminalState(); 354 355 uint32_t IsExecutingPython() const { return m_lock_count > 0; } 356 357 uint32_t IncrementLockCount() { return ++m_lock_count; } 358 359 uint32_t DecrementLockCount() { 360 if (m_lock_count > 0) 361 --m_lock_count; 362 return m_lock_count; 363 } 364 365 enum ActiveIOHandler { 366 eIOHandlerNone, 367 eIOHandlerBreakpoint, 368 eIOHandlerWatchpoint 369 }; 370 371 PythonObject &GetMainModule(); 372 373 PythonDictionary &GetSessionDictionary(); 374 375 PythonDictionary &GetSysModuleDictionary(); 376 377 bool GetEmbeddedInterpreterModuleObjects(); 378 379 bool SetStdHandle(File &file, const char *py_name, PythonFile &save_file, 380 const char *mode); 381 382 PythonFile m_saved_stdin; 383 PythonFile m_saved_stdout; 384 PythonFile m_saved_stderr; 385 PythonObject m_main_module; 386 PythonDictionary m_session_dict; 387 PythonDictionary m_sys_module_dict; 388 PythonObject m_run_one_line_function; 389 PythonObject m_run_one_line_str_global; 390 std::string m_dictionary_name; 391 TerminalState m_terminal_state; 392 ActiveIOHandler m_active_io_handler; 393 bool m_session_is_active; 394 bool m_pty_slave_is_open; 395 bool m_valid_session; 396 uint32_t m_lock_count; 397 PyThreadState *m_command_thread_state; 398 }; 399 400 class IOHandlerPythonInterpreter : public IOHandler { 401 public: 402 IOHandlerPythonInterpreter(Debugger &debugger, 403 ScriptInterpreterPythonImpl *python) 404 : IOHandler(debugger, IOHandler::Type::PythonInterpreter), 405 m_python(python) {} 406 407 ~IOHandlerPythonInterpreter() override {} 408 409 ConstString GetControlSequence(char ch) override { 410 if (ch == 'd') 411 return ConstString("quit()\n"); 412 return ConstString(); 413 } 414 415 void Run() override { 416 if (m_python) { 417 int stdin_fd = GetInputFD(); 418 if (stdin_fd >= 0) { 419 Terminal terminal(stdin_fd); 420 TerminalState terminal_state; 421 const bool is_a_tty = terminal.IsATerminal(); 422 423 if (is_a_tty) { 424 terminal_state.Save(stdin_fd, false); 425 terminal.SetCanonical(false); 426 terminal.SetEcho(true); 427 } 428 429 ScriptInterpreterPythonImpl::Locker locker( 430 m_python, 431 ScriptInterpreterPythonImpl::Locker::AcquireLock | 432 ScriptInterpreterPythonImpl::Locker::InitSession | 433 ScriptInterpreterPythonImpl::Locker::InitGlobals, 434 ScriptInterpreterPythonImpl::Locker::FreeAcquiredLock | 435 ScriptInterpreterPythonImpl::Locker::TearDownSession); 436 437 // The following call drops into the embedded interpreter loop and 438 // stays there until the user chooses to exit from the Python 439 // interpreter. This embedded interpreter will, as any Python code that 440 // performs I/O, unlock the GIL before a system call that can hang, and 441 // lock it when the syscall has returned. 442 443 // We need to surround the call to the embedded interpreter with calls 444 // to PyGILState_Ensure and PyGILState_Release (using the Locker 445 // above). This is because Python has a global lock which must be held 446 // whenever we want to touch any Python objects. Otherwise, if the user 447 // calls Python code, the interpreter state will be off, and things 448 // could hang (it's happened before). 449 450 StreamString run_string; 451 run_string.Printf("run_python_interpreter (%s)", 452 m_python->GetDictionaryName()); 453 PyRun_SimpleString(run_string.GetData()); 454 455 if (is_a_tty) 456 terminal_state.Restore(); 457 } 458 } 459 SetIsDone(true); 460 } 461 462 void Cancel() override {} 463 464 bool Interrupt() override { return m_python->Interrupt(); } 465 466 void GotEOF() override {} 467 468 protected: 469 ScriptInterpreterPythonImpl *m_python; 470 }; 471 472 } // namespace lldb_private 473 474 #endif 475