import.cpp 97 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453
  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 <memory>
  6. #include <optional>
  7. #include <string>
  8. #include <tuple>
  9. #include <utility>
  10. #include "clang/AST/ASTContext.h"
  11. #include "clang/AST/RecordLayout.h"
  12. #include "clang/AST/UnresolvedSet.h"
  13. #include "clang/AST/VTableBuilder.h"
  14. #include "clang/Basic/FileManager.h"
  15. #include "clang/Frontend/ASTUnit.h"
  16. #include "clang/Frontend/CompilerInstance.h"
  17. #include "clang/Frontend/CompilerInvocation.h"
  18. #include "clang/Frontend/TextDiagnostic.h"
  19. #include "clang/Lex/PreprocessorOptions.h"
  20. #include "clang/Sema/Lookup.h"
  21. #include "common/check.h"
  22. #include "common/ostream.h"
  23. #include "common/raw_string_ostream.h"
  24. #include "llvm/ADT/IntrusiveRefCntPtr.h"
  25. #include "llvm/ADT/StringRef.h"
  26. #include "llvm/Support/raw_ostream.h"
  27. #include "toolchain/base/kind_switch.h"
  28. #include "toolchain/check/class.h"
  29. #include "toolchain/check/context.h"
  30. #include "toolchain/check/control_flow.h"
  31. #include "toolchain/check/convert.h"
  32. #include "toolchain/check/cpp/custom_type_mapping.h"
  33. #include "toolchain/check/cpp/thunk.h"
  34. #include "toolchain/check/diagnostic_helpers.h"
  35. #include "toolchain/check/eval.h"
  36. #include "toolchain/check/function.h"
  37. #include "toolchain/check/import.h"
  38. #include "toolchain/check/inst.h"
  39. #include "toolchain/check/literal.h"
  40. #include "toolchain/check/operator.h"
  41. #include "toolchain/check/pattern.h"
  42. #include "toolchain/check/pattern_match.h"
  43. #include "toolchain/check/type.h"
  44. #include "toolchain/check/type_completion.h"
  45. #include "toolchain/diagnostics/diagnostic.h"
  46. #include "toolchain/diagnostics/diagnostic_emitter.h"
  47. #include "toolchain/diagnostics/format_providers.h"
  48. #include "toolchain/parse/node_ids.h"
  49. #include "toolchain/sem_ir/clang_decl.h"
  50. #include "toolchain/sem_ir/class.h"
  51. #include "toolchain/sem_ir/cpp_overload_set.h"
  52. #include "toolchain/sem_ir/function.h"
  53. #include "toolchain/sem_ir/ids.h"
  54. #include "toolchain/sem_ir/inst.h"
  55. #include "toolchain/sem_ir/name_scope.h"
  56. #include "toolchain/sem_ir/typed_insts.h"
  57. namespace Carbon::Check {
  58. // Add a line marker directive pointing at the location of the `import Cpp`
  59. // declaration in the Carbon source file. This will cause Clang's diagnostics
  60. // machinery to track and report the location in Carbon code where the import
  61. // was written.
  62. static auto GenerateLineMarker(Context& context, llvm::raw_ostream& out,
  63. int line) {
  64. out << "# " << line << " \""
  65. << FormatEscaped(context.tokens().source().filename()) << "\"\n";
  66. }
  67. // Generates C++ file contents to #include all requested imports.
  68. static auto GenerateCppIncludesHeaderCode(
  69. Context& context, llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
  70. -> std::string {
  71. std::string code;
  72. llvm::raw_string_ostream code_stream(code);
  73. for (const Parse::Tree::PackagingNames& import : imports) {
  74. if (import.inline_body_id.has_value()) {
  75. // Expand `import Cpp inline "code";` directly into the specified code.
  76. auto code_token = context.parse_tree().node_token(import.inline_body_id);
  77. // Compute the line number on which the C++ code starts. Usually the code
  78. // is specified as a block string literal and starts on the line after the
  79. // start of the string token.
  80. // TODO: Determine if this is a block string literal without calling
  81. // `GetTokenText`, which re-lexes the string.
  82. int line = context.tokens().GetLineNumber(code_token);
  83. if (context.tokens().GetTokenText(code_token).contains('\n')) {
  84. ++line;
  85. }
  86. GenerateLineMarker(context, code_stream, line);
  87. code_stream << context.string_literal_values().Get(
  88. context.tokens().GetStringLiteralValue(code_token))
  89. << "\n";
  90. // TODO: Inject a clang pragma here to produce an error if there are
  91. // unclosed scopes at the end of this inline C++ fragment.
  92. } else {
  93. // Translate `import Cpp library "foo.h";` into `#include "foo.h"`.
  94. GenerateLineMarker(context, code_stream,
  95. context.tokens().GetLineNumber(
  96. context.parse_tree().node_token(import.node_id)));
  97. code_stream << "#include \""
  98. << FormatEscaped(
  99. context.string_literal_values().Get(import.library_id))
  100. << "\"\n";
  101. }
  102. }
  103. // Inject a declaration of placement operator new, because the code we
  104. // generate in thunks depends on it for placement new expressions. Clang has
  105. // special-case logic for lowering a new-expression using this, so a
  106. // definition is not required.
  107. // TODO: This is a hack. We should be able to directly generate Clang AST to
  108. // construct objects in-place without this.
  109. // TODO: Once we can rely on libc++ being available, consider including
  110. // `<__new/placement_new_delete.h>` instead.
  111. code_stream << R"(# 1 "<carbon-internal>"
  112. #undef constexpr
  113. #if __cplusplus > 202302L
  114. constexpr
  115. #endif
  116. #undef void
  117. #undef operator
  118. #undef new
  119. void* operator new(__SIZE_TYPE__, void*)
  120. #if __cplusplus < 201103L
  121. #undef throw
  122. throw()
  123. #else
  124. #undef noexcept
  125. noexcept
  126. #endif
  127. ;
  128. )";
  129. return code;
  130. }
  131. // Adds the name to the scope with the given `access_kind` and `inst_id`.
  132. // `inst_id` must have a value.
  133. static auto AddNameToScope(Context& context, SemIR::NameScopeId scope_id,
  134. SemIR::NameId name_id, SemIR::AccessKind access_kind,
  135. SemIR::InstId inst_id) -> void {
  136. CARBON_CHECK(inst_id.has_value());
  137. context.name_scopes().Get(scope_id).AddRequired(
  138. {.name_id = name_id,
  139. .result = SemIR::ScopeLookupResult::MakeFound(inst_id, access_kind)});
  140. }
  141. // Maps a Clang name to a Carbon `NameId`.
  142. static auto AddIdentifierName(Context& context, llvm::StringRef name)
  143. -> SemIR::NameId {
  144. return SemIR::NameId::ForIdentifier(context.identifiers().Add(name));
  145. }
  146. // Adds the given source location and an `ImportIRInst` referring to it in
  147. // `ImportIRId::Cpp`.
  148. static auto AddImportIRInst(SemIR::File& file,
  149. clang::SourceLocation clang_source_loc)
  150. -> SemIR::ImportIRInstId {
  151. SemIR::ClangSourceLocId clang_source_loc_id =
  152. file.clang_source_locs().Add(clang_source_loc);
  153. return file.import_ir_insts().Add(SemIR::ImportIRInst(clang_source_loc_id));
  154. }
  155. namespace {
  156. // Used to convert Clang diagnostics to Carbon diagnostics.
  157. //
  158. // Handling of Clang notes is a little subtle: as far as Clang is concerned,
  159. // notes are separate diagnostics, not connected to the error or warning that
  160. // precedes them. But in Carbon's diagnostics system, notes are part of the
  161. // enclosing diagnostic. To handle this, we buffer Clang diagnostics until we
  162. // reach a point where we know we're not in the middle of a diagnostic, and then
  163. // emit a diagnostic along with all of its notes. This is triggered when adding
  164. // or removing a Carbon context note, which could otherwise get attached to the
  165. // wrong C++ diagnostics, and at the end of the Carbon program.
  166. class CarbonClangDiagnosticConsumer : public clang::DiagnosticConsumer {
  167. public:
  168. // Creates an instance with the location that triggers calling Clang. The
  169. // `context` is not stored here, and the diagnostics consumer is expected to
  170. // outlive it.
  171. explicit CarbonClangDiagnosticConsumer(
  172. Context& context, std::shared_ptr<clang::CompilerInvocation> invocation)
  173. : sem_ir_(&context.sem_ir()),
  174. emitter_(&context.emitter()),
  175. invocation_(std::move(invocation)) {
  176. emitter_->AddFlushFn([this] { EmitDiagnostics(); });
  177. }
  178. ~CarbonClangDiagnosticConsumer() override {
  179. // Do not inspect `emitter_` here; it's typically destroyed before the
  180. // consumer is.
  181. // TODO: If Clang produces diagnostics after check finishes, they'll get
  182. // added to the list of pending diagnostics and never emitted.
  183. CARBON_CHECK(diagnostic_infos_.empty(),
  184. "Missing flush before destroying diagnostic consumer");
  185. }
  186. // Generates a Carbon warning for each Clang warning and a Carbon error for
  187. // each Clang error or fatal.
  188. auto HandleDiagnostic(clang::DiagnosticsEngine::Level diag_level,
  189. const clang::Diagnostic& info) -> void override {
  190. DiagnosticConsumer::HandleDiagnostic(diag_level, info);
  191. SemIR::ImportIRInstId clang_import_ir_inst_id =
  192. AddImportIRInst(*sem_ir_, info.getLocation());
  193. llvm::SmallString<256> message;
  194. info.FormatDiagnostic(message);
  195. // Render a code snippet including any highlighted ranges and fixit hints.
  196. // TODO: Also include the #include stack and macro expansion stack in the
  197. // diagnostic output in some way.
  198. RawStringOstream snippet_stream;
  199. if (!info.hasSourceManager()) {
  200. // If we don't have a source manager, this is an error from early in the
  201. // frontend. Don't produce a snippet.
  202. CARBON_CHECK(info.getLocation().isInvalid());
  203. } else {
  204. CodeContextRenderer(snippet_stream, invocation_->getLangOpts(),
  205. invocation_->getDiagnosticOpts())
  206. .emitDiagnostic(
  207. clang::FullSourceLoc(info.getLocation(), info.getSourceManager()),
  208. diag_level, message, info.getRanges(), info.getFixItHints());
  209. }
  210. diagnostic_infos_.push_back({.level = diag_level,
  211. .import_ir_inst_id = clang_import_ir_inst_id,
  212. .message = message.str().str(),
  213. .snippet = snippet_stream.TakeStr()});
  214. }
  215. // Returns the diagnostic to use for a given Clang diagnostic level.
  216. static auto GetDiagnostic(clang::DiagnosticsEngine::Level level)
  217. -> const Diagnostics::DiagnosticBase<std::string>& {
  218. switch (level) {
  219. case clang::DiagnosticsEngine::Ignored: {
  220. CARBON_FATAL("Emitting an ignored diagnostic");
  221. break;
  222. }
  223. case clang::DiagnosticsEngine::Note: {
  224. CARBON_DIAGNOSTIC(CppInteropParseNote, Note, "{0}", std::string);
  225. return CppInteropParseNote;
  226. }
  227. case clang::DiagnosticsEngine::Remark:
  228. case clang::DiagnosticsEngine::Warning: {
  229. // TODO: Add a distinct Remark level to Carbon diagnostics, and stop
  230. // mapping remarks to warnings.
  231. CARBON_DIAGNOSTIC(CppInteropParseWarning, Warning, "{0}", std::string);
  232. return CppInteropParseWarning;
  233. }
  234. case clang::DiagnosticsEngine::Error:
  235. case clang::DiagnosticsEngine::Fatal: {
  236. CARBON_DIAGNOSTIC(CppInteropParseError, Error, "{0}", std::string);
  237. return CppInteropParseError;
  238. }
  239. }
  240. }
  241. // Outputs Carbon diagnostics based on the collected Clang diagnostics. Must
  242. // be called after the AST is set in the context.
  243. auto EmitDiagnostics() -> void {
  244. CARBON_CHECK(sem_ir_->clang_ast_unit(),
  245. "Attempted to emit diagnostics before the AST Unit is loaded");
  246. for (size_t i = 0; i != diagnostic_infos_.size(); ++i) {
  247. const ClangDiagnosticInfo& info = diagnostic_infos_[i];
  248. auto builder = emitter_->Build(SemIR::LocId(info.import_ir_inst_id),
  249. GetDiagnostic(info.level), info.message);
  250. builder.OverrideSnippet(info.snippet);
  251. for (; i + 1 < diagnostic_infos_.size() &&
  252. diagnostic_infos_[i + 1].level == clang::DiagnosticsEngine::Note;
  253. ++i) {
  254. const ClangDiagnosticInfo& note_info = diagnostic_infos_[i + 1];
  255. builder
  256. .Note(SemIR::LocId(note_info.import_ir_inst_id),
  257. GetDiagnostic(note_info.level), note_info.message)
  258. .OverrideSnippet(note_info.snippet);
  259. }
  260. // TODO: This will apply all current Carbon annotation functions. We
  261. // should instead track how Clang's context notes and Carbon's annotation
  262. // functions are interleaved, and interleave the notes in the same order.
  263. builder.Emit();
  264. }
  265. diagnostic_infos_.clear();
  266. }
  267. private:
  268. // A diagnostics renderer based on clang's TextDiagnostic that captures just
  269. // the code context (the snippet).
  270. class CodeContextRenderer : public clang::TextDiagnostic {
  271. public:
  272. using TextDiagnostic::TextDiagnostic;
  273. void emitDiagnosticMessage(
  274. clang::FullSourceLoc /*loc*/, clang::PresumedLoc /*ploc*/,
  275. clang::DiagnosticsEngine::Level /*level*/, llvm::StringRef /*message*/,
  276. llvm::ArrayRef<clang::CharSourceRange> /*ranges*/,
  277. clang::DiagOrStoredDiag /*info*/) override {}
  278. void emitDiagnosticLoc(
  279. clang::FullSourceLoc /*loc*/, clang::PresumedLoc /*ploc*/,
  280. clang::DiagnosticsEngine::Level /*level*/,
  281. llvm::ArrayRef<clang::CharSourceRange> /*ranges*/) override {}
  282. // emitCodeContext is inherited from clang::TextDiagnostic.
  283. void emitIncludeLocation(clang::FullSourceLoc /*loc*/,
  284. clang::PresumedLoc /*ploc*/) override {}
  285. void emitImportLocation(clang::FullSourceLoc /*loc*/,
  286. clang::PresumedLoc /*ploc*/,
  287. llvm::StringRef /*module_name*/) override {}
  288. void emitBuildingModuleLocation(clang::FullSourceLoc /*loc*/,
  289. clang::PresumedLoc /*ploc*/,
  290. llvm::StringRef /*module_name*/) override {}
  291. // beginDiagnostic and endDiagnostic are inherited from
  292. // clang::TextDiagnostic in case it wants to do any setup / teardown work.
  293. };
  294. // Information on a Clang diagnostic that can be converted to a Carbon
  295. // diagnostic.
  296. struct ClangDiagnosticInfo {
  297. // The Clang diagnostic level.
  298. clang::DiagnosticsEngine::Level level;
  299. // The ID of the ImportIR instruction referring to the Clang source
  300. // location.
  301. SemIR::ImportIRInstId import_ir_inst_id;
  302. // The Clang diagnostic textual message.
  303. std::string message;
  304. // The code snippet produced by clang.
  305. std::string snippet;
  306. };
  307. // The Carbon file that this C++ compilation is attached to.
  308. SemIR::File* sem_ir_;
  309. // The diagnostic emitter that we're emitting diagnostics into.
  310. DiagnosticEmitterBase* emitter_;
  311. // The compiler invocation that is producing the diagnostics.
  312. std::shared_ptr<clang::CompilerInvocation> invocation_;
  313. // Collects the information for all Clang diagnostics to be converted to
  314. // Carbon diagnostics after the context has been initialized with the Clang
  315. // AST.
  316. llvm::SmallVector<ClangDiagnosticInfo> diagnostic_infos_;
  317. };
  318. // A wrapper around a clang::CompilerInvocation that allows us to make a shallow
  319. // copy of most of the invocation and only make a deep copy of the parts that we
  320. // want to change.
  321. //
  322. // clang::CowCompilerInvocation almost allows this, but doesn't derive from
  323. // CompilerInvocation or support shallow copies from a CompilerInvocation, so is
  324. // not useful to us as we can't build an ASTUnit from it.
  325. class ShallowCopyCompilerInvocation : public clang::CompilerInvocation {
  326. public:
  327. explicit ShallowCopyCompilerInvocation(
  328. const clang::CompilerInvocation& invocation) {
  329. shallow_copy_assign(invocation);
  330. // The preprocessor options are modified to hold a replacement includes
  331. // buffer, so make our own version of those options.
  332. PPOpts = std::make_shared<clang::PreprocessorOptions>(*PPOpts);
  333. }
  334. };
  335. } // namespace
  336. // Returns an AST for the C++ imports and a bool that represents whether
  337. // compilation errors where encountered or the generated AST is null due to an
  338. // error. Sets the AST in the context's `sem_ir`.
  339. // TODO: Consider to always have a (non-null) AST.
  340. static auto GenerateAst(
  341. Context& context, llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
  342. llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs,
  343. std::shared_ptr<clang::CompilerInvocation> base_invocation)
  344. -> std::pair<std::unique_ptr<clang::ASTUnit>, bool> {
  345. auto invocation =
  346. std::make_shared<ShallowCopyCompilerInvocation>(*base_invocation);
  347. // Build a diagnostics engine.
  348. llvm::IntrusiveRefCntPtr<clang::DiagnosticsEngine> diags(
  349. clang::CompilerInstance::createDiagnostics(
  350. *fs, invocation->getDiagnosticOpts(),
  351. new CarbonClangDiagnosticConsumer(context, invocation),
  352. /*ShouldOwnClient=*/true));
  353. // Extract the input from the frontend invocation and make sure it makes
  354. // sense.
  355. const auto& inputs = invocation->getFrontendOpts().Inputs;
  356. CARBON_CHECK(inputs.size() == 1 &&
  357. inputs[0].getKind().getLanguage() == clang::Language::CXX &&
  358. inputs[0].getKind().getFormat() == clang::InputKind::Source);
  359. llvm::StringRef file_name = inputs[0].getFile();
  360. // Remap the imports file name to the corresponding `#include`s.
  361. // TODO: Modify the frontend options to specify this memory buffer as input
  362. // instead of remapping the file.
  363. std::string includes = GenerateCppIncludesHeaderCode(context, imports);
  364. auto includes_buffer =
  365. llvm::MemoryBuffer::getMemBufferCopy(includes, file_name);
  366. invocation->getPreprocessorOpts().addRemappedFile(file_name,
  367. includes_buffer.release());
  368. clang::DiagnosticErrorTrap trap(*diags);
  369. // Create the AST unit.
  370. auto ast = clang::ASTUnit::LoadFromCompilerInvocation(
  371. invocation, std::make_shared<clang::PCHContainerOperations>(), nullptr,
  372. diags, new clang::FileManager(invocation->getFileSystemOpts(), fs));
  373. // Attach the AST to SemIR. This needs to be done before we can emit any
  374. // diagnostics, so their locations can be properly interpreted by our
  375. // diagnostics machinery.
  376. context.sem_ir().set_clang_ast_unit(ast.get());
  377. // Emit any diagnostics we queued up while building the AST.
  378. context.emitter().Flush();
  379. return {std::move(ast), !ast || trap.hasErrorOccurred()};
  380. }
  381. // Adds a namespace for the `Cpp` import and returns its `NameScopeId`.
  382. static auto AddNamespace(Context& context, PackageNameId cpp_package_id,
  383. llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
  384. -> SemIR::NameScopeId {
  385. auto& import_cpps = context.sem_ir().import_cpps();
  386. import_cpps.Reserve(imports.size());
  387. for (const Parse::Tree::PackagingNames& import : imports) {
  388. import_cpps.Add({.node_id = context.parse_tree().As<Parse::ImportDeclId>(
  389. import.node_id),
  390. .library_id = import.library_id});
  391. }
  392. return AddImportNamespaceToScope(
  393. context,
  394. GetSingletonType(context, SemIR::NamespaceType::TypeInstId),
  395. SemIR::NameId::ForPackageName(cpp_package_id),
  396. SemIR::NameScopeId::Package,
  397. /*diagnose_duplicate_namespace=*/false,
  398. [&]() {
  399. return AddInst<SemIR::ImportCppDecl>(
  400. context,
  401. context.parse_tree().As<Parse::ImportDeclId>(
  402. imports.front().node_id),
  403. {});
  404. })
  405. .add_result.name_scope_id;
  406. }
  407. auto ImportCppFiles(Context& context,
  408. llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
  409. llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs,
  410. std::shared_ptr<clang::CompilerInvocation> invocation)
  411. -> std::unique_ptr<clang::ASTUnit> {
  412. if (imports.empty()) {
  413. return nullptr;
  414. }
  415. CARBON_CHECK(!context.sem_ir().clang_ast_unit());
  416. PackageNameId package_id = imports.front().package_id;
  417. CARBON_CHECK(
  418. llvm::all_of(imports, [&](const Parse::Tree::PackagingNames& import) {
  419. return import.package_id == package_id;
  420. }));
  421. auto name_scope_id = AddNamespace(context, package_id, imports);
  422. auto [generated_ast, ast_has_error] =
  423. GenerateAst(context, imports, fs, std::move(invocation));
  424. SemIR::NameScope& name_scope = context.name_scopes().Get(name_scope_id);
  425. name_scope.set_is_closed_import(true);
  426. name_scope.set_clang_decl_context_id(context.sem_ir().clang_decls().Add(
  427. {.decl = generated_ast->getASTContext().getTranslationUnitDecl(),
  428. .inst_id = name_scope.inst_id()}));
  429. if (ast_has_error) {
  430. name_scope.set_has_error();
  431. }
  432. return std::move(generated_ast);
  433. }
  434. // Returns the Clang `DeclContext` for the given name scope. Return the
  435. // translation unit decl if no scope is provided.
  436. static auto GetDeclContext(Context& context, SemIR::NameScopeId scope_id)
  437. -> clang::DeclContext* {
  438. if (!scope_id.has_value()) {
  439. return context.ast_context().getTranslationUnitDecl();
  440. }
  441. auto scope_clang_decl_context_id =
  442. context.name_scopes().Get(scope_id).clang_decl_context_id();
  443. return dyn_cast<clang::DeclContext>(
  444. context.sem_ir().clang_decls().Get(scope_clang_decl_context_id).decl);
  445. }
  446. static auto ClangLookup(Context& context, SemIR::NameScopeId scope_id,
  447. clang::DeclarationName name)
  448. -> std::optional<clang::LookupResult> {
  449. clang::ASTUnit* ast = context.sem_ir().clang_ast_unit();
  450. CARBON_CHECK(ast);
  451. clang::Sema& sema = ast->getSema();
  452. // TODO: Map the LocId of the lookup to a clang SourceLocation and provide it
  453. // here so that clang's diagnostics can point into the carbon code that uses
  454. // the name.
  455. clang::LookupResult lookup(
  456. sema, clang::DeclarationNameInfo(name, clang::SourceLocation()),
  457. clang::Sema::LookupNameKind::LookupOrdinaryName);
  458. bool found =
  459. sema.LookupQualifiedName(lookup, GetDeclContext(context, scope_id));
  460. if (!found) {
  461. return std::nullopt;
  462. }
  463. return lookup;
  464. }
  465. // Looks up the given declaration name in the Clang AST in a specific scope.
  466. // Returns the found declaration and its access. If not found, returns
  467. // `nullopt`. If there's not a single result, returns `nullptr` and default
  468. // access.
  469. static auto ClangLookupDeclarationName(Context& context, SemIR::LocId loc_id,
  470. SemIR::NameScopeId scope_id,
  471. clang::DeclarationName name)
  472. -> std::optional<std::tuple<clang::NamedDecl*, clang::AccessSpecifier>> {
  473. auto lookup = ClangLookup(context, scope_id, name);
  474. if (!lookup) {
  475. return std::nullopt;
  476. }
  477. std::tuple<clang::NamedDecl*, clang::AccessSpecifier> result{
  478. nullptr, clang::AccessSpecifier::AS_none};
  479. // Access checks are performed separately by the Carbon name lookup logic.
  480. lookup->suppressAccessDiagnostics();
  481. if (!lookup->isSingleResult()) {
  482. // Clang will diagnose ambiguous lookup results for us.
  483. if (!lookup->isAmbiguous()) {
  484. context.TODO(loc_id,
  485. llvm::formatv("Unsupported: Lookup succeeded but couldn't "
  486. "find a single result; LookupResultKind: {0}",
  487. static_cast<int>(lookup->getResultKind())));
  488. }
  489. return result;
  490. }
  491. result = {lookup->getFoundDecl(), lookup->begin().getAccess()};
  492. return result;
  493. }
  494. // Looks up for constructors in the class scope and returns the lookup result.
  495. static auto ClangConstructorLookup(const Context& context,
  496. SemIR::NameScopeId scope_id)
  497. -> clang::DeclContextLookupResult {
  498. const SemIR::NameScope& scope = context.sem_ir().name_scopes().Get(scope_id);
  499. clang::Sema& sema = context.sem_ir().clang_ast_unit()->getSema();
  500. clang::Decl* decl =
  501. context.sem_ir().clang_decls().Get(scope.clang_decl_context_id()).decl;
  502. return sema.LookupConstructors(cast<clang::CXXRecordDecl>(decl));
  503. }
  504. // Returns true if the given Clang declaration is the implicit injected class
  505. // name within the class.
  506. static auto IsDeclInjectedClassName(const Context& context,
  507. SemIR::NameScopeId scope_id,
  508. SemIR::NameId name_id,
  509. const clang::NamedDecl* named_decl)
  510. -> bool {
  511. if (!named_decl->isImplicit()) {
  512. return false;
  513. }
  514. const auto* record_decl = dyn_cast<clang::CXXRecordDecl>(named_decl);
  515. if (!record_decl) {
  516. return false;
  517. }
  518. const SemIR::ClangDecl& clang_decl = context.sem_ir().clang_decls().Get(
  519. context.sem_ir().name_scopes().Get(scope_id).clang_decl_context_id());
  520. const auto* scope_record_decl = cast<clang::CXXRecordDecl>(clang_decl.decl);
  521. const clang::ASTContext& ast_context =
  522. context.sem_ir().clang_ast_unit()->getASTContext();
  523. CARBON_CHECK(ast_context.getCanonicalTagType(scope_record_decl) ==
  524. ast_context.getCanonicalTagType(record_decl));
  525. auto class_decl =
  526. context.sem_ir().insts().GetAs<SemIR::ClassDecl>(clang_decl.inst_id);
  527. CARBON_CHECK(name_id ==
  528. context.sem_ir().classes().Get(class_decl.class_id).name_id);
  529. return true;
  530. }
  531. // Returns a Clang DeclarationName for the given `NameId`.
  532. static auto GetDeclarationName(Context& context, SemIR::NameId name_id)
  533. -> std::optional<clang::DeclarationName> {
  534. std::optional<llvm::StringRef> name =
  535. context.names().GetAsStringIfIdentifier(name_id);
  536. if (!name) {
  537. // Special names never exist in C++ code.
  538. return std::nullopt;
  539. }
  540. return clang::DeclarationName(context.sem_ir()
  541. .clang_ast_unit()
  542. ->getSema()
  543. .getPreprocessor()
  544. .getIdentifierInfo(*name));
  545. }
  546. // Looks up the given name in the Clang AST in a specific scope. Returns the
  547. // lookup result if lookup was successful.
  548. // TODO: Merge this with `ClangLookupDeclarationName`.
  549. static auto ClangLookupName(Context& context, SemIR::NameScopeId scope_id,
  550. SemIR::NameId name_id)
  551. -> std::optional<clang::LookupResult> {
  552. auto declaration_name = GetDeclarationName(context, name_id);
  553. if (!declaration_name) {
  554. return std::nullopt;
  555. }
  556. return ClangLookup(context, scope_id, *declaration_name);
  557. }
  558. // Returns whether `decl` already mapped to an instruction.
  559. static auto IsClangDeclImported(const Context& context, clang::Decl* decl)
  560. -> bool {
  561. return context.sem_ir()
  562. .clang_decls()
  563. .Lookup(decl->getCanonicalDecl())
  564. .has_value();
  565. }
  566. // If `decl` already mapped to an instruction, returns that instruction.
  567. // Otherwise returns `None`.
  568. static auto LookupClangDeclInstId(const Context& context, clang::Decl* decl)
  569. -> SemIR::InstId {
  570. const auto& clang_decls = context.sem_ir().clang_decls();
  571. if (auto context_clang_decl_id = clang_decls.Lookup(decl->getCanonicalDecl());
  572. context_clang_decl_id.has_value()) {
  573. return clang_decls.Get(context_clang_decl_id).inst_id;
  574. }
  575. return SemIR::InstId::None;
  576. }
  577. // Returns the parent of the given declaration. Skips declaration types we
  578. // ignore.
  579. static auto GetParentDecl(clang::Decl* clang_decl) -> clang::Decl* {
  580. auto* parent_dc = clang_decl->getDeclContext();
  581. while (!parent_dc->isLookupContext()) {
  582. parent_dc = parent_dc->getParent();
  583. }
  584. return cast<clang::Decl>(parent_dc);
  585. }
  586. // Returns the given declaration's parent scope. Assumes the parent declaration
  587. // was already imported.
  588. static auto GetParentNameScopeId(Context& context, clang::Decl* clang_decl)
  589. -> SemIR::NameScopeId {
  590. SemIR::InstId parent_inst_id =
  591. LookupClangDeclInstId(context, GetParentDecl(clang_decl));
  592. CARBON_CHECK(parent_inst_id.has_value());
  593. CARBON_KIND_SWITCH(context.insts().Get(parent_inst_id)) {
  594. case CARBON_KIND(SemIR::ClassDecl class_decl): {
  595. return context.classes().Get(class_decl.class_id).scope_id;
  596. }
  597. case CARBON_KIND(SemIR::InterfaceDecl interface_decl): {
  598. return context.interfaces().Get(interface_decl.interface_id).scope_id;
  599. }
  600. case CARBON_KIND(SemIR::Namespace namespace_inst): {
  601. return namespace_inst.name_scope_id;
  602. }
  603. default: {
  604. CARBON_FATAL("Unexpected parent instruction kind");
  605. }
  606. }
  607. }
  608. // Imports a namespace declaration from Clang to Carbon. If successful, returns
  609. // the new Carbon namespace declaration `InstId`. If the declaration was already
  610. // imported, returns the mapped instruction.
  611. static auto ImportNamespaceDecl(Context& context,
  612. clang::NamespaceDecl* clang_decl)
  613. -> SemIR::InstId {
  614. // Check if the declaration is already mapped.
  615. if (SemIR::InstId existing_inst_id =
  616. LookupClangDeclInstId(context, clang_decl);
  617. existing_inst_id.has_value()) {
  618. return existing_inst_id;
  619. }
  620. auto result = AddImportNamespace(
  621. context, GetSingletonType(context, SemIR::NamespaceType::TypeInstId),
  622. AddIdentifierName(context, clang_decl->getName()),
  623. GetParentNameScopeId(context, clang_decl),
  624. /*import_id=*/SemIR::InstId::None);
  625. context.name_scopes()
  626. .Get(result.name_scope_id)
  627. .set_clang_decl_context_id(context.sem_ir().clang_decls().Add(
  628. {.decl = clang_decl->getCanonicalDecl(), .inst_id = result.inst_id}));
  629. return result.inst_id;
  630. }
  631. static auto ImportTypeAndDependencies(Context& context, SemIR::LocId loc_id,
  632. clang::QualType type) -> TypeExpr;
  633. // Creates a class declaration for the given class name in the given scope.
  634. // Returns the `InstId` for the declaration.
  635. static auto BuildClassDecl(Context& context,
  636. SemIR::ImportIRInstId import_ir_inst_id,
  637. SemIR::NameScopeId parent_scope_id,
  638. SemIR::NameId name_id)
  639. -> std::tuple<SemIR::ClassId, SemIR::TypeInstId> {
  640. // Add the class declaration.
  641. auto class_decl = SemIR::ClassDecl{.type_id = SemIR::TypeType::TypeId,
  642. .class_id = SemIR::ClassId::None,
  643. .decl_block_id = SemIR::InstBlockId::None};
  644. auto class_decl_id = AddPlaceholderInstInNoBlock(
  645. context,
  646. SemIR::LocIdAndInst::UncheckedLoc(import_ir_inst_id, class_decl));
  647. context.imports().push_back(class_decl_id);
  648. SemIR::Class class_info = {
  649. {.name_id = name_id,
  650. .parent_scope_id = parent_scope_id,
  651. .generic_id = SemIR::GenericId::None,
  652. .first_param_node_id = Parse::NodeId::None,
  653. .last_param_node_id = Parse::NodeId::None,
  654. .pattern_block_id = SemIR::InstBlockId::None,
  655. .implicit_param_patterns_id = SemIR::InstBlockId::None,
  656. .param_patterns_id = SemIR::InstBlockId::None,
  657. .is_extern = false,
  658. .extern_library_id = SemIR::LibraryNameId::None,
  659. .non_owning_decl_id = SemIR::InstId::None,
  660. .first_owning_decl_id = class_decl_id},
  661. {// `.self_type_id` depends on the ClassType, so is set below.
  662. .self_type_id = SemIR::TypeId::None,
  663. // TODO: Support Dynamic classes.
  664. // TODO: Support Final classes.
  665. .inheritance_kind = SemIR::Class::Base}};
  666. class_decl.class_id = context.classes().Add(class_info);
  667. // Write the class ID into the ClassDecl.
  668. ReplaceInstBeforeConstantUse(context, class_decl_id, class_decl);
  669. SetClassSelfType(context, class_decl.class_id);
  670. return {class_decl.class_id, context.types().GetAsTypeInstId(class_decl_id)};
  671. }
  672. // Imports a tag declaration from Clang to Carbon. This covers classes (which
  673. // includes structs and unions) as well as enums. If successful, returns the new
  674. // Carbon class declaration `InstId`.
  675. static auto ImportTagDecl(Context& context, clang::TagDecl* clang_decl)
  676. -> SemIR::InstId {
  677. auto import_ir_inst_id =
  678. AddImportIRInst(context.sem_ir(), clang_decl->getLocation());
  679. auto [class_id, class_inst_id] = BuildClassDecl(
  680. context, import_ir_inst_id, GetParentNameScopeId(context, clang_decl),
  681. AddIdentifierName(context, clang_decl->getName()));
  682. // TODO: The caller does the same lookup. Avoid doing it twice.
  683. auto clang_decl_id = context.sem_ir().clang_decls().Add(
  684. {.decl = clang_decl->getCanonicalDecl(), .inst_id = class_inst_id});
  685. // Name lookup into the Carbon class looks in the C++ class definition.
  686. auto& class_info = context.classes().Get(class_id);
  687. class_info.scope_id = context.name_scopes().Add(
  688. class_inst_id, SemIR::NameId::None, class_info.parent_scope_id);
  689. context.name_scopes()
  690. .Get(class_info.scope_id)
  691. .set_clang_decl_context_id(clang_decl_id);
  692. return class_inst_id;
  693. }
  694. // Determines the Carbon inheritance kind to use for a C++ class definition.
  695. static auto GetInheritanceKind(clang::CXXRecordDecl* class_def)
  696. -> SemIR::Class::InheritanceKind {
  697. if (class_def->isUnion()) {
  698. // Treat all unions as final classes to match their C++ semantics. While we
  699. // could support this, the author of a C++ union has no way to mark their
  700. // type as `final` to prevent it, and so we assume the intent was to
  701. // disallow inheritance.
  702. return SemIR::Class::Final;
  703. }
  704. if (class_def->hasAttr<clang::FinalAttr>()) {
  705. // The class is final in C++; don't allow Carbon types to derive from it.
  706. // Note that such a type might also be abstract in C++; we treat final as
  707. // taking precedence.
  708. //
  709. // We could also treat classes with a final destructor as being final, as
  710. // Clang does when determining whether a class is "effectively final", but
  711. // to keep our rules simpler we do not.
  712. return SemIR::Class::Final;
  713. }
  714. if (class_def->isAbstract()) {
  715. // If the class has any abstract members, it's abstract.
  716. return SemIR::Class::Abstract;
  717. }
  718. // Allow inheritance from any other C++ class type.
  719. return SemIR::Class::Base;
  720. }
  721. // Checks that the specified finished class definition is valid and builds and
  722. // returns a corresponding complete type witness instruction.
  723. static auto ImportClassObjectRepr(Context& context, SemIR::ClassId class_id,
  724. SemIR::ImportIRInstId import_ir_inst_id,
  725. SemIR::TypeInstId class_type_inst_id,
  726. const clang::CXXRecordDecl* clang_def)
  727. -> SemIR::TypeInstId {
  728. if (clang_def->isInvalidDecl()) {
  729. // Clang already diagnosed this error.
  730. return SemIR::ErrorInst::TypeInstId;
  731. }
  732. // For now, if the class is empty, produce an empty struct as the object
  733. // representation. This allows our tests to continue to pass while we don't
  734. // properly support initializing imported C++ classes.
  735. // TODO: Remove this.
  736. if (clang_def->isEmpty() && !clang_def->getNumBases()) {
  737. return context.types().GetAsTypeInstId(AddInst(
  738. context,
  739. MakeImportedLocIdAndInst(
  740. context, import_ir_inst_id,
  741. SemIR::StructType{.type_id = SemIR::TypeType::TypeId,
  742. .fields_id = SemIR::StructTypeFieldsId::Empty})));
  743. }
  744. const auto& clang_layout =
  745. context.ast_context().getASTRecordLayout(clang_def);
  746. llvm::SmallVector<uint64_t> layout;
  747. llvm::SmallVector<SemIR::StructTypeField> fields;
  748. static_assert(SemIR::CustomLayoutId::SizeIndex == 0);
  749. layout.push_back(clang_layout.getSize().getQuantity());
  750. static_assert(SemIR::CustomLayoutId::AlignIndex == 1);
  751. layout.push_back(clang_layout.getAlignment().getQuantity());
  752. static_assert(SemIR::CustomLayoutId::FirstFieldIndex == 2);
  753. // TODO: Import vptr(s).
  754. // Import bases.
  755. for (const auto& base : clang_def->bases()) {
  756. CARBON_CHECK(!base.isVirtual(),
  757. "Should not import definition for class with a virtual base");
  758. auto [base_type_inst_id, base_type_id] =
  759. ImportTypeAndDependencies(context, import_ir_inst_id, base.getType());
  760. if (!base_type_id.has_value()) {
  761. // TODO: If the base class's type can't be mapped, skip it.
  762. continue;
  763. }
  764. auto base_decl_id = AddInst(
  765. context,
  766. MakeImportedLocIdAndInst(
  767. context, import_ir_inst_id,
  768. SemIR::BaseDecl{.type_id = GetUnboundElementType(
  769. context, class_type_inst_id, base_type_inst_id),
  770. .base_type_inst_id = base_type_inst_id,
  771. .index = SemIR::ElementIndex(fields.size())}));
  772. // If there's exactly one base class, treat it as a Carbon base class too.
  773. // TODO: Improve handling for the case where the class has multiple base
  774. // classes.
  775. if (clang_def->getNumBases() == 1) {
  776. auto& class_info = context.classes().Get(class_id);
  777. CARBON_CHECK(!class_info.base_id.has_value());
  778. class_info.base_id = base_decl_id;
  779. }
  780. auto* base_class = base.getType()->getAsCXXRecordDecl();
  781. CARBON_CHECK(base_class, "Base class {0} is not a class",
  782. base.getType().getAsString());
  783. auto base_offset = base.isVirtual()
  784. ? clang_layout.getVBaseClassOffset(base_class)
  785. : clang_layout.getBaseClassOffset(base_class);
  786. layout.push_back(base_offset.getQuantity());
  787. fields.push_back(
  788. {.name_id = SemIR::NameId::Base, .type_inst_id = base_type_inst_id});
  789. }
  790. // Import fields.
  791. for (auto* decl : clang_def->decls()) {
  792. auto* field = dyn_cast<clang::FieldDecl>(decl);
  793. // Track the chain of fields from the class to this field. This chain is
  794. // only one element long unless the field is a member of an anonymous struct
  795. // or union.
  796. clang::NamedDecl* single_field_chain[1] = {field};
  797. llvm::ArrayRef<clang::NamedDecl*> chain = single_field_chain;
  798. // If this isn't a field, it might be an indirect field in an anonymous
  799. // struct or union.
  800. if (!field) {
  801. auto* indirect_field = dyn_cast<clang::IndirectFieldDecl>(decl);
  802. if (!indirect_field) {
  803. continue;
  804. }
  805. chain = indirect_field->chain();
  806. field = indirect_field->getAnonField();
  807. }
  808. if (field->isBitField()) {
  809. // TODO: Add a representation for named bitfield members.
  810. continue;
  811. }
  812. if (field->isAnonymousStructOrUnion()) {
  813. // Fields within an anonymous structure or union will be added via their
  814. // IndirectFieldDecls.
  815. continue;
  816. }
  817. auto field_name_id = AddIdentifierName(context, field->getName());
  818. auto [field_type_inst_id, field_type_id] =
  819. ImportTypeAndDependencies(context, import_ir_inst_id, field->getType());
  820. if (!field_type_inst_id.has_value()) {
  821. // TODO: For now, just skip over fields whose types we can't map.
  822. continue;
  823. }
  824. // Create a field now, as we know the index to use.
  825. // TODO: Consider doing this lazily instead.
  826. auto field_decl_id = AddInst(
  827. context, MakeImportedLocIdAndInst(
  828. context, import_ir_inst_id,
  829. SemIR::FieldDecl{
  830. .type_id = GetUnboundElementType(
  831. context, class_type_inst_id, field_type_inst_id),
  832. .name_id = field_name_id,
  833. .index = SemIR::ElementIndex(fields.size())}));
  834. context.sem_ir().clang_decls().Add(
  835. {.decl = decl->getCanonicalDecl(), .inst_id = field_decl_id});
  836. // Compute the offset to the field that appears directly in the class.
  837. uint64_t offset = clang_layout.getFieldOffset(
  838. cast<clang::FieldDecl>(chain.front())->getFieldIndex());
  839. // If this is an indirect field, walk the path and accumulate the offset to
  840. // the named field.
  841. for (auto* inner_decl : chain.drop_front()) {
  842. auto* inner_field = cast<clang::FieldDecl>(inner_decl);
  843. const auto& inner_layout =
  844. context.ast_context().getASTRecordLayout(inner_field->getParent());
  845. offset += inner_layout.getFieldOffset(inner_field->getFieldIndex());
  846. }
  847. layout.push_back(
  848. context.ast_context().toCharUnitsFromBits(offset).getQuantity());
  849. fields.push_back(
  850. {.name_id = field_name_id, .type_inst_id = field_type_inst_id});
  851. }
  852. // TODO: Add a field to prevent tail padding reuse if necessary.
  853. return AddTypeInst<SemIR::CustomLayoutType>(
  854. context, import_ir_inst_id,
  855. {.type_id = SemIR::TypeType::TypeId,
  856. .fields_id = context.struct_type_fields().Add(fields),
  857. .layout_id = context.custom_layouts().Add(layout)});
  858. }
  859. // Creates a Carbon class definition based on the information in the given Clang
  860. // class declaration, which is assumed to be for a class definition.
  861. static auto BuildClassDefinition(Context& context,
  862. SemIR::ImportIRInstId import_ir_inst_id,
  863. SemIR::ClassId class_id,
  864. SemIR::TypeInstId class_inst_id,
  865. clang::CXXRecordDecl* clang_def) -> void {
  866. auto& class_info = context.classes().Get(class_id);
  867. CARBON_CHECK(!class_info.has_definition_started());
  868. class_info.definition_id = class_inst_id;
  869. context.inst_block_stack().Push();
  870. class_info.inheritance_kind = GetInheritanceKind(clang_def);
  871. // Compute the class's object representation.
  872. auto object_repr_id = ImportClassObjectRepr(
  873. context, class_id, import_ir_inst_id, class_inst_id, clang_def);
  874. class_info.complete_type_witness_id = AddInst<SemIR::CompleteTypeWitness>(
  875. context, import_ir_inst_id,
  876. {.type_id = GetSingletonType(context, SemIR::WitnessType::TypeInstId),
  877. .object_repr_type_inst_id = object_repr_id});
  878. class_info.body_block_id = context.inst_block_stack().Pop();
  879. }
  880. // Computes and returns the Carbon type to use as the object representation of
  881. // the given C++ enum type. This is a builtin int type matching the enum's
  882. // representation.
  883. static auto ImportEnumObjectRepresentation(
  884. Context& context, SemIR::ImportIRInstId import_ir_inst_id,
  885. clang::EnumDecl* enum_decl) -> SemIR::TypeInstId {
  886. auto int_type = enum_decl->getIntegerType();
  887. CARBON_CHECK(!int_type.isNull(), "incomplete enum type {0}",
  888. enum_decl->getNameAsString());
  889. auto int_kind = int_type->isSignedIntegerType() ? SemIR::IntKind::Signed
  890. : SemIR::IntKind::Unsigned;
  891. auto bit_width_id = GetOrAddInst<SemIR::IntValue>(
  892. context, import_ir_inst_id,
  893. {.type_id = GetSingletonType(context, SemIR::IntLiteralType::TypeInstId),
  894. .int_id = context.ints().AddUnsigned(
  895. llvm::APInt(64, context.ast_context().getIntWidth(int_type)))});
  896. return context.types().GetAsTypeInstId(
  897. GetOrAddInst(context, SemIR::LocIdAndInst::NoLoc(SemIR::IntType{
  898. .type_id = SemIR::TypeType::TypeId,
  899. .int_kind = int_kind,
  900. .bit_width_id = bit_width_id})));
  901. }
  902. // Creates a Carbon class definition based on the information in the given Clang
  903. // enum declaration.
  904. static auto BuildEnumDefinition(Context& context,
  905. SemIR::ImportIRInstId import_ir_inst_id,
  906. SemIR::ClassId class_id,
  907. SemIR::TypeInstId class_inst_id,
  908. clang::EnumDecl* enum_decl) -> void {
  909. auto& class_info = context.classes().Get(class_id);
  910. CARBON_CHECK(!class_info.has_definition_started());
  911. class_info.definition_id = class_inst_id;
  912. context.inst_block_stack().Push();
  913. // Don't allow inheritance from C++ enums, to match the behavior in C++.
  914. class_info.inheritance_kind = SemIR::Class::Final;
  915. // Compute the enum type's object representation. An enum is an adapter for
  916. // the corresponding builtin integer type.
  917. auto object_repr_id =
  918. ImportEnumObjectRepresentation(context, import_ir_inst_id, enum_decl);
  919. class_info.adapt_id = AddInst(
  920. context, SemIR::LocIdAndInst::UncheckedLoc(
  921. import_ir_inst_id,
  922. SemIR::AdaptDecl{.adapted_type_inst_id = object_repr_id}));
  923. class_info.complete_type_witness_id = AddInst<SemIR::CompleteTypeWitness>(
  924. context, import_ir_inst_id,
  925. {.type_id = GetSingletonType(context, SemIR::WitnessType::TypeInstId),
  926. .object_repr_type_inst_id = object_repr_id});
  927. class_info.body_block_id = context.inst_block_stack().Pop();
  928. }
  929. // Imports an enumerator declaration from Clang to Carbon.
  930. static auto ImportEnumConstantDecl(Context& context,
  931. clang::EnumConstantDecl* enumerator_decl)
  932. -> SemIR::InstId {
  933. CARBON_CHECK(!IsClangDeclImported(context, enumerator_decl));
  934. // Find the enclosing enum type.
  935. auto type_inst_id = LookupClangDeclInstId(
  936. context, cast<clang::EnumDecl>(enumerator_decl->getDeclContext()));
  937. auto type_id = context.types().GetTypeIdForTypeInstId(type_inst_id);
  938. // Build a corresponding IntValue.
  939. auto int_id = context.ints().Add(enumerator_decl->getInitVal());
  940. auto loc_id =
  941. AddImportIRInst(context.sem_ir(), enumerator_decl->getLocation());
  942. auto inst_id = AddInstInNoBlock<SemIR::IntValue>(
  943. context, loc_id, {.type_id = type_id, .int_id = int_id});
  944. context.imports().push_back(inst_id);
  945. context.sem_ir().clang_decls().Add(
  946. {.decl = enumerator_decl->getCanonicalDecl(), .inst_id = inst_id});
  947. return inst_id;
  948. }
  949. // Mark the given `Decl` as failed in `clang_decls`.
  950. static auto MarkFailedDecl(Context& context, clang::Decl* clang_decl) {
  951. context.sem_ir().clang_decls().Add({.decl = clang_decl->getCanonicalDecl(),
  952. .inst_id = SemIR::ErrorInst::InstId});
  953. }
  954. // Creates an integer type of the given size.
  955. static auto MakeIntType(Context& context, IntId size_id, bool is_signed)
  956. -> TypeExpr {
  957. auto type_inst_id = MakeIntTypeLiteral(
  958. context, Parse::NodeId::None,
  959. is_signed ? SemIR::IntKind::Signed : SemIR::IntKind::Unsigned, size_id);
  960. return ExprAsType(context, Parse::NodeId::None, type_inst_id);
  961. }
  962. // Maps a C++ builtin integer type to a Carbon type.
  963. // TODO: Handle integer types that map to named aliases.
  964. static auto MapBuiltinIntegerType(Context& context, SemIR::LocId loc_id,
  965. clang::QualType qual_type,
  966. const clang::BuiltinType& type) -> TypeExpr {
  967. clang::ASTContext& ast_context = context.ast_context();
  968. unsigned width = ast_context.getIntWidth(qual_type);
  969. bool is_signed = type.isSignedInteger();
  970. auto int_n_type = ast_context.getIntTypeForBitwidth(width, is_signed);
  971. if (ast_context.hasSameType(qual_type, int_n_type)) {
  972. TypeExpr type_expr =
  973. MakeIntType(context, context.ints().Add(width), is_signed);
  974. // Try to make sure integer types of 32 or 64 bits are complete so we can
  975. // check against them when deciding whether we need to generate a thunk.
  976. if (width == 32 || width == 64) {
  977. SemIR::TypeId type_id = type_expr.type_id;
  978. if (!context.types().IsComplete(type_id)) {
  979. TryToCompleteType(context, type_id, loc_id);
  980. }
  981. }
  982. return type_expr;
  983. }
  984. if (ast_context.hasSameType(qual_type, ast_context.CharTy)) {
  985. return ExprAsType(context, Parse::NodeId::None,
  986. MakeCharTypeLiteral(context, Parse::NodeId::None));
  987. }
  988. return TypeExpr::None;
  989. }
  990. // Maps a C++ builtin type to a Carbon type.
  991. // TODO: Support more builtin types.
  992. static auto MapBuiltinType(Context& context, SemIR::LocId loc_id,
  993. clang::QualType qual_type,
  994. const clang::BuiltinType& type) -> TypeExpr {
  995. clang::ASTContext& ast_context = context.ast_context();
  996. if (type.isBooleanType()) {
  997. CARBON_CHECK(ast_context.hasSameType(qual_type, ast_context.BoolTy));
  998. return ExprAsType(context, Parse::NodeId::None,
  999. context.types().GetInstId(GetSingletonType(
  1000. context, SemIR::BoolType::TypeInstId)));
  1001. }
  1002. if (type.isInteger()) {
  1003. return MapBuiltinIntegerType(context, loc_id, qual_type, type);
  1004. }
  1005. if (type.isFloatingPoint()) {
  1006. if (type.isFloat16Type() || type.isFloat32Type() || type.isDoubleType() ||
  1007. type.isFloat128Type()) {
  1008. return ExprAsType(
  1009. context, Parse::NodeId::None,
  1010. MakeFloatTypeLiteral(
  1011. context, Parse::NodeId::None,
  1012. context.ints().Add(ast_context.getTypeSize(qual_type))));
  1013. }
  1014. // TODO: Handle floating-point types that map to named aliases.
  1015. }
  1016. return TypeExpr::None;
  1017. }
  1018. // Determines whether record_decl is a C++ class that has a custom mapping into
  1019. // Carbon, and if so, returns the corresponding Carbon type. Otherwise returns
  1020. // None.
  1021. static auto LookupCustomRecordType(Context& context,
  1022. const clang::CXXRecordDecl* record_decl)
  1023. -> TypeExpr {
  1024. switch (GetCustomCppTypeMapping(record_decl)) {
  1025. case CustomCppTypeMapping::None:
  1026. return TypeExpr::None;
  1027. case CustomCppTypeMapping::Str:
  1028. return MakeStringType(
  1029. context,
  1030. AddImportIRInst(context.sem_ir(), record_decl->getLocation()));
  1031. }
  1032. }
  1033. // Maps a C++ tag type (class, struct, union, enum) to a Carbon type.
  1034. static auto MapTagType(Context& context, const clang::TagType& type)
  1035. -> TypeExpr {
  1036. auto* tag_decl = type.getOriginalDecl();
  1037. CARBON_CHECK(tag_decl);
  1038. // Check if the declaration is already mapped.
  1039. SemIR::InstId tag_inst_id = LookupClangDeclInstId(context, tag_decl);
  1040. if (!tag_inst_id.has_value()) {
  1041. if (auto* record_decl = dyn_cast<clang::CXXRecordDecl>(tag_decl)) {
  1042. auto custom_type = LookupCustomRecordType(context, record_decl);
  1043. if (custom_type.inst_id.has_value()) {
  1044. context.sem_ir().clang_decls().Add(
  1045. {.decl = record_decl, .inst_id = custom_type.inst_id});
  1046. return custom_type;
  1047. }
  1048. }
  1049. tag_inst_id = ImportTagDecl(context, tag_decl);
  1050. }
  1051. SemIR::TypeInstId record_type_inst_id =
  1052. context.types().GetAsTypeInstId(tag_inst_id);
  1053. return {
  1054. .inst_id = record_type_inst_id,
  1055. .type_id = context.types().GetTypeIdForTypeInstId(record_type_inst_id)};
  1056. }
  1057. // Maps a C++ type that is not a wrapper type such as a pointer to a Carbon
  1058. // type.
  1059. // TODO: Support more types.
  1060. static auto MapNonWrapperType(Context& context, SemIR::LocId loc_id,
  1061. clang::QualType type) -> TypeExpr {
  1062. if (const auto* builtin_type = type->getAs<clang::BuiltinType>()) {
  1063. return MapBuiltinType(context, loc_id, type, *builtin_type);
  1064. }
  1065. if (const auto* tag_type = type->getAs<clang::TagType>()) {
  1066. return MapTagType(context, *tag_type);
  1067. }
  1068. CARBON_CHECK(!type.hasQualifiers() && !type->isPointerType(),
  1069. "Should not see wrapper types here");
  1070. return TypeExpr::None;
  1071. }
  1072. // Maps a qualified C++ type to a Carbon type.
  1073. static auto MapQualifiedType(Context& context, clang::QualType type,
  1074. TypeExpr type_expr) -> TypeExpr {
  1075. auto quals = type.getQualifiers();
  1076. if (quals.hasConst()) {
  1077. auto type_id = GetConstType(context, type_expr.inst_id);
  1078. type_expr = {.inst_id = context.types().GetInstId(type_id),
  1079. .type_id = type_id};
  1080. quals.removeConst();
  1081. }
  1082. // TODO: Support other qualifiers.
  1083. if (!quals.empty()) {
  1084. return TypeExpr::None;
  1085. }
  1086. return type_expr;
  1087. }
  1088. // Maps a C++ pointer type to a Carbon pointer type.
  1089. static auto MapPointerType(Context& context, clang::QualType type,
  1090. TypeExpr pointee_type_expr) -> TypeExpr {
  1091. CARBON_CHECK(type->isPointerType());
  1092. if (auto nullability = type->getNullability();
  1093. !nullability.has_value() ||
  1094. *nullability != clang::NullabilityKind::NonNull) {
  1095. // If the type was produced by C++ template substitution, then we assume it
  1096. // was deduced from a Carbon pointer type, so it's non-null.
  1097. if (!type->getAs<clang::SubstTemplateTypeParmType>()) {
  1098. // TODO: Support nullable pointers.
  1099. return TypeExpr::None;
  1100. }
  1101. }
  1102. SemIR::TypeId pointer_type_id =
  1103. GetPointerType(context, pointee_type_expr.inst_id);
  1104. return {.inst_id = context.types().GetInstId(pointer_type_id),
  1105. .type_id = pointer_type_id};
  1106. }
  1107. // Maps a C++ type to a Carbon type. `type` should not be canonicalized because
  1108. // we check for pointer nullability and nullability will be lost by
  1109. // canonicalization.
  1110. static auto MapType(Context& context, SemIR::LocId loc_id, clang::QualType type)
  1111. -> TypeExpr {
  1112. // Unwrap any type modifiers and wrappers.
  1113. llvm::SmallVector<clang::QualType> wrapper_types;
  1114. while (true) {
  1115. clang::QualType orig_type = type;
  1116. if (type.hasQualifiers()) {
  1117. type = type.getUnqualifiedType();
  1118. } else if (type->isPointerType()) {
  1119. type = type->getPointeeType();
  1120. } else {
  1121. break;
  1122. }
  1123. wrapper_types.push_back(orig_type);
  1124. }
  1125. auto mapped = MapNonWrapperType(context, loc_id, type);
  1126. for (auto wrapper : llvm::reverse(wrapper_types)) {
  1127. if (!mapped.inst_id.has_value() ||
  1128. mapped.type_id == SemIR::ErrorInst::TypeId) {
  1129. break;
  1130. }
  1131. if (wrapper.hasQualifiers()) {
  1132. mapped = MapQualifiedType(context, wrapper, mapped);
  1133. } else if (wrapper->isPointerType()) {
  1134. mapped = MapPointerType(context, wrapper, mapped);
  1135. } else {
  1136. CARBON_FATAL("Unexpected wrapper type {0}", wrapper.getAsString());
  1137. }
  1138. }
  1139. return mapped;
  1140. }
  1141. // Returns a block for the implicit parameters of the given function
  1142. // declaration. Because function templates are not yet supported, this currently
  1143. // only contains the `self` parameter. On error, produces a diagnostic and
  1144. // returns None.
  1145. static auto MakeImplicitParamPatternsBlockId(
  1146. Context& context, SemIR::LocId loc_id,
  1147. const clang::FunctionDecl& clang_decl) -> SemIR::InstBlockId {
  1148. const auto* method_decl = dyn_cast<clang::CXXMethodDecl>(&clang_decl);
  1149. if (!method_decl || method_decl->isStatic() ||
  1150. isa<clang::CXXConstructorDecl>(clang_decl)) {
  1151. return SemIR::InstBlockId::Empty;
  1152. }
  1153. // Build a `self` parameter from the object parameter.
  1154. BeginSubpattern(context);
  1155. // Perform some special-case mapping for the object parameter:
  1156. //
  1157. // - If it's a const reference to T, produce a by-value `self: T` parameter.
  1158. // - If it's a non-const reference to T, produce an `addr self: T*`
  1159. // parameter.
  1160. // - Otherwise, map it directly, which will currently fail for `&&`-qualified
  1161. // methods.
  1162. //
  1163. // TODO: Some of this mapping should be performed for all parameters.
  1164. clang::QualType param_type =
  1165. method_decl->getFunctionObjectParameterReferenceType();
  1166. bool addr_self = false;
  1167. if (param_type->isLValueReferenceType()) {
  1168. param_type = param_type.getNonReferenceType();
  1169. if (param_type.isConstQualified()) {
  1170. // TODO: Consider only doing this if `const` is the only qualifier. For
  1171. // now, any other qualifier will fail when mapping the type.
  1172. auto split_type = param_type.getSplitUnqualifiedType();
  1173. split_type.Quals.removeConst();
  1174. param_type = method_decl->getASTContext().getQualifiedType(split_type);
  1175. } else {
  1176. addr_self = true;
  1177. }
  1178. }
  1179. auto [type_inst_id, type_id] = MapType(context, loc_id, param_type);
  1180. SemIR::ExprRegionId type_expr_region_id =
  1181. EndSubpatternAsExpr(context, type_inst_id);
  1182. if (!type_id.has_value()) {
  1183. context.TODO(loc_id,
  1184. llvm::formatv("Unsupported: object parameter type: {0}",
  1185. param_type.getAsString()));
  1186. return SemIR::InstBlockId::None;
  1187. }
  1188. // TODO: Fill in a location once available.
  1189. auto pattern_id =
  1190. addr_self ? AddAddrSelfParamPattern(context, SemIR::LocId::None,
  1191. type_expr_region_id, type_inst_id)
  1192. : AddSelfParamPattern(context, SemIR::LocId::None,
  1193. type_expr_region_id, type_id);
  1194. return context.inst_blocks().Add({pattern_id});
  1195. }
  1196. // Returns a block id for the explicit parameters of the given function
  1197. // declaration. If the function declaration has no parameters, it returns
  1198. // `SemIR::InstBlockId::Empty`. In the case of an unsupported parameter type, it
  1199. // produces an error and returns `SemIR::InstBlockId::None`.
  1200. // TODO: Consider refactoring to extract and reuse more logic from
  1201. // `HandleAnyBindingPattern()`.
  1202. static auto MakeParamPatternsBlockId(Context& context, SemIR::LocId loc_id,
  1203. const clang::FunctionDecl& clang_decl)
  1204. -> SemIR::InstBlockId {
  1205. if (clang_decl.parameters().empty()) {
  1206. return SemIR::InstBlockId::Empty;
  1207. }
  1208. llvm::SmallVector<SemIR::InstId> params;
  1209. params.reserve(clang_decl.getNumNonObjectParams());
  1210. for (unsigned i : llvm::seq(clang_decl.getNumNonObjectParams())) {
  1211. const auto* param = clang_decl.getNonObjectParameter(i);
  1212. // TODO: Get the parameter type from the function, not from the
  1213. // `ParmVarDecl`. The type of the `ParmVarDecl` is the type within the
  1214. // function, and isn't in general the same as the type that's exposed to
  1215. // callers. In particular, the parameter type exposed to callers will never
  1216. // be cv-qualified.
  1217. clang::QualType param_type = param->getType();
  1218. // We map `T&` parameters to `addr param: T*`, and `T&&` parameters to
  1219. // `param: T`.
  1220. // TODO: Revisit this and decide what we really want to do here.
  1221. bool is_ref_param = param_type->isLValueReferenceType();
  1222. param_type = param_type.getNonReferenceType();
  1223. // Mark the start of a region of insts, needed for the type expression
  1224. // created later with the call of `EndSubpatternAsExpr()`.
  1225. BeginSubpattern(context);
  1226. auto [orig_type_inst_id, type_id] = MapType(context, loc_id, param_type);
  1227. // Type expression of the binding pattern - a single-entry/single-exit
  1228. // region that allows control flow in the type expression e.g. fn F(x: if C
  1229. // then i32 else i64).
  1230. SemIR::ExprRegionId type_expr_region_id =
  1231. EndSubpatternAsExpr(context, orig_type_inst_id);
  1232. if (!type_id.has_value()) {
  1233. context.TODO(loc_id, llvm::formatv("Unsupported: parameter type: {0}",
  1234. param->getType().getAsString()));
  1235. return SemIR::InstBlockId::None;
  1236. }
  1237. if (is_ref_param) {
  1238. type_id = GetPointerType(context, orig_type_inst_id);
  1239. }
  1240. llvm::StringRef param_name = param->getName();
  1241. SemIR::NameId name_id =
  1242. param_name.empty()
  1243. // Translate an unnamed parameter to an underscore to
  1244. // match Carbon's naming of unnamed/unused function params.
  1245. ? SemIR::NameId::Underscore
  1246. : AddIdentifierName(context, param_name);
  1247. // TODO: Fix this once templates are supported.
  1248. bool is_template = false;
  1249. // TODO: Fix this once generics are supported.
  1250. bool is_generic = false;
  1251. SemIR::InstId pattern_id =
  1252. // TODO: Fill in a location once available.
  1253. AddBindingPattern(context, SemIR::LocId::None, name_id, type_id,
  1254. type_expr_region_id, is_generic, is_template)
  1255. .pattern_id;
  1256. pattern_id = AddPatternInst(
  1257. context,
  1258. // TODO: Fill in a location once available.
  1259. SemIR::LocIdAndInst::NoLoc(SemIR::ValueParamPattern(
  1260. {.type_id = context.insts().Get(pattern_id).type_id(),
  1261. .subpattern_id = pattern_id,
  1262. .index = SemIR::CallParamIndex::None})));
  1263. if (is_ref_param) {
  1264. pattern_id = AddPatternInst(
  1265. context,
  1266. // TODO: Fill in a location once available.
  1267. SemIR::LocIdAndInst::NoLoc(SemIR::AddrPattern(
  1268. {.type_id = GetPatternType(
  1269. context,
  1270. context.types().GetTypeIdForTypeInstId(orig_type_inst_id)),
  1271. .inner_id = pattern_id})));
  1272. }
  1273. params.push_back(pattern_id);
  1274. }
  1275. return context.inst_blocks().Add(params);
  1276. }
  1277. // Returns the return `TypeExpr` of the given function declaration. In case of
  1278. // an unsupported return type, returns `SemIR::ErrorInst::InstId`. Constructors
  1279. // are treated as returning a class instance.
  1280. // TODO: Support more return types.
  1281. static auto GetReturnTypeExpr(Context& context, SemIR::LocId loc_id,
  1282. clang::FunctionDecl* clang_decl) -> TypeExpr {
  1283. clang::QualType ret_type = clang_decl->getReturnType();
  1284. if (!ret_type->isVoidType()) {
  1285. TypeExpr mapped_type = MapType(context, loc_id, ret_type);
  1286. if (!mapped_type.inst_id.has_value()) {
  1287. context.TODO(loc_id, llvm::formatv("Unsupported: return type: {0}",
  1288. ret_type.getAsString()));
  1289. return {.inst_id = SemIR::ErrorInst::TypeInstId,
  1290. .type_id = SemIR::ErrorInst::TypeId};
  1291. }
  1292. return mapped_type;
  1293. }
  1294. if (!isa<clang::CXXConstructorDecl>(clang_decl)) {
  1295. // void.
  1296. return TypeExpr::None;
  1297. }
  1298. // TODO: Make this a `PartialType`.
  1299. SemIR::TypeInstId record_type_inst_id = context.types().GetAsTypeInstId(
  1300. context.sem_ir()
  1301. .clang_decls()
  1302. .Get(context.sem_ir().clang_decls().Lookup(
  1303. cast<clang::Decl>(clang_decl->getParent())))
  1304. .inst_id);
  1305. return {
  1306. .inst_id = record_type_inst_id,
  1307. .type_id = context.types().GetTypeIdForTypeInstId(record_type_inst_id)};
  1308. }
  1309. // Returns the return pattern of the given function declaration. In case of an
  1310. // unsupported return type, it produces a diagnostic and returns
  1311. // `SemIR::ErrorInst::InstId`. Constructors are treated as returning a class
  1312. // instance.
  1313. static auto GetReturnPattern(Context& context, SemIR::LocId loc_id,
  1314. clang::FunctionDecl* clang_decl) -> SemIR::InstId {
  1315. auto [type_inst_id, type_id] = GetReturnTypeExpr(context, loc_id, clang_decl);
  1316. if (!type_inst_id.has_value()) {
  1317. // void.
  1318. return SemIR::InstId::None;
  1319. }
  1320. auto pattern_type_id = GetPatternType(context, type_id);
  1321. SemIR::InstId return_slot_pattern_id = AddPatternInst(
  1322. // TODO: Fill in a location for the return type once available.
  1323. context,
  1324. SemIR::LocIdAndInst::NoLoc(SemIR::ReturnSlotPattern(
  1325. {.type_id = pattern_type_id, .type_inst_id = type_inst_id})));
  1326. SemIR::InstId param_pattern_id = AddPatternInst(
  1327. // TODO: Fill in a location for the return type once available.
  1328. context, SemIR::LocIdAndInst::NoLoc(SemIR::OutParamPattern(
  1329. {.type_id = pattern_type_id,
  1330. .subpattern_id = return_slot_pattern_id,
  1331. .index = SemIR::CallParamIndex::None})));
  1332. return param_pattern_id;
  1333. }
  1334. namespace {
  1335. // Represents the parameter patterns block id, the return slot pattern id and
  1336. // the call parameters block id for a function declaration.
  1337. struct FunctionParamsInsts {
  1338. SemIR::InstBlockId implicit_param_patterns_id;
  1339. SemIR::InstBlockId param_patterns_id;
  1340. SemIR::InstId return_slot_pattern_id;
  1341. SemIR::InstBlockId call_params_id;
  1342. };
  1343. } // namespace
  1344. // Creates a block containing the parameter pattern instructions for the
  1345. // explicit parameters, a parameter pattern instruction for the return type and
  1346. // a block containing the call parameters of the function. Emits a callee
  1347. // pattern-match for the explicit parameter patterns and the return slot pattern
  1348. // to create the Call parameters instructions block. Currently the implicit
  1349. // parameter patterns are not taken into account. Returns the parameter patterns
  1350. // block id, the return slot pattern id, and the call parameters block id.
  1351. // Produces a diagnostic and returns `std::nullopt` if the function declaration
  1352. // has an unsupported parameter type.
  1353. static auto CreateFunctionParamsInsts(Context& context, SemIR::LocId loc_id,
  1354. clang::FunctionDecl* clang_decl)
  1355. -> std::optional<FunctionParamsInsts> {
  1356. if (isa<clang::CXXDestructorDecl>(clang_decl)) {
  1357. context.TODO(loc_id, "Unsupported: Destructor");
  1358. return std::nullopt;
  1359. }
  1360. auto implicit_param_patterns_id =
  1361. MakeImplicitParamPatternsBlockId(context, loc_id, *clang_decl);
  1362. if (!implicit_param_patterns_id.has_value()) {
  1363. return std::nullopt;
  1364. }
  1365. auto param_patterns_id =
  1366. MakeParamPatternsBlockId(context, loc_id, *clang_decl);
  1367. if (!param_patterns_id.has_value()) {
  1368. return std::nullopt;
  1369. }
  1370. auto return_slot_pattern_id = GetReturnPattern(context, loc_id, clang_decl);
  1371. if (SemIR::ErrorInst::InstId == return_slot_pattern_id) {
  1372. return std::nullopt;
  1373. }
  1374. auto call_params_id =
  1375. CalleePatternMatch(context, implicit_param_patterns_id, param_patterns_id,
  1376. return_slot_pattern_id);
  1377. return {{.implicit_param_patterns_id = implicit_param_patterns_id,
  1378. .param_patterns_id = param_patterns_id,
  1379. .return_slot_pattern_id = return_slot_pattern_id,
  1380. .call_params_id = call_params_id}};
  1381. }
  1382. // Returns the Carbon function name for the given function.
  1383. static auto GetFunctionName(Context& context, clang::FunctionDecl* clang_decl)
  1384. -> SemIR::NameId {
  1385. switch (clang_decl->getDeclName().getNameKind()) {
  1386. case clang::DeclarationName::CXXConstructorName: {
  1387. return context.classes()
  1388. .Get(context.insts()
  1389. .GetAs<SemIR::ClassDecl>(LookupClangDeclInstId(
  1390. context, cast<clang::Decl>(clang_decl->getParent())))
  1391. .class_id)
  1392. .name_id;
  1393. }
  1394. case clang::DeclarationName::CXXOperatorName: {
  1395. return SemIR::NameId::CppOperator;
  1396. }
  1397. default: {
  1398. return AddIdentifierName(context, clang_decl->getName());
  1399. }
  1400. }
  1401. }
  1402. // Creates a `FunctionDecl` and a `Function` without C++ thunk information.
  1403. // Returns std::nullopt on failure. The given Clang declaration is assumed to:
  1404. // * Have not been imported before.
  1405. // * Be of supported type (ignoring parameters).
  1406. static auto ImportFunction(Context& context, SemIR::LocId loc_id,
  1407. clang::FunctionDecl* clang_decl)
  1408. -> std::optional<SemIR::FunctionId> {
  1409. context.scope_stack().PushForDeclName();
  1410. context.inst_block_stack().Push();
  1411. context.pattern_block_stack().Push();
  1412. auto function_params_insts =
  1413. CreateFunctionParamsInsts(context, loc_id, clang_decl);
  1414. auto pattern_block_id = context.pattern_block_stack().Pop();
  1415. auto decl_block_id = context.inst_block_stack().Pop();
  1416. context.scope_stack().Pop();
  1417. if (!function_params_insts.has_value()) {
  1418. return std::nullopt;
  1419. }
  1420. auto function_decl = SemIR::FunctionDecl{
  1421. SemIR::TypeId::None, SemIR::FunctionId::None, decl_block_id};
  1422. auto decl_id =
  1423. AddPlaceholderInstInNoBlock(context, Parse::NodeId::None, function_decl);
  1424. context.imports().push_back(decl_id);
  1425. auto virtual_modifier = SemIR::Function::VirtualModifier::None;
  1426. int32_t virtual_index = -1;
  1427. if (auto* method_decl = dyn_cast<clang::CXXMethodDecl>(clang_decl)) {
  1428. if (method_decl->size_overridden_methods()) {
  1429. virtual_modifier = SemIR::Function::VirtualModifier::Override;
  1430. } else if (method_decl->isVirtual()) {
  1431. virtual_modifier = SemIR::Function::VirtualModifier::Virtual;
  1432. }
  1433. if (virtual_modifier != SemIR::Function::VirtualModifier::None) {
  1434. // TODO: Add support for Microsoft/non-Itanium vtables.
  1435. virtual_index = dyn_cast<clang::ItaniumVTableContext>(
  1436. context.ast_context().getVTableContext())
  1437. ->getMethodVTableIndex(method_decl);
  1438. }
  1439. }
  1440. auto function_info = SemIR::Function{
  1441. {.name_id = GetFunctionName(context, clang_decl),
  1442. .parent_scope_id = GetParentNameScopeId(context, clang_decl),
  1443. .generic_id = SemIR::GenericId::None,
  1444. .first_param_node_id = Parse::NodeId::None,
  1445. .last_param_node_id = Parse::NodeId::None,
  1446. .pattern_block_id = pattern_block_id,
  1447. .implicit_param_patterns_id =
  1448. function_params_insts->implicit_param_patterns_id,
  1449. .param_patterns_id = function_params_insts->param_patterns_id,
  1450. .is_extern = false,
  1451. .extern_library_id = SemIR::LibraryNameId::None,
  1452. .non_owning_decl_id = SemIR::InstId::None,
  1453. .first_owning_decl_id = decl_id,
  1454. .definition_id = SemIR::InstId::None},
  1455. {.call_params_id = function_params_insts->call_params_id,
  1456. .return_slot_pattern_id = function_params_insts->return_slot_pattern_id,
  1457. .virtual_modifier = virtual_modifier,
  1458. .virtual_index = virtual_index,
  1459. .self_param_id = FindSelfPattern(
  1460. context, function_params_insts->implicit_param_patterns_id),
  1461. .clang_decl_id = context.sem_ir().clang_decls().Add(
  1462. {.decl = clang_decl, .inst_id = decl_id})}};
  1463. function_decl.function_id = context.functions().Add(function_info);
  1464. function_decl.type_id = GetFunctionType(context, function_decl.function_id,
  1465. SemIR::SpecificId::None);
  1466. ReplaceInstBeforeConstantUse(context, decl_id, function_decl);
  1467. return function_decl.function_id;
  1468. }
  1469. auto ImportCppFunctionDecl(Context& context, SemIR::LocId loc_id,
  1470. clang::FunctionDecl* clang_decl) -> SemIR::InstId {
  1471. // Check if the declaration is already mapped.
  1472. if (SemIR::InstId existing_inst_id =
  1473. LookupClangDeclInstId(context, clang_decl);
  1474. existing_inst_id.has_value()) {
  1475. return existing_inst_id;
  1476. }
  1477. if (clang_decl->isVariadic()) {
  1478. context.TODO(loc_id, "Unsupported: Variadic function");
  1479. MarkFailedDecl(context, clang_decl);
  1480. return SemIR::ErrorInst::InstId;
  1481. }
  1482. if (clang_decl->getTemplatedKind() ==
  1483. clang::FunctionDecl::TK_FunctionTemplate) {
  1484. context.TODO(loc_id, "Unsupported: Template function");
  1485. MarkFailedDecl(context, clang_decl);
  1486. return SemIR::ErrorInst::InstId;
  1487. }
  1488. CARBON_CHECK(clang_decl->getFunctionType()->isFunctionProtoType(),
  1489. "Not Prototype function (non-C++ code)");
  1490. auto function_id = ImportFunction(context, loc_id, clang_decl);
  1491. if (!function_id) {
  1492. MarkFailedDecl(context, clang_decl);
  1493. return SemIR::ErrorInst::InstId;
  1494. }
  1495. SemIR::Function& function_info = context.functions().Get(*function_id);
  1496. if (IsCppThunkRequired(context, function_info)) {
  1497. clang::FunctionDecl* thunk_clang_decl =
  1498. BuildCppThunk(context, function_info);
  1499. if (thunk_clang_decl) {
  1500. SemIR::FunctionId thunk_function_id =
  1501. *ImportFunction(context, loc_id, thunk_clang_decl);
  1502. SemIR::InstId thunk_function_decl_id =
  1503. context.functions().Get(thunk_function_id).first_owning_decl_id;
  1504. function_info.SetHasCppThunk(thunk_function_decl_id);
  1505. }
  1506. }
  1507. return function_info.first_owning_decl_id;
  1508. }
  1509. namespace {
  1510. // An item to be imported in an import worklist.
  1511. // TODO: If worklists ever become particularly large, consider changing this
  1512. // to use a `PointerIntPair`.
  1513. struct ImportItem {
  1514. // A declaration that we want to import.
  1515. clang::Decl* decl;
  1516. // Whether we have added `decl`'s dependencies to the worklist.
  1517. bool added_dependencies;
  1518. };
  1519. // A worklist of declarations to import.
  1520. using ImportWorklist = llvm::SmallVector<ImportItem>;
  1521. } // namespace
  1522. // Adds the given declaration to our list of declarations to import.
  1523. static auto AddDependentDecl(const Context& context, clang::Decl* decl,
  1524. ImportWorklist& worklist) -> void {
  1525. if (!IsClangDeclImported(context, decl)) {
  1526. worklist.push_back({.decl = decl, .added_dependencies = false});
  1527. }
  1528. }
  1529. // Finds all decls that need to be imported before importing the given type and
  1530. // adds them to the given set.
  1531. static auto AddDependentUnimportedTypeDecls(const Context& context,
  1532. clang::QualType type,
  1533. ImportWorklist& worklist) -> void {
  1534. while (true) {
  1535. if (type->isPointerType() || type->isReferenceType()) {
  1536. type = type->getPointeeType();
  1537. } else if (const clang::ArrayType* array_type =
  1538. type->getAsArrayTypeUnsafe()) {
  1539. type = array_type->getElementType();
  1540. } else {
  1541. break;
  1542. }
  1543. }
  1544. if (const auto* tag_type = type->getAs<clang::TagType>()) {
  1545. AddDependentDecl(context, tag_type->getOriginalDecl(), worklist);
  1546. }
  1547. }
  1548. // Finds all decls that need to be imported before importing the given function
  1549. // and adds them to the given set.
  1550. static auto AddDependentUnimportedFunctionDecls(
  1551. const Context& context, const clang::FunctionDecl& clang_decl,
  1552. ImportWorklist& worklist) -> void {
  1553. for (const auto* param : clang_decl.parameters()) {
  1554. AddDependentUnimportedTypeDecls(context, param->getType(), worklist);
  1555. }
  1556. AddDependentUnimportedTypeDecls(context, clang_decl.getReturnType(),
  1557. worklist);
  1558. }
  1559. // Finds all decls that need to be imported before importing the given
  1560. // declaration and adds them to the given set.
  1561. static auto AddDependentUnimportedDecls(const Context& context,
  1562. clang::Decl* clang_decl,
  1563. ImportWorklist& worklist) -> void {
  1564. if (auto* clang_function_decl = clang_decl->getAsFunction()) {
  1565. AddDependentUnimportedFunctionDecls(context, *clang_function_decl,
  1566. worklist);
  1567. } else if (auto* type_decl = dyn_cast<clang::TypeDecl>(clang_decl)) {
  1568. if (!isa<clang::TagDecl>(clang_decl)) {
  1569. AddDependentUnimportedTypeDecls(
  1570. context, type_decl->getASTContext().getTypeDeclType(type_decl),
  1571. worklist);
  1572. }
  1573. }
  1574. if (!isa<clang::TranslationUnitDecl>(clang_decl)) {
  1575. AddDependentDecl(context, GetParentDecl(clang_decl), worklist);
  1576. }
  1577. }
  1578. static auto ImportVarDecl(Context& context, SemIR::LocId loc_id,
  1579. clang::VarDecl* var_decl) -> SemIR::InstId {
  1580. if (SemIR::InstId existing_inst_id = LookupClangDeclInstId(context, var_decl);
  1581. existing_inst_id.has_value()) {
  1582. return existing_inst_id;
  1583. }
  1584. // Extract type and name.
  1585. clang::QualType var_type = var_decl->getType();
  1586. SemIR::TypeId var_type_id = MapType(context, loc_id, var_type).type_id;
  1587. if (!var_type_id.has_value()) {
  1588. context.TODO(loc_id, llvm::formatv("Unsupported: var type: {0}",
  1589. var_type.getAsString()));
  1590. return SemIR::ErrorInst::InstId;
  1591. }
  1592. SemIR::NameId var_name_id = AddIdentifierName(context, var_decl->getName());
  1593. SemIR::VarStorage var_storage{.type_id = var_type_id,
  1594. .pattern_id = SemIR::InstId::None};
  1595. // We can't use the convenience for `AddPlaceholderInstInNoBlock()` with typed
  1596. // nodes because it doesn't support insts with cleanup.
  1597. SemIR::InstId var_storage_inst_id =
  1598. AddPlaceholderInstInNoBlock(context, {loc_id, var_storage});
  1599. auto clang_decl_id = context.sem_ir().clang_decls().Add(
  1600. {.decl = var_decl, .inst_id = var_storage_inst_id});
  1601. // Entity name referring to a Clang decl for mangling.
  1602. SemIR::EntityNameId entity_name_id =
  1603. context.entity_names().AddSymbolicBindingName(
  1604. var_name_id, GetParentNameScopeId(context, var_decl),
  1605. SemIR::CompileTimeBindIndex::None, false, clang_decl_id);
  1606. // Create `BindingPattern` and `VarPattern` in a `NameBindingDecl`.
  1607. context.pattern_block_stack().Push();
  1608. SemIR::TypeId pattern_type_id = GetPatternType(context, var_type_id);
  1609. SemIR::InstId binding_pattern_inst_id = AddPatternInst<SemIR::BindingPattern>(
  1610. context, loc_id,
  1611. {.type_id = pattern_type_id, .entity_name_id = entity_name_id});
  1612. var_storage.pattern_id = AddPatternInst<SemIR::VarPattern>(
  1613. context, Parse::VariablePatternId::None,
  1614. {.type_id = pattern_type_id, .subpattern_id = binding_pattern_inst_id});
  1615. context.imports().push_back(AddInstInNoBlock<SemIR::NameBindingDecl>(
  1616. context, loc_id,
  1617. {.pattern_block_id = context.pattern_block_stack().Pop()}));
  1618. // Finalize the `VarStorage` instruction.
  1619. ReplaceInstBeforeConstantUse(context, var_storage_inst_id, var_storage);
  1620. context.imports().push_back(var_storage_inst_id);
  1621. return var_storage_inst_id;
  1622. }
  1623. // Imports a declaration from Clang to Carbon. Returns the instruction for the
  1624. // new Carbon declaration, which will be an ErrorInst on failure. Assumes all
  1625. // dependencies have already been imported.
  1626. static auto ImportDeclAfterDependencies(Context& context, SemIR::LocId loc_id,
  1627. clang::Decl* clang_decl)
  1628. -> SemIR::InstId {
  1629. if (auto* clang_function_decl = clang_decl->getAsFunction()) {
  1630. return ImportCppFunctionDecl(context, loc_id, clang_function_decl);
  1631. }
  1632. if (auto* clang_namespace_decl = dyn_cast<clang::NamespaceDecl>(clang_decl)) {
  1633. return ImportNamespaceDecl(context, clang_namespace_decl);
  1634. }
  1635. if (auto* type_decl = dyn_cast<clang::TypeDecl>(clang_decl)) {
  1636. auto type = clang_decl->getASTContext().getTypeDeclType(type_decl);
  1637. auto type_inst_id = MapType(context, loc_id, type).inst_id;
  1638. if (!type_inst_id.has_value()) {
  1639. context.TODO(AddImportIRInst(context.sem_ir(), type_decl->getLocation()),
  1640. llvm::formatv("Unsupported: Type declaration: {0}",
  1641. type.getAsString()));
  1642. return SemIR::ErrorInst::InstId;
  1643. }
  1644. context.sem_ir().clang_decls().Add(
  1645. {.decl = clang_decl, .inst_id = type_inst_id});
  1646. return type_inst_id;
  1647. }
  1648. if (isa<clang::FieldDecl, clang::IndirectFieldDecl>(clang_decl)) {
  1649. // Usable fields get imported as a side effect of importing the class.
  1650. if (SemIR::InstId existing_inst_id =
  1651. LookupClangDeclInstId(context, clang_decl);
  1652. existing_inst_id.has_value()) {
  1653. return existing_inst_id;
  1654. }
  1655. context.TODO(AddImportIRInst(context.sem_ir(), clang_decl->getLocation()),
  1656. "Unsupported: field declaration has unhandled type or kind");
  1657. return SemIR::ErrorInst::InstId;
  1658. }
  1659. if (auto* enum_const_decl = dyn_cast<clang::EnumConstantDecl>(clang_decl)) {
  1660. return ImportEnumConstantDecl(context, enum_const_decl);
  1661. }
  1662. if (auto* var_decl = dyn_cast<clang::VarDecl>(clang_decl)) {
  1663. return ImportVarDecl(context, loc_id, var_decl);
  1664. }
  1665. context.TODO(AddImportIRInst(context.sem_ir(), clang_decl->getLocation()),
  1666. llvm::formatv("Unsupported: Declaration type {0}",
  1667. clang_decl->getDeclKindName()));
  1668. return SemIR::ErrorInst::InstId;
  1669. }
  1670. // Attempts to import a set of declarations. Returns `false` if an error was
  1671. // produced, `true` otherwise.
  1672. // TODO: Merge overload set and operators and remove the `is_overload_set`
  1673. // param.
  1674. static auto ImportDeclSet(Context& context, SemIR::LocId loc_id,
  1675. ImportWorklist& worklist,
  1676. bool is_overload_set = false) -> bool {
  1677. // Walk the dependency graph in depth-first order, and import declarations
  1678. // once we've imported all of their dependencies.
  1679. while (!worklist.empty()) {
  1680. auto& item = worklist.back();
  1681. if (!item.added_dependencies) {
  1682. // Skip items we've already imported. We checked this when initially
  1683. // adding the item to the worklist, but it might have been added to the
  1684. // worklist twice before the first time we visited it. For example, this
  1685. // happens for `fn F(a: Cpp.T, b: Cpp.T)`.
  1686. if (IsClangDeclImported(context, item.decl)) {
  1687. worklist.pop_back();
  1688. continue;
  1689. }
  1690. // First time visiting this declaration (preorder): add its dependencies
  1691. // to the work list.
  1692. item.added_dependencies = true;
  1693. AddDependentUnimportedDecls(context, item.decl, worklist);
  1694. } else {
  1695. // Second time visiting this declaration (postorder): its dependencies are
  1696. // already imported, so we can import it now.
  1697. auto* decl = worklist.pop_back_val().decl;
  1698. // Functions that are part of the overload set are imported at a later
  1699. // point, once the overload resolution has selected the suitable function
  1700. // for the call.
  1701. if (is_overload_set && decl->getAsFunction()) {
  1702. continue;
  1703. }
  1704. auto inst_id = ImportDeclAfterDependencies(context, loc_id, decl);
  1705. CARBON_CHECK(inst_id.has_value());
  1706. if (inst_id == SemIR::ErrorInst::InstId) {
  1707. return false;
  1708. }
  1709. CARBON_CHECK(IsClangDeclImported(context, decl));
  1710. }
  1711. }
  1712. return true;
  1713. }
  1714. // Imports a declaration from Clang to Carbon. If successful, returns the
  1715. // instruction for the new Carbon declaration. All unimported dependencies are
  1716. // imported first.
  1717. static auto ImportDeclAndDependencies(Context& context, SemIR::LocId loc_id,
  1718. clang::Decl* clang_decl)
  1719. -> SemIR::InstId {
  1720. // Collect dependencies by walking the dependency graph in depth-first order.
  1721. ImportWorklist worklist;
  1722. AddDependentDecl(context, clang_decl, worklist);
  1723. if (!ImportDeclSet(context, loc_id, worklist)) {
  1724. return SemIR::ErrorInst::InstId;
  1725. }
  1726. return LookupClangDeclInstId(context, clang_decl);
  1727. }
  1728. // Imports a type from Clang to Carbon. If successful, returns the imported
  1729. // TypeId. All unimported dependencies are imported first.
  1730. static auto ImportTypeAndDependencies(Context& context, SemIR::LocId loc_id,
  1731. clang::QualType type) -> TypeExpr {
  1732. // Collect dependencies by walking the dependency graph in depth-first order.
  1733. ImportWorklist worklist;
  1734. AddDependentUnimportedTypeDecls(context, type, worklist);
  1735. if (!ImportDeclSet(context, loc_id, worklist)) {
  1736. return {.inst_id = SemIR::ErrorInst::TypeInstId,
  1737. .type_id = SemIR::ErrorInst::TypeId};
  1738. }
  1739. return MapType(context, loc_id, type);
  1740. }
  1741. // Maps `clang::AccessSpecifier` to `SemIR::AccessKind`.
  1742. static auto MapAccess(clang::AccessSpecifier access_specifier)
  1743. -> SemIR::AccessKind {
  1744. switch (access_specifier) {
  1745. case clang::AS_public:
  1746. case clang::AS_none:
  1747. return SemIR::AccessKind::Public;
  1748. case clang::AS_protected:
  1749. return SemIR::AccessKind::Protected;
  1750. case clang::AS_private:
  1751. return SemIR::AccessKind::Private;
  1752. }
  1753. }
  1754. // Imports a `clang::NamedDecl` into Carbon and adds that name into the
  1755. // `NameScope`.
  1756. static auto ImportNameDeclIntoScope(Context& context, SemIR::LocId loc_id,
  1757. SemIR::NameScopeId scope_id,
  1758. SemIR::NameId name_id,
  1759. clang::NamedDecl* clang_decl,
  1760. clang::AccessSpecifier access)
  1761. -> SemIR::ScopeLookupResult {
  1762. SemIR::InstId inst_id =
  1763. ImportDeclAndDependencies(context, loc_id, clang_decl);
  1764. if (!inst_id.has_value()) {
  1765. return SemIR::ScopeLookupResult::MakeNotFound();
  1766. }
  1767. SemIR::AccessKind access_kind = MapAccess(access);
  1768. AddNameToScope(context, scope_id, name_id, access_kind, inst_id);
  1769. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(inst_id,
  1770. access_kind);
  1771. }
  1772. // Returns true if the scope is the top `Cpp` scope.
  1773. static auto IsTopCppScope(Context& context, SemIR::NameScopeId scope_id)
  1774. -> bool {
  1775. const SemIR::NameScope& name_scope = context.name_scopes().Get(scope_id);
  1776. CARBON_CHECK(name_scope.is_cpp_scope());
  1777. return name_scope.parent_scope_id() == SemIR::NameScopeId::Package;
  1778. }
  1779. // For builtin names like `Cpp.long`, return the associated types.
  1780. static auto LookupBuiltinTypes(Context& context, SemIR::LocId loc_id,
  1781. SemIR::NameScopeId scope_id,
  1782. SemIR::NameId name_id) -> SemIR::InstId {
  1783. if (!IsTopCppScope(context, scope_id)) {
  1784. return SemIR::InstId::None;
  1785. }
  1786. auto name = context.names().GetAsStringIfIdentifier(name_id);
  1787. if (!name) {
  1788. return SemIR::InstId::None;
  1789. }
  1790. const clang::ASTContext& ast_context = context.ast_context();
  1791. // List of types based on
  1792. // https://github.com/carbon-language/carbon-lang/blob/trunk/proposals/p5448.md#details
  1793. auto builtin_type =
  1794. llvm::StringSwitch<clang::QualType>(*name)
  1795. .Case("signed_char", ast_context.SignedCharTy)
  1796. .Case("short", ast_context.ShortTy)
  1797. .Case("int", ast_context.IntTy)
  1798. .Case("long", ast_context.LongTy)
  1799. .Case("long_long", ast_context.LongLongTy)
  1800. .Case("unsigned_char", ast_context.UnsignedCharTy)
  1801. .Case("unsigned_short", ast_context.UnsignedShortTy)
  1802. .Case("unsigned_int", ast_context.UnsignedIntTy)
  1803. .Case("unsigned_long", ast_context.UnsignedLongTy)
  1804. .Case("unsigned_long_long", ast_context.UnsignedLongLongTy)
  1805. .Case("float", ast_context.FloatTy)
  1806. .Case("double", ast_context.DoubleTy)
  1807. .Case("long_double", ast_context.LongDoubleTy)
  1808. .Default(clang::QualType());
  1809. if (builtin_type.isNull()) {
  1810. return SemIR::InstId::None;
  1811. }
  1812. SemIR::InstId inst_id =
  1813. MapNonWrapperType(context, loc_id, builtin_type).inst_id;
  1814. if (!inst_id.has_value()) {
  1815. context.TODO(loc_id, llvm::formatv("Unsupported: builtin type: {0}",
  1816. builtin_type.getAsString()));
  1817. return SemIR::ErrorInst::InstId;
  1818. }
  1819. return inst_id;
  1820. }
  1821. // Imports an overloaded function set from Clang to Carbon.
  1822. static auto ImportCppOverloadSet(Context& context, SemIR::NameScopeId scope_id,
  1823. SemIR::NameId name_id,
  1824. const clang::UnresolvedSet<4>& overload_set)
  1825. -> SemIR::InstId {
  1826. SemIR::CppOverloadSetId overload_set_id = context.cpp_overload_sets().Add(
  1827. SemIR::CppOverloadSet{.name_id = name_id,
  1828. .parent_scope_id = scope_id,
  1829. .candidate_functions = overload_set});
  1830. auto overload_set_inst_id =
  1831. // TODO: Add a location.
  1832. AddInstInNoBlock<SemIR::CppOverloadSetValue>(
  1833. context, Parse::NodeId::None,
  1834. {.type_id = GetCppOverloadSetType(context, overload_set_id,
  1835. SemIR::SpecificId::None),
  1836. .overload_set_id = overload_set_id});
  1837. context.imports().push_back(overload_set_inst_id);
  1838. return overload_set_inst_id;
  1839. }
  1840. // Gets the access for an overloaded function set. Returns std::nullopt
  1841. // if the access is not the same for all functions in the overload set.
  1842. // TODO: Fix to support functions with different access levels.
  1843. static auto GetOverloadSetAccess(Context& context, SemIR::LocId loc_id,
  1844. const clang::UnresolvedSet<4>& overload_set)
  1845. -> std::optional<SemIR::AccessKind> {
  1846. clang::AccessSpecifier access = overload_set.begin().getAccess();
  1847. for (auto it = overload_set.begin() + 1; it != overload_set.end(); ++it) {
  1848. if (it.getAccess() != access) {
  1849. context.TODO(
  1850. loc_id,
  1851. llvm::formatv("Unsupported: Overloaded set with mixed access").str());
  1852. return std::nullopt;
  1853. }
  1854. }
  1855. return MapAccess(access);
  1856. }
  1857. static auto ImportOverloadSetAndDependencies(
  1858. Context& context, SemIR::LocId loc_id, SemIR::NameScopeId scope_id,
  1859. SemIR::NameId name_id, const clang::UnresolvedSet<4>& overloaded_set)
  1860. -> SemIR::InstId {
  1861. ImportWorklist worklist;
  1862. for (clang::NamedDecl* fn_decl : overloaded_set) {
  1863. AddDependentDecl(context, fn_decl, worklist);
  1864. }
  1865. if (!ImportDeclSet(context, loc_id, worklist, true)) {
  1866. return SemIR::ErrorInst::InstId;
  1867. }
  1868. return ImportCppOverloadSet(context, scope_id, name_id, overloaded_set);
  1869. }
  1870. // Imports an overloaded function set from Clang to Carbon and adds the
  1871. // name into the `NameScope`.
  1872. static auto ImportOverloadSetIntoScope(
  1873. Context& context, SemIR::LocId loc_id, SemIR::NameScopeId scope_id,
  1874. SemIR::NameId name_id, const clang::UnresolvedSet<4>& overload_set)
  1875. -> SemIR::ScopeLookupResult {
  1876. std::optional<SemIR::AccessKind> access_kind =
  1877. GetOverloadSetAccess(context, loc_id, overload_set);
  1878. if (!access_kind.has_value()) {
  1879. return SemIR::ScopeLookupResult::MakeError();
  1880. }
  1881. SemIR::InstId inst_id = ImportOverloadSetAndDependencies(
  1882. context, loc_id, scope_id, name_id, overload_set);
  1883. AddNameToScope(context, scope_id, name_id, access_kind.value(), inst_id);
  1884. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(inst_id,
  1885. access_kind.value());
  1886. }
  1887. // TODO: Refactor this method.
  1888. // TODO: Do we need to import the dependences for all functions in the overload
  1889. // set?
  1890. auto ImportNameFromCpp(Context& context, SemIR::LocId loc_id,
  1891. SemIR::NameScopeId scope_id, SemIR::NameId name_id)
  1892. -> SemIR::ScopeLookupResult {
  1893. Diagnostics::AnnotationScope annotate_diagnostics(
  1894. &context.emitter(), [&](auto& builder) {
  1895. CARBON_DIAGNOSTIC(InCppNameLookup, Note,
  1896. "in `Cpp` name lookup for `{0}`", SemIR::NameId);
  1897. builder.Note(loc_id, InCppNameLookup, name_id);
  1898. });
  1899. auto lookup = ClangLookupName(context, scope_id, name_id);
  1900. if (!lookup) {
  1901. SemIR::InstId builtin_inst_id =
  1902. LookupBuiltinTypes(context, loc_id, scope_id, name_id);
  1903. if (builtin_inst_id.has_value()) {
  1904. AddNameToScope(context, scope_id, name_id, SemIR::AccessKind::Public,
  1905. builtin_inst_id);
  1906. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(
  1907. builtin_inst_id, SemIR::AccessKind::Public);
  1908. }
  1909. return SemIR::ScopeLookupResult::MakeNotFound();
  1910. }
  1911. // Access checks are performed separately by the Carbon name lookup logic.
  1912. lookup->suppressAccessDiagnostics();
  1913. if (lookup->isOverloadedResult() ||
  1914. (lookup->isSingleResult() &&
  1915. lookup->getFoundDecl()->isFunctionOrFunctionTemplate())) {
  1916. clang::UnresolvedSet<4> overload_set;
  1917. overload_set.append(lookup->begin(), lookup->end());
  1918. return ImportOverloadSetIntoScope(context, loc_id, scope_id, name_id,
  1919. overload_set);
  1920. }
  1921. if (!lookup->isSingleResult()) {
  1922. // Clang will diagnose ambiguous lookup results for us.
  1923. if (!lookup->isAmbiguous()) {
  1924. context.TODO(loc_id,
  1925. llvm::formatv("Unsupported: Lookup succeeded but couldn't "
  1926. "find a single result; LookupResultKind: {0}",
  1927. static_cast<int>(lookup->getResultKind())));
  1928. }
  1929. context.name_scopes().AddRequiredName(scope_id, name_id,
  1930. SemIR::ErrorInst::InstId);
  1931. return SemIR::ScopeLookupResult::MakeError();
  1932. }
  1933. if (!IsDeclInjectedClassName(context, scope_id, name_id,
  1934. lookup->getFoundDecl())) {
  1935. return ImportNameDeclIntoScope(context, loc_id, scope_id, name_id,
  1936. lookup->getFoundDecl(),
  1937. lookup->begin().getAccess());
  1938. }
  1939. clang::DeclContextLookupResult constructors_lookup =
  1940. ClangConstructorLookup(context, scope_id);
  1941. clang::UnresolvedSet<4> overload_set;
  1942. for (clang::Decl* decl : constructors_lookup) {
  1943. auto* constructor = cast<clang::CXXConstructorDecl>(decl);
  1944. if (constructor->isDeleted() || constructor->isCopyOrMoveConstructor()) {
  1945. continue;
  1946. }
  1947. overload_set.addDecl(constructor, constructor->getAccess());
  1948. }
  1949. if (overload_set.empty()) {
  1950. return SemIR::ScopeLookupResult::MakeNotFound();
  1951. }
  1952. return ImportOverloadSetIntoScope(context, loc_id, scope_id, name_id,
  1953. overload_set);
  1954. }
  1955. static auto GetClangOperatorKind(Context& context, SemIR::LocId loc_id,
  1956. llvm::StringLiteral interface_name,
  1957. llvm::StringLiteral op_name)
  1958. -> std::optional<clang::OverloadedOperatorKind> {
  1959. // Unary operators.
  1960. if (interface_name == "Destroy" || interface_name == "As" ||
  1961. interface_name == "ImplicitAs") {
  1962. // TODO: Support destructors and conversions.
  1963. return std::nullopt;
  1964. }
  1965. // Increment and Decrement.
  1966. if (interface_name == "Inc") {
  1967. CARBON_CHECK(op_name == "Op");
  1968. return clang::OO_PlusPlus;
  1969. }
  1970. if (interface_name == "Dec") {
  1971. CARBON_CHECK(op_name == "Op");
  1972. return clang::OO_MinusMinus;
  1973. }
  1974. // Arithmetic.
  1975. if (interface_name == "Negate") {
  1976. CARBON_CHECK(op_name == "Op");
  1977. return clang::OO_Minus;
  1978. }
  1979. // Binary operators.
  1980. // Arithmetic Operators.
  1981. if (interface_name == "AddWith") {
  1982. CARBON_CHECK(op_name == "Op");
  1983. return clang::OO_Plus;
  1984. }
  1985. if (interface_name == "SubWith") {
  1986. CARBON_CHECK(op_name == "Op");
  1987. return clang::OO_Minus;
  1988. }
  1989. if (interface_name == "MulWith") {
  1990. CARBON_CHECK(op_name == "Op");
  1991. return clang::OO_Star;
  1992. }
  1993. if (interface_name == "DivWith") {
  1994. CARBON_CHECK(op_name == "Op");
  1995. return clang::OO_Slash;
  1996. }
  1997. if (interface_name == "ModWith") {
  1998. CARBON_CHECK(op_name == "Op");
  1999. return clang::OO_Percent;
  2000. }
  2001. // Bitwise Operators.
  2002. if (interface_name == "BitAndWith") {
  2003. CARBON_CHECK(op_name == "Op");
  2004. return clang::OO_Amp;
  2005. }
  2006. if (interface_name == "BitOrWith") {
  2007. CARBON_CHECK(op_name == "Op");
  2008. return clang::OO_Pipe;
  2009. }
  2010. if (interface_name == "BitXorWith") {
  2011. CARBON_CHECK(op_name == "Op");
  2012. return clang::OO_Caret;
  2013. }
  2014. if (interface_name == "LeftShiftWith") {
  2015. CARBON_CHECK(op_name == "Op");
  2016. return clang::OO_LessLess;
  2017. }
  2018. if (interface_name == "RightShiftWith") {
  2019. CARBON_CHECK(op_name == "Op");
  2020. return clang::OO_GreaterGreater;
  2021. }
  2022. // Compound Assignment Arithmetic Operators.
  2023. if (interface_name == "AddAssignWith") {
  2024. CARBON_CHECK(op_name == "Op");
  2025. return clang::OO_PlusEqual;
  2026. }
  2027. if (interface_name == "SubAssignWith") {
  2028. CARBON_CHECK(op_name == "Op");
  2029. return clang::OO_MinusEqual;
  2030. }
  2031. if (interface_name == "MulAssignWith") {
  2032. CARBON_CHECK(op_name == "Op");
  2033. return clang::OO_StarEqual;
  2034. }
  2035. if (interface_name == "DivAssignWith") {
  2036. CARBON_CHECK(op_name == "Op");
  2037. return clang::OO_SlashEqual;
  2038. }
  2039. if (interface_name == "ModAssignWith") {
  2040. CARBON_CHECK(op_name == "Op");
  2041. return clang::OO_PercentEqual;
  2042. }
  2043. // Compound Assignment Bitwise Operators.
  2044. if (interface_name == "BitAndAssignWith") {
  2045. CARBON_CHECK(op_name == "Op");
  2046. return clang::OO_AmpEqual;
  2047. }
  2048. if (interface_name == "BitOrAssignWith") {
  2049. CARBON_CHECK(op_name == "Op");
  2050. return clang::OO_PipeEqual;
  2051. }
  2052. if (interface_name == "BitXorAssignWith") {
  2053. CARBON_CHECK(op_name == "Op");
  2054. return clang::OO_CaretEqual;
  2055. }
  2056. // TODO: Add support for `LeftShiftAssignWith` (`OO_LessLessEqual`) and
  2057. // `RightShiftAssignWith` (`OO_GreaterGreaterEqual`) when references are
  2058. // supported.
  2059. // Relational Operators.
  2060. if (interface_name == "EqWith") {
  2061. if (op_name == "Equal") {
  2062. return clang::OO_EqualEqual;
  2063. }
  2064. CARBON_CHECK(op_name == "NotEqual");
  2065. return clang::OO_ExclaimEqual;
  2066. }
  2067. if (interface_name == "OrderedWith") {
  2068. if (op_name == "Less") {
  2069. return clang::OO_Less;
  2070. }
  2071. if (op_name == "Greater") {
  2072. return clang::OO_Greater;
  2073. }
  2074. if (op_name == "LessOrEquivalent") {
  2075. return clang::OO_LessEqual;
  2076. }
  2077. CARBON_CHECK(op_name == "GreaterOrEquivalent");
  2078. return clang::OO_GreaterEqual;
  2079. }
  2080. context.TODO(loc_id, llvm::formatv("Unsupported operator interface `{0}`",
  2081. interface_name));
  2082. return std::nullopt;
  2083. }
  2084. auto ImportOperatorFromCpp(Context& context, SemIR::LocId loc_id,
  2085. SemIR::NameScopeId scope_id, Operator op)
  2086. -> SemIR::ScopeLookupResult {
  2087. Diagnostics::AnnotationScope annotate_diagnostics(
  2088. &context.emitter(), [&](auto& builder) {
  2089. CARBON_DIAGNOSTIC(InCppOperatorLookup, Note,
  2090. "in `Cpp` operator `{0}` lookup", std::string);
  2091. builder.Note(loc_id, InCppOperatorLookup, op.interface_name.str());
  2092. });
  2093. auto op_kind =
  2094. GetClangOperatorKind(context, loc_id, op.interface_name, op.op_name);
  2095. if (!op_kind) {
  2096. return SemIR::ScopeLookupResult::MakeNotFound();
  2097. }
  2098. // TODO: We should do ADL-only lookup for operators
  2099. // (`Sema::ArgumentDependentLookup`), when we support mapping Carbon types
  2100. // into C++ types. See
  2101. // https://github.com/carbon-language/carbon-lang/pull/5996/files/5d01fa69511b76f87efbc0387f5e40abcf4c911a#r2316950123
  2102. auto decl_and_access = ClangLookupDeclarationName(
  2103. context, loc_id, scope_id,
  2104. context.ast_context().DeclarationNames.getCXXOperatorName(*op_kind));
  2105. if (!decl_and_access) {
  2106. return SemIR::ScopeLookupResult::MakeNotFound();
  2107. }
  2108. auto [decl, access] = *decl_and_access;
  2109. if (!decl) {
  2110. return SemIR::ScopeLookupResult::MakeError();
  2111. }
  2112. SemIR::InstId inst_id = ImportDeclAndDependencies(context, loc_id, decl);
  2113. if (!inst_id.has_value()) {
  2114. return SemIR::ScopeLookupResult::MakeNotFound();
  2115. }
  2116. SemIR::AccessKind access_kind = MapAccess(access);
  2117. return SemIR::ScopeLookupResult::MakeWrappedLookupResult(inst_id,
  2118. access_kind);
  2119. }
  2120. auto ImportClassDefinitionForClangDecl(Context& context, SemIR::LocId loc_id,
  2121. SemIR::ClassId class_id,
  2122. SemIR::ClangDeclId clang_decl_id)
  2123. -> bool {
  2124. clang::ASTUnit* ast = context.sem_ir().clang_ast_unit();
  2125. CARBON_CHECK(ast);
  2126. auto* clang_decl = cast<clang::TagDecl>(
  2127. context.sem_ir().clang_decls().Get(clang_decl_id).decl);
  2128. auto class_inst_id = context.types().GetAsTypeInstId(
  2129. context.classes().Get(class_id).first_owning_decl_id);
  2130. // TODO: Map loc_id into a clang location and use it for diagnostics if
  2131. // instantiation fails, instead of annotating the diagnostic with another
  2132. // location.
  2133. clang::SourceLocation loc = clang_decl->getLocation();
  2134. Diagnostics::AnnotationScope annotate_diagnostics(
  2135. &context.emitter(), [&](auto& builder) {
  2136. CARBON_DIAGNOSTIC(InCppTypeCompletion, Note,
  2137. "while completing C++ type {0}", SemIR::TypeId);
  2138. builder.Note(loc_id, InCppTypeCompletion,
  2139. context.classes().Get(class_id).self_type_id);
  2140. });
  2141. // Ask Clang whether the type is complete. This triggers template
  2142. // instantiation if necessary.
  2143. clang::DiagnosticErrorTrap trap(ast->getDiagnostics());
  2144. if (!ast->getSema().isCompleteType(
  2145. loc, context.ast_context().getCanonicalTagType(clang_decl))) {
  2146. // Type is incomplete. Nothing more to do, but tell the caller if we
  2147. // produced an error.
  2148. return !trap.hasErrorOccurred();
  2149. }
  2150. auto import_ir_inst_id =
  2151. context.insts().GetCanonicalLocId(class_inst_id).import_ir_inst_id();
  2152. if (auto* class_decl = dyn_cast<clang::CXXRecordDecl>(clang_decl)) {
  2153. auto* class_def = class_decl->getDefinition();
  2154. CARBON_CHECK(class_def, "Complete type has no definition");
  2155. if (class_def->getNumVBases()) {
  2156. // TODO: Handle virtual bases. We don't actually know where they go in the
  2157. // layout. We may also want to use a different size in the layout for
  2158. // `partial C`, excluding the virtual base. It's also not entirely safe to
  2159. // just skip over the virtual base, as the type we would construct would
  2160. // have a misleading size. For now, treat a C++ class with vbases as
  2161. // incomplete in Carbon.
  2162. context.TODO(loc_id, "class with virtual bases");
  2163. return false;
  2164. }
  2165. BuildClassDefinition(context, import_ir_inst_id, class_id, class_inst_id,
  2166. class_def);
  2167. } else if (auto* enum_decl = dyn_cast<clang::EnumDecl>(clang_decl)) {
  2168. BuildEnumDefinition(context, import_ir_inst_id, class_id, class_inst_id,
  2169. enum_decl);
  2170. }
  2171. return true;
  2172. }
  2173. } // namespace Carbon::Check