1 /** 2 * Copyright (c) 2021-2022 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef ASSEMBLER_ASSEMBLY_EMITTER_H 17 #define ASSEMBLER_ASSEMBLY_EMITTER_H 18 19 #include <memory> 20 #include <type_traits> 21 #include <vector> 22 #include <unordered_map> 23 24 #include "assembly-ins.h" 25 #include "assembly-literals.h" 26 #include "assembly-program.h" 27 #include "assembly-type.h" 28 #include "assembly-function.h" 29 #include "bytecode_emitter.h" 30 #include "file_item_container.h" 31 #include "pgo.h" 32 33 namespace panda::pandasm { 34 class AsmEmitter { 35 public: 36 struct PandaFileToPandaAsmMaps { 37 std::unordered_map<uint32_t, std::string> methods; 38 std::unordered_map<uint32_t, std::string> fields; 39 std::unordered_map<uint32_t, std::string> classes; 40 std::unordered_map<uint32_t, std::string> strings; 41 std::unordered_map<uint32_t, std::string> literalarrays; 42 }; 43 44 struct AsmEntityCollections { 45 std::unordered_map<std::string, panda_file::BaseMethodItem *> method_items; 46 std::unordered_map<std::string, panda_file::BaseFieldItem *> field_items; 47 std::unordered_map<std::string, panda_file::BaseClassItem *> class_items; 48 std::unordered_map<std::string, panda_file::StringItem *> string_items; 49 std::unordered_map<std::string, panda_file::LiteralArrayItem *> literalarray_items; 50 }; 51 52 static bool Emit(panda_file::ItemContainer *items, const Program &program, PandaFileToPandaAsmMaps *maps = nullptr, 53 bool emit_debug_info = true, panda::panda_file::pgo::ProfileOptimizer *profile_opt = nullptr); 54 55 static bool Emit(panda_file::Writer *writer, const Program &program, std::map<std::string, size_t> *stat = nullptr, 56 PandaFileToPandaAsmMaps *maps = nullptr, bool debug_info = true, 57 panda::panda_file::pgo::ProfileOptimizer *profile_opt = nullptr, 58 uint8_t api = 0, std::string subApi = panda_file::DEFAULT_SUB_API_VERSION); 59 60 static bool Emit(const std::string &filename, const Program &program, std::map<std::string, size_t> *stat = nullptr, 61 PandaFileToPandaAsmMaps *maps = nullptr, bool debug_info = true, 62 panda::panda_file::pgo::ProfileOptimizer *profile_opt = nullptr, 63 uint8_t api = 0, std::string subApi = panda_file::DEFAULT_SUB_API_VERSION); 64 65 static bool EmitPrograms(const std::string &filename, const std::vector<Program *> &progs, bool emit_debug_info, 66 uint8_t api = 0, std::string subApi = panda_file::DEFAULT_SUB_API_VERSION); 67 68 static std::unique_ptr<const panda_file::File> Emit(const Program &program, 69 PandaFileToPandaAsmMaps *maps = nullptr, 70 uint8_t api = 0, 71 std::string subApi = panda_file::DEFAULT_SUB_API_VERSION); 72 GetLastError()73 static std::string GetLastError() 74 { 75 return last_error; 76 } 77 78 private: 79 static bool FillFields(panda_file::ItemContainer *items, const Program &program, 80 const panda::pandasm::Record &record, const AsmEmitter::AsmEntityCollections &entities); 81 static bool CheckDuplicateField(panda_file::ValueItem &value_item, panda_file::FieldItem &field_item, 82 std::string &field_name); 83 static void MakeStringItems(panda_file::ItemContainer *items, const Program &program, 84 AsmEntityCollections &entities); 85 static void MakeLiteralItems(panda_file::ItemContainer *items, const Program &program, 86 AsmEmitter::AsmEntityCollections &entities); 87 static void MakeArrayTypeItems(panda_file::ItemContainer *items, const Program &program, 88 AsmEntityCollections &entities); 89 static bool HandleRecordAsForeign( 90 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 91 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 92 const std::string &name, const Record &rec); 93 static bool HandleBaseRecord(panda_file::ItemContainer *items, const Program &program, const std::string &name, 94 const Record &base_rec, panda_file::ClassItem *record); 95 static bool HandleInterfaces(panda_file::ItemContainer *items, const Program &program, const std::string &name, 96 const Record &rec, panda_file::ClassItem *record); 97 static bool HandleFields( 98 panda_file::ItemContainer *items, const Program &program, AsmEmitter::AsmEntityCollections &entities, 99 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 100 const std::string &name, const Record &rec, panda_file::ClassItem *record); 101 static bool HandleRecord( 102 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 103 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 104 const std::string &name, const Record &rec); 105 static bool MakeRecordItems( 106 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 107 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types); 108 static panda_file::StringItem *GetMethodName(panda_file::ItemContainer *items, const Function &func, 109 const std::string &name); 110 static bool HandleAreaForInner(panda_file::ItemContainer *items, const Program &program, 111 panda_file::ClassItem **area, panda_file::ForeignClassItem **foreign_area, 112 const std::string &name, const std::string &record_owner_name); 113 static bool HandleRecordOnwer(panda_file::ItemContainer *items, const Program &program, 114 panda_file::ClassItem **area, panda_file::ForeignClassItem **foreign_area, 115 const std::string &name, const std::string &record_owner_name); 116 static bool HandleFunctionParams( 117 panda_file::ItemContainer *items, const Program &program, size_t idx, const std::string &name, 118 const Function &func, 119 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 120 std::vector<panda_file::MethodParamItem> ¶ms); 121 static bool HandleFunctionLocalVariables(panda_file::ItemContainer *items, const Function &func, 122 const std::string &name); 123 static bool CreateMethodItem(panda_file::ItemContainer *items, AsmEmitter::AsmEntityCollections &entities, 124 const Function &func, panda_file::TypeItem *type_item, panda_file::ClassItem *area, 125 panda_file::ForeignClassItem *foreign_area, uint32_t access_flags, 126 panda_file::StringItem *method_name, const std::string &mangled_name, 127 const std::string &name, std::vector<panda_file::MethodParamItem> ¶ms); 128 static bool MakeFunctionItems( 129 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 130 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 131 bool emit_debug_info); 132 static bool MakeRecordAnnotations(panda_file::ItemContainer *items, const Program &program, 133 const AsmEntityCollections &entities); 134 static void SetCodeAndDebugInfo(panda_file::ItemContainer *items, panda_file::MethodItem *method, 135 const Function &func, bool emit_debug_info); 136 static bool AddMethodAndParamsAnnotations(panda_file::ItemContainer *items, const Program &program, 137 const AsmEmitter::AsmEntityCollections &entities, 138 panda_file::MethodItem *method, const Function &func); 139 static bool MakeFunctionDebugInfoAndAnnotations(panda_file::ItemContainer *items, const Program &program, 140 const AsmEntityCollections &entities, bool emit_debug_info); 141 static void FillMap(PandaFileToPandaAsmMaps *maps, AsmEntityCollections &entities); 142 static void EmitDebugInfo(panda_file::ItemContainer *items, const Program &program, 143 const std::vector<uint8_t> *bytes, const panda_file::MethodItem *method, 144 const Function &func, const std::string &name, bool emit_debug_info); 145 static bool EmitFunctions(panda_file::ItemContainer *items, const Program &program, 146 const AsmEntityCollections &entities, bool emit_debug_info); 147 148 static panda_file::TypeItem *GetTypeItem( 149 panda_file::ItemContainer *items, 150 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 151 const Type &type, const Program &program); 152 SetLastError(const std::string &message)153 static void SetLastError(const std::string &message) 154 { 155 last_error = message; 156 } 157 158 static bool MakeItemsForSingleProgram(panda_file::ItemContainer *items, const Program &program, 159 bool emit_debug_info, AsmEntityCollections &entities, 160 std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> primitive_types); 161 162 static std::string GetMethodSignatureFromProgram(const std::string &name, const Program &program); 163 164 static panda_file::LiteralItem *CreateLiteralItem( 165 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::LiteralItem> *out, 166 const AsmEmitter::AsmEntityCollections &entities); 167 168 template <class PrimType> CreateScalarPrimValueItem(panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out)169 static panda_file::ScalarValueItem *CreateScalarPrimValueItem(panda_file::ItemContainer *container, 170 const Value *value, 171 std::vector<panda_file::ScalarValueItem> *out) 172 { 173 static_assert(std::is_arithmetic<PrimType>::value); 174 auto v = value->GetAsScalar()->GetValue<PrimType>(); 175 if (out != nullptr) { 176 out->emplace_back(v, container); 177 return &out->back(); 178 } 179 180 if constexpr (std::is_same<PrimType, uint32_t>::value) { 181 return container->GetOrCreateIntegerValueItem(v); 182 } else if constexpr (std::is_same<PrimType, uint64_t>::value) { 183 return container->GetOrCreateLongValueItem(v); 184 } else if constexpr (std::is_same<PrimType, float>::value) { 185 return container->GetOrCreateFloatValueItem(v); 186 } else if constexpr (std::is_same<PrimType, double>::value) { 187 return container->GetOrCreateDoubleValueItem(v); 188 } else { 189 UNREACHABLE(); 190 return nullptr; 191 } 192 } 193 194 static panda_file::ScalarValueItem *CreateScalarStringValueItem(panda_file::ItemContainer *container, 195 const Value *value, 196 std::vector<panda_file::ScalarValueItem> *out); 197 static panda_file::ScalarValueItem *CreateScalarRecordValueItem( 198 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 199 const std::unordered_map<std::string, panda_file::BaseClassItem *> &classes); 200 static panda_file::ScalarValueItem *CreateScalarMethodValueItem( 201 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 202 const Program &program, const std::unordered_map<std::string, panda_file::BaseMethodItem *> &methods); 203 static panda_file::ScalarValueItem *CreateScalarLiteralArrayItem( 204 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 205 const Program &program, const std::unordered_map<std::string, panda_file::LiteralArrayItem *> &literalarrays); 206 static panda_file::ScalarValueItem *CreateScalarEnumValueItem( 207 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 208 const std::unordered_map<std::string, panda_file::BaseFieldItem *> &fields); 209 static panda_file::ScalarValueItem *CreateScalarAnnotationValueItem( 210 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 211 const Program &program, const AsmEmitter::AsmEntityCollections &entities); 212 213 static panda_file::ScalarValueItem *CreateScalarValueItem( 214 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 215 const Program &program, const AsmEmitter::AsmEntityCollections &entities); 216 217 static panda_file::ValueItem *CreateValueItem( 218 panda_file::ItemContainer *container, const Value *value, const Program &program, 219 const AsmEmitter::AsmEntityCollections &entities); 220 221 static panda_file::AnnotationItem *CreateAnnotationItem( 222 panda_file::ItemContainer *container, const AnnotationData &annotation, const Program &program, 223 const AsmEmitter::AsmEntityCollections &entities); 224 225 static panda_file::MethodHandleItem *CreateMethodHandleItem( 226 panda_file::ItemContainer *container, const MethodHandle &mh, 227 const std::unordered_map<std::string, panda_file::BaseFieldItem *> &fields, 228 const std::unordered_map<std::string, panda_file::BaseMethodItem *> &methods); 229 230 template <class T> 231 static bool AddAnnotations(T *item, panda_file::ItemContainer *container, const AnnotationMetadata &metadata, 232 const Program &program, const AsmEmitter::AsmEntityCollections &entities); 233 234 // TODO(mgonopolsky): Refactor to introduce a single error-processing mechanism for parser and emitter 235 static std::string last_error; 236 }; 237 238 std::string GetOwnerName(std::string name); 239 std::string GetItemName(std::string name); 240 241 } // namespace panda::pandasm 242 243 #endif // ASSEMBLER_ASSEMBLY_EMITTER_H 244