Index: include/lldb/Core/Log.h =================================================================== --- include/lldb/Core/Log.h +++ include/lldb/Core/Log.h @@ -18,6 +18,9 @@ // C++ Includes // Other libraries and framework includes +#include "llvm/Support/raw_ostream.h" +#include "llvm/Support/Path.h" + // Project includes #include "lldb/Core/ConstString.h" #include "lldb/Core/Flags.h" @@ -192,6 +195,39 @@ DISALLOW_COPY_AND_ASSIGN(LogChannel); }; +class LogWrapper { +public: + LogWrapper(Log &log) : m_log(log), m_stream(m_message) {} + ~LogWrapper() { m_log.Printf("%s", m_stream.str().c_str()); } + + llvm::raw_ostream &stream() { return m_stream; } + +private: + Log &m_log; + std::string m_message; + llvm::raw_string_ostream m_stream; +}; + +#define AMBIGUOUS_ELSE_BLOCKER \ + switch (0) \ + case 0: \ + default: +#define LLDB_LOG_(log) \ + AMBIGUOUS_ELSE_BLOCKER \ + if (!(log)) \ + ; \ + else \ + LogWrapper(*(log)).stream() << llvm::sys::path::filename(__FILE__) \ + << "::" << __FUNCTION__ << ": " + +// This may be overkill, but it is somewhat shorter, and all our log variables +// are called "log" anyway. If we don't want this, we can remove the underscore +// from the previous macro. +#define LLDB_LOG() LLDB_LOG_(log) + +// If we really want, we can have separate IF_ALL and IF_ANY versions of this +#define LLDB_LOG_IF(flags) LLDB_LOG_(lldb_private::GetLogIfAnyCategoriesSet(flags)) + } // namespace lldb_private #endif // liblldb_Log_h_ Index: source/Plugins/Process/Linux/NativeProcessLinux.cpp =================================================================== --- source/Plugins/Process/Linux/NativeProcessLinux.cpp +++ source/Plugins/Process/Linux/NativeProcessLinux.cpp @@ -41,6 +41,7 @@ #include "lldb/Utility/LLDBAssert.h" #include "lldb/Utility/PseudoTerminal.h" #include "lldb/Utility/StringExtractor.h" +#include "llvm/Support/FormatVariadic.h" #include "NativeThreadLinux.h" #include "Plugins/Process/POSIX/ProcessPOSIXLog.h" @@ -72,6 +73,16 @@ using namespace lldb_private::process_linux; using namespace llvm; +// Obviously, these would not live in this file. +namespace lldb_private { +llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const FileSpec &spec) { + return OS << spec.GetCString(); +} +llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, Error &error) { + return OS << error.AsCString(); +} +} + // Private bits we only need internally. static bool ProcessVmReadvSupported() { @@ -93,16 +104,12 @@ // value from our own process. ssize_t res = process_vm_readv(getpid(), &local, 1, &remote, 1, 0); is_supported = (res == sizeof(source) && source == dest); - if (log) { - if (is_supported) - log->Printf("%s: Detected kernel support for process_vm_readv syscall. " - "Fast memory reads enabled.", - __FUNCTION__); - else - log->Printf("%s: syscall process_vm_readv failed (error: %s). Fast " - "memory reads disabled.", - __FUNCTION__, strerror(errno)); - } + if (is_supported) + LLDB_LOG() << "Detected kernel support for process_vm_readv syscall. " + "Fast memory reads enabled."; + else + LLDB_LOG() << "syscall process_vm_readv failed (error: " + << strerror(errno) << "). Fast memory reads disabled."; }); return is_supported; @@ -115,16 +122,15 @@ return; if (const FileAction *action = info.GetFileActionForFD(STDIN_FILENO)) - log->Printf("%s: setting STDIN to '%s'", __FUNCTION__, - action->GetFileSpec().GetCString()); + LLDB_LOG() << "setting STDIN to " << action->GetFileSpec(); else - log->Printf("%s leaving STDIN as is", __FUNCTION__); + LLDB_LOG() << "leaving STDIN as is"; if (const FileAction *action = info.GetFileActionForFD(STDOUT_FILENO)) - log->Printf("%s setting STDOUT to '%s'", __FUNCTION__, - action->GetFileSpec().GetCString()); + LLDB_LOG() << llvm::formatv("setting STDOUT to '{}'", + action->GetFileSpec().GetCString()); else - log->Printf("%s leaving STDOUT as is", __FUNCTION__); + LLDB_LOG() << "leaving STDOUT as is"; if (const FileAction *action = info.GetFileActionForFD(STDERR_FILENO)) log->Printf("%s setting STDERR to '%s'", __FUNCTION__, @@ -135,8 +141,7 @@ int i = 0; for (const char **args = info.GetArguments().GetConstArgumentVector(); *args; ++args, ++i) - log->Printf("%s arg %d: \"%s\"", __FUNCTION__, i, - *args ? *args : "nullptr"); + LLDB_LOG() << llvm::formatv("arg {}: \"{}\"", *args); } void DisplayBytes(StreamString &s, void *bytes, uint32_t count) { @@ -256,9 +261,7 @@ if (error.Fail()) { native_process_sp.reset(); - if (log) - log->Printf("NativeProcessLinux::%s failed to launch process: %s", - __FUNCTION__, error.AsCString()); + LLDB_LOG() << "failed to launch process: " << error; return error; } @@ -308,9 +311,7 @@ void NativeProcessLinux::AttachToInferior(MainLoop &mainloop, lldb::pid_t pid, Error &error) { Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS)); - if (log) - log->Printf("NativeProcessLinux::%s (pid = %" PRIi64 ")", __FUNCTION__, - pid); + LLDB_LOG() << "(pid = " << pid << ")"; m_sigchld_handle = mainloop.RegisterSignal( SIGCHLD, [this](MainLoopBase &) { SigchldHandler(); }, error); @@ -322,10 +323,8 @@ return; // Set the architecture to the exe architecture. - if (log) - log->Printf("NativeProcessLinux::%s (pid = %" PRIi64 - ") detected architecture %s", - __FUNCTION__, pid, m_arch.GetArchitectureName()); + LLDB_LOG() << "(pid = " << pid << ") detected architecture " + << m_arch.GetArchitectureName(); m_pid = pid; SetState(eStateAttaching); @@ -357,9 +356,7 @@ int status; if ((wpid = waitpid(pid, &status, 0)) < 0) { error.SetErrorToErrno(); - if (log) - log->Printf("NativeProcessLinux::%s waitpid for inferior failed with %s", - __FUNCTION__, error.AsCString()); + LLDB_LOG() << "waitpid for inferior failed with: " << error; // Mark the inferior as invalid. // FIXME this could really use a new state - eStateLaunchFailure. For now, @@ -371,16 +368,11 @@ assert(WIFSTOPPED(status) && (wpid == static_cast<::pid_t>(pid)) && "Could not sync with inferior process."); - if (log) - log->Printf("NativeProcessLinux::%s inferior started, now in stopped state", - __FUNCTION__); + LLDB_LOG() << "inferior started, now in stopped state"; error = SetDefaultPtraceOpts(pid); if (error.Fail()) { - if (log) - log->Printf("NativeProcessLinux::%s inferior failed to set default " - "ptrace options: %s", - __FUNCTION__, error.AsCString()); + LLDB_LOG() << "inferior failed to set default ptrace options: " << error; // Mark the inferior as invalid. // FIXME this could really use a new state - eStateLaunchFailure. For now, @@ -579,11 +571,9 @@ // Handle when the thread exits. if (exited) { - if (log) - log->Printf( - "NativeProcessLinux::%s() got exit signal(%d) , tid = %" PRIu64 - " (%s main thread)", - __FUNCTION__, signal, pid, is_main_thread ? "is" : "is not"); + LLDB_LOG() << llvm::formatv( + "got exit signal({}) , tid = {} ({} main thread)", signal, pid, + is_main_thread ? "is" : "is not"); // This is a thread that exited. Ensure we're not tracking it anymore. const bool thread_found = StopTrackingThread(pid); @@ -597,15 +587,13 @@ const bool already_notified = (GetState() == StateType::eStateExited) || (GetState() == StateType::eStateCrashed); if (!already_notified) { - if (log) - log->Printf("NativeProcessLinux::%s() tid = %" PRIu64 - " handling main thread exit (%s), expected exit state " - "already set but state was %s instead, setting exit " - "state now", - __FUNCTION__, pid, - thread_found ? "stopped tracking thread metadata" - : "thread metadata not found", - StateAsCString(GetState())); + LLDB_LOG() << llvm::formatv( + "tid = {} handling main thread exit ({}), expected exit state " + "already set but state was {} instead, setting exit state now", + pid, + thread_found ? "stopped tracking thread metadata" + : "thread metadata not found", + StateAsCString(GetState())); // The main thread exited. We're done monitoring. Report to delegate. SetExitStatus(convert_pid_status_to_exit_type(status), convert_pid_status_to_return_code(status), nullptr, true); @@ -646,24 +634,20 @@ // received a new thread notification. This is indicated by GetSignalInfo() // returning // si_code == SI_USER and si_pid == 0 - if (log) - log->Printf("NativeProcessLinux::%s received notification about an " - "unknown tid %" PRIu64 ".", - __FUNCTION__, pid); + LLDB_LOG() << "received notification about an unknown tid " << pid; if (info_err.Fail()) { - if (log) - log->Printf("NativeProcessLinux::%s (tid %" PRIu64 - ") GetSignalInfo failed (%s). Ingoring this notification.", - __FUNCTION__, pid, info_err.AsCString()); + LLDB_LOG() << llvm::formatv( + "(tid {}) GetSignalInfo failed ({}). Ingoring this notification.", + pid, info_err.AsCString()); return; } - if (log && (info.si_code != SI_USER || info.si_pid != 0)) - log->Printf("NativeProcessLinux::%s (tid %" PRIu64 - ") unexpected signal info (si_code: %d, si_pid: %d). " - "Treating as a new thread notification anyway.", - __FUNCTION__, pid, info.si_code, info.si_pid); + if (info.si_code != SI_USER || info.si_pid != 0) + LLDB_LOG() << llvm::formatv( + "(tid {}) unexpected signal info (si_code: {}, si_pid: {}). " + "Treating as a new thread notification anyway.", + pid, info.si_code, info.si_pid); auto thread_sp = AddThread(pid); // Resume the newly created thread. @@ -764,32 +748,25 @@ int status = -1; ::pid_t wait_pid; do { - if (log) - log->Printf("NativeProcessLinux::%s() received thread creation event for " - "tid %" PRIu32 - ". tid not tracked yet, waiting for thread to appear...", - __FUNCTION__, tid); + LLDB_LOG() << "received thread creation event for tid " << tid + << ". tid not tracked yet, waiting for thread to appear..."; wait_pid = waitpid(tid, &status, __WALL); } while (wait_pid == -1 && errno == EINTR); // Since we are waiting on a specific tid, this must be the creation event. // But let's do // some checks just in case. if (wait_pid != tid) { - if (log) - log->Printf( - "NativeProcessLinux::%s() waiting for tid %" PRIu32 - " failed. Assuming the thread has disappeared in the meantime", - __FUNCTION__, tid); + LLDB_LOG() + << "waiting for tid " << tid + << " failed. Assuming the thread has disappeared in the meantime"; // The only way I know of this could happen is if the whole process was // SIGKILLed in the mean time. In any case, we can't do anything about that // now. return; } if (WIFEXITED(status)) { - if (log) - log->Printf("NativeProcessLinux::%s() waiting for tid %" PRIu32 - " returned an 'exited' event. Not tracking the thread.", - __FUNCTION__, tid); + LLDB_LOG() << "waiting for tid " << tid << + " returned an 'exited' event. Not tracking the thread."; // Also a very improbable event. return; } @@ -797,11 +774,8 @@ siginfo_t info; Error error = GetSignalInfo(tid, &info); if (error.Fail()) { - if (log) - log->Printf( - "NativeProcessLinux::%s() GetSignalInfo for tid %" PRIu32 - " failed. Assuming the thread has disappeared in the meantime.", - __FUNCTION__, tid); + LLDB_LOG() << "GetSignalInfo for tid " << tid << + " failed. Assuming the thread has disappeared in the meantime."; return; } @@ -813,15 +787,12 @@ // thread is alive and we are receiving events from it, we shall pretend // that it was // created properly. - log->Printf("NativeProcessLinux::%s() GetSignalInfo for tid %" PRIu32 - " received unexpected signal with code %d from pid %d.", - __FUNCTION__, tid, info.si_code, info.si_pid); + LLDB_LOG() << "GetSignalInfo for tid " << tid + << " received unexpected signal with code " << info.si_code + << " from pid " << info.si_pid << "."; } - if (log) - log->Printf("NativeProcessLinux::%s() pid = %" PRIu64 - ": tracking new thread tid %" PRIu32, - __FUNCTION__, GetID(), tid); + LLDB_LOG() << "pid = " << GetID() << ": tracking new thread tid " << tid; new_thread_sp = AddThread(tid); ResumeThread(*new_thread_sp, eStateRunning, LLDB_INVALID_SIGNAL_NUMBER);