cpp_import.cpp 95 KB

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