import.cpp 94 KB

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