lldb/tools/lldb-server/LLDBServerUtilities.cpp

//===-- LLDBServerUtilities.cpp ---------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "LLDBServerUtilities.h"

#include "lldb/Utility/Args.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/StreamString.h"

#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/FormatAdapters.h"

using namespace lldb;
using namespace lldb_private::lldb_server;
using namespace lldb_private;
using namespace llvm;

class TestLogHandler : public LogHandler {
public:
  TestLogHandler(std::shared_ptr<llvm::raw_ostream> stream_sp)
      : m_stream_sp(stream_sp) {}

  void Emit(llvm::StringRef message) override {
    std::lock_guard<std::mutex> guard(m_mutex);
    (*m_stream_sp) << message;
    m_stream_sp->flush();
  }

private:
  std::mutex m_mutex;
  std::shared_ptr<raw_ostream> m_stream_sp;
};

static std::shared_ptr<TestLogHandler> GetLogStream(StringRef log_file) {
  if (!log_file.empty()) {
    std::error_code EC;
    auto stream_sp = std::make_shared<raw_fd_ostream>(
        log_file, EC, sys::fs::OF_TextWithCRLF | sys::fs::OF_Append);
    if (!EC)
      return std::make_shared<TestLogHandler>(stream_sp);
    errs() << llvm::formatv(
        "Failed to open log file `{0}`: {1}\nWill log to stderr instead.\n",
        log_file, EC.message());
  }
  // No need to delete the stderr stream.
  return std::make_shared<TestLogHandler>(
      std::shared_ptr<raw_ostream>(&errs(), [](raw_ostream *) {}));
}

bool LLDBServerUtilities::SetupLogging(const std::string &log_file,
                                       const StringRef &log_channels,
                                       uint32_t log_options) {

  auto log_stream_sp = GetLogStream(log_file);

  SmallVector<StringRef, 32> channel_array;
  log_channels.split(channel_array, ":", /*MaxSplit*/ -1, /*KeepEmpty*/ false);
  for (auto channel_with_categories : channel_array) {
    Args channel_then_categories(channel_with_categories);
    std::string channel(channel_then_categories.GetArgumentAtIndex(0));
    channel_then_categories.Shift(); // Shift off the channel

    llvm::Error error =
        Log::EnableLogChannel(log_stream_sp, log_options, channel,
                              channel_then_categories.GetArgumentArrayRef());
    if (error) {
      errs() << formatv("Unable to setup logging for channel \"{0}\": {1}",
                        channel, fmt_consume(std::move(error)));
      return false;
    }
  }
  return true;
}