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 // The function releases the data in progs in advance for the sake of the peak memory at compiler time. 66 static bool EmitPrograms(const std::string &filename, const std::vector<Program *> &progs, bool emit_debug_info, 67 uint8_t api = 0, std::string subApi = panda_file::DEFAULT_SUB_API_VERSION); 68 69 static std::unique_ptr<const panda_file::File> Emit(const Program &program, 70 PandaFileToPandaAsmMaps *maps = nullptr, 71 uint8_t api = 0, 72 std::string subApi = panda_file::DEFAULT_SUB_API_VERSION); 73 GetLastError()74 static std::string GetLastError() 75 { 76 return last_error; 77 } 78 79 private: 80 static bool FillFields(panda_file::ItemContainer *items, const Program &program, 81 const panda::pandasm::Record &record, const AsmEmitter::AsmEntityCollections &entities); 82 static bool CheckDuplicateField(panda_file::ValueItem &value_item, panda_file::FieldItem &field_item, 83 std::string &field_name); 84 static void MakeStringItems(panda_file::ItemContainer *items, const Program &program, 85 AsmEntityCollections &entities); 86 static void MakeLiteralItems(panda_file::ItemContainer *items, const Program &program, 87 AsmEmitter::AsmEntityCollections &entities); 88 static void MakeArrayTypeItems(panda_file::ItemContainer *items, const Program &program, 89 AsmEntityCollections &entities); 90 static bool HandleRecordAsForeign( 91 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 92 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 93 const std::string &name, const Record &rec); 94 static bool HandleBaseRecord(panda_file::ItemContainer *items, const Program &program, const std::string &name, 95 const Record &base_rec, panda_file::ClassItem *record); 96 static bool HandleInterfaces(panda_file::ItemContainer *items, const Program &program, const std::string &name, 97 const Record &rec, panda_file::ClassItem *record); 98 static bool HandleFields( 99 panda_file::ItemContainer *items, const Program &program, AsmEmitter::AsmEntityCollections &entities, 100 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 101 const std::string &name, const Record &rec, panda_file::ClassItem *record); 102 static bool HandleRecord( 103 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 104 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 105 const std::string &name, const Record &rec); 106 static bool MakeRecordItems( 107 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 108 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types); 109 static panda_file::StringItem *GetMethodName(panda_file::ItemContainer *items, const Function &func, 110 const std::string &name); 111 static bool HandleAreaForInner(panda_file::ItemContainer *items, const Program &program, 112 panda_file::ClassItem **area, panda_file::ForeignClassItem **foreign_area, 113 const std::string &name, const std::string &record_owner_name); 114 static bool HandleRecordOnwer(panda_file::ItemContainer *items, const Program &program, 115 panda_file::ClassItem **area, panda_file::ForeignClassItem **foreign_area, 116 const std::string &name, const std::string &record_owner_name); 117 static bool HandleFunctionParams( 118 panda_file::ItemContainer *items, const Program &program, size_t idx, const std::string &name, 119 const Function &func, 120 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 121 std::vector<panda_file::MethodParamItem> ¶ms); 122 static bool HandleFunctionLocalVariables(panda_file::ItemContainer *items, const Function &func, 123 const std::string &name); 124 static bool CreateMethodItem(panda_file::ItemContainer *items, AsmEmitter::AsmEntityCollections &entities, 125 const Function &func, panda_file::TypeItem *type_item, panda_file::ClassItem *area, 126 panda_file::ForeignClassItem *foreign_area, uint32_t access_flags, 127 panda_file::StringItem *method_name, const std::string &mangled_name, 128 const std::string &name, std::vector<panda_file::MethodParamItem> ¶ms); 129 static bool MakeFunctionItems( 130 panda_file::ItemContainer *items, const Program &program, AsmEntityCollections &entities, 131 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 132 bool emit_debug_info); 133 static bool MakeRecordAnnotations(panda_file::ItemContainer *items, const Program &program, 134 const AsmEntityCollections &entities); 135 static void SetCodeAndDebugInfo(panda_file::ItemContainer *items, panda_file::MethodItem *method, 136 const Function &func, bool emit_debug_info); 137 static bool AddMethodAndParamsAnnotations(panda_file::ItemContainer *items, const Program &program, 138 const AsmEmitter::AsmEntityCollections &entities, 139 panda_file::MethodItem *method, const Function &func); 140 static bool MakeFunctionDebugInfoAndAnnotations(panda_file::ItemContainer *items, const Program &program, 141 const AsmEntityCollections &entities, bool emit_debug_info); 142 static void FillMap(PandaFileToPandaAsmMaps *maps, AsmEntityCollections &entities); 143 static void EmitDebugInfo(panda_file::ItemContainer *items, const Program &program, 144 const std::vector<uint8_t> *bytes, const panda_file::MethodItem *method, 145 const Function &func, const std::string &name, bool emit_debug_info); 146 static bool EmitFunctions(panda_file::ItemContainer *items, const Program &program, 147 const AsmEntityCollections &entities, bool emit_debug_info); 148 149 static panda_file::TypeItem *GetTypeItem( 150 panda_file::ItemContainer *items, 151 const std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> &primitive_types, 152 const Type &type, const Program &program); 153 SetLastError(const std::string & message)154 static void SetLastError(const std::string &message) 155 { 156 last_error = message; 157 } 158 159 static bool MakeItemsForSingleProgram(panda_file::ItemContainer *items, const Program &program, 160 bool emit_debug_info, AsmEntityCollections &entities, 161 std::unordered_map<panda_file::Type::TypeId, panda_file::PrimitiveTypeItem *> primitive_types); 162 163 static std::string GetMethodSignatureFromProgram(const std::string &name, const Program &program); 164 165 static panda_file::LiteralItem *CreateLiteralItem( 166 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::LiteralItem> *out, 167 const AsmEmitter::AsmEntityCollections &entities); 168 169 template <class PrimType> CreateScalarPrimValueItem(panda_file::ItemContainer * container,const Value * value,std::vector<panda_file::ScalarValueItem> * out)170 static panda_file::ScalarValueItem *CreateScalarPrimValueItem(panda_file::ItemContainer *container, 171 const Value *value, 172 std::vector<panda_file::ScalarValueItem> *out) 173 { 174 static_assert(std::is_arithmetic<PrimType>::value); 175 auto v = value->GetAsScalar()->GetValue<PrimType>(); 176 if (out != nullptr) { 177 out->emplace_back(v, container); 178 return &out->back(); 179 } 180 181 if constexpr (std::is_same<PrimType, uint32_t>::value) { 182 return container->GetOrCreateIntegerValueItem(v); 183 } else if constexpr (std::is_same<PrimType, uint64_t>::value) { 184 return container->GetOrCreateLongValueItem(v); 185 } else if constexpr (std::is_same<PrimType, float>::value) { 186 return container->GetOrCreateFloatValueItem(v); 187 } else if constexpr (std::is_same<PrimType, double>::value) { 188 return container->GetOrCreateDoubleValueItem(v); 189 } else { 190 UNREACHABLE(); 191 return nullptr; 192 } 193 } 194 195 static panda_file::ScalarValueItem *CreateScalarStringValueItem(panda_file::ItemContainer *container, 196 const Value *value, 197 std::vector<panda_file::ScalarValueItem> *out); 198 static panda_file::ScalarValueItem *CreateScalarRecordValueItem( 199 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 200 const std::unordered_map<std::string, panda_file::BaseClassItem *> &classes); 201 static panda_file::ScalarValueItem *CreateScalarMethodValueItem( 202 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 203 const Program &program, const std::unordered_map<std::string, panda_file::BaseMethodItem *> &methods); 204 static panda_file::ScalarValueItem *CreateScalarLiteralArrayItem( 205 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 206 const Program &program, const std::unordered_map<std::string, panda_file::LiteralArrayItem *> &literalarrays); 207 static panda_file::ScalarValueItem *CreateScalarEnumValueItem( 208 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 209 const std::unordered_map<std::string, panda_file::BaseFieldItem *> &fields); 210 static panda_file::ScalarValueItem *CreateScalarAnnotationValueItem( 211 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 212 const Program &program, const AsmEmitter::AsmEntityCollections &entities); 213 214 static panda_file::ScalarValueItem *CreateScalarValueItem( 215 panda_file::ItemContainer *container, const Value *value, std::vector<panda_file::ScalarValueItem> *out, 216 const Program &program, const AsmEmitter::AsmEntityCollections &entities); 217 218 static panda_file::ValueItem *CreateValueItem( 219 panda_file::ItemContainer *container, const Value *value, const Program &program, 220 const AsmEmitter::AsmEntityCollections &entities); 221 222 static panda_file::AnnotationItem *CreateAnnotationItem( 223 panda_file::ItemContainer *container, const AnnotationData &annotation, const Program &program, 224 const AsmEmitter::AsmEntityCollections &entities); 225 226 static panda_file::MethodHandleItem *CreateMethodHandleItem( 227 panda_file::ItemContainer *container, const MethodHandle &mh, 228 const std::unordered_map<std::string, panda_file::BaseFieldItem *> &fields, 229 const std::unordered_map<std::string, panda_file::BaseMethodItem *> &methods); 230 231 template <class T> 232 static bool AddAnnotations(T *item, panda_file::ItemContainer *container, const AnnotationMetadata &metadata, 233 const Program &program, const AsmEmitter::AsmEntityCollections &entities); 234 235 // TODO(mgonopolsky): Refactor to introduce a single error-processing mechanism for parser and emitter 236 static std::string last_error; 237 }; 238 239 std::string GetOwnerName(std::string name); 240 std::string GetItemName(std::string name); 241 242 } // namespace panda::pandasm 243 244 #endif // ASSEMBLER_ASSEMBLY_EMITTER_H 245