xref: /openbsd-src/gnu/llvm/lldb/source/Plugins/ObjectFile/Minidump/ObjectFileMinidump.cpp (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1*f6aab3d8Srobert //===-- ObjectFileMinidump.cpp --------------------------------------------===//
2*f6aab3d8Srobert //
3*f6aab3d8Srobert // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*f6aab3d8Srobert // See https://llvm.org/LICENSE.txt for license information.
5*f6aab3d8Srobert // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*f6aab3d8Srobert //
7*f6aab3d8Srobert //===----------------------------------------------------------------------===//
8*f6aab3d8Srobert 
9*f6aab3d8Srobert #include "ObjectFileMinidump.h"
10*f6aab3d8Srobert 
11*f6aab3d8Srobert #include "MinidumpFileBuilder.h"
12*f6aab3d8Srobert 
13*f6aab3d8Srobert #include "lldb/Core/ModuleSpec.h"
14*f6aab3d8Srobert #include "lldb/Core/PluginManager.h"
15*f6aab3d8Srobert #include "lldb/Core/Section.h"
16*f6aab3d8Srobert #include "lldb/Target/Process.h"
17*f6aab3d8Srobert 
18*f6aab3d8Srobert #include "llvm/Support/FileSystem.h"
19*f6aab3d8Srobert 
20*f6aab3d8Srobert using namespace lldb;
21*f6aab3d8Srobert using namespace lldb_private;
22*f6aab3d8Srobert 
LLDB_PLUGIN_DEFINE(ObjectFileMinidump)23*f6aab3d8Srobert LLDB_PLUGIN_DEFINE(ObjectFileMinidump)
24*f6aab3d8Srobert 
25*f6aab3d8Srobert void ObjectFileMinidump::Initialize() {
26*f6aab3d8Srobert   PluginManager::RegisterPlugin(
27*f6aab3d8Srobert       GetPluginNameStatic(), GetPluginDescriptionStatic(), CreateInstance,
28*f6aab3d8Srobert       CreateMemoryInstance, GetModuleSpecifications, SaveCore);
29*f6aab3d8Srobert }
30*f6aab3d8Srobert 
Terminate()31*f6aab3d8Srobert void ObjectFileMinidump::Terminate() {
32*f6aab3d8Srobert   PluginManager::UnregisterPlugin(CreateInstance);
33*f6aab3d8Srobert }
34*f6aab3d8Srobert 
CreateInstance(const lldb::ModuleSP & module_sp,lldb::DataBufferSP data_sp,lldb::offset_t data_offset,const lldb_private::FileSpec * file,lldb::offset_t offset,lldb::offset_t length)35*f6aab3d8Srobert ObjectFile *ObjectFileMinidump::CreateInstance(
36*f6aab3d8Srobert     const lldb::ModuleSP &module_sp, lldb::DataBufferSP data_sp,
37*f6aab3d8Srobert     lldb::offset_t data_offset, const lldb_private::FileSpec *file,
38*f6aab3d8Srobert     lldb::offset_t offset, lldb::offset_t length) {
39*f6aab3d8Srobert   return nullptr;
40*f6aab3d8Srobert }
41*f6aab3d8Srobert 
CreateMemoryInstance(const lldb::ModuleSP & module_sp,WritableDataBufferSP data_sp,const ProcessSP & process_sp,lldb::addr_t header_addr)42*f6aab3d8Srobert ObjectFile *ObjectFileMinidump::CreateMemoryInstance(
43*f6aab3d8Srobert     const lldb::ModuleSP &module_sp, WritableDataBufferSP data_sp,
44*f6aab3d8Srobert     const ProcessSP &process_sp, lldb::addr_t header_addr) {
45*f6aab3d8Srobert   return nullptr;
46*f6aab3d8Srobert }
47*f6aab3d8Srobert 
GetModuleSpecifications(const lldb_private::FileSpec & file,lldb::DataBufferSP & data_sp,lldb::offset_t data_offset,lldb::offset_t file_offset,lldb::offset_t length,lldb_private::ModuleSpecList & specs)48*f6aab3d8Srobert size_t ObjectFileMinidump::GetModuleSpecifications(
49*f6aab3d8Srobert     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
50*f6aab3d8Srobert     lldb::offset_t data_offset, lldb::offset_t file_offset,
51*f6aab3d8Srobert     lldb::offset_t length, lldb_private::ModuleSpecList &specs) {
52*f6aab3d8Srobert   specs.Clear();
53*f6aab3d8Srobert   return 0;
54*f6aab3d8Srobert }
55*f6aab3d8Srobert 
SaveCore(const lldb::ProcessSP & process_sp,const lldb_private::FileSpec & outfile,lldb::SaveCoreStyle & core_style,lldb_private::Status & error)56*f6aab3d8Srobert bool ObjectFileMinidump::SaveCore(const lldb::ProcessSP &process_sp,
57*f6aab3d8Srobert                                   const lldb_private::FileSpec &outfile,
58*f6aab3d8Srobert                                   lldb::SaveCoreStyle &core_style,
59*f6aab3d8Srobert                                   lldb_private::Status &error) {
60*f6aab3d8Srobert   if (core_style != SaveCoreStyle::eSaveCoreStackOnly) {
61*f6aab3d8Srobert     error.SetErrorString("Only stack minidumps supported yet.");
62*f6aab3d8Srobert     return false;
63*f6aab3d8Srobert   }
64*f6aab3d8Srobert 
65*f6aab3d8Srobert   if (!process_sp)
66*f6aab3d8Srobert     return false;
67*f6aab3d8Srobert 
68*f6aab3d8Srobert   MinidumpFileBuilder builder;
69*f6aab3d8Srobert 
70*f6aab3d8Srobert   Target &target = process_sp->GetTarget();
71*f6aab3d8Srobert 
72*f6aab3d8Srobert   error = builder.AddSystemInfo(target.GetArchitecture().GetTriple());
73*f6aab3d8Srobert   if (error.Fail())
74*f6aab3d8Srobert     return false;
75*f6aab3d8Srobert 
76*f6aab3d8Srobert   error = builder.AddModuleList(target);
77*f6aab3d8Srobert   if (error.Fail())
78*f6aab3d8Srobert     return false;
79*f6aab3d8Srobert 
80*f6aab3d8Srobert   builder.AddMiscInfo(process_sp);
81*f6aab3d8Srobert 
82*f6aab3d8Srobert   if (target.GetArchitecture().GetMachine() == llvm::Triple::ArchType::x86_64) {
83*f6aab3d8Srobert     error = builder.AddThreadList(process_sp);
84*f6aab3d8Srobert     if (error.Fail())
85*f6aab3d8Srobert       return false;
86*f6aab3d8Srobert 
87*f6aab3d8Srobert     error = builder.AddException(process_sp);
88*f6aab3d8Srobert     if (error.Fail())
89*f6aab3d8Srobert       return false;
90*f6aab3d8Srobert 
91*f6aab3d8Srobert     error = builder.AddMemoryList(process_sp);
92*f6aab3d8Srobert     if (error.Fail())
93*f6aab3d8Srobert       return false;
94*f6aab3d8Srobert   }
95*f6aab3d8Srobert 
96*f6aab3d8Srobert   if (target.GetArchitecture().GetTriple().getOS() ==
97*f6aab3d8Srobert       llvm::Triple::OSType::Linux) {
98*f6aab3d8Srobert     builder.AddLinuxFileStreams(process_sp);
99*f6aab3d8Srobert   }
100*f6aab3d8Srobert 
101*f6aab3d8Srobert   llvm::Expected<lldb::FileUP> maybe_core_file = FileSystem::Instance().Open(
102*f6aab3d8Srobert       outfile, File::eOpenOptionWriteOnly | File::eOpenOptionCanCreate);
103*f6aab3d8Srobert   if (!maybe_core_file) {
104*f6aab3d8Srobert     error = maybe_core_file.takeError();
105*f6aab3d8Srobert     return false;
106*f6aab3d8Srobert   }
107*f6aab3d8Srobert   lldb::FileUP core_file = std::move(maybe_core_file.get());
108*f6aab3d8Srobert 
109*f6aab3d8Srobert   error = builder.Dump(core_file);
110*f6aab3d8Srobert   if (error.Fail())
111*f6aab3d8Srobert     return false;
112*f6aab3d8Srobert 
113*f6aab3d8Srobert   return true;
114*f6aab3d8Srobert }
115