import.cpp 94 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283
  1. // Part of the Carbon Language project, under the Apache License v2.0 with LLVM
  2. // Exceptions. See /LICENSE for license information.
  3. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  4. #include "toolchain/check/cpp/import.h"
  5. #include <algorithm>
  6. #include <memory>
  7. #include <optional>
  8. #include <string>
  9. #include <tuple>
  10. #include <utility>
  11. #include "clang/AST/ASTContext.h"
  12. #include "clang/AST/RecordLayout.h"
  13. #include "clang/AST/UnresolvedSet.h"
  14. #include "clang/AST/VTableBuilder.h"
  15. #include "clang/Frontend/CompilerInvocation.h"
  16. #include "clang/Sema/Lookup.h"
  17. #include "clang/Sema/Overload.h"
  18. #include "common/check.h"
  19. #include "common/ostream.h"
  20. #include "common/raw_string_ostream.h"
  21. #include "llvm/ADT/IntrusiveRefCntPtr.h"
  22. #include "llvm/ADT/ScopeExit.h"
  23. #include "llvm/ADT/StringRef.h"
  24. #include "llvm/Support/raw_ostream.h"
  25. #include "toolchain/base/int.h"
  26. #include "toolchain/base/kind_switch.h"
  27. #include "toolchain/base/value_ids.h"
  28. #include "toolchain/check/call.h"
  29. #include "toolchain/check/class.h"
  30. #include "toolchain/check/context.h"
  31. #include "toolchain/check/control_flow.h"
  32. #include "toolchain/check/convert.h"
  33. #include "toolchain/check/core_identifier.h"
  34. #include "toolchain/check/cpp/access.h"
  35. #include "toolchain/check/cpp/custom_type_mapping.h"
  36. #include "toolchain/check/cpp/generate_ast.h"
  37. #include "toolchain/check/cpp/location.h"
  38. #include "toolchain/check/cpp/macros.h"
  39. #include "toolchain/check/cpp/thunk.h"
  40. #include "toolchain/check/diagnostic_helpers.h"
  41. #include "toolchain/check/eval.h"
  42. #include "toolchain/check/function.h"
  43. #include "toolchain/check/import.h"
  44. #include "toolchain/check/inst.h"
  45. #include "toolchain/check/literal.h"
  46. #include "toolchain/check/member_access.h"
  47. #include "toolchain/check/name_lookup.h"
  48. #include "toolchain/check/operator.h"
  49. #include "toolchain/check/pattern.h"
  50. #include "toolchain/check/pattern_match.h"
  51. #include "toolchain/check/type.h"
  52. #include "toolchain/check/type_completion.h"
  53. #include "toolchain/parse/node_ids.h"
  54. #include "toolchain/sem_ir/clang_decl.h"
  55. #include "toolchain/sem_ir/class.h"
  56. #include "toolchain/sem_ir/cpp_file.h"
  57. #include "toolchain/sem_ir/cpp_overload_set.h"
  58. #include "toolchain/sem_ir/function.h"
  59. #include "toolchain/sem_ir/ids.h"
  60. #include "toolchain/sem_ir/inst.h"
  61. #include "toolchain/sem_ir/name_scope.h"
  62. #include "toolchain/sem_ir/typed_insts.h"
  63. namespace Carbon::Check {
  64. // Adds the name to the scope with the given `access_kind` and `inst_id`.
  65. // `inst_id` must have a value.
  66. static auto AddNameToScope(Context& context, SemIR::NameScopeId scope_id,
  67. SemIR::NameId name_id, SemIR::AccessKind access_kind,
  68. SemIR::InstId inst_id) -> void {
  69. CARBON_CHECK(inst_id.has_value());
  70. context.name_scopes().Get(scope_id).AddRequired(
  71. {.name_id = name_id,
  72. .result = SemIR::ScopeLookupResult::MakeFound(inst_id, access_kind)});
  73. }
  74. // Maps a Clang name to a Carbon `NameId`.
  75. static auto AddIdentifierName(Context& context, llvm::StringRef name)
  76. -> SemIR::NameId {
  77. return SemIR::NameId::ForIdentifier(context.identifiers().Add(name));
  78. }
  79. // Adds the given source location and an `ImportIRInst` referring to it in
  80. // `ImportIRId::Cpp`.
  81. static auto AddImportIRInst(SemIR::File& file,
  82. clang::SourceLocation clang_source_loc)
  83. -> SemIR::ImportIRInstId {
  84. SemIR::ClangSourceLocId clang_source_loc_id =
  85. file.clang_source_locs().Add(clang_source_loc);
  86. return file.import_ir_insts().Add(SemIR::ImportIRInst(clang_source_loc_id));
  87. }
  88. // Adds a namespace for the `Cpp` import and returns its `NameScopeId`.
  89. static auto AddNamespace(Context& context, PackageNameId cpp_package_id,
  90. llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
  91. -> SemIR::NameScopeId {
  92. return AddImportNamespaceToScope(
  93. context,
  94. GetSingletonType(context, SemIR::NamespaceType::TypeInstId),
  95. SemIR::NameId::ForPackageName(cpp_package_id),
  96. SemIR::NameScopeId::Package,
  97. /*diagnose_duplicate_namespace=*/false,
  98. [&]() {
  99. return AddInst<SemIR::ImportCppDecl>(
  100. context,
  101. context.parse_tree().As<Parse::ImportDeclId>(
  102. imports.front().node_id),
  103. {});
  104. })
  105. .add_result.name_scope_id;
  106. }
  107. auto ImportCpp(Context& context,
  108. llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
  109. llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs,
  110. llvm::LLVMContext* llvm_context,
  111. std::shared_ptr<clang::CompilerInvocation> invocation) -> void {
  112. if (imports.empty()) {
  113. // TODO: Consider always having a (non-null) AST even if there are no Cpp
  114. // imports.
  115. return;
  116. }
  117. PackageNameId package_id = imports.front().package_id;
  118. CARBON_CHECK(
  119. llvm::all_of(imports, [&](const Parse::Tree::PackagingNames& import) {
  120. return import.package_id == package_id;
  121. }));
  122. auto name_scope_id = AddNamespace(context, package_id, imports);
  123. bool ast_has_error =
  124. !GenerateAst(context, imports, fs, llvm_context, std::move(invocation));
  125. SemIR::NameScope& name_scope = context.name_scopes().Get(name_scope_id);
  126. name_scope.set_is_closed_import(true);
  127. name_scope.set_clang_decl_context_id(context.clang_decls().Add(
  128. {.key =
  129. SemIR::ClangDeclKey(context.ast_context().getTranslationUnitDecl()),
  130. .inst_id = name_scope.inst_id()}));
  131. if (ast_has_error) {
  132. name_scope.set_has_error();
  133. }
  134. }
  135. // Returns the Clang `DeclContext` for the given name scope. Return the
  136. // translation unit decl if no scope is provided.
  137. static auto GetDeclContext(Context& context, SemIR::NameScopeId scope_id)
  138. -> clang::DeclContext* {
  139. if (!scope_id.has_value()) {
  140. return context.ast_context().getTranslationUnitDecl();
  141. }
  142. auto scope_clang_decl_context_id =
  143. context.name_scopes().Get(scope_id).clang_decl_context_id();
  144. return dyn_cast<clang::DeclContext>(
  145. context.clang_decls().Get(scope_clang_decl_context_id).key.decl);
  146. }
  147. // Returns true if the given Clang declaration is the implicit injected class
  148. // name within the class.
  149. static auto IsDeclInjectedClassName(Context& context,
  150. SemIR::NameScopeId scope_id,
  151. SemIR::NameId name_id,
  152. const clang::NamedDecl* named_decl)
  153. -> bool {
  154. if (!named_decl->isImplicit()) {
  155. return false;
  156. }
  157. const auto* record_decl = dyn_cast<clang::CXXRecordDecl>(named_decl);
  158. if (!record_decl) {
  159. return false;
  160. }
  161. const SemIR::ClangDecl& clang_decl = context.clang_decls().Get(
  162. context.name_scopes().Get(scope_id).clang_decl_context_id());
  163. const auto* scope_record_decl =
  164. cast<clang::CXXRecordDecl>(clang_decl.key.decl);
  165. const clang::ASTContext& ast_context = context.ast_context();
  166. CARBON_CHECK(ast_context.getCanonicalTagType(scope_record_decl) ==
  167. ast_context.getCanonicalTagType(record_decl));
  168. auto class_decl = context.insts().GetAs<SemIR::ClassDecl>(clang_decl.inst_id);
  169. CARBON_CHECK(name_id == context.classes().Get(class_decl.class_id).name_id);
  170. return true;
  171. }
  172. // Performs a qualified name lookup of the identifier in the given scope.
  173. // Returns the lookup result if lookup was successful.
  174. static auto ClangLookupName(Context& context, SemIR::NameScopeId scope_id,
  175. clang::IdentifierInfo* identifier_name)
  176. -> std::optional<clang::LookupResult> {
  177. CARBON_CHECK(identifier_name, "Identifier name is empty");
  178. clang::Sema& sema = context.clang_sema();
  179. // TODO: Map the LocId of the lookup to a clang SourceLocation and provide it
  180. // here so that clang's diagnostics can point into the carbon code that uses
  181. // the name.
  182. clang::LookupResult lookup(
  183. sema,
  184. clang::DeclarationNameInfo(clang::DeclarationName(identifier_name),
  185. clang::SourceLocation()),
  186. clang::Sema::LookupNameKind::LookupOrdinaryName);
  187. bool found =
  188. sema.LookupQualifiedName(lookup, GetDeclContext(context, scope_id));
  189. if (!found) {
  190. return std::nullopt;
  191. }
  192. return lookup;
  193. }
  194. // Returns whether `decl` already mapped to an instruction.
  195. static auto IsClangDeclImported(Context& context, SemIR::ClangDeclKey key)
  196. -> bool {
  197. return context.clang_decls().Lookup(key).has_value();
  198. }
  199. // If `decl` already mapped to an instruction, returns that instruction.
  200. // Otherwise returns `None`.
  201. static auto LookupClangDeclInstId(Context& context, SemIR::ClangDeclKey key)
  202. -> SemIR::InstId {
  203. const auto& clang_decls = context.clang_decls();
  204. if (auto context_clang_decl_id = clang_decls.Lookup(key);
  205. context_clang_decl_id.has_value()) {
  206. return clang_decls.Get(context_clang_decl_id).inst_id;
  207. }
  208. return SemIR::InstId::None;
  209. }
  210. // Returns the parent of the given declaration. Skips declaration types we
  211. // ignore.
  212. static auto GetParentDecl(clang::Decl* clang_decl) -> clang::Decl* {
  213. auto* parent_dc = clang_decl->getDeclContext();
  214. while (!parent_dc->isLookupContext()) {
  215. parent_dc = parent_dc->getParent();
  216. }
  217. return cast<clang::Decl>(parent_dc);
  218. }
  219. // Returns the given declaration's parent scope. Assumes the parent declaration
  220. // was already imported.
  221. static auto GetParentNameScopeId(Context& context, clang::Decl* clang_decl)
  222. -> SemIR::NameScopeId {
  223. auto* parent_decl = GetParentDecl(clang_decl);
  224. if (auto* tag_decl = dyn_cast<clang::TagDecl>(parent_decl)) {
  225. auto class_inst_id =
  226. LookupClangDeclInstId(context, SemIR::ClangDeclKey(tag_decl));
  227. CARBON_CHECK(class_inst_id.has_value());
  228. auto class_inst = context.insts().Get(class_inst_id);
  229. auto class_id = SemIR::ClassId::None;
  230. if (auto class_decl = class_inst.TryAs<SemIR::ClassDecl>()) {
  231. // Common case: the tag was imported as a new Carbon class.
  232. class_id = class_decl->class_id;
  233. } else {
  234. // Rare case: the tag was imported as an existing Carbon class. This
  235. // happens for C++ classes that get mapped to Carbon prelude types, such
  236. // as `std::string_view`.
  237. // TODO: In this case, should we import the C++ class declaration and use
  238. // it as the parent, rather than using the existing Carbon class?
  239. class_id = class_inst.As<SemIR::ClassType>().class_id;
  240. }
  241. return context.classes().Get(class_id).scope_id;
  242. }
  243. if (isa<clang::NamespaceDecl, clang::TranslationUnitDecl>(parent_decl)) {
  244. auto namespace_inst_id = LookupClangDeclInstId(
  245. context, SemIR::ClangDeclKey::ForNonFunctionDecl(parent_decl));
  246. CARBON_CHECK(namespace_inst_id.has_value());
  247. return context.insts()
  248. .GetAs<SemIR::Namespace>(namespace_inst_id)
  249. .name_scope_id;
  250. }
  251. CARBON_FATAL("Unexpected kind of parent {0}", parent_decl->getDeclKindName());
  252. }
  253. // Imports a namespace declaration from Clang to Carbon. If successful, returns
  254. // the new Carbon namespace declaration `InstId`. If the declaration was already
  255. // imported, returns the mapped instruction.
  256. static auto ImportNamespaceDecl(Context& context,
  257. clang::NamespaceDecl* clang_decl)
  258. -> SemIR::InstId {
  259. auto key = SemIR::ClangDeclKey(clang_decl);
  260. // Check if the declaration is already mapped.
  261. if (SemIR::InstId existing_inst_id = LookupClangDeclInstId(context, key);
  262. existing_inst_id.has_value()) {
  263. return existing_inst_id;
  264. }
  265. auto result = AddImportNamespace(
  266. context, GetSingletonType(context, SemIR::NamespaceType::TypeInstId),
  267. AddIdentifierName(context, clang_decl->getName()),
  268. GetParentNameScopeId(context, clang_decl),
  269. /*import_id=*/SemIR::InstId::None);
  270. context.name_scopes()
  271. .Get(result.name_scope_id)
  272. .set_clang_decl_context_id(
  273. context.clang_decls().Add({.key = key, .inst_id = result.inst_id}));
  274. return result.inst_id;
  275. }
  276. // Creates a class declaration for the given class name in the given scope.
  277. // Returns the `InstId` for the declaration.
  278. static auto BuildClassDecl(Context& context,
  279. SemIR::ImportIRInstId import_ir_inst_id,
  280. SemIR::NameScopeId parent_scope_id,
  281. SemIR::NameId name_id)
  282. -> std::tuple<SemIR::ClassId, SemIR::TypeInstId> {
  283. // Add the class declaration.
  284. auto class_decl = SemIR::ClassDecl{.type_id = SemIR::TypeType::TypeId,
  285. .class_id = SemIR::ClassId::None,
  286. .decl_block_id = SemIR::InstBlockId::None};
  287. auto class_decl_id = AddPlaceholderImportedInstInNoBlock(
  288. context,
  289. MakeImportedLocIdAndInst(context, import_ir_inst_id, class_decl));
  290. SemIR::Class class_info = {
  291. {.name_id = name_id,
  292. .parent_scope_id = parent_scope_id,
  293. .generic_id = SemIR::GenericId::None,
  294. .first_param_node_id = Parse::NodeId::None,
  295. .last_param_node_id = Parse::NodeId::None,
  296. .pattern_block_id = SemIR::InstBlockId::None,
  297. .implicit_param_patterns_id = SemIR::InstBlockId::None,
  298. .param_patterns_id = SemIR::InstBlockId::None,
  299. .is_extern = false,
  300. .extern_library_id = SemIR::LibraryNameId::None,
  301. .non_owning_decl_id = SemIR::InstId::None,
  302. .first_owning_decl_id = class_decl_id},
  303. {// `.self_type_id` depends on the ClassType, so is set below.
  304. .self_type_id = SemIR::TypeId::None,
  305. // TODO: Support Dynamic classes.
  306. // TODO: Support Final classes.
  307. .inheritance_kind = SemIR::Class::Base}};
  308. class_decl.class_id = context.classes().Add(class_info);
  309. // Write the class ID into the ClassDecl.
  310. ReplaceInstBeforeConstantUse(context, class_decl_id, class_decl);
  311. SetClassSelfType(context, class_decl.class_id);
  312. return {class_decl.class_id, context.types().GetAsTypeInstId(class_decl_id)};
  313. }
  314. // Imports a tag declaration from Clang to Carbon. This covers classes (which
  315. // includes structs and unions) as well as enums. If successful, returns the new
  316. // Carbon class declaration `InstId`.
  317. static auto ImportTagDecl(Context& context, clang::TagDecl* clang_decl)
  318. -> SemIR::InstId {
  319. auto import_ir_inst_id =
  320. AddImportIRInst(context.sem_ir(), clang_decl->getLocation());
  321. auto [class_id, class_inst_id] = BuildClassDecl(
  322. context, import_ir_inst_id, GetParentNameScopeId(context, clang_decl),
  323. AddIdentifierName(context, clang_decl->getName()));
  324. // TODO: The caller does the same lookup. Avoid doing it twice.
  325. auto key = SemIR::ClangDeclKey(clang_decl);
  326. auto clang_decl_id =
  327. context.clang_decls().Add({.key = key, .inst_id = class_inst_id});
  328. // Name lookup into the Carbon class looks in the C++ class definition.
  329. auto& class_info = context.classes().Get(class_id);
  330. class_info.scope_id = context.name_scopes().Add(
  331. class_inst_id, SemIR::NameId::None, class_info.parent_scope_id);
  332. context.name_scopes()
  333. .Get(class_info.scope_id)
  334. .set_clang_decl_context_id(clang_decl_id);
  335. return class_inst_id;
  336. }
  337. // Determines the Carbon inheritance kind to use for a C++ class definition.
  338. static auto GetInheritanceKind(clang::CXXRecordDecl* class_def)
  339. -> SemIR::Class::InheritanceKind {
  340. if (class_def->isUnion()) {
  341. // Treat all unions as final classes to match their C++ semantics. While we
  342. // could support this, the author of a C++ union has no way to mark their
  343. // type as `final` to prevent it, and so we assume the intent was to
  344. // disallow inheritance.
  345. return SemIR::Class::Final;
  346. }
  347. if (class_def->hasAttr<clang::FinalAttr>()) {
  348. // The class is final in C++; don't allow Carbon types to derive from it.
  349. // Note that such a type might also be abstract in C++; we treat final as
  350. // taking precedence.
  351. //
  352. // We could also treat classes with a final destructor as being final, as
  353. // Clang does when determining whether a class is "effectively final", but
  354. // to keep our rules simpler we do not.
  355. return SemIR::Class::Final;
  356. }
  357. if (class_def->getNumVBases()) {
  358. // TODO: We treat classes with virtual bases as final for now. We use the
  359. // layout of the class including its virtual bases as its Carbon type
  360. // layout, so we wouldn't behave correctly if we derived from it.
  361. return SemIR::Class::Final;
  362. }
  363. if (class_def->isAbstract()) {
  364. // If the class has any abstract members, it's abstract.
  365. return SemIR::Class::Abstract;
  366. }
  367. // Allow inheritance from any other C++ class type.
  368. return SemIR::Class::Base;
  369. }
  370. // Checks that the specified finished class definition is valid and builds and
  371. // returns a corresponding complete type witness instruction.
  372. static auto ImportClassObjectRepr(Context& context, SemIR::ClassId class_id,
  373. SemIR::ImportIRInstId import_ir_inst_id,
  374. SemIR::TypeInstId class_type_inst_id,
  375. const clang::CXXRecordDecl* clang_def)
  376. -> SemIR::TypeInstId {
  377. if (clang_def->isInvalidDecl()) {
  378. // Clang already diagnosed this error.
  379. return SemIR::ErrorInst::TypeInstId;
  380. }
  381. // For now, if the class is empty, produce an empty struct as the object
  382. // representation. This allows our tests to continue to pass while we don't
  383. // properly support initializing imported C++ classes.
  384. // TODO: Remove this.
  385. if (clang_def->isEmpty() && !clang_def->getNumBases()) {
  386. return context.types().GetAsTypeInstId(AddInst(
  387. context,
  388. MakeImportedLocIdAndInst(
  389. context, import_ir_inst_id,
  390. SemIR::StructType{.type_id = SemIR::TypeType::TypeId,
  391. .fields_id = SemIR::StructTypeFieldsId::Empty})));
  392. }
  393. const auto& clang_layout =
  394. context.ast_context().getASTRecordLayout(clang_def);
  395. llvm::SmallVector<uint64_t> layout;
  396. llvm::SmallVector<SemIR::StructTypeField> fields;
  397. static_assert(SemIR::CustomLayoutId::SizeIndex == 0);
  398. layout.push_back(clang_layout.getSize().getQuantity());
  399. static_assert(SemIR::CustomLayoutId::AlignIndex == 1);
  400. layout.push_back(clang_layout.getAlignment().getQuantity());
  401. static_assert(SemIR::CustomLayoutId::FirstFieldIndex == 2);
  402. // TODO: Import vptr(s).
  403. // The kind of base class we've picked so far. These are ordered in increasing
  404. // preference order.
  405. enum class BaseKind {
  406. None,
  407. Empty,
  408. NonEmpty,
  409. Polymorphic,
  410. };
  411. BaseKind base_kind = BaseKind::None;
  412. // Import bases.
  413. for (const auto& base : clang_def->bases()) {
  414. if (base.isVirtual()) {
  415. // If the base is virtual, skip it from the layout. We don't know where it
  416. // will actually appear within the complete object layout, as a pointer to
  417. // this class might point to a derived type that puts the vbase in a
  418. // different place.
  419. // TODO: Track that the virtual base existed. Support derived-to-vbase
  420. // conversions by generating a clang AST fragment.
  421. continue;
  422. }
  423. auto [base_type_inst_id, base_type_id] =
  424. ImportCppType(context, import_ir_inst_id, base.getType());
  425. if (!base_type_id.has_value()) {
  426. // TODO: If the base class's type can't be mapped, skip it.
  427. continue;
  428. }
  429. auto base_decl_id = AddInst(
  430. context,
  431. MakeImportedLocIdAndInst(
  432. context, import_ir_inst_id,
  433. SemIR::BaseDecl{.type_id = GetUnboundElementType(
  434. context, class_type_inst_id, base_type_inst_id),
  435. .base_type_inst_id = base_type_inst_id,
  436. .index = SemIR::ElementIndex(fields.size())}));
  437. auto* base_class = base.getType()->getAsCXXRecordDecl();
  438. CARBON_CHECK(base_class, "Base class {0} is not a class",
  439. base.getType().getAsString());
  440. // If there's a unique "best" base class, treat it as a Carbon base class
  441. // too.
  442. // TODO: Improve handling for the case where the class has multiple base
  443. // classes.
  444. BaseKind kind = base_class->isPolymorphic() ? BaseKind::Polymorphic
  445. : base_class->isEmpty() ? BaseKind::Empty
  446. : BaseKind::NonEmpty;
  447. auto& class_info = context.classes().Get(class_id);
  448. if (kind > base_kind) {
  449. // This base is better than the previous best.
  450. class_info.base_id = base_decl_id;
  451. base_kind = kind;
  452. } else if (kind == base_kind) {
  453. // Multiple base classes of this kind: no unique best.
  454. class_info.base_id = SemIR::InstId::None;
  455. }
  456. // TODO: If the base class has virtual bases, the size of the type that we
  457. // add to the layout here will be the full size of the class (including
  458. // virtual bases), whereas the size actually occupied by this base class is
  459. // only the nvsize (excluding virtual bases).
  460. auto base_offset = base.isVirtual()
  461. ? clang_layout.getVBaseClassOffset(base_class)
  462. : clang_layout.getBaseClassOffset(base_class);
  463. layout.push_back(base_offset.getQuantity());
  464. fields.push_back(
  465. {.name_id = SemIR::NameId::Base, .type_inst_id = base_type_inst_id});
  466. }
  467. // Import fields.
  468. for (auto* decl : clang_def->decls()) {
  469. auto* field = dyn_cast<clang::FieldDecl>(decl);
  470. // Track the chain of fields from the class to this field. This chain is
  471. // only one element long unless the field is a member of an anonymous struct
  472. // or union.
  473. clang::NamedDecl* single_field_chain[1] = {field};
  474. llvm::ArrayRef<clang::NamedDecl*> chain = single_field_chain;
  475. // If this isn't a field, it might be an indirect field in an anonymous
  476. // struct or union.
  477. if (!field) {
  478. auto* indirect_field = dyn_cast<clang::IndirectFieldDecl>(decl);
  479. if (!indirect_field) {
  480. continue;
  481. }
  482. chain = indirect_field->chain();
  483. field = indirect_field->getAnonField();
  484. }
  485. if (field->isBitField()) {
  486. // TODO: Add a representation for named bitfield members.
  487. continue;
  488. }
  489. if (field->isAnonymousStructOrUnion()) {
  490. // Fields within an anonymous structure or union will be added via their
  491. // IndirectFieldDecls.
  492. continue;
  493. }
  494. auto field_name_id = AddIdentifierName(context, field->getName());
  495. auto [field_type_inst_id, field_type_id] =
  496. ImportCppType(context, import_ir_inst_id, field->getType());
  497. if (!field_type_inst_id.has_value()) {
  498. // TODO: For now, just skip over fields whose types we can't map.
  499. continue;
  500. }
  501. // Create a field now, as we know the index to use.
  502. // TODO: Consider doing this lazily instead.
  503. auto field_decl_id = AddInst(
  504. context, MakeImportedLocIdAndInst(
  505. context, import_ir_inst_id,
  506. SemIR::FieldDecl{
  507. .type_id = GetUnboundElementType(
  508. context, class_type_inst_id, field_type_inst_id),
  509. .name_id = field_name_id,
  510. .index = SemIR::ElementIndex(fields.size())}));
  511. // The imported SemIR::FieldDecl represents the original declaration `decl`,
  512. // which is either the field or the indirect field declaration.
  513. auto key = SemIR::ClangDeclKey::ForNonFunctionDecl(decl);
  514. context.clang_decls().Add({.key = key, .inst_id = field_decl_id});
  515. // Compute the offset to the field that appears directly in the class.
  516. uint64_t offset = clang_layout.getFieldOffset(
  517. cast<clang::FieldDecl>(chain.front())->getFieldIndex());
  518. // If this is an indirect field, walk the path and accumulate the offset to
  519. // the named field.
  520. for (auto* inner_decl : chain.drop_front()) {
  521. auto* inner_field = cast<clang::FieldDecl>(inner_decl);
  522. const auto& inner_layout =
  523. context.ast_context().getASTRecordLayout(inner_field->getParent());
  524. offset += inner_layout.getFieldOffset(inner_field->getFieldIndex());
  525. }
  526. layout.push_back(
  527. context.ast_context().toCharUnitsFromBits(offset).getQuantity());
  528. fields.push_back(
  529. {.name_id = field_name_id, .type_inst_id = field_type_inst_id});
  530. }
  531. // TODO: Add a field to prevent tail padding reuse if necessary.
  532. return AddTypeInst(context,
  533. MakeImportedLocIdAndInst<SemIR::CustomLayoutType>(
  534. context, import_ir_inst_id,
  535. {.type_id = SemIR::TypeType::TypeId,
  536. .fields_id = context.struct_type_fields().Add(fields),
  537. .layout_id = context.custom_layouts().Add(layout)}));
  538. }
  539. // Creates a Carbon class definition based on the information in the given Clang
  540. // class declaration, which is assumed to be for a class definition.
  541. static auto BuildClassDefinition(Context& context,
  542. SemIR::ImportIRInstId import_ir_inst_id,
  543. SemIR::ClassId class_id,
  544. SemIR::TypeInstId class_inst_id,
  545. clang::CXXRecordDecl* clang_def) -> void {
  546. auto& class_info = context.classes().Get(class_id);
  547. CARBON_CHECK(!class_info.has_definition_started());
  548. class_info.definition_id = class_inst_id;
  549. context.inst_block_stack().Push();
  550. class_info.inheritance_kind = GetInheritanceKind(clang_def);
  551. // Compute the class's object representation.
  552. auto object_repr_id = ImportClassObjectRepr(
  553. context, class_id, import_ir_inst_id, class_inst_id, clang_def);
  554. class_info.complete_type_witness_id = AddInst(
  555. context,
  556. MakeImportedLocIdAndInst<SemIR::CompleteTypeWitness>(
  557. context, import_ir_inst_id,
  558. {.type_id = GetSingletonType(context, SemIR::WitnessType::TypeInstId),
  559. .object_repr_type_inst_id = object_repr_id}));
  560. class_info.body_block_id = context.inst_block_stack().Pop();
  561. }
  562. // Computes and returns the Carbon type to use as the object representation of
  563. // the given C++ enum type. This is a builtin int type matching the enum's
  564. // representation.
  565. static auto ImportEnumObjectRepresentation(
  566. Context& context, SemIR::ImportIRInstId import_ir_inst_id,
  567. clang::EnumDecl* enum_decl) -> SemIR::TypeInstId {
  568. auto int_type = enum_decl->getIntegerType();
  569. CARBON_CHECK(!int_type.isNull(), "incomplete enum type {0}",
  570. enum_decl->getNameAsString());
  571. auto int_kind = int_type->isSignedIntegerType() ? SemIR::IntKind::Signed
  572. : SemIR::IntKind::Unsigned;
  573. auto bit_width_id = GetOrAddInst(
  574. context, MakeImportedLocIdAndInst<SemIR::IntValue>(
  575. context, import_ir_inst_id,
  576. {.type_id = GetSingletonType(
  577. context, SemIR::IntLiteralType::TypeInstId),
  578. .int_id = context.ints().AddUnsigned(llvm::APInt(
  579. 64, context.ast_context().getIntWidth(int_type)))}));
  580. return context.types().GetAsTypeInstId(
  581. GetOrAddInst(context, SemIR::LocIdAndInst::NoLoc(SemIR::IntType{
  582. .type_id = SemIR::TypeType::TypeId,
  583. .int_kind = int_kind,
  584. .bit_width_id = bit_width_id})));
  585. }
  586. // Creates a Carbon class definition based on the information in the given Clang
  587. // enum declaration.
  588. static auto BuildEnumDefinition(Context& context,
  589. SemIR::ImportIRInstId import_ir_inst_id,
  590. SemIR::ClassId class_id,
  591. SemIR::TypeInstId class_inst_id,
  592. clang::EnumDecl* enum_decl) -> void {
  593. auto& class_info = context.classes().Get(class_id);
  594. CARBON_CHECK(!class_info.has_definition_started());
  595. class_info.definition_id = class_inst_id;
  596. context.inst_block_stack().Push();
  597. // Don't allow inheritance from C++ enums, to match the behavior in C++.
  598. class_info.inheritance_kind = SemIR::Class::Final;
  599. // Compute the enum type's object representation. An enum is an adapter for
  600. // the corresponding builtin integer type.
  601. auto object_repr_id =
  602. ImportEnumObjectRepresentation(context, import_ir_inst_id, enum_decl);
  603. class_info.adapt_id = AddInst(
  604. context, MakeImportedLocIdAndInst(
  605. context, import_ir_inst_id,
  606. SemIR::AdaptDecl{.adapted_type_inst_id = object_repr_id}));
  607. class_info.complete_type_witness_id = AddInst(
  608. context,
  609. MakeImportedLocIdAndInst<SemIR::CompleteTypeWitness>(
  610. context, import_ir_inst_id,
  611. {.type_id = GetSingletonType(context, SemIR::WitnessType::TypeInstId),
  612. .object_repr_type_inst_id = object_repr_id}));
  613. class_info.body_block_id = context.inst_block_stack().Pop();
  614. }
  615. // Imports an enumerator declaration from Clang to Carbon.
  616. static auto ImportEnumConstantDecl(Context& context,
  617. clang::EnumConstantDecl* enumerator_decl)
  618. -> SemIR::InstId {
  619. auto key = SemIR::ClangDeclKey(enumerator_decl);
  620. CARBON_CHECK(!IsClangDeclImported(context, key));
  621. // Find the enclosing enum type.
  622. auto enum_key = SemIR::ClangDeclKey(
  623. cast<clang::EnumDecl>(enumerator_decl->getDeclContext()));
  624. auto type_inst_id = LookupClangDeclInstId(context, enum_key);
  625. auto type_id = context.types().GetTypeIdForTypeInstId(type_inst_id);
  626. // Build a corresponding IntValue.
  627. auto int_id = context.ints().Add(enumerator_decl->getInitVal());
  628. auto import_ir_inst_id =
  629. AddImportIRInst(context.sem_ir(), enumerator_decl->getLocation());
  630. auto inst_id = AddInstInNoBlock(
  631. context,
  632. MakeImportedLocIdAndInst<SemIR::IntValue>(
  633. context, import_ir_inst_id, {.type_id = type_id, .int_id = int_id}));
  634. context.imports().push_back(inst_id);
  635. context.clang_decls().Add({.key = key, .inst_id = inst_id});
  636. return inst_id;
  637. }
  638. // Mark the given `key` as failed in `clang_decls`.
  639. static auto MarkFailedDecl(Context& context, SemIR::ClangDeclKey key) {
  640. context.clang_decls().Add({.key = key, .inst_id = SemIR::ErrorInst::InstId});
  641. }
  642. // Creates an integer type of the given size.
  643. static auto MakeIntType(Context& context, IntId size_id, bool is_signed)
  644. -> TypeExpr {
  645. auto type_inst_id = MakeIntTypeLiteral(
  646. context, Parse::NodeId::None,
  647. is_signed ? SemIR::IntKind::Signed : SemIR::IntKind::Unsigned, size_id);
  648. return ExprAsType(context, Parse::NodeId::None, type_inst_id);
  649. }
  650. static auto MakeCppCompatType(Context& context, SemIR::LocId loc_id,
  651. CoreIdentifier name) -> TypeExpr {
  652. return ExprAsType(
  653. context, loc_id,
  654. LookupNameInCore(context, loc_id, {CoreIdentifier::CppCompat, name}));
  655. }
  656. // Maps a C++ builtin integer type to a Carbon `Core.CppCompat` type.
  657. static auto MapBuiltinCppCompatIntegerType(Context& context,
  658. unsigned int cpp_width,
  659. unsigned int carbon_width,
  660. CoreIdentifier cpp_compat_name)
  661. -> TypeExpr {
  662. if (cpp_width != carbon_width) {
  663. return TypeExpr::None;
  664. }
  665. return MakeCppCompatType(context, Parse::NodeId::None, cpp_compat_name);
  666. }
  667. // Maps a C++ builtin integer type to a Carbon type.
  668. // TODO: Handle integer types that map to named aliases.
  669. static auto MapBuiltinIntegerType(Context& context, SemIR::LocId loc_id,
  670. clang::QualType qual_type,
  671. const clang::BuiltinType& type) -> TypeExpr {
  672. clang::ASTContext& ast_context = context.ast_context();
  673. unsigned width = ast_context.getIntWidth(qual_type);
  674. bool is_signed = type.isSignedInteger();
  675. auto int_n_type = ast_context.getIntTypeForBitwidth(width, is_signed);
  676. if (clang::ASTContext::hasSameType(qual_type, int_n_type)) {
  677. TypeExpr type_expr =
  678. MakeIntType(context, context.ints().Add(width), is_signed);
  679. // Try to make sure integer types of 32 or 64 bits are complete so we can
  680. // check against them when deciding whether we need to generate a thunk.
  681. if (width == 32 || width == 64) {
  682. SemIR::TypeId type_id = type_expr.type_id;
  683. if (!context.types().IsComplete(type_id)) {
  684. TryToCompleteType(context, type_id, loc_id);
  685. }
  686. }
  687. return type_expr;
  688. }
  689. if (clang::ASTContext::hasSameType(qual_type, ast_context.CharTy)) {
  690. return ExprAsType(context, Parse::NodeId::None,
  691. MakeCharTypeLiteral(context, Parse::NodeId::None));
  692. }
  693. if (clang::ASTContext::hasSameType(qual_type, ast_context.LongTy)) {
  694. return MapBuiltinCppCompatIntegerType(context, width, 32,
  695. CoreIdentifier::Long32);
  696. }
  697. if (clang::ASTContext::hasSameType(qual_type, ast_context.UnsignedLongTy)) {
  698. return MapBuiltinCppCompatIntegerType(context, width, 32,
  699. CoreIdentifier::ULong32);
  700. }
  701. if (clang::ASTContext::hasSameType(qual_type, ast_context.LongLongTy)) {
  702. return MapBuiltinCppCompatIntegerType(context, width, 64,
  703. CoreIdentifier::LongLong64);
  704. }
  705. if (clang::ASTContext::hasSameType(qual_type,
  706. ast_context.UnsignedLongLongTy)) {
  707. return MapBuiltinCppCompatIntegerType(context, width, 64,
  708. CoreIdentifier::ULongLong64);
  709. }
  710. return TypeExpr::None;
  711. }
  712. static auto MapNullptrType(Context& context, SemIR::LocId loc_id) -> TypeExpr {
  713. return MakeCppCompatType(context, loc_id, CoreIdentifier::NullptrT);
  714. }
  715. // Maps a C++ builtin type to a Carbon type.
  716. // TODO: Support more builtin types.
  717. static auto MapBuiltinType(Context& context, SemIR::LocId loc_id,
  718. clang::QualType qual_type,
  719. const clang::BuiltinType& type) -> TypeExpr {
  720. clang::ASTContext& ast_context = context.ast_context();
  721. if (type.isBooleanType()) {
  722. CARBON_CHECK(ast_context.hasSameType(qual_type, ast_context.BoolTy));
  723. return ExprAsType(context, Parse::NodeId::None,
  724. context.types().GetInstId(GetSingletonType(
  725. context, SemIR::BoolType::TypeInstId)));
  726. }
  727. if (type.isInteger()) {
  728. return MapBuiltinIntegerType(context, loc_id, qual_type, type);
  729. }
  730. if (type.isFloatingPoint()) {
  731. if (type.isFloat16Type() || type.isFloat32Type() || type.isDoubleType() ||
  732. type.isFloat128Type()) {
  733. return ExprAsType(
  734. context, Parse::NodeId::None,
  735. MakeFloatTypeLiteral(
  736. context, Parse::NodeId::None,
  737. context.ints().Add(ast_context.getTypeSize(qual_type))));
  738. }
  739. // TODO: Handle floating-point types that map to named aliases.
  740. } else if (type.isVoidType()) {
  741. return MakeCppCompatType(context, loc_id, CoreIdentifier::VoidBase);
  742. } else if (type.isNullPtrType()) {
  743. return MapNullptrType(context, loc_id);
  744. }
  745. return TypeExpr::None;
  746. }
  747. // Determines whether record_decl is a C++ class that has a custom mapping into
  748. // Carbon, and if so, returns the corresponding Carbon type. Otherwise returns
  749. // None.
  750. static auto LookupCustomRecordType(Context& context,
  751. const clang::CXXRecordDecl* record_decl)
  752. -> TypeExpr {
  753. switch (GetCustomCppTypeMapping(record_decl)) {
  754. case CustomCppTypeMapping::None:
  755. return TypeExpr::None;
  756. case CustomCppTypeMapping::Str:
  757. return MakeStringType(
  758. context,
  759. AddImportIRInst(context.sem_ir(), record_decl->getLocation()));
  760. }
  761. }
  762. // Maps a C++ tag type (class, struct, union, enum) to a Carbon type.
  763. static auto MapTagType(Context& context, const clang::TagType& type)
  764. -> TypeExpr {
  765. auto* tag_decl = type.getDecl();
  766. CARBON_CHECK(tag_decl);
  767. // Check if the declaration is already mapped.
  768. auto key = SemIR::ClangDeclKey(tag_decl);
  769. SemIR::InstId tag_inst_id = LookupClangDeclInstId(context, key);
  770. if (!tag_inst_id.has_value()) {
  771. if (auto* record_decl = dyn_cast<clang::CXXRecordDecl>(tag_decl)) {
  772. auto custom_type = LookupCustomRecordType(context, record_decl);
  773. if (custom_type.inst_id.has_value()) {
  774. context.clang_decls().Add({.key = key, .inst_id = custom_type.inst_id});
  775. return custom_type;
  776. }
  777. }
  778. tag_inst_id = ImportTagDecl(context, tag_decl);
  779. }
  780. SemIR::TypeInstId record_type_inst_id =
  781. context.types().GetAsTypeInstId(tag_inst_id);
  782. return {
  783. // TODO: inst_id's location should be the location of the usage, not
  784. // the location of the type definition. Possibly we should synthesize a
  785. // NameRef inst, to match how this would work in Carbon code.
  786. .inst_id = record_type_inst_id,
  787. .type_id = context.types().GetTypeIdForTypeInstId(record_type_inst_id)};
  788. }
  789. // Maps a C++ type that is not a wrapper type such as a pointer to a Carbon
  790. // type.
  791. // TODO: Support more types.
  792. static auto MapNonWrapperType(Context& context, SemIR::LocId loc_id,
  793. clang::QualType type) -> TypeExpr {
  794. if (const auto* builtin_type = type->getAs<clang::BuiltinType>()) {
  795. return MapBuiltinType(context, loc_id, type, *builtin_type);
  796. }
  797. if (const auto* tag_type = type->getAs<clang::TagType>()) {
  798. return MapTagType(context, *tag_type);
  799. }
  800. CARBON_CHECK(!type.hasQualifiers() && !type->isPointerType(),
  801. "Should not see wrapper types here");
  802. return TypeExpr::None;
  803. }
  804. // Maps a qualified C++ type to a Carbon type.
  805. static auto MapQualifiedType(Context& context, clang::QualType type,
  806. TypeExpr type_expr) -> TypeExpr {
  807. auto quals = type.getQualifiers();
  808. if (quals.hasConst()) {
  809. auto type_id = GetConstType(context, type_expr.inst_id);
  810. type_expr = TypeExpr::ForUnsugared(context, type_id);
  811. quals.removeConst();
  812. }
  813. // TODO: Support other qualifiers.
  814. if (!quals.empty()) {
  815. return TypeExpr::None;
  816. }
  817. return type_expr;
  818. }
  819. // Returns true if the type has the `_Nonnull` attribute.
  820. static auto IsClangTypeNonNull(clang::QualType type) -> bool {
  821. auto nullability = type->getNullability();
  822. return nullability.has_value() &&
  823. *nullability == clang::NullabilityKind::NonNull;
  824. }
  825. // Like `clang::QualType::getUnqualifiedType()`, retrieves the unqualified
  826. // variant of the given type, but preserves `_Nonnull`.
  827. static auto ClangGetUnqualifiedTypePreserveNonNull(
  828. Context& context, clang::QualType original_type) -> clang::QualType {
  829. clang::QualType type = original_type.getUnqualifiedType();
  830. // Preserve non-nullability.
  831. if (IsClangTypeNonNull(original_type) && !IsClangTypeNonNull(type)) {
  832. type = context.ast_context().getAttributedType(
  833. clang::NullabilityKind::NonNull, type, type);
  834. }
  835. return type;
  836. }
  837. // Returns the type `Core.Optional(T)`, where `T` is described by
  838. // `inner_type_inst_id`.
  839. static auto MakeOptionalType(Context& context, SemIR::LocId loc_id,
  840. SemIR::InstId inner_type_inst_id) -> TypeExpr {
  841. auto fn_inst_id = LookupNameInCore(context, loc_id, CoreIdentifier::Optional);
  842. auto call_id = PerformCall(context, loc_id, fn_inst_id, {inner_type_inst_id});
  843. return ExprAsType(context, loc_id, call_id);
  844. }
  845. // Maps a C++ pointer type to a Carbon pointer type.
  846. static auto MapPointerType(Context& context, SemIR::LocId loc_id,
  847. clang::QualType type, TypeExpr pointee_type_expr)
  848. -> TypeExpr {
  849. CARBON_CHECK(type->isPointerType());
  850. bool optional =
  851. !IsClangTypeNonNull(type) &&
  852. // If the type was produced by C++ template substitution, then we assume
  853. // it was deduced from a Carbon pointer type, so it's non-null.
  854. !type->getAs<clang::SubstTemplateTypeParmType>();
  855. TypeExpr pointer_type_expr = TypeExpr::ForUnsugared(
  856. context, GetPointerType(context, pointee_type_expr.inst_id));
  857. if (optional) {
  858. pointer_type_expr =
  859. MakeOptionalType(context, loc_id, pointer_type_expr.inst_id);
  860. }
  861. return pointer_type_expr;
  862. }
  863. // Maps a C++ reference type to a Carbon type. We map all references to
  864. // pointers for now. Note that when mapping function parameters and return
  865. // types, a different rule is used; see MapParameterType for details.
  866. // TODO: Revisit this and decide what we really want to do here.
  867. static auto MapReferenceType(Context& context, clang::QualType type,
  868. TypeExpr referenced_type_expr) -> TypeExpr {
  869. CARBON_CHECK(type->isReferenceType());
  870. SemIR::TypeId pointer_type_id =
  871. GetPointerType(context, referenced_type_expr.inst_id);
  872. pointer_type_id =
  873. GetConstType(context, context.types().GetInstId(pointer_type_id));
  874. return TypeExpr::ForUnsugared(context, pointer_type_id);
  875. }
  876. // Maps a C++ type to a Carbon type. `type` should not be canonicalized because
  877. // we check for pointer nullability and nullability will be lost by
  878. // canonicalization.
  879. static auto MapType(Context& context, SemIR::LocId loc_id, clang::QualType type)
  880. -> TypeExpr {
  881. // Unwrap any type modifiers and wrappers.
  882. llvm::SmallVector<clang::QualType> wrapper_types;
  883. while (true) {
  884. clang::QualType orig_type = type;
  885. if (type.hasQualifiers()) {
  886. type = ClangGetUnqualifiedTypePreserveNonNull(context, type);
  887. } else if (type->isPointerType()) {
  888. type = type->getPointeeType();
  889. } else if (type->isReferenceType()) {
  890. type = type.getNonReferenceType();
  891. } else {
  892. break;
  893. }
  894. wrapper_types.push_back(orig_type);
  895. }
  896. auto mapped = MapNonWrapperType(context, loc_id, type);
  897. for (auto wrapper : llvm::reverse(wrapper_types)) {
  898. if (!mapped.inst_id.has_value() ||
  899. mapped.type_id == SemIR::ErrorInst::TypeId) {
  900. break;
  901. }
  902. if (wrapper.hasQualifiers()) {
  903. mapped = MapQualifiedType(context, wrapper, mapped);
  904. } else if (wrapper->isPointerType()) {
  905. mapped = MapPointerType(context, loc_id, wrapper, mapped);
  906. } else if (wrapper->isReferenceType()) {
  907. mapped = MapReferenceType(context, wrapper, mapped);
  908. } else {
  909. CARBON_FATAL("Unexpected wrapper type {0}", wrapper.getAsString());
  910. }
  911. }
  912. return mapped;
  913. }
  914. namespace {
  915. // Information about how to map a C++ parameter type into Carbon.
  916. struct ParameterTypeInfo {
  917. // The type to use for the Carbon parameter.
  918. TypeExpr type;
  919. // Whether to build a `ref` pattern.
  920. bool want_ref_pattern;
  921. };
  922. } // namespace
  923. // Given the type of a C++ function parameter, returns information about the
  924. // type to use for the corresponding Carbon parameter.
  925. //
  926. // Note that if the parameter has a type for which `IsSimpleAbiType` returns
  927. // true, we must produce a parameter type that has the same calling convention
  928. // as the C++ type.
  929. static auto MapParameterType(Context& context, SemIR::LocId loc_id,
  930. clang::QualType param_type) -> ParameterTypeInfo {
  931. ParameterTypeInfo info = {.type = TypeExpr::None, .want_ref_pattern = false};
  932. // Perform some custom mapping for parameters of reference type:
  933. //
  934. // * `T& x` -> `ref x: T`.
  935. // * `const T& x` -> `x: T`.
  936. // * `T&& x` -> `x: T`.
  937. //
  938. // TODO: For the `&&` mapping, we allow an rvalue reference to bind to a
  939. // durable reference expression. This should not be allowed.
  940. if (param_type->isReferenceType()) {
  941. clang::QualType pointee_type = param_type->getPointeeType();
  942. if (param_type->isLValueReferenceType()) {
  943. if (pointee_type.isConstQualified()) {
  944. // TODO: Consider only doing this if `const` is the only qualifier. For
  945. // now, any other qualifier will fail when mapping the type.
  946. auto split_type = pointee_type.getSplitUnqualifiedType();
  947. split_type.Quals.removeConst();
  948. pointee_type = context.ast_context().getQualifiedType(split_type);
  949. } else {
  950. // The reference will map to a `ref` pattern.
  951. info.want_ref_pattern = true;
  952. }
  953. }
  954. param_type = pointee_type;
  955. }
  956. info.type = MapType(context, loc_id, param_type);
  957. return info;
  958. }
  959. // Returns a block for the implicit parameters of the given function
  960. // declaration. Because function templates are not yet supported, this currently
  961. // only contains the `self` parameter. On error, produces a diagnostic and
  962. // returns None.
  963. static auto MakeImplicitParamPatternsBlockId(
  964. Context& context, SemIR::LocId loc_id,
  965. const clang::FunctionDecl& clang_decl) -> SemIR::InstBlockId {
  966. const auto* method_decl = dyn_cast<clang::CXXMethodDecl>(&clang_decl);
  967. if (!method_decl || method_decl->isStatic() ||
  968. isa<clang::CXXConstructorDecl>(clang_decl)) {
  969. return SemIR::InstBlockId::Empty;
  970. }
  971. // Build a `self` parameter from the object parameter.
  972. BeginSubpattern(context);
  973. clang::QualType param_type =
  974. method_decl->getFunctionObjectParameterReferenceType();
  975. auto param_info = MapParameterType(context, loc_id, param_type);
  976. auto [type_inst_id, type_id] = param_info.type;
  977. SemIR::ExprRegionId type_expr_region_id =
  978. EndSubpatternAsExpr(context, type_inst_id);
  979. if (!type_id.has_value()) {
  980. context.TODO(loc_id,
  981. llvm::formatv("Unsupported: object parameter type: {0}",
  982. param_type.getAsString()));
  983. return SemIR::InstBlockId::None;
  984. }
  985. // TODO: Fill in a location once available.
  986. auto pattern_id = AddParamPattern(context, loc_id, SemIR::NameId::SelfValue,
  987. type_expr_region_id, type_id,
  988. param_info.want_ref_pattern);
  989. return context.inst_blocks().Add({pattern_id});
  990. }
  991. // Returns a block id for the explicit parameters of the given function
  992. // declaration. If the function declaration has no parameters, it returns
  993. // `SemIR::InstBlockId::Empty`. In the case of an unsupported parameter type, it
  994. // produces an error and returns `SemIR::InstBlockId::None`.
  995. // TODO: Consider refactoring to extract and reuse more logic from
  996. // `HandleAnyBindingPattern()`.
  997. static auto MakeParamPatternsBlockId(Context& context, SemIR::LocId loc_id,
  998. const clang::FunctionDecl& clang_decl,
  999. int num_params) -> SemIR::InstBlockId {
  1000. if (clang_decl.parameters().empty() || num_params == 0) {
  1001. return SemIR::InstBlockId::Empty;
  1002. }
  1003. llvm::SmallVector<SemIR::InstId> params;
  1004. params.reserve(num_params);
  1005. CARBON_CHECK(
  1006. static_cast<int>(clang_decl.getNumNonObjectParams()) >= num_params,
  1007. "varargs functions are not supported");
  1008. const auto* function_type =
  1009. clang_decl.getType()->castAs<clang::FunctionProtoType>();
  1010. for (int i : llvm::seq(num_params)) {
  1011. const auto* param = clang_decl.getNonObjectParameter(i);
  1012. clang::QualType orig_param_type = function_type->getParamType(
  1013. clang_decl.hasCXXExplicitFunctionObjectParameter() + i);
  1014. // The parameter type is decayed but hasn't necessarily had its qualifiers
  1015. // removed.
  1016. // TODO: The presence of qualifiers here is probably a Clang bug.
  1017. clang::QualType param_type =
  1018. ClangGetUnqualifiedTypePreserveNonNull(context, orig_param_type);
  1019. // Mark the start of a region of insts, needed for the type expression
  1020. // created later with the call of `EndSubpatternAsExpr()`.
  1021. BeginSubpattern(context);
  1022. auto param_info = MapParameterType(context, loc_id, param_type);
  1023. auto [orig_type_inst_id, type_id] = param_info.type;
  1024. // Type expression of the binding pattern - a single-entry/single-exit
  1025. // region that allows control flow in the type expression e.g. fn F(x: if C
  1026. // then i32 else i64).
  1027. SemIR::ExprRegionId type_expr_region_id =
  1028. EndSubpatternAsExpr(context, orig_type_inst_id);
  1029. if (!type_id.has_value()) {
  1030. context.TODO(loc_id, llvm::formatv("Unsupported: parameter type: {0}",
  1031. orig_param_type.getAsString()));
  1032. return SemIR::InstBlockId::None;
  1033. }
  1034. llvm::StringRef param_name = param->getName();
  1035. SemIR::NameId name_id =
  1036. param_name.empty()
  1037. // Translate an unnamed parameter to an underscore to
  1038. // match Carbon's naming of unnamed/unused function params.
  1039. ? SemIR::NameId::Underscore
  1040. : AddIdentifierName(context, param_name);
  1041. SemIR::LocId param_loc_id =
  1042. AddImportIRInst(context.sem_ir(), param->getLocation());
  1043. // TODO: Add template support.
  1044. SemIR::InstId pattern_id =
  1045. AddParamPattern(context, param_loc_id, name_id, type_expr_region_id,
  1046. type_id, param_info.want_ref_pattern);
  1047. params.push_back(pattern_id);
  1048. }
  1049. return context.inst_blocks().Add(params);
  1050. }
  1051. // Returns the return `TypeExpr` of the given function declaration. In case of
  1052. // an unsupported return type, returns `SemIR::ErrorInst::InstId`. Constructors
  1053. // are treated as returning a class instance.
  1054. // TODO: Support more return types.
  1055. static auto GetReturnTypeExpr(Context& context, SemIR::LocId loc_id,
  1056. clang::FunctionDecl* clang_decl)
  1057. -> Context::FormExpr {
  1058. auto make_init_form = [&](SemIR::TypeInstId type_component_inst_id) {
  1059. SemIR::InitForm inst = {
  1060. .type_id = SemIR::FormType::TypeId,
  1061. .type_component_inst_id = type_component_inst_id,
  1062. .index = context.full_pattern_stack().NextCallParamIndex()};
  1063. return context.constant_values().GetInstId(TryEvalInst(context, inst));
  1064. };
  1065. auto make_ref_form = [&](SemIR::TypeInstId type_component_inst_id) {
  1066. SemIR::RefForm inst = {.type_id = SemIR::FormType::TypeId,
  1067. .type_component_inst_id = type_component_inst_id};
  1068. return context.constant_values().GetInstId(TryEvalInst(context, inst));
  1069. };
  1070. clang::QualType orig_ret_type = clang_decl->getReturnType();
  1071. if (!orig_ret_type->isVoidType()) {
  1072. bool is_reference = orig_ret_type->isReferenceType();
  1073. if (is_reference) {
  1074. orig_ret_type = orig_ret_type->getPointeeType();
  1075. }
  1076. // TODO: We should eventually map reference returns to non-pointer types
  1077. // here. We should return by `ref` for `T&` return types once `ref` return
  1078. // is implemented.
  1079. auto [orig_type_inst_id, type_id] = MapType(context, loc_id, orig_ret_type);
  1080. if (!orig_type_inst_id.has_value()) {
  1081. context.TODO(loc_id, llvm::formatv("Unsupported: return type: {0}",
  1082. orig_ret_type.getAsString()));
  1083. return {.form_inst_id = SemIR::ErrorInst::InstId,
  1084. .type_component_id = SemIR::ErrorInst::TypeInstId,
  1085. .type_id = SemIR::ErrorInst::TypeId};
  1086. }
  1087. Context::FormExpr result = {
  1088. .form_inst_id = is_reference ? make_ref_form(orig_type_inst_id)
  1089. : make_init_form(orig_type_inst_id),
  1090. .type_component_id = orig_type_inst_id,
  1091. .type_id = type_id};
  1092. return result;
  1093. }
  1094. auto* ctor = dyn_cast<clang::CXXConstructorDecl>(clang_decl);
  1095. if (!ctor) {
  1096. // void.
  1097. return {.form_inst_id = SemIR::InstId::None,
  1098. .type_component_id = SemIR::TypeInstId::None,
  1099. .type_id = SemIR::TypeId::None};
  1100. }
  1101. // TODO: Make this a `PartialType`.
  1102. SemIR::TypeInstId record_type_inst_id = context.types().GetAsTypeInstId(
  1103. LookupClangDeclInstId(context, SemIR::ClangDeclKey(ctor->getParent())));
  1104. return {
  1105. .form_inst_id = make_init_form(record_type_inst_id),
  1106. .type_component_id = record_type_inst_id,
  1107. .type_id = context.types().GetTypeIdForTypeInstId(record_type_inst_id)};
  1108. }
  1109. // Information about a function's declared return type, corresponding to the
  1110. // fields of SemIR::Function with the same names.
  1111. struct ReturnInfo {
  1112. SemIR::TypeInstId return_type_inst_id;
  1113. SemIR::InstId return_form_inst_id;
  1114. SemIR::InstBlockId return_patterns_id;
  1115. };
  1116. // Returns information about the declared return type of the given function
  1117. // declaration. In case of an unsupported return type, it produces a diagnostic,
  1118. // and the returned return_type_inst_id will be `SemIR::ErrorInst::InstId`.
  1119. // Constructors are treated as returning a class instance.
  1120. static auto GetReturnInfo(Context& context, SemIR::LocId loc_id,
  1121. clang::FunctionDecl* clang_decl) -> ReturnInfo {
  1122. auto [form_inst_id, type_inst_id, type_id] =
  1123. GetReturnTypeExpr(context, loc_id, clang_decl);
  1124. if (!form_inst_id.has_value()) {
  1125. // void.
  1126. return {.return_type_inst_id = SemIR::TypeInstId::None,
  1127. .return_form_inst_id = SemIR::InstId::None,
  1128. .return_patterns_id = SemIR::InstBlockId::None};
  1129. }
  1130. if (form_inst_id == SemIR::ErrorInst::InstId) {
  1131. return {.return_type_inst_id = SemIR::ErrorInst::TypeInstId,
  1132. .return_form_inst_id = SemIR::ErrorInst::InstId,
  1133. .return_patterns_id = SemIR::InstBlockId::None};
  1134. }
  1135. auto pattern_type_id = GetPatternType(context, type_id);
  1136. clang::SourceLocation return_type_loc =
  1137. clang_decl->getReturnTypeSourceRange().getBegin();
  1138. if (return_type_loc.isInvalid()) {
  1139. // TODO: While `getReturnTypeSourceRange()` should work, it seems broken for
  1140. // trailing return type. See
  1141. // https://github.com/llvm/llvm-project/issues/162649. Until this is fixed,
  1142. // we fallback to `getTypeSpecStartLoc()`.
  1143. return_type_loc = clang_decl->getTypeSpecStartLoc();
  1144. }
  1145. SemIR::ImportIRInstId return_type_import_ir_inst_id =
  1146. AddImportIRInst(context.sem_ir(), return_type_loc);
  1147. auto return_patterns_id = SemIR::InstBlockId::Empty;
  1148. if (auto init_form =
  1149. context.insts().TryGetAs<SemIR::InitForm>(form_inst_id)) {
  1150. SemIR::InstId return_slot_pattern_id = AddPatternInst(
  1151. context, MakeImportedLocIdAndInst(
  1152. context, return_type_import_ir_inst_id,
  1153. SemIR::ReturnSlotPattern({.type_id = pattern_type_id,
  1154. .type_inst_id = type_inst_id})));
  1155. auto param_pattern_id = AddPatternInst(
  1156. context,
  1157. MakeImportedLocIdAndInst(
  1158. context, return_type_import_ir_inst_id,
  1159. SemIR::OutParamPattern({.type_id = pattern_type_id,
  1160. .subpattern_id = return_slot_pattern_id,
  1161. .index = init_form->index})));
  1162. return_patterns_id = context.inst_blocks().Add({param_pattern_id});
  1163. }
  1164. return {.return_type_inst_id = type_inst_id,
  1165. .return_form_inst_id = form_inst_id,
  1166. .return_patterns_id = return_patterns_id};
  1167. }
  1168. namespace {
  1169. // Represents the insts and inst blocks associated with the parameters and
  1170. // returns of a function declaration, corresponding to the fields of
  1171. // SemIR::Function with the same names.
  1172. struct FunctionSignatureInsts {
  1173. SemIR::InstBlockId implicit_param_patterns_id;
  1174. SemIR::InstBlockId param_patterns_id;
  1175. SemIR::TypeInstId return_type_inst_id;
  1176. SemIR::InstId return_form_inst_id;
  1177. SemIR::InstBlockId return_patterns_id;
  1178. SemIR::InstBlockId call_param_patterns_id;
  1179. SemIR::InstBlockId call_params_id;
  1180. };
  1181. } // namespace
  1182. // Creates the insts and inst blocks that represent the parameters and returns
  1183. // of the given C++ function's Carbon counterpart, including emitting a callee
  1184. // pattern match to create the `Call` parameters, and returns a
  1185. // FunctionSignatureInsts containing the results. Produces a diagnostic and
  1186. // returns `std::nullopt` if the function declaration has an unsupported
  1187. // parameter type.
  1188. static auto CreateFunctionSignatureInsts(Context& context, SemIR::LocId loc_id,
  1189. clang::FunctionDecl* clang_decl,
  1190. int num_params)
  1191. -> std::optional<FunctionSignatureInsts> {
  1192. context.full_pattern_stack().PushFullPattern(
  1193. FullPatternStack::Kind::ImplicitParamList);
  1194. std::optional pop = llvm::scope_exit(
  1195. [&context] { context.full_pattern_stack().PopFullPattern(); });
  1196. auto implicit_param_patterns_id =
  1197. MakeImplicitParamPatternsBlockId(context, loc_id, *clang_decl);
  1198. if (!implicit_param_patterns_id.has_value()) {
  1199. return std::nullopt;
  1200. }
  1201. context.full_pattern_stack().EndImplicitParamList();
  1202. auto param_patterns_id =
  1203. MakeParamPatternsBlockId(context, loc_id, *clang_decl, num_params);
  1204. if (!param_patterns_id.has_value()) {
  1205. return std::nullopt;
  1206. }
  1207. auto [return_type_inst_id, return_form_inst_id, return_patterns_id] =
  1208. GetReturnInfo(context, loc_id, clang_decl);
  1209. if (return_type_inst_id == SemIR::ErrorInst::TypeInstId) {
  1210. return std::nullopt;
  1211. }
  1212. pop.reset();
  1213. auto [call_param_patterns_id, call_params_id] =
  1214. CalleePatternMatch(context, implicit_param_patterns_id, param_patterns_id,
  1215. return_patterns_id);
  1216. return {{.implicit_param_patterns_id = implicit_param_patterns_id,
  1217. .param_patterns_id = param_patterns_id,
  1218. .return_type_inst_id = return_type_inst_id,
  1219. .return_form_inst_id = return_form_inst_id,
  1220. .return_patterns_id = return_patterns_id,
  1221. .call_param_patterns_id = call_param_patterns_id,
  1222. .call_params_id = call_params_id}};
  1223. }
  1224. // Returns the Carbon function name for the given function.
  1225. static auto GetFunctionName(Context& context, clang::FunctionDecl* clang_decl)
  1226. -> SemIR::NameId {
  1227. switch (clang_decl->getDeclName().getNameKind()) {
  1228. case clang::DeclarationName::CXXConstructorName: {
  1229. auto key = SemIR::ClangDeclKey(
  1230. cast<clang::CXXConstructorDecl>(clang_decl)->getParent());
  1231. return context.classes()
  1232. .Get(context.insts()
  1233. .GetAs<SemIR::ClassDecl>(LookupClangDeclInstId(context, key))
  1234. .class_id)
  1235. .name_id;
  1236. }
  1237. case clang::DeclarationName::CXXDestructorName: {
  1238. return SemIR::NameId::CppDestructor;
  1239. }
  1240. case clang::DeclarationName::CXXOperatorName: {
  1241. return SemIR::NameId::CppOperator;
  1242. }
  1243. default: {
  1244. return AddIdentifierName(context, clang_decl->getName());
  1245. }
  1246. }
  1247. }
  1248. // Creates a `FunctionDecl` and a `Function` without C++ thunk information.
  1249. // Returns std::nullopt on failure. The given Clang declaration is assumed to:
  1250. // * Have not been imported before.
  1251. // * Be of supported type (ignoring parameters).
  1252. static auto ImportFunction(Context& context, SemIR::LocId loc_id,
  1253. clang::FunctionDecl* clang_decl, int num_params)
  1254. -> std::optional<SemIR::FunctionId> {
  1255. context.scope_stack().PushForDeclName();
  1256. context.inst_block_stack().Push();
  1257. context.pattern_block_stack().Push();
  1258. auto function_params_insts =
  1259. CreateFunctionSignatureInsts(context, loc_id, clang_decl, num_params);
  1260. auto pattern_block_id = context.pattern_block_stack().Pop();
  1261. auto decl_block_id = context.inst_block_stack().Pop();
  1262. context.scope_stack().Pop();
  1263. if (!function_params_insts.has_value()) {
  1264. return std::nullopt;
  1265. }
  1266. auto function_decl = SemIR::FunctionDecl{
  1267. SemIR::TypeId::None, SemIR::FunctionId::None, decl_block_id};
  1268. auto decl_id = AddPlaceholderImportedInstInNoBlock(
  1269. context, SemIR::LocIdAndInst::NoLoc(function_decl));
  1270. auto virtual_modifier = SemIR::Function::VirtualModifier::None;
  1271. int32_t virtual_index = -1;
  1272. if (auto* method_decl = dyn_cast<clang::CXXMethodDecl>(clang_decl)) {
  1273. if (method_decl->size_overridden_methods()) {
  1274. virtual_modifier = SemIR::Function::VirtualModifier::Override;
  1275. } else if (method_decl->isVirtual()) {
  1276. virtual_modifier = SemIR::Function::VirtualModifier::Virtual;
  1277. }
  1278. if (virtual_modifier != SemIR::Function::VirtualModifier::None) {
  1279. // TODO: Add support for Microsoft/non-Itanium vtables.
  1280. virtual_index = dyn_cast<clang::ItaniumVTableContext>(
  1281. context.ast_context().getVTableContext())
  1282. ->getMethodVTableIndex(method_decl);
  1283. }
  1284. }
  1285. auto function_info = SemIR::Function{
  1286. {.name_id = GetFunctionName(context, clang_decl),
  1287. .parent_scope_id = GetParentNameScopeId(context, clang_decl),
  1288. .generic_id = SemIR::GenericId::None,
  1289. .first_param_node_id = Parse::NodeId::None,
  1290. .last_param_node_id = Parse::NodeId::None,
  1291. .pattern_block_id = pattern_block_id,
  1292. .implicit_param_patterns_id =
  1293. function_params_insts->implicit_param_patterns_id,
  1294. .param_patterns_id = function_params_insts->param_patterns_id,
  1295. .is_extern = false,
  1296. .extern_library_id = SemIR::LibraryNameId::None,
  1297. .non_owning_decl_id = SemIR::InstId::None,
  1298. .first_owning_decl_id = decl_id,
  1299. .definition_id = SemIR::InstId::None},
  1300. {.call_param_patterns_id = function_params_insts->call_param_patterns_id,
  1301. .call_params_id = function_params_insts->call_params_id,
  1302. .return_type_inst_id = function_params_insts->return_type_inst_id,
  1303. .return_form_inst_id = function_params_insts->return_form_inst_id,
  1304. .return_patterns_id = function_params_insts->return_patterns_id,
  1305. .virtual_modifier = virtual_modifier,
  1306. .virtual_index = virtual_index,
  1307. .self_param_id = FindSelfPattern(
  1308. context, function_params_insts->implicit_param_patterns_id),
  1309. .clang_decl_id = context.clang_decls().Add(
  1310. {.key = SemIR::ClangDeclKey::ForFunctionDecl(clang_decl, num_params),
  1311. .inst_id = decl_id})}};
  1312. function_decl.function_id = context.functions().Add(function_info);
  1313. function_decl.type_id = GetFunctionType(context, function_decl.function_id,
  1314. SemIR::SpecificId::None);
  1315. ReplaceInstBeforeConstantUse(context, decl_id, function_decl);
  1316. return function_decl.function_id;
  1317. }
  1318. // Imports a C++ function, returning a corresponding Carbon function.
  1319. // `num_params` specifies how many parameters the corresponding Carbon function
  1320. // should have, which may be fewer than the number of parameters that the C++
  1321. // function has if default arguments are available for the trailing parameters.
  1322. static auto ImportFunctionDecl(Context& context, SemIR::LocId loc_id,
  1323. clang::FunctionDecl* clang_decl, int num_params)
  1324. -> SemIR::InstId {
  1325. auto key = SemIR::ClangDeclKey::ForFunctionDecl(clang_decl, num_params);
  1326. // Check if the declaration is already mapped.
  1327. if (SemIR::InstId existing_inst_id = LookupClangDeclInstId(context, key);
  1328. existing_inst_id.has_value()) {
  1329. return existing_inst_id;
  1330. }
  1331. if (clang_decl->isVariadic()) {
  1332. context.TODO(loc_id, "Unsupported: Variadic function");
  1333. MarkFailedDecl(context, key);
  1334. return SemIR::ErrorInst::InstId;
  1335. }
  1336. if (clang_decl->getTemplatedKind() ==
  1337. clang::FunctionDecl::TK_FunctionTemplate) {
  1338. context.TODO(loc_id, "Unsupported: Template function");
  1339. MarkFailedDecl(context, key);
  1340. return SemIR::ErrorInst::InstId;
  1341. }
  1342. CARBON_CHECK(clang_decl->getFunctionType()->isFunctionProtoType(),
  1343. "Not Prototype function (non-C++ code)");
  1344. auto function_id = ImportFunction(context, loc_id, clang_decl, num_params);
  1345. if (!function_id) {
  1346. MarkFailedDecl(context, key);
  1347. return SemIR::ErrorInst::InstId;
  1348. }
  1349. SemIR::Function& function_info = context.functions().Get(*function_id);
  1350. if (IsCppThunkRequired(context, function_info)) {
  1351. Diagnostics::AnnotationScope annotate_diagnostics(
  1352. &context.emitter(), [&](auto& builder) {
  1353. CARBON_DIAGNOSTIC(InCppThunk, Note,
  1354. "in thunk for C++ function used here");
  1355. builder.Note(loc_id, InCppThunk);
  1356. });
  1357. if (clang::FunctionDecl* thunk_clang_decl =
  1358. BuildCppThunk(context, function_info)) {
  1359. if (auto thunk_function_id =
  1360. ImportFunction(context, loc_id, thunk_clang_decl,
  1361. thunk_clang_decl->getNumParams())) {
  1362. SemIR::InstId thunk_function_decl_id =
  1363. context.functions().Get(*thunk_function_id).first_owning_decl_id;
  1364. function_info.SetHasCppThunk(thunk_function_decl_id);
  1365. }
  1366. }
  1367. } else {
  1368. // Inform Clang that the function has been referenced. This will trigger
  1369. // instantiation if needed.
  1370. context.clang_sema().MarkFunctionReferenced(GetCppLocation(context, loc_id),
  1371. clang_decl);
  1372. // If the function is trivial, mark it as being a builtin if possible.
  1373. if (clang_decl->isTrivial()) {
  1374. // Trivial destructors map to a "no_op" builtin.
  1375. if (isa<clang::CXXDestructorDecl>(clang_decl)) {
  1376. function_info.SetBuiltinFunction(SemIR::BuiltinFunctionKind::NoOp);
  1377. }
  1378. // TODO: Should we model a trivial default constructor as performing
  1379. // value-initialization (zero-initializing all fields) or
  1380. // default-initialization (leaving fields uniniitalized)? Either way we
  1381. // could model that effect as a builtin.
  1382. // TODO: Add a builtin to model trivial copies.
  1383. }
  1384. }
  1385. return function_info.first_owning_decl_id;
  1386. }
  1387. namespace {
  1388. // An item to be imported in an import worklist.
  1389. // TODO: If worklists ever become particularly large, consider changing this
  1390. // to use a `PointerIntPair`.
  1391. struct ImportItem {
  1392. // A declaration that we want to import.
  1393. SemIR::ClangDeclKey decl_key;
  1394. // Whether we have added `decl`'s dependencies to the worklist.
  1395. bool added_dependencies;
  1396. };
  1397. // A worklist of declarations to import.
  1398. using ImportWorklist = llvm::SmallVector<ImportItem>;
  1399. } // namespace
  1400. // Adds the given declaration to our list of declarations to import.
  1401. static auto AddDependentDecl(Context& context, SemIR::ClangDeclKey decl,
  1402. ImportWorklist& worklist) -> void {
  1403. if (!IsClangDeclImported(context, decl)) {
  1404. worklist.push_back({.decl_key = decl, .added_dependencies = false});
  1405. }
  1406. }
  1407. // Finds all decls that need to be imported before importing the given type and
  1408. // adds them to the given set.
  1409. static auto AddDependentUnimportedTypeDecls(Context& context,
  1410. clang::QualType type,
  1411. ImportWorklist& worklist) -> void {
  1412. while (true) {
  1413. if (type->isPointerType() || type->isReferenceType()) {
  1414. type = type->getPointeeType();
  1415. } else if (const clang::ArrayType* array_type =
  1416. type->getAsArrayTypeUnsafe()) {
  1417. type = array_type->getElementType();
  1418. } else {
  1419. break;
  1420. }
  1421. }
  1422. if (const auto* tag_type = type->getAs<clang::TagType>()) {
  1423. AddDependentDecl(context, SemIR::ClangDeclKey(tag_type->getDecl()),
  1424. worklist);
  1425. }
  1426. }
  1427. // Finds all decls that need to be imported before importing the given function
  1428. // and adds them to the given set.
  1429. static auto AddDependentUnimportedFunctionDecls(
  1430. Context& context, const clang::FunctionDecl& clang_decl, int num_params,
  1431. ImportWorklist& worklist) -> void {
  1432. const auto* function_type =
  1433. clang_decl.getType()->castAs<clang::FunctionProtoType>();
  1434. for (int i : llvm::seq(clang_decl.hasCXXExplicitFunctionObjectParameter() +
  1435. num_params)) {
  1436. AddDependentUnimportedTypeDecls(context, function_type->getParamType(i),
  1437. worklist);
  1438. }
  1439. AddDependentUnimportedTypeDecls(context, clang_decl.getReturnType(),
  1440. worklist);
  1441. }
  1442. // Finds all decls that need to be imported before importing the given
  1443. // declaration and adds them to the given set.
  1444. static auto AddDependentUnimportedDecls(Context& context,
  1445. SemIR::ClangDeclKey key,
  1446. ImportWorklist& worklist) -> void {
  1447. clang::Decl* clang_decl = key.decl;
  1448. if (auto* clang_function_decl = clang_decl->getAsFunction()) {
  1449. AddDependentUnimportedFunctionDecls(context, *clang_function_decl,
  1450. key.num_params, worklist);
  1451. } else if (auto* type_decl = dyn_cast<clang::TypeDecl>(clang_decl)) {
  1452. if (!isa<clang::TagDecl>(clang_decl)) {
  1453. AddDependentUnimportedTypeDecls(
  1454. context, type_decl->getASTContext().getTypeDeclType(type_decl),
  1455. worklist);
  1456. }
  1457. }
  1458. auto* parent = GetParentDecl(clang_decl);
  1459. if (llvm::isa_and_nonnull<clang::TagDecl, clang::NamespaceDecl,
  1460. clang::TranslationUnitDecl>(parent)) {
  1461. AddDependentDecl(context, SemIR::ClangDeclKey::ForNonFunctionDecl(parent),
  1462. worklist);
  1463. }
  1464. }
  1465. static auto ImportVarDecl(Context& context, SemIR::LocId loc_id,
  1466. clang::VarDecl* var_decl) -> SemIR::InstId {
  1467. if (SemIR::InstId existing_inst_id =
  1468. LookupClangDeclInstId(context, SemIR::ClangDeclKey(var_decl));
  1469. existing_inst_id.has_value()) {
  1470. return existing_inst_id;
  1471. }
  1472. // Extract type and name.
  1473. clang::QualType var_type = var_decl->getType();
  1474. SemIR::TypeId var_type_id = MapType(context, loc_id, var_type).type_id;
  1475. if (!var_type_id.has_value()) {
  1476. context.TODO(loc_id, llvm::formatv("Unsupported: var type: {0}",
  1477. var_type.getAsString()));
  1478. return SemIR::ErrorInst::InstId;
  1479. }
  1480. SemIR::NameId var_name_id = AddIdentifierName(context, var_decl->getName());
  1481. // Create an entity name to identify this variable.
  1482. SemIR::EntityNameId entity_name_id =
  1483. context.entity_names().AddSymbolicBindingName(
  1484. var_name_id, GetParentNameScopeId(context, var_decl),
  1485. SemIR::CompileTimeBindIndex::None, false);
  1486. // Create `RefBindingPattern` and `VarPattern`. Mirror the behavior of
  1487. // import_ref and don't create a `NameBindingDecl` here; we'd never use it for
  1488. // anything.
  1489. SemIR::TypeId pattern_type_id = GetPatternType(context, var_type_id);
  1490. SemIR::InstId binding_pattern_inst_id =
  1491. AddInstInNoBlock<SemIR::RefBindingPattern>(
  1492. context, loc_id,
  1493. {.type_id = pattern_type_id, .entity_name_id = entity_name_id});
  1494. context.imports().push_back(binding_pattern_inst_id);
  1495. auto pattern_id = AddInstInNoBlock<SemIR::VarPattern>(
  1496. context, Parse::VariablePatternId::None,
  1497. {.type_id = pattern_type_id, .subpattern_id = binding_pattern_inst_id});
  1498. context.imports().push_back(pattern_id);
  1499. // Create the imported storage for the global. We intentionally use the
  1500. // untyped form of `AddInstInNoBlock` to bypass the check on adding an
  1501. // instruction that requires a cleanup, because we don't want a cleanup here!
  1502. SemIR::InstId var_storage_inst_id = AddInstInNoBlock(
  1503. context, {loc_id, SemIR::VarStorage{.type_id = var_type_id,
  1504. .pattern_id = pattern_id}});
  1505. context.imports().push_back(var_storage_inst_id);
  1506. // Register the variable so we don't create it again, and track the
  1507. // corresponding declaration to use for mangling.
  1508. auto clang_decl_id = context.clang_decls().Add(
  1509. {.key = SemIR::ClangDeclKey(var_decl), .inst_id = var_storage_inst_id});
  1510. context.cpp_global_names().Add({.key = {.entity_name_id = entity_name_id},
  1511. .clang_decl_id = clang_decl_id});
  1512. // Inform Clang that the variable has been referenced.
  1513. context.clang_sema().MarkVariableReferenced(GetCppLocation(context, loc_id),
  1514. var_decl);
  1515. return var_storage_inst_id;
  1516. }
  1517. static auto ImportTemplateDecl(Context& context,
  1518. clang::TemplateDecl* template_decl)
  1519. -> SemIR::InstId {
  1520. auto key = SemIR::ClangDeclKey(template_decl);
  1521. // TODO: Avoid doing this lookup both here and in the insertion below.
  1522. if (SemIR::InstId existing_inst_id = LookupClangDeclInstId(context, key);
  1523. existing_inst_id.has_value()) {
  1524. return existing_inst_id;
  1525. }
  1526. // Add a placeholder instruction to resolve cycle between the clang
  1527. // declaration and the type.
  1528. auto import_loc_id =
  1529. AddImportIRInst(context.sem_ir(), template_decl->getLocation());
  1530. SemIR::StructValue value = {.type_id = SemIR::TypeId::None,
  1531. .elements_id = SemIR::InstBlockId::Empty};
  1532. auto inst_id = AddPlaceholderImportedInstInNoBlock(
  1533. context, MakeImportedLocIdAndInst(context, import_loc_id, value));
  1534. // Create a type for the constant value.
  1535. auto name_id = context.entity_names().Add(
  1536. {.name_id = AddIdentifierName(context, template_decl->getName()),
  1537. .parent_scope_id = GetParentNameScopeId(context, template_decl)});
  1538. auto decl_id = context.clang_decls().Add({.key = key, .inst_id = inst_id});
  1539. value.type_id = GetCppTemplateNameType(context, name_id, decl_id);
  1540. // Update the value with its type.
  1541. ReplaceInstBeforeConstantUse(context, inst_id, value);
  1542. return inst_id;
  1543. }
  1544. // Imports a declaration from Clang to Carbon. Returns the instruction for the
  1545. // new Carbon declaration, which will be an ErrorInst on failure. Assumes all
  1546. // dependencies have already been imported.
  1547. static auto ImportDeclAfterDependencies(Context& context, SemIR::LocId loc_id,
  1548. SemIR::ClangDeclKey key)
  1549. -> SemIR::InstId {
  1550. clang::Decl* clang_decl = key.decl;
  1551. if (auto* clang_function_decl = clang_decl->getAsFunction()) {
  1552. return ImportFunctionDecl(context, loc_id, clang_function_decl,
  1553. key.num_params);
  1554. }
  1555. if (auto* clang_namespace_decl = dyn_cast<clang::NamespaceDecl>(clang_decl)) {
  1556. return ImportNamespaceDecl(context, clang_namespace_decl);
  1557. }
  1558. if (auto* type_decl = dyn_cast<clang::TypeDecl>(clang_decl)) {
  1559. auto type = clang_decl->getASTContext().getTypeDeclType(type_decl);
  1560. auto type_inst_id = MapType(context, loc_id, type).inst_id;
  1561. if (!type_inst_id.has_value()) {
  1562. context.TODO(AddImportIRInst(context.sem_ir(), type_decl->getLocation()),
  1563. llvm::formatv("Unsupported: Type declaration: {0}",
  1564. type.getAsString()));
  1565. return SemIR::ErrorInst::InstId;
  1566. }
  1567. context.clang_decls().Add({.key = key, .inst_id = type_inst_id});
  1568. return type_inst_id;
  1569. }
  1570. if (isa<clang::FieldDecl, clang::IndirectFieldDecl>(clang_decl)) {
  1571. // Usable fields get imported as a side effect of importing the class.
  1572. if (SemIR::InstId existing_inst_id = LookupClangDeclInstId(context, key);
  1573. existing_inst_id.has_value()) {
  1574. return existing_inst_id;
  1575. }
  1576. context.TODO(AddImportIRInst(context.sem_ir(), clang_decl->getLocation()),
  1577. "Unsupported: field declaration has unhandled type or kind");
  1578. return SemIR::ErrorInst::InstId;
  1579. }
  1580. if (auto* enum_const_decl = dyn_cast<clang::EnumConstantDecl>(clang_decl)) {
  1581. return ImportEnumConstantDecl(context, enum_const_decl);
  1582. }
  1583. if (auto* var_decl = dyn_cast<clang::VarDecl>(clang_decl)) {
  1584. return ImportVarDecl(context, loc_id, var_decl);
  1585. }
  1586. if (auto* template_decl = dyn_cast<clang::TemplateDecl>(clang_decl)) {
  1587. return ImportTemplateDecl(context, template_decl);
  1588. }
  1589. context.TODO(AddImportIRInst(context.sem_ir(), clang_decl->getLocation()),
  1590. llvm::formatv("Unsupported: Declaration type {0}",
  1591. clang_decl->getDeclKindName()));
  1592. return SemIR::ErrorInst::InstId;
  1593. }
  1594. // Attempts to import a set of declarations. Returns `false` if an error was
  1595. // produced, `true` otherwise.
  1596. static auto ImportDeclSet(Context& context, SemIR::LocId loc_id,
  1597. ImportWorklist& worklist) -> bool {
  1598. // Walk the dependency graph in depth-first order, and import declarations
  1599. // once we've imported all of their dependencies.
  1600. while (!worklist.empty()) {
  1601. auto& item = worklist.back();
  1602. if (!item.added_dependencies) {
  1603. // Skip items we've already imported. We checked this when initially
  1604. // adding the item to the worklist, but it might have been added to the
  1605. // worklist twice before the first time we visited it. For example, this
  1606. // happens for `fn F(a: Cpp.T, b: Cpp.T)`.
  1607. if (IsClangDeclImported(context, item.decl_key)) {
  1608. worklist.pop_back();
  1609. continue;
  1610. }
  1611. // First time visiting this declaration (preorder): add its dependencies
  1612. // to the work list.
  1613. item.added_dependencies = true;
  1614. AddDependentUnimportedDecls(context, item.decl_key, worklist);
  1615. } else {
  1616. // Second time visiting this declaration (postorder): its dependencies are
  1617. // already imported, so we can import it now.
  1618. auto decl_key = worklist.pop_back_val().decl_key;
  1619. auto inst_id = ImportDeclAfterDependencies(context, loc_id, decl_key);
  1620. CARBON_CHECK(inst_id.has_value());
  1621. if (inst_id == SemIR::ErrorInst::InstId) {
  1622. return false;
  1623. }
  1624. CARBON_CHECK(IsClangDeclImported(context, decl_key));
  1625. }
  1626. }
  1627. return true;
  1628. }
  1629. auto ImportCppDecl(Context& context, SemIR::LocId loc_id,
  1630. SemIR::ClangDeclKey key) -> SemIR::InstId {
  1631. // Collect dependencies by walking the dependency graph in depth-first order.
  1632. ImportWorklist worklist;
  1633. AddDependentDecl(context, key, worklist);
  1634. if (!ImportDeclSet(context, loc_id, worklist)) {
  1635. return SemIR::ErrorInst::InstId;
  1636. }
  1637. return LookupClangDeclInstId(context, key);
  1638. }
  1639. auto ImportCppType(Context& context, SemIR::LocId loc_id, clang::QualType type)
  1640. -> TypeExpr {
  1641. // Collect dependencies by walking the dependency graph in depth-first order.
  1642. ImportWorklist worklist;
  1643. AddDependentUnimportedTypeDecls(context, type, worklist);
  1644. if (!ImportDeclSet(context, loc_id, worklist)) {
  1645. return {.inst_id = SemIR::ErrorInst::TypeInstId,
  1646. .type_id = SemIR::ErrorInst::TypeId};
  1647. }
  1648. return MapType(context, loc_id, type);
  1649. }
  1650. // Imports a Clang declaration into Carbon and adds that name into the
  1651. // `NameScope`.
  1652. static auto ImportNameDeclIntoScope(Context& context, SemIR::LocId loc_id,
  1653. SemIR::NameScopeId scope_id,
  1654. SemIR::NameId name_id,
  1655. SemIR::ClangDeclKey key,
  1656. SemIR::AccessKind access_kind)
  1657. -> SemIR::ScopeLookupResult {
  1658. SemIR::InstId inst_id = ImportCppDecl(context, loc_id, key);
  1659. if (!inst_id.has_value()) {
  1660. return SemIR::ScopeLookupResult::MakeNotFound();
  1661. }
  1662. AddNameToScope(context, scope_id, name_id, access_kind, inst_id);
  1663. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(inst_id,
  1664. access_kind);
  1665. }
  1666. // Returns true if the scope is the top `Cpp` scope.
  1667. static auto IsTopCppScope(Context& context, SemIR::NameScopeId scope_id)
  1668. -> bool {
  1669. const SemIR::NameScope& name_scope = context.name_scopes().Get(scope_id);
  1670. CARBON_CHECK(name_scope.is_cpp_scope());
  1671. return name_scope.parent_scope_id() == SemIR::NameScopeId::Package;
  1672. }
  1673. // For a builtin name like `Cpp.long`, returns the associated type.
  1674. static auto LookupBuiltinName(Context& context, SemIR::LocId loc_id,
  1675. SemIR::NameScopeId scope_id,
  1676. SemIR::NameId name_id) -> SemIR::InstId {
  1677. if (!IsTopCppScope(context, scope_id)) {
  1678. return SemIR::InstId::None;
  1679. }
  1680. auto name = context.names().GetAsStringIfIdentifier(name_id);
  1681. if (!name) {
  1682. return SemIR::InstId::None;
  1683. }
  1684. const clang::ASTContext& ast_context = context.ast_context();
  1685. // List of types based on
  1686. // https://github.com/carbon-language/carbon-lang/blob/trunk/proposals/p5448.md#details
  1687. auto builtin_type =
  1688. llvm::StringSwitch<clang::QualType>(*name)
  1689. .Case("signed_char", ast_context.SignedCharTy)
  1690. .Case("short", ast_context.ShortTy)
  1691. .Case("int", ast_context.IntTy)
  1692. .Case("long", ast_context.LongTy)
  1693. .Case("long_long", ast_context.LongLongTy)
  1694. .Case("unsigned_char", ast_context.UnsignedCharTy)
  1695. .Case("unsigned_short", ast_context.UnsignedShortTy)
  1696. .Case("unsigned_int", ast_context.UnsignedIntTy)
  1697. .Case("unsigned_long", ast_context.UnsignedLongTy)
  1698. .Case("unsigned_long_long", ast_context.UnsignedLongLongTy)
  1699. .Case("float", ast_context.FloatTy)
  1700. .Case("double", ast_context.DoubleTy)
  1701. .Case("long_double", ast_context.LongDoubleTy)
  1702. .Case("void", ast_context.VoidTy)
  1703. .Default(clang::QualType());
  1704. if (builtin_type.isNull()) {
  1705. if (*name == "nullptr") {
  1706. // Map `Cpp.nullptr` to an uninitialized value of type `Core.CppNullptrT`.
  1707. auto type_id = MapNullptrType(context, loc_id).type_id;
  1708. return GetOrAddInst<SemIR::UninitializedValue>(
  1709. context, SemIR::LocId::None, {.type_id = type_id});
  1710. }
  1711. return SemIR::InstId::None;
  1712. }
  1713. SemIR::InstId inst_id =
  1714. MapNonWrapperType(context, loc_id, builtin_type).inst_id;
  1715. if (!inst_id.has_value()) {
  1716. context.TODO(loc_id, llvm::formatv("Unsupported: builtin type: {0}",
  1717. builtin_type.getAsString()));
  1718. return SemIR::ErrorInst::InstId;
  1719. }
  1720. return inst_id;
  1721. }
  1722. auto ImportCppOverloadSet(
  1723. Context& context, SemIR::LocId loc_id, SemIR::NameScopeId scope_id,
  1724. SemIR::NameId name_id, clang::CXXRecordDecl* naming_class,
  1725. clang::UnresolvedSet<4>&& overload_set,
  1726. clang::OverloadCandidateSet::OperatorRewriteInfo operator_rewrite_info)
  1727. -> SemIR::InstId {
  1728. SemIR::CppOverloadSetId overload_set_id = context.cpp_overload_sets().Add(
  1729. SemIR::CppOverloadSet{.name_id = name_id,
  1730. .parent_scope_id = scope_id,
  1731. .naming_class = naming_class,
  1732. .candidate_functions = std::move(overload_set),
  1733. .operator_rewrite_info = operator_rewrite_info});
  1734. auto overload_set_inst_id = AddInstInNoBlock<SemIR::CppOverloadSetValue>(
  1735. context, loc_id,
  1736. {.type_id = GetCppOverloadSetType(context, overload_set_id,
  1737. SemIR::SpecificId::None),
  1738. .overload_set_id = overload_set_id});
  1739. context.imports().push_back(overload_set_inst_id);
  1740. return overload_set_inst_id;
  1741. }
  1742. // Gets the best access for an overloaded function set. This is the access that
  1743. // we use for the overload set as a whole. More fine-grained checking is done
  1744. // after overload resolution.
  1745. static auto GetOverloadSetAccess(const clang::UnresolvedSet<4>& overload_set)
  1746. -> SemIR::AccessKind {
  1747. SemIR::AccessKind access_kind = SemIR::AccessKind::Private;
  1748. for (clang::DeclAccessPair overload : overload_set.pairs()) {
  1749. access_kind = std::min(access_kind, MapCppAccess(overload));
  1750. if (access_kind == SemIR::AccessKind::Public) {
  1751. break;
  1752. }
  1753. }
  1754. return access_kind;
  1755. }
  1756. // Imports an overload set from Clang to Carbon and adds the name into the
  1757. // `NameScope`.
  1758. static auto ImportOverloadSetIntoScope(Context& context, SemIR::LocId loc_id,
  1759. SemIR::NameScopeId scope_id,
  1760. SemIR::NameId name_id,
  1761. clang::CXXRecordDecl* naming_class,
  1762. clang::UnresolvedSet<4>&& overload_set)
  1763. -> SemIR::ScopeLookupResult {
  1764. SemIR::AccessKind access_kind = GetOverloadSetAccess(overload_set);
  1765. SemIR::InstId inst_id = ImportCppOverloadSet(
  1766. context, loc_id, scope_id, name_id, naming_class, std::move(overload_set),
  1767. /*operator_rewrite_info=*/{});
  1768. AddNameToScope(context, scope_id, name_id, access_kind, inst_id);
  1769. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(inst_id,
  1770. access_kind);
  1771. }
  1772. // Imports the constructors for a given class name. The found constructors are
  1773. // imported as part of an overload set into the scope. Currently copy/move
  1774. // constructors are not imported.
  1775. static auto ImportConstructorsIntoScope(Context& context, SemIR::LocId loc_id,
  1776. SemIR::NameScopeId scope_id,
  1777. SemIR::NameId name_id)
  1778. -> SemIR::ScopeLookupResult {
  1779. auto* naming_class =
  1780. cast<clang::CXXRecordDecl>(GetDeclContext(context, scope_id));
  1781. clang::DeclContextLookupResult constructors_lookup =
  1782. context.clang_sema().LookupConstructors(naming_class);
  1783. clang::UnresolvedSet<4> overload_set;
  1784. for (auto* decl : constructors_lookup) {
  1785. auto info = clang::getConstructorInfo(decl);
  1786. if (!info.Constructor || info.Constructor->isCopyOrMoveConstructor()) {
  1787. continue;
  1788. }
  1789. overload_set.addDecl(info.FoundDecl, info.FoundDecl.getAccess());
  1790. }
  1791. if (overload_set.empty()) {
  1792. return SemIR::ScopeLookupResult::MakeNotFound();
  1793. }
  1794. return ImportOverloadSetIntoScope(context, loc_id, scope_id, name_id,
  1795. naming_class, std::move(overload_set));
  1796. }
  1797. // Attempts to import a builtin name from Clang to Carbon and adds the name into
  1798. // the scope.
  1799. static auto ImportBuiltinNameIntoScope(Context& context, SemIR::LocId loc_id,
  1800. SemIR::NameScopeId scope_id,
  1801. SemIR::NameId name_id)
  1802. -> SemIR::ScopeLookupResult {
  1803. SemIR::InstId builtin_inst_id =
  1804. LookupBuiltinName(context, loc_id, scope_id, name_id);
  1805. if (builtin_inst_id.has_value()) {
  1806. AddNameToScope(context, scope_id, name_id, SemIR::AccessKind::Public,
  1807. builtin_inst_id);
  1808. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(
  1809. builtin_inst_id, SemIR::AccessKind::Public);
  1810. }
  1811. return SemIR::ScopeLookupResult::MakeNotFound();
  1812. }
  1813. // Checks if the name scope is a class that is not complete.
  1814. static auto IsIncompleteClass(Context& context, SemIR::NameScopeId scope_id)
  1815. -> bool {
  1816. auto class_decl = context.insts().TryGetAs<SemIR::ClassDecl>(
  1817. context.name_scopes().Get(scope_id).inst_id());
  1818. return class_decl.has_value() &&
  1819. !context.types().IsComplete(
  1820. context.classes().Get(class_decl->class_id).self_type_id);
  1821. }
  1822. // Maps a Clang literal expression to a Carbon constant.
  1823. // TODO: Add support for all constant types for which a C++ to Carbon type
  1824. // mapping exists.
  1825. static auto MapConstant(Context& context, SemIR::LocId loc_id,
  1826. clang::Expr* expr) -> SemIR::InstId {
  1827. CARBON_CHECK(expr, "empty expression");
  1828. if (auto* string_literal = dyn_cast<clang::StringLiteral>(expr)) {
  1829. if (!string_literal->isOrdinary() && !string_literal->isUTF8()) {
  1830. context.TODO(loc_id,
  1831. llvm::formatv("Unsupported: string literal type: {0}",
  1832. expr->getType()));
  1833. return SemIR::ErrorInst::InstId;
  1834. }
  1835. StringLiteralValueId string_id =
  1836. context.string_literal_values().Add(string_literal->getString());
  1837. auto inst_id =
  1838. MakeStringLiteral(context, Parse::StringLiteralId::None, string_id);
  1839. return inst_id;
  1840. } else if (isa<clang::CXXNullPtrLiteralExpr>(expr)) {
  1841. auto type_id = MapNullptrType(context, loc_id).type_id;
  1842. return GetOrAddInst<SemIR::UninitializedValue>(context, SemIR::LocId::None,
  1843. {.type_id = type_id});
  1844. }
  1845. SemIR::TypeId type_id = MapType(context, loc_id, expr->getType()).type_id;
  1846. if (!type_id.has_value()) {
  1847. context.TODO(loc_id, llvm::formatv("Unsupported: C++ literal's type `{0}` "
  1848. "could not be mapped to a Carbon type",
  1849. expr->getType().getAsString()));
  1850. return SemIR::ErrorInst::InstId;
  1851. }
  1852. SemIR::InstId inst_id = SemIR::InstId::None;
  1853. SemIR::ImportIRInstId imported_loc_id =
  1854. AddImportIRInst(context.sem_ir(), expr->getExprLoc());
  1855. if (auto* integer_literal = dyn_cast<clang::IntegerLiteral>(expr)) {
  1856. IntId int_id =
  1857. context.ints().Add(integer_literal->getValue().getSExtValue());
  1858. inst_id = AddInstInNoBlock(
  1859. context,
  1860. MakeImportedLocIdAndInst<SemIR::IntValue>(
  1861. context, imported_loc_id, {.type_id = type_id, .int_id = int_id}));
  1862. } else if (auto* bool_literal = dyn_cast<clang::CXXBoolLiteralExpr>(expr)) {
  1863. inst_id = AddInstInNoBlock(
  1864. context,
  1865. MakeImportedLocIdAndInst<SemIR::BoolLiteral>(
  1866. context, imported_loc_id,
  1867. {.type_id = type_id,
  1868. .value = SemIR::BoolValue::From(bool_literal->getValue())}));
  1869. } else if (auto* float_literal = dyn_cast<clang::FloatingLiteral>(expr)) {
  1870. FloatId float_id = context.floats().Add(float_literal->getValue());
  1871. inst_id = AddInstInNoBlock(context,
  1872. MakeImportedLocIdAndInst<SemIR::FloatValue>(
  1873. context, imported_loc_id,
  1874. {.type_id = type_id, .float_id = float_id}));
  1875. } else if (auto* character_literal =
  1876. dyn_cast<clang::CharacterLiteral>(expr)) {
  1877. inst_id = AddInstInNoBlock(
  1878. context, MakeImportedLocIdAndInst<SemIR::CharLiteralValue>(
  1879. context, imported_loc_id,
  1880. {.type_id = type_id,
  1881. .value = SemIR::CharId(character_literal->getValue())}));
  1882. } else {
  1883. context.TODO(loc_id, llvm::formatv(
  1884. "Unsupported: C++ constant expression type: '{0}'",
  1885. expr->getType().getAsString()));
  1886. return SemIR::ErrorInst::InstId;
  1887. }
  1888. context.imports().push_back(inst_id);
  1889. return inst_id;
  1890. }
  1891. // Imports a macro definition into the scope. Currently supports only simple
  1892. // object-like macros that expand to a constant integer value.
  1893. // TODO: Add support for other macro types and non-integer literal values.
  1894. static auto ImportMacro(Context& context, SemIR::LocId loc_id,
  1895. SemIR::NameScopeId scope_id, SemIR::NameId name_id,
  1896. clang::MacroInfo* macro_info)
  1897. -> SemIR::ScopeLookupResult {
  1898. clang::Expr* macro_expr =
  1899. TryEvaluateMacroToConstant(context, loc_id, name_id, macro_info);
  1900. if (!macro_expr) {
  1901. return SemIR::ScopeLookupResult::MakeNotFound();
  1902. }
  1903. auto inst_id = MapConstant(context, loc_id, macro_expr);
  1904. if (inst_id == SemIR::ErrorInst::InstId) {
  1905. return SemIR::ScopeLookupResult::MakeNotFound();
  1906. }
  1907. AddNameToScope(context, scope_id, name_id, SemIR::AccessKind::Public,
  1908. inst_id);
  1909. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(
  1910. inst_id, SemIR::AccessKind::Public);
  1911. }
  1912. // Looks up a macro definition in the top-level `Cpp` scope. Returns nullptr if
  1913. // the macro is not found or if it is a builtin macro, function-like macro or a
  1914. // macro used for header guards.
  1915. // TODO: Function-like and builtin macros are currently not supported and their
  1916. // support still needs to be clarified.
  1917. static auto LookupMacro(Context& context, SemIR::NameScopeId scope_id,
  1918. clang::IdentifierInfo* identifier_info)
  1919. -> clang::MacroInfo* {
  1920. if (!IsTopCppScope(context, scope_id)) {
  1921. return nullptr;
  1922. }
  1923. CARBON_CHECK(identifier_info, "Identifier info is empty");
  1924. clang::MacroInfo* macro_info =
  1925. context.clang_sema().getPreprocessor().getMacroInfo(identifier_info);
  1926. if (macro_info && !macro_info->isUsedForHeaderGuard() &&
  1927. !macro_info->isFunctionLike() && !macro_info->isBuiltinMacro()) {
  1928. return macro_info;
  1929. }
  1930. return nullptr;
  1931. }
  1932. // Gets the identifier info for a name. Returns `nullptr` if the name is not an
  1933. // identifier name.
  1934. static auto GetIdentifierInfo(Context& context, SemIR::NameId name_id)
  1935. -> clang::IdentifierInfo* {
  1936. std::optional<llvm::StringRef> string_name =
  1937. context.names().GetAsStringIfIdentifier(name_id);
  1938. if (!string_name) {
  1939. return nullptr;
  1940. }
  1941. clang::IdentifierInfo* identifier_info =
  1942. context.clang_sema().getPreprocessor().getIdentifierInfo(*string_name);
  1943. return identifier_info;
  1944. }
  1945. auto ImportNameFromCpp(Context& context, SemIR::LocId loc_id,
  1946. SemIR::NameScopeId scope_id, SemIR::NameId name_id)
  1947. -> SemIR::ScopeLookupResult {
  1948. Diagnostics::AnnotationScope annotate_diagnostics(
  1949. &context.emitter(), [&](auto& builder) {
  1950. CARBON_DIAGNOSTIC(InCppNameLookup, Note,
  1951. "in `Cpp` name lookup for `{0}`", SemIR::NameId);
  1952. builder.Note(loc_id, InCppNameLookup, name_id);
  1953. });
  1954. if (IsIncompleteClass(context, scope_id)) {
  1955. return SemIR::ScopeLookupResult::MakeError();
  1956. }
  1957. clang::IdentifierInfo* identifier_info = GetIdentifierInfo(context, name_id);
  1958. if (!identifier_info) {
  1959. return SemIR::ScopeLookupResult::MakeNotFound();
  1960. }
  1961. if (clang::MacroInfo* macro_info =
  1962. LookupMacro(context, scope_id, identifier_info)) {
  1963. return ImportMacro(context, loc_id, scope_id, name_id, macro_info);
  1964. }
  1965. auto lookup = ClangLookupName(context, scope_id, identifier_info);
  1966. if (!lookup) {
  1967. return ImportBuiltinNameIntoScope(context, loc_id, scope_id, name_id);
  1968. }
  1969. // Access checks are performed separately by the Carbon name lookup logic.
  1970. lookup->suppressAccessDiagnostics();
  1971. if (lookup->isOverloadedResult() ||
  1972. (lookup->isSingleResult() &&
  1973. lookup->getFoundDecl()->isFunctionOrFunctionTemplate())) {
  1974. clang::UnresolvedSet<4> overload_set;
  1975. overload_set.append(lookup->begin(), lookup->end());
  1976. return ImportOverloadSetIntoScope(context, loc_id, scope_id, name_id,
  1977. lookup->getNamingClass(),
  1978. std::move(overload_set));
  1979. }
  1980. if (!lookup->isSingleResult()) {
  1981. // Clang will diagnose ambiguous lookup results for us.
  1982. if (!lookup->isAmbiguous()) {
  1983. context.TODO(loc_id,
  1984. llvm::formatv("Unsupported: Lookup succeeded but couldn't "
  1985. "find a single result; LookupResultKind: {0}",
  1986. static_cast<int>(lookup->getResultKind())));
  1987. }
  1988. context.name_scopes().AddRequiredName(scope_id, name_id,
  1989. SemIR::ErrorInst::InstId);
  1990. return SemIR::ScopeLookupResult::MakeError();
  1991. }
  1992. if (IsDeclInjectedClassName(context, scope_id, name_id,
  1993. lookup->getFoundDecl())) {
  1994. return ImportConstructorsIntoScope(context, loc_id, scope_id, name_id);
  1995. }
  1996. auto key = SemIR::ClangDeclKey::ForNonFunctionDecl(lookup->getFoundDecl());
  1997. return ImportNameDeclIntoScope(context, loc_id, scope_id, name_id, key,
  1998. MapCppAccess(lookup->begin().getPair()));
  1999. }
  2000. auto ImportClassDefinitionForClangDecl(Context& context, SemIR::LocId loc_id,
  2001. SemIR::ClassId class_id,
  2002. SemIR::ClangDeclId clang_decl_id)
  2003. -> bool {
  2004. SemIR::CppFile* cpp_file = context.sem_ir().cpp_file();
  2005. CARBON_CHECK(cpp_file);
  2006. auto* clang_decl =
  2007. cast<clang::TagDecl>(context.clang_decls().Get(clang_decl_id).key.decl);
  2008. auto class_inst_id = context.types().GetAsTypeInstId(
  2009. context.classes().Get(class_id).first_owning_decl_id);
  2010. // TODO: Map loc_id into a clang location and use it for diagnostics if
  2011. // instantiation fails, instead of annotating the diagnostic with another
  2012. // location.
  2013. clang::SourceLocation loc = clang_decl->getLocation();
  2014. Diagnostics::AnnotationScope annotate_diagnostics(
  2015. &context.emitter(), [&](auto& builder) {
  2016. CARBON_DIAGNOSTIC(InCppTypeCompletion, Note,
  2017. "while completing C++ type {0}", SemIR::TypeId);
  2018. builder.Note(loc_id, InCppTypeCompletion,
  2019. context.classes().Get(class_id).self_type_id);
  2020. });
  2021. // Ask Clang whether the type is complete. This triggers template
  2022. // instantiation if necessary.
  2023. clang::DiagnosticErrorTrap trap(cpp_file->diagnostics());
  2024. if (!context.cpp_context()->sema().isCompleteType(
  2025. loc, context.ast_context().getCanonicalTagType(clang_decl))) {
  2026. // Type is incomplete. Nothing more to do, but tell the caller if we
  2027. // produced an error.
  2028. return !trap.hasErrorOccurred();
  2029. }
  2030. auto import_ir_inst_id =
  2031. context.insts().GetCanonicalLocId(class_inst_id).import_ir_inst_id();
  2032. if (auto* class_decl = dyn_cast<clang::CXXRecordDecl>(clang_decl)) {
  2033. auto* class_def = class_decl->getDefinition();
  2034. CARBON_CHECK(class_def, "Complete type has no definition");
  2035. BuildClassDefinition(context, import_ir_inst_id, class_id, class_inst_id,
  2036. class_def);
  2037. } else if (auto* enum_decl = dyn_cast<clang::EnumDecl>(clang_decl)) {
  2038. BuildEnumDefinition(context, import_ir_inst_id, class_id, class_inst_id,
  2039. enum_decl);
  2040. }
  2041. return true;
  2042. }
  2043. } // namespace Carbon::Check