mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2025-04-14 12:22:27 +00:00
21dfcd9d41
This checkin adds the capability for LLDB to load plugins from external dylibs that can provide new commands It exports an SBCommand class from the public API layer, and a new SBCommandPluginInterface There is a minimal load-only plugin manager built into the debugger, which can be accessed via Debugger::LoadPlugin. Plugins are loaded from two locations at debugger startup (LLDB.framework/Resources/PlugIns and ~/Library/Application Support/LLDB/PlugIns) and more can be (re)loaded via the "plugin load" command For an example of how to make a plugin, refer to the fooplugin.cpp file in examples/plugins/commands Caveats: Currently, the new API objects and features are not exposed via Python. The new commands can only be "parsed" (i.e. not raw) and get their command line via a char** parameter (we do not expose our internal Args object) There is no unloading feature, which can potentially lead to leaks if you overwrite the commands by reloading the same or different plugins There is no API exposed for option parsing, which means you may need to use getopt or roll-your-own llvm-svn: 164865
118 lines
4.0 KiB
C++
118 lines
4.0 KiB
C++
//===-- CommandObjectPlugin.cpp ----------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "CommandObjectPlugin.h"
|
|
|
|
#include "lldb/API/SBDebugger.h"
|
|
#include "lldb/API/SBCommandInterpreter.h"
|
|
#include "lldb/API/SBCommandReturnObject.h"
|
|
|
|
#include "lldb/Host/Host.h"
|
|
|
|
#include "lldb/Interpreter/CommandInterpreter.h"
|
|
#include "lldb/Interpreter/CommandReturnObject.h"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
|
|
class CommandObjectPluginLoad : public CommandObjectParsed
|
|
{
|
|
private:
|
|
public:
|
|
CommandObjectPluginLoad (CommandInterpreter &interpreter) :
|
|
CommandObjectParsed (interpreter,
|
|
"plugin load",
|
|
"Import a dylib that implements an LLDB plugin.",
|
|
NULL)
|
|
{
|
|
CommandArgumentEntry arg1;
|
|
CommandArgumentData cmd_arg;
|
|
|
|
// Define the first (and only) variant of this arg.
|
|
cmd_arg.arg_type = eArgTypeFilename;
|
|
cmd_arg.arg_repetition = eArgRepeatPlain;
|
|
|
|
// There is only one variant this argument could be; put it into the argument entry.
|
|
arg1.push_back (cmd_arg);
|
|
|
|
// Push the data for the first argument into the m_arguments vector.
|
|
m_arguments.push_back (arg1);
|
|
}
|
|
|
|
~CommandObjectPluginLoad ()
|
|
{
|
|
}
|
|
|
|
int
|
|
HandleArgumentCompletion (Args &input,
|
|
int &cursor_index,
|
|
int &cursor_char_position,
|
|
OptionElementVector &opt_element_vector,
|
|
int match_start_point,
|
|
int max_return_elements,
|
|
bool &word_complete,
|
|
StringList &matches)
|
|
{
|
|
std::string completion_str (input.GetArgumentAtIndex(cursor_index));
|
|
completion_str.erase (cursor_char_position);
|
|
|
|
CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
|
|
CommandCompletions::eDiskFileCompletion,
|
|
completion_str.c_str(),
|
|
match_start_point,
|
|
max_return_elements,
|
|
NULL,
|
|
word_complete,
|
|
matches);
|
|
return matches.GetSize();
|
|
}
|
|
|
|
protected:
|
|
bool
|
|
DoExecute (Args& command, CommandReturnObject &result)
|
|
{
|
|
typedef void (*LLDBCommandPluginInit) (lldb::SBDebugger debugger);
|
|
|
|
size_t argc = command.GetArgumentCount();
|
|
|
|
if (argc != 1)
|
|
{
|
|
result.AppendError ("'plugin load' requires one argument");
|
|
result.SetStatus (eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
|
|
const char* path = command.GetArgumentAtIndex(0);
|
|
|
|
Error error;
|
|
|
|
FileSpec dylib_fspec(path,true);
|
|
|
|
if (m_interpreter.GetDebugger().LoadPlugin(dylib_fspec))
|
|
result.SetStatus(eReturnStatusSuccessFinishResult);
|
|
else
|
|
result.SetStatus(eReturnStatusFailed);
|
|
|
|
return result.Succeeded();
|
|
}
|
|
};
|
|
|
|
CommandObjectPlugin::CommandObjectPlugin (CommandInterpreter &interpreter) :
|
|
CommandObjectMultiword (interpreter,
|
|
"plugin",
|
|
"A set of commands for managing or customizing plugin commands.",
|
|
"plugin <subcommand> [<subcommand-options>]")
|
|
{
|
|
LoadSubCommand ("load", CommandObjectSP (new CommandObjectPluginLoad (interpreter)));
|
|
}
|
|
|
|
CommandObjectPlugin::~CommandObjectPlugin ()
|
|
{
|
|
}
|