import.cpp 99 KB

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