219 lines · cpp
1//===-- MsvcStl.cpp -------------------------------------------------------===//2//3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.4// See https://llvm.org/LICENSE.txt for license information.5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception6//7//===----------------------------------------------------------------------===//8 9#include "MsvcStl.h"10 11#include "lldb/Core/Debugger.h"12#include "lldb/Core/FormatEntity.h"13#include "lldb/DataFormatters/StringPrinter.h"14#include "lldb/DataFormatters/TypeSummary.h"15#include "lldb/Utility/ConstString.h"16#include "lldb/Utility/Status.h"17#include "lldb/Utility/Stream.h"18#include "lldb/ValueObject/ValueObject.h"19 20#include "Plugins/Language/CPlusPlus/CxxStringTypes.h"21 22#include "lldb/lldb-forward.h"23#include <optional>24#include <tuple>25 26using namespace lldb;27using namespace lldb_private;28using namespace lldb_private::formatters;29 30using StringElementType = StringPrinter::StringElementType;31 32template <StringElementType element_type>33static constexpr uint64_t StringElementByteSize() {34 switch (element_type) {35 case StringElementType::ASCII:36 case StringElementType::UTF8:37 return 1;38 case StringElementType::UTF16:39 return 2;40 case StringElementType::UTF32:41 return 3;42 }43 return 0;44}45 46static ValueObjectSP ExtractMsvcStlStringData(ValueObject &valobj) {47 return valobj.GetChildAtNamePath({"_Mypair", "_Myval2"});48}49 50/// Determine the size in bytes of \p valobj (a MSVC STL std::string object) and51/// extract its data payload. Return the size + payload pair.52static std::optional<std::pair<uint64_t, ValueObjectSP>>53ExtractMsvcStlStringInfo(ValueObject &valobj, uint64_t element_size) {54 ValueObjectSP valobj_pair_sp = ExtractMsvcStlStringData(valobj);55 if (!valobj_pair_sp || !valobj_pair_sp->GetError().Success())56 return {};57 58 ValueObjectSP size_sp = valobj_pair_sp->GetChildMemberWithName("_Mysize");59 ValueObjectSP capacity_sp = valobj_pair_sp->GetChildMemberWithName("_Myres");60 ValueObjectSP bx_sp = valobj_pair_sp->GetChildMemberWithName("_Bx");61 if (!size_sp || !capacity_sp || !bx_sp)62 return {};63 64 bool success = false;65 uint64_t size = size_sp->GetValueAsUnsigned(0, &success);66 if (!success)67 return {};68 uint64_t capacity = capacity_sp->GetValueAsUnsigned(0, &success);69 if (!success)70 return {};71 72 size_t bufSize = std::max<size_t>(16 / element_size, 1);73 bool isShortString = capacity < bufSize;74 75 if (isShortString) {76 ValueObjectSP buf_sp = bx_sp->GetChildMemberWithName("_Buf");77 if (buf_sp)78 return std::make_pair(size, buf_sp);79 return {};80 }81 ValueObjectSP ptr_sp = bx_sp->GetChildMemberWithName("_Ptr");82 if (ptr_sp)83 return std::make_pair(size, ptr_sp);84 return {};85}86 87template <StringPrinter::StringElementType element_type>88static bool89MsvcStlStringSummaryProviderImpl(ValueObject &valobj, Stream &stream,90 const TypeSummaryOptions &summary_options,91 std::string prefix_token) {92 auto string_info =93 ExtractMsvcStlStringInfo(valobj, StringElementByteSize<element_type>());94 if (!string_info)95 return false;96 auto [size, location_sp] = *string_info;97 98 return StringBufferSummaryProvider<element_type>(99 stream, summary_options, location_sp, size, prefix_token);100}101template <StringPrinter::StringElementType element_type>102static bool formatStringImpl(ValueObject &valobj, Stream &stream,103 const TypeSummaryOptions &summary_options,104 std::string prefix_token) {105 StreamString scratch_stream;106 const bool success = MsvcStlStringSummaryProviderImpl<element_type>(107 valobj, scratch_stream, summary_options, prefix_token);108 if (success)109 stream << scratch_stream.GetData();110 else111 stream << "Summary Unavailable";112 return true;113}114 115template <StringPrinter::StringElementType element_type>116static bool formatStringViewImpl(ValueObject &valobj, Stream &stream,117 const TypeSummaryOptions &summary_options,118 std::string prefix_token) {119 auto data_sp = valobj.GetChildMemberWithName("_Mydata");120 auto size_sp = valobj.GetChildMemberWithName("_Mysize");121 if (!data_sp || !size_sp)122 return false;123 124 bool success = false;125 uint64_t size = size_sp->GetValueAsUnsigned(0, &success);126 if (!success) {127 stream << "Summary Unavailable";128 return true;129 }130 131 StreamString scratch_stream;132 success = StringBufferSummaryProvider<element_type>(133 scratch_stream, summary_options, data_sp, size, prefix_token);134 135 if (success)136 stream << scratch_stream.GetData();137 else138 stream << "Summary Unavailable";139 return true;140}141 142bool lldb_private::formatters::IsMsvcStlStringType(ValueObject &valobj) {143 std::vector<uint32_t> indexes;144 return valobj.GetCompilerType().GetIndexOfChildMemberWithName("_Mypair", true,145 indexes) > 0;146}147 148bool lldb_private::formatters::MsvcStlWStringSummaryProvider(149 ValueObject &valobj, Stream &stream,150 const TypeSummaryOptions &summary_options) {151 return formatStringImpl<StringElementType::UTF16>(valobj, stream,152 summary_options, "L");153}154 155template <>156bool lldb_private::formatters::MsvcStlStringSummaryProvider<157 StringElementType::ASCII>(ValueObject &valobj, Stream &stream,158 const TypeSummaryOptions &summary_options) {159 return MsvcStlStringSummaryProviderImpl<StringElementType::ASCII>(160 valobj, stream, summary_options, "");161}162template <>163bool lldb_private::formatters::MsvcStlStringSummaryProvider<164 StringElementType::UTF8>(ValueObject &valobj, Stream &stream,165 const TypeSummaryOptions &summary_options) {166 return MsvcStlStringSummaryProviderImpl<StringElementType::UTF8>(167 valobj, stream, summary_options, "u8");168}169template <>170bool lldb_private::formatters::MsvcStlStringSummaryProvider<171 StringElementType::UTF16>(ValueObject &valobj, Stream &stream,172 const TypeSummaryOptions &summary_options) {173 return MsvcStlStringSummaryProviderImpl<StringElementType::UTF16>(174 valobj, stream, summary_options, "u");175}176template <>177bool lldb_private::formatters::MsvcStlStringSummaryProvider<178 StringElementType::UTF32>(ValueObject &valobj, Stream &stream,179 const TypeSummaryOptions &summary_options) {180 return MsvcStlStringSummaryProviderImpl<StringElementType::UTF32>(181 valobj, stream, summary_options, "U");182}183 184bool lldb_private::formatters::MsvcStlWStringViewSummaryProvider(185 ValueObject &valobj, Stream &stream,186 const TypeSummaryOptions &summary_options) {187 return formatStringViewImpl<StringElementType::UTF16>(valobj, stream,188 summary_options, "L");189}190 191template <>192bool lldb_private::formatters::MsvcStlStringViewSummaryProvider<193 StringElementType::ASCII>(ValueObject &valobj, Stream &stream,194 const TypeSummaryOptions &summary_options) {195 return formatStringViewImpl<StringElementType::ASCII>(valobj, stream,196 summary_options, "");197}198template <>199bool lldb_private::formatters::MsvcStlStringViewSummaryProvider<200 StringElementType::UTF8>(ValueObject &valobj, Stream &stream,201 const TypeSummaryOptions &summary_options) {202 return formatStringViewImpl<StringElementType::UTF8>(valobj, stream,203 summary_options, "u8");204}205template <>206bool lldb_private::formatters::MsvcStlStringViewSummaryProvider<207 StringElementType::UTF16>(ValueObject &valobj, Stream &stream,208 const TypeSummaryOptions &summary_options) {209 return formatStringViewImpl<StringElementType::UTF16>(valobj, stream,210 summary_options, "u");211}212template <>213bool lldb_private::formatters::MsvcStlStringViewSummaryProvider<214 StringElementType::UTF32>(ValueObject &valobj, Stream &stream,215 const TypeSummaryOptions &summary_options) {216 return formatStringViewImpl<StringElementType::UTF32>(valobj, stream,217 summary_options, "U");218}219