File: TraceSessionSaver.cpp

package info (click to toggle)
llvm-toolchain-14 1%3A14.0.6-12
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,496,180 kB
  • sloc: cpp: 5,593,972; ansic: 986,872; asm: 585,869; python: 184,223; objc: 72,530; lisp: 31,119; f90: 27,793; javascript: 9,780; pascal: 9,762; sh: 9,482; perl: 7,468; ml: 5,432; awk: 3,523; makefile: 2,538; xml: 953; cs: 573; fortran: 567
file content (149 lines) | stat: -rw-r--r-- 5,637 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
//===-- TraceSessionSaver.cpp ---------------------------------------------===//
//
// 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 "TraceSessionSaver.h"

#include "lldb/Core/Module.h"
#include "lldb/Core/Value.h"
#include "lldb/Target/Process.h"
#include "lldb/Target/SectionLoadList.h"
#include "lldb/Target/Target.h"
#include "lldb/lldb-types.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/JSON.h"

#include <fstream>

using namespace lldb;
using namespace lldb_private;
using namespace llvm;

llvm::Error TraceSessionSaver::WriteSessionToFile(
    const llvm::json::Value &trace_session_description, FileSpec directory) {

  FileSpec trace_path = directory;
  trace_path.AppendPathComponent("trace.json");
  std::ofstream os(trace_path.GetPath());
  os << std::string(formatv("{0:2}", trace_session_description));
  os.close();
  if (!os)
    return createStringError(inconvertibleErrorCode(),
                             formatv("couldn't write to the file {0}",
                                     trace_path.GetPath().c_str()));
  return Error::success();
}

llvm::Expected<JSONTraceSessionBase> TraceSessionSaver::BuildProcessesSection(
    Process &live_process,
    std::function<
        llvm::Expected<llvm::Optional<std::vector<uint8_t>>>(lldb::tid_t tid)>
        raw_trace_fetcher,
    FileSpec directory) {

  JSONTraceSessionBase json_session_description;
  Expected<std::vector<JSONThread>> json_threads =
      BuildThreadsSection(live_process, raw_trace_fetcher, directory);
  if (!json_threads)
    return json_threads.takeError();

  Expected<std::vector<JSONModule>> json_modules =
      BuildModulesSection(live_process, directory);
  if (!json_modules)
    return json_modules.takeError();

  json_session_description.processes.push_back(JSONProcess{
      static_cast<int64_t>(live_process.GetID()),
      live_process.GetTarget().GetArchitecture().GetTriple().getTriple(),
      json_threads.get(), json_modules.get()});
  return json_session_description;
}

llvm::Expected<std::vector<JSONThread>> TraceSessionSaver::BuildThreadsSection(
    Process &live_process,
    std::function<
        llvm::Expected<llvm::Optional<std::vector<uint8_t>>>(lldb::tid_t tid)>
        raw_trace_fetcher,
    FileSpec directory) {
  std::vector<JSONThread> json_threads;
  for (ThreadSP thread_sp : live_process.Threads()) {
    // resolve the directory just in case
    FileSystem::Instance().Resolve(directory);
    FileSpec raw_trace_path = directory;
    raw_trace_path.AppendPathComponent(std::to_string(thread_sp->GetID()) +
                                       ".trace");
    json_threads.push_back(JSONThread{static_cast<int64_t>(thread_sp->GetID()),
                                      raw_trace_path.GetPath().c_str()});

    llvm::Expected<llvm::Optional<std::vector<uint8_t>>> raw_trace =
        raw_trace_fetcher(thread_sp->GetID());

    if (!raw_trace)
      return raw_trace.takeError();
    if (!raw_trace.get())
      continue;

    std::basic_fstream<char> raw_trace_fs = std::fstream(
        raw_trace_path.GetPath().c_str(), std::ios::out | std::ios::binary);
    raw_trace_fs.write(reinterpret_cast<const char *>(&raw_trace.get()->at(0)),
                       raw_trace.get()->size() * sizeof(uint8_t));
    raw_trace_fs.close();
    if (!raw_trace_fs) {
      return createStringError(inconvertibleErrorCode(),
                               formatv("couldn't write to the file {0}",
                                       raw_trace_path.GetPath().c_str()));
    }
  }
  return json_threads;
}

llvm::Expected<std::vector<JSONModule>>
TraceSessionSaver::BuildModulesSection(Process &live_process,
                                       FileSpec directory) {
  std::vector<JSONModule> json_modules;
  ModuleList module_list = live_process.GetTarget().GetImages();
  for (size_t i = 0; i < module_list.GetSize(); ++i) {
    ModuleSP module_sp(module_list.GetModuleAtIndex(i));
    if (!module_sp)
      continue;
    std::string system_path = module_sp->GetPlatformFileSpec().GetPath();
    // TODO: support memory-only libraries like [vdso]
    if (!module_sp->GetFileSpec().IsAbsolute())
      continue;

    std::string file = module_sp->GetFileSpec().GetPath();
    ObjectFile *objfile = module_sp->GetObjectFile();
    if (objfile == nullptr)
      continue;

    lldb::addr_t load_addr = LLDB_INVALID_ADDRESS;
    Address base_addr(objfile->GetBaseAddress());
    if (base_addr.IsValid() &&
        !live_process.GetTarget().GetSectionLoadList().IsEmpty())
      load_addr = base_addr.GetLoadAddress(&live_process.GetTarget());

    if (load_addr == LLDB_INVALID_ADDRESS)
      continue;

    FileSystem::Instance().Resolve(directory);
    FileSpec path_to_copy_module = directory;
    path_to_copy_module.AppendPathComponent("modules");
    path_to_copy_module.AppendPathComponent(system_path);
    sys::fs::create_directories(path_to_copy_module.GetDirectory().AsCString());

    if (std::error_code ec = llvm::sys::fs::copy_file(
            system_path, path_to_copy_module.GetPath()))
      return createStringError(
          inconvertibleErrorCode(),
          formatv("couldn't write to the file. {0}", ec.message()));

    json_modules.push_back(
        JSONModule{system_path, path_to_copy_module.GetPath(),
                   JSONAddress{load_addr}, module_sp->GetUUID().GetAsString()});
  }
  return json_modules;
}