62930e57eb
Summary: There was some confusion in the code about how to represent process environment. Most of the code (ab)used the Args class for this purpose, but some of it used a more basic StringList class instead. In either case, the fact that the underlying abstraction did not provide primitive operations for the typical environment operations meant that even a simple operation like checking for an environment variable value was several lines of code. This patch adds a separate Environment class, which is essentialy a llvm::StringMap<std::string> in disguise. To standard StringMap functionality, it adds a couple of new functions, which are specific to the environment use case: - (most important) envp conversion for passing into execve() and likes. Instead of trying to maintain a constantly up-to-date envp view, it provides a function which creates a envp view on demand, with the expectation that this will be called as the very last thing before handing the value to the system function. - insert(StringRef KeyEqValue) - splits KeyEqValue into (key, value) pair and inserts it into the environment map. - compose(value_type KeyValue) - takes a map entry and converts in back into "KEY=VALUE" representation. With this interface most of the environment-manipulating code becomes one-liners. The only tricky part was maintaining compatibility in SBLaunchInfo, which expects that the environment entries are accessible by index and that the returned const char* is backed by the launch info object (random access into maps is hard and the map stores the entry in a deconstructed form, so we cannot just return a .c_str() value). To solve this, I have the SBLaunchInfo convert the environment into the "envp" form, and use it to answer the environment queries. Extra code is added to make sure the envp version is always in sync. (This also improves the layering situation as Args was in the Interpreter module whereas Environment is in Utility.) Reviewers: zturner, davide, jingham, clayborg Subscribers: emaste, lldb-commits, mgorny Differential Revision: https://reviews.llvm.org/D41359 llvm-svn: 322174
212 lines
8.4 KiB
C++
212 lines
8.4 KiB
C++
//===-- PlatformPOSIX.h -----------------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef liblldb_PlatformPOSIX_h_
|
|
#define liblldb_PlatformPOSIX_h_
|
|
|
|
// C Includes
|
|
// C++ Includes
|
|
#include <map>
|
|
#include <memory>
|
|
|
|
// Other libraries and framework includes
|
|
// Project includes
|
|
#include "lldb/Interpreter/Options.h"
|
|
#include "lldb/Target/Platform.h"
|
|
|
|
class PlatformPOSIX : public lldb_private::Platform {
|
|
public:
|
|
PlatformPOSIX(bool is_host);
|
|
|
|
~PlatformPOSIX() override;
|
|
|
|
//------------------------------------------------------------
|
|
// lldb_private::Platform functions
|
|
//------------------------------------------------------------
|
|
|
|
bool GetModuleSpec(const lldb_private::FileSpec &module_file_spec,
|
|
const lldb_private::ArchSpec &arch,
|
|
lldb_private::ModuleSpec &module_spec) override;
|
|
|
|
lldb_private::OptionGroupOptions *
|
|
GetConnectionOptions(lldb_private::CommandInterpreter &interpreter) override;
|
|
|
|
const char *GetHostname() override;
|
|
|
|
const char *GetUserName(uint32_t uid) override;
|
|
|
|
const char *GetGroupName(uint32_t gid) override;
|
|
|
|
lldb_private::Status PutFile(const lldb_private::FileSpec &source,
|
|
const lldb_private::FileSpec &destination,
|
|
uint32_t uid = UINT32_MAX,
|
|
uint32_t gid = UINT32_MAX) override;
|
|
|
|
lldb::user_id_t OpenFile(const lldb_private::FileSpec &file_spec,
|
|
uint32_t flags, uint32_t mode,
|
|
lldb_private::Status &error) override;
|
|
|
|
bool CloseFile(lldb::user_id_t fd, lldb_private::Status &error) override;
|
|
|
|
uint64_t ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
|
|
uint64_t dst_len, lldb_private::Status &error) override;
|
|
|
|
uint64_t WriteFile(lldb::user_id_t fd, uint64_t offset, const void *src,
|
|
uint64_t src_len, lldb_private::Status &error) override;
|
|
|
|
lldb::user_id_t GetFileSize(const lldb_private::FileSpec &file_spec) override;
|
|
|
|
lldb_private::Status
|
|
CreateSymlink(const lldb_private::FileSpec &src,
|
|
const lldb_private::FileSpec &dst) override;
|
|
|
|
lldb_private::Status
|
|
GetFile(const lldb_private::FileSpec &source,
|
|
const lldb_private::FileSpec &destination) override;
|
|
|
|
lldb_private::FileSpec GetRemoteWorkingDirectory() override;
|
|
|
|
bool
|
|
SetRemoteWorkingDirectory(const lldb_private::FileSpec &working_dir) override;
|
|
|
|
bool GetRemoteOSVersion() override;
|
|
|
|
bool GetRemoteOSBuildString(std::string &s) override;
|
|
|
|
bool GetRemoteOSKernelDescription(std::string &s) override;
|
|
|
|
lldb_private::ArchSpec GetRemoteSystemArchitecture() override;
|
|
|
|
const lldb::UnixSignalsSP &GetRemoteUnixSignals() override;
|
|
|
|
lldb_private::Environment GetEnvironment() override;
|
|
|
|
bool IsConnected() const override;
|
|
|
|
lldb_private::Status RunShellCommand(
|
|
const char *command, // Shouldn't be nullptr
|
|
const lldb_private::FileSpec &working_dir, // Pass empty FileSpec to use
|
|
// the current working
|
|
// directory
|
|
int *status_ptr, // Pass nullptr if you don't want the process exit status
|
|
int *signo_ptr, // Pass nullptr if you don't want the signal that caused
|
|
// the process to exit
|
|
std::string
|
|
*command_output, // Pass nullptr if you don't want the command output
|
|
uint32_t timeout_sec)
|
|
override; // Timeout in seconds to wait for shell program to finish
|
|
|
|
lldb_private::Status ResolveExecutable(
|
|
const lldb_private::ModuleSpec &module_spec, lldb::ModuleSP &module_sp,
|
|
const lldb_private::FileSpecList *module_search_paths_ptr) override;
|
|
|
|
lldb_private::Status
|
|
GetFileWithUUID(const lldb_private::FileSpec &platform_file,
|
|
const lldb_private::UUID *uuid,
|
|
lldb_private::FileSpec &local_file) override;
|
|
|
|
bool GetProcessInfo(lldb::pid_t pid, lldb_private::ProcessInstanceInfo &proc_info) override;
|
|
|
|
uint32_t FindProcesses(const lldb_private::ProcessInstanceInfoMatch &match_info,
|
|
lldb_private::ProcessInstanceInfoList &process_infos) override;
|
|
|
|
lldb_private::Status MakeDirectory(const lldb_private::FileSpec &file_spec,
|
|
uint32_t mode) override;
|
|
|
|
lldb_private::Status
|
|
GetFilePermissions(const lldb_private::FileSpec &file_spec,
|
|
uint32_t &file_permissions) override;
|
|
|
|
lldb_private::Status
|
|
SetFilePermissions(const lldb_private::FileSpec &file_spec,
|
|
uint32_t file_permissions) override;
|
|
|
|
bool GetFileExists(const lldb_private::FileSpec &file_spec) override;
|
|
|
|
lldb_private::Status Unlink(const lldb_private::FileSpec &file_spec) override;
|
|
|
|
lldb_private::Status
|
|
LaunchProcess(lldb_private::ProcessLaunchInfo &launch_info) override;
|
|
|
|
lldb_private::Status KillProcess(const lldb::pid_t pid) override;
|
|
|
|
lldb::ProcessSP Attach(lldb_private::ProcessAttachInfo &attach_info,
|
|
lldb_private::Debugger &debugger,
|
|
lldb_private::Target *target, // Can be nullptr, if
|
|
// nullptr create a new
|
|
// target, else use
|
|
// existing one
|
|
lldb_private::Status &error) override;
|
|
|
|
lldb::ProcessSP DebugProcess(lldb_private::ProcessLaunchInfo &launch_info,
|
|
lldb_private::Debugger &debugger,
|
|
lldb_private::Target *target, // Can be nullptr,
|
|
// if nullptr
|
|
// create a new
|
|
// target, else use
|
|
// existing one
|
|
lldb_private::Status &error) override;
|
|
|
|
std::string GetPlatformSpecificConnectionInformation() override;
|
|
|
|
bool CalculateMD5(const lldb_private::FileSpec &file_spec, uint64_t &low,
|
|
uint64_t &high) override;
|
|
|
|
void CalculateTrapHandlerSymbolNames() override;
|
|
|
|
lldb_private::Status ConnectRemote(lldb_private::Args &args) override;
|
|
|
|
lldb_private::Status DisconnectRemote() override;
|
|
|
|
uint32_t DoLoadImage(lldb_private::Process *process,
|
|
const lldb_private::FileSpec &remote_file,
|
|
lldb_private::Status &error) override;
|
|
|
|
lldb_private::Status UnloadImage(lldb_private::Process *process,
|
|
uint32_t image_token) override;
|
|
|
|
lldb::ProcessSP ConnectProcess(llvm::StringRef connect_url,
|
|
llvm::StringRef plugin_name,
|
|
lldb_private::Debugger &debugger,
|
|
lldb_private::Target *target,
|
|
lldb_private::Status &error) override;
|
|
|
|
size_t ConnectToWaitingProcesses(lldb_private::Debugger &debugger,
|
|
lldb_private::Status &error) override;
|
|
|
|
lldb_private::ConstString GetFullNameForDylib(lldb_private::ConstString basename) override;
|
|
|
|
protected:
|
|
std::unique_ptr<lldb_private::OptionGroupPlatformRSync>
|
|
m_option_group_platform_rsync;
|
|
std::unique_ptr<lldb_private::OptionGroupPlatformSSH>
|
|
m_option_group_platform_ssh;
|
|
std::unique_ptr<lldb_private::OptionGroupPlatformCaching>
|
|
m_option_group_platform_caching;
|
|
|
|
std::map<lldb_private::CommandInterpreter *,
|
|
std::unique_ptr<lldb_private::OptionGroupOptions>>
|
|
m_options;
|
|
lldb::PlatformSP m_remote_platform_sp; // Allow multiple ways to connect to a
|
|
// remote POSIX-compliant OS
|
|
|
|
lldb_private::Status
|
|
EvaluateLibdlExpression(lldb_private::Process *process, const char *expr_cstr,
|
|
llvm::StringRef expr_prefix,
|
|
lldb::ValueObjectSP &result_valobj_sp);
|
|
|
|
virtual
|
|
llvm::StringRef GetLibdlFunctionDeclarations(lldb_private::Process *process);
|
|
|
|
private:
|
|
DISALLOW_COPY_AND_ASSIGN(PlatformPOSIX);
|
|
};
|
|
|
|
#endif // liblldb_PlatformPOSIX_h_
|