1 //===- FormatUtil.cpp ----------------------------------------- *- C++ --*-===// 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-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "llvm/DebugInfo/PDB/Native/FormatUtil.h" 10 11 #include "llvm/ADT/STLExtras.h" 12 #include "llvm/ADT/StringExtras.h" 13 #include "llvm/BinaryFormat/COFF.h" 14 #include "llvm/DebugInfo/CodeView/CodeView.h" 15 #include "llvm/Support/FormatAdapters.h" 16 #include "llvm/Support/FormatVariadic.h" 17 18 using namespace llvm; 19 using namespace llvm::codeview; 20 using namespace llvm::pdb; 21 22 std::string llvm::pdb::typesetItemList(ArrayRef<std::string> Opts, 23 uint32_t IndentLevel, uint32_t GroupSize, 24 StringRef Sep) { 25 std::string Result; 26 while (!Opts.empty()) { 27 ArrayRef<std::string> ThisGroup; 28 ThisGroup = Opts.take_front(GroupSize); 29 Opts = Opts.drop_front(ThisGroup.size()); 30 Result += join(ThisGroup, Sep); 31 if (!Opts.empty()) { 32 Result += Sep; 33 Result += "\n"; 34 Result += std::string(formatv("{0}", fmt_repeat(' ', IndentLevel))); 35 } 36 } 37 return Result; 38 } 39 40 std::string llvm::pdb::typesetStringList(uint32_t IndentLevel, 41 ArrayRef<StringRef> Strings) { 42 std::string Result = "["; 43 for (const auto &S : Strings) { 44 Result += std::string(formatv("\n{0}{1}", fmt_repeat(' ', IndentLevel), S)); 45 } 46 Result += "]"; 47 return Result; 48 } 49 50 std::string llvm::pdb::formatChunkKind(DebugSubsectionKind Kind, 51 bool Friendly) { 52 if (Friendly) { 53 switch (Kind) { 54 RETURN_CASE(DebugSubsectionKind, None, "none"); 55 RETURN_CASE(DebugSubsectionKind, Symbols, "symbols"); 56 RETURN_CASE(DebugSubsectionKind, Lines, "lines"); 57 RETURN_CASE(DebugSubsectionKind, StringTable, "strings"); 58 RETURN_CASE(DebugSubsectionKind, FileChecksums, "checksums"); 59 RETURN_CASE(DebugSubsectionKind, FrameData, "frames"); 60 RETURN_CASE(DebugSubsectionKind, InlineeLines, "inlinee lines"); 61 RETURN_CASE(DebugSubsectionKind, CrossScopeImports, "xmi"); 62 RETURN_CASE(DebugSubsectionKind, CrossScopeExports, "xme"); 63 RETURN_CASE(DebugSubsectionKind, ILLines, "il lines"); 64 RETURN_CASE(DebugSubsectionKind, FuncMDTokenMap, "func md token map"); 65 RETURN_CASE(DebugSubsectionKind, TypeMDTokenMap, "type md token map"); 66 RETURN_CASE(DebugSubsectionKind, MergedAssemblyInput, 67 "merged assembly input"); 68 RETURN_CASE(DebugSubsectionKind, CoffSymbolRVA, "coff symbol rva"); 69 } 70 } else { 71 switch (Kind) { 72 RETURN_CASE(DebugSubsectionKind, None, "none"); 73 RETURN_CASE(DebugSubsectionKind, Symbols, "DEBUG_S_SYMBOLS"); 74 RETURN_CASE(DebugSubsectionKind, Lines, "DEBUG_S_LINES"); 75 RETURN_CASE(DebugSubsectionKind, StringTable, "DEBUG_S_STRINGTABLE"); 76 RETURN_CASE(DebugSubsectionKind, FileChecksums, "DEBUG_S_FILECHKSMS"); 77 RETURN_CASE(DebugSubsectionKind, FrameData, "DEBUG_S_FRAMEDATA"); 78 RETURN_CASE(DebugSubsectionKind, InlineeLines, "DEBUG_S_INLINEELINES"); 79 RETURN_CASE(DebugSubsectionKind, CrossScopeImports, 80 "DEBUG_S_CROSSSCOPEIMPORTS"); 81 RETURN_CASE(DebugSubsectionKind, CrossScopeExports, 82 "DEBUG_S_CROSSSCOPEEXPORTS"); 83 RETURN_CASE(DebugSubsectionKind, ILLines, "DEBUG_S_IL_LINES"); 84 RETURN_CASE(DebugSubsectionKind, FuncMDTokenMap, 85 "DEBUG_S_FUNC_MDTOKEN_MAP"); 86 RETURN_CASE(DebugSubsectionKind, TypeMDTokenMap, 87 "DEBUG_S_TYPE_MDTOKEN_MAP"); 88 RETURN_CASE(DebugSubsectionKind, MergedAssemblyInput, 89 "DEBUG_S_MERGED_ASSEMBLYINPUT"); 90 RETURN_CASE(DebugSubsectionKind, CoffSymbolRVA, 91 "DEBUG_S_COFF_SYMBOL_RVA"); 92 } 93 } 94 return formatUnknownEnum(Kind); 95 } 96 97 std::string llvm::pdb::formatSymbolKind(SymbolKind K) { 98 switch (uint32_t(K)) { 99 #define SYMBOL_RECORD(EnumName, value, name) \ 100 case EnumName: \ 101 return #EnumName; 102 #define CV_SYMBOL(EnumName, value) SYMBOL_RECORD(EnumName, value, EnumName) 103 #include "llvm/DebugInfo/CodeView/CodeViewSymbols.def" 104 } 105 return formatUnknownEnum(K); 106 } 107 108 std::string llvm::pdb::formatTypeLeafKind(TypeLeafKind K) { 109 switch (K) { 110 #define TYPE_RECORD(EnumName, value, name) \ 111 case EnumName: \ 112 return #EnumName; 113 #include "llvm/DebugInfo/CodeView/CodeViewTypes.def" 114 default: 115 return formatv("UNKNOWN RECORD ({0:X})", 116 static_cast<std::underlying_type_t<TypeLeafKind>>(K)) 117 .str(); 118 } 119 } 120 121 std::string llvm::pdb::formatSegmentOffset(uint16_t Segment, uint32_t Offset) { 122 return std::string(formatv("{0:4}:{1:4}", Segment, Offset)); 123 } 124 125 #define PUSH_CHARACTERISTIC_FLAG(Enum, TheOpt, Value, Style, Descriptive) \ 126 PUSH_FLAG(Enum, TheOpt, Value, \ 127 ((Style == CharacteristicStyle::HeaderDefinition) ? #TheOpt \ 128 : Descriptive)) 129 130 #define PUSH_MASKED_CHARACTERISTIC_FLAG(Enum, Mask, TheOpt, Value, Style, \ 131 Descriptive) \ 132 PUSH_MASKED_FLAG(Enum, Mask, TheOpt, Value, \ 133 ((Style == CharacteristicStyle::HeaderDefinition) \ 134 ? #TheOpt \ 135 : Descriptive)) 136 137 std::string llvm::pdb::formatSectionCharacteristics(uint32_t IndentLevel, 138 uint32_t C, 139 uint32_t FlagsPerLine, 140 StringRef Separator, 141 CharacteristicStyle Style) { 142 using SC = COFF::SectionCharacteristics; 143 std::vector<std::string> Opts; 144 if (C == COFF::SC_Invalid) 145 return "invalid"; 146 if (C == 0) 147 return "none"; 148 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_TYPE_NOLOAD, C, Style, "noload"); 149 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_TYPE_NO_PAD, C, Style, "no padding"); 150 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_CNT_CODE, C, Style, "code"); 151 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_CNT_INITIALIZED_DATA, C, Style, 152 "initialized data"); 153 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_CNT_UNINITIALIZED_DATA, C, Style, 154 "uninitialized data"); 155 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_LNK_OTHER, C, Style, "other"); 156 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_LNK_INFO, C, Style, "info"); 157 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_LNK_REMOVE, C, Style, "remove"); 158 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_LNK_COMDAT, C, Style, "comdat"); 159 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_GPREL, C, Style, "gp rel"); 160 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_PURGEABLE, C, Style, "purgeable"); 161 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_16BIT, C, Style, "16-bit"); 162 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_LOCKED, C, Style, "locked"); 163 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_PRELOAD, C, Style, "preload"); 164 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_1BYTES, C, 165 Style, "1 byte align"); 166 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_2BYTES, C, 167 Style, "2 byte align"); 168 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_4BYTES, C, 169 Style, "4 byte align"); 170 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_8BYTES, C, 171 Style, "8 byte align"); 172 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_16BYTES, C, 173 Style, "16 byte align"); 174 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_32BYTES, C, 175 Style, "32 byte align"); 176 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_64BYTES, C, 177 Style, "64 byte align"); 178 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_128BYTES, C, 179 Style, "128 byte align"); 180 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_256BYTES, C, 181 Style, "256 byte align"); 182 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_512BYTES, C, 183 Style, "512 byte align"); 184 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_1024BYTES, C, 185 Style, "1024 byte align"); 186 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_2048BYTES, C, 187 Style, "2048 byte align"); 188 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_4096BYTES, C, 189 Style, "4096 byte align"); 190 PUSH_MASKED_CHARACTERISTIC_FLAG(SC, 0xF00000, IMAGE_SCN_ALIGN_8192BYTES, C, 191 Style, "8192 byte align"); 192 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_LNK_NRELOC_OVFL, C, Style, 193 "noreloc overflow"); 194 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_DISCARDABLE, C, Style, 195 "discardable"); 196 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_NOT_CACHED, C, Style, 197 "not cached"); 198 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_NOT_PAGED, C, Style, "not paged"); 199 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_SHARED, C, Style, "shared"); 200 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_EXECUTE, C, Style, 201 "execute permissions"); 202 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_READ, C, Style, 203 "read permissions"); 204 PUSH_CHARACTERISTIC_FLAG(SC, IMAGE_SCN_MEM_WRITE, C, Style, 205 "write permissions"); 206 return typesetItemList(Opts, IndentLevel, FlagsPerLine, Separator); 207 } 208