1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114 |
- //===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
- //
- // The LLVM Compiler Infrastructure
- //
- // This file is distributed under the University of Illinois Open Source
- // License. See LICENSE.TXT for details.
- //
- //===----------------------------------------------------------------------===//
- //
- // This is the internal per-function state used for llvm translation.
- //
- //===----------------------------------------------------------------------===//
- #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
- #define LLVM_CLANG_LIB_CODEGEN_CODEGENFUNCTION_H
- #include "CGBuilder.h"
- #include "CGDebugInfo.h"
- #include "CGLoopInfo.h"
- #include "CGValue.h"
- #include "CodeGenModule.h"
- #include "CodeGenPGO.h"
- #include "EHScopeStack.h"
- #include "VarBypassDetector.h"
- #include "clang/AST/CharUnits.h"
- #include "clang/AST/ExprCXX.h"
- #include "clang/AST/ExprObjC.h"
- #include "clang/AST/ExprOpenMP.h"
- #include "clang/AST/Type.h"
- #include "clang/Basic/ABI.h"
- #include "clang/Basic/CapturedStmt.h"
- #include "clang/Basic/OpenMPKinds.h"
- #include "clang/Basic/TargetInfo.h"
- #include "clang/Frontend/CodeGenOptions.h"
- #include "llvm/ADT/ArrayRef.h"
- #include "llvm/ADT/DenseMap.h"
- #include "llvm/ADT/MapVector.h"
- #include "llvm/ADT/SmallVector.h"
- #include "llvm/IR/ValueHandle.h"
- #include "llvm/Support/Debug.h"
- #include "llvm/Transforms/Utils/SanitizerStats.h"
- namespace llvm {
- class BasicBlock;
- class LLVMContext;
- class MDNode;
- class Module;
- class SwitchInst;
- class Twine;
- class Value;
- class CallSite;
- }
- namespace clang {
- class ASTContext;
- class BlockDecl;
- class CXXDestructorDecl;
- class CXXForRangeStmt;
- class CXXTryStmt;
- class Decl;
- class LabelDecl;
- class EnumConstantDecl;
- class FunctionDecl;
- class FunctionProtoType;
- class LabelStmt;
- class ObjCContainerDecl;
- class ObjCInterfaceDecl;
- class ObjCIvarDecl;
- class ObjCMethodDecl;
- class ObjCImplementationDecl;
- class ObjCPropertyImplDecl;
- class TargetInfo;
- class VarDecl;
- class ObjCForCollectionStmt;
- class ObjCAtTryStmt;
- class ObjCAtThrowStmt;
- class ObjCAtSynchronizedStmt;
- class ObjCAutoreleasePoolStmt;
- namespace analyze_os_log {
- class OSLogBufferLayout;
- }
- namespace CodeGen {
- class CodeGenTypes;
- class CGCallee;
- class CGFunctionInfo;
- class CGRecordLayout;
- class CGBlockInfo;
- class CGCXXABI;
- class BlockByrefHelpers;
- class BlockByrefInfo;
- class BlockFlags;
- class BlockFieldFlags;
- class RegionCodeGenTy;
- class TargetCodeGenInfo;
- struct OMPTaskDataTy;
- struct CGCoroData;
- /// The kind of evaluation to perform on values of a particular
- /// type. Basically, is the code in CGExprScalar, CGExprComplex, or
- /// CGExprAgg?
- ///
- /// TODO: should vectors maybe be split out into their own thing?
- enum TypeEvaluationKind {
- TEK_Scalar,
- TEK_Complex,
- TEK_Aggregate
- };
- #define LIST_SANITIZER_CHECKS \
- SANITIZER_CHECK(AddOverflow, add_overflow, 0) \
- SANITIZER_CHECK(BuiltinUnreachable, builtin_unreachable, 0) \
- SANITIZER_CHECK(CFICheckFail, cfi_check_fail, 0) \
- SANITIZER_CHECK(DivremOverflow, divrem_overflow, 0) \
- SANITIZER_CHECK(DynamicTypeCacheMiss, dynamic_type_cache_miss, 0) \
- SANITIZER_CHECK(FloatCastOverflow, float_cast_overflow, 0) \
- SANITIZER_CHECK(FunctionTypeMismatch, function_type_mismatch, 0) \
- SANITIZER_CHECK(InvalidBuiltin, invalid_builtin, 0) \
- SANITIZER_CHECK(LoadInvalidValue, load_invalid_value, 0) \
- SANITIZER_CHECK(MissingReturn, missing_return, 0) \
- SANITIZER_CHECK(MulOverflow, mul_overflow, 0) \
- SANITIZER_CHECK(NegateOverflow, negate_overflow, 0) \
- SANITIZER_CHECK(NullabilityArg, nullability_arg, 0) \
- SANITIZER_CHECK(NullabilityReturn, nullability_return, 1) \
- SANITIZER_CHECK(NonnullArg, nonnull_arg, 0) \
- SANITIZER_CHECK(NonnullReturn, nonnull_return, 1) \
- SANITIZER_CHECK(OutOfBounds, out_of_bounds, 0) \
- SANITIZER_CHECK(PointerOverflow, pointer_overflow, 0) \
- SANITIZER_CHECK(ShiftOutOfBounds, shift_out_of_bounds, 0) \
- SANITIZER_CHECK(SubOverflow, sub_overflow, 0) \
- SANITIZER_CHECK(TypeMismatch, type_mismatch, 1) \
- SANITIZER_CHECK(VLABoundNotPositive, vla_bound_not_positive, 0)
- enum SanitizerHandler {
- #define SANITIZER_CHECK(Enum, Name, Version) Enum,
- LIST_SANITIZER_CHECKS
- #undef SANITIZER_CHECK
- };
- /// CodeGenFunction - This class organizes the per-function state that is used
- /// while generating LLVM code.
- class CodeGenFunction : public CodeGenTypeCache {
- CodeGenFunction(const CodeGenFunction &) = delete;
- void operator=(const CodeGenFunction &) = delete;
- friend class CGCXXABI;
- public:
- /// A jump destination is an abstract label, branching to which may
- /// require a jump out through normal cleanups.
- struct JumpDest {
- JumpDest() : Block(nullptr), ScopeDepth(), Index(0) {}
- JumpDest(llvm::BasicBlock *Block,
- EHScopeStack::stable_iterator Depth,
- unsigned Index)
- : Block(Block), ScopeDepth(Depth), Index(Index) {}
- bool isValid() const { return Block != nullptr; }
- llvm::BasicBlock *getBlock() const { return Block; }
- EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
- unsigned getDestIndex() const { return Index; }
- // This should be used cautiously.
- void setScopeDepth(EHScopeStack::stable_iterator depth) {
- ScopeDepth = depth;
- }
- private:
- llvm::BasicBlock *Block;
- EHScopeStack::stable_iterator ScopeDepth;
- unsigned Index;
- };
- CodeGenModule &CGM; // Per-module state.
- const TargetInfo &Target;
- typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
- LoopInfoStack LoopStack;
- CGBuilderTy Builder;
- // Stores variables for which we can't generate correct lifetime markers
- // because of jumps.
- VarBypassDetector Bypasses;
- // CodeGen lambda for loops and support for ordered clause
- typedef llvm::function_ref<void(CodeGenFunction &, const OMPLoopDirective &,
- JumpDest)>
- CodeGenLoopTy;
- typedef llvm::function_ref<void(CodeGenFunction &, SourceLocation,
- const unsigned, const bool)>
- CodeGenOrderedTy;
- // Codegen lambda for loop bounds in worksharing loop constructs
- typedef llvm::function_ref<std::pair<LValue, LValue>(
- CodeGenFunction &, const OMPExecutableDirective &S)>
- CodeGenLoopBoundsTy;
- // Codegen lambda for loop bounds in dispatch-based loop implementation
- typedef llvm::function_ref<std::pair<llvm::Value *, llvm::Value *>(
- CodeGenFunction &, const OMPExecutableDirective &S, Address LB,
- Address UB)>
- CodeGenDispatchBoundsTy;
- /// \brief CGBuilder insert helper. This function is called after an
- /// instruction is created using Builder.
- void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name,
- llvm::BasicBlock *BB,
- llvm::BasicBlock::iterator InsertPt) const;
- /// CurFuncDecl - Holds the Decl for the current outermost
- /// non-closure context.
- const Decl *CurFuncDecl;
- /// CurCodeDecl - This is the inner-most code context, which includes blocks.
- const Decl *CurCodeDecl;
- const CGFunctionInfo *CurFnInfo;
- QualType FnRetTy;
- llvm::Function *CurFn;
- // Holds coroutine data if the current function is a coroutine. We use a
- // wrapper to manage its lifetime, so that we don't have to define CGCoroData
- // in this header.
- struct CGCoroInfo {
- std::unique_ptr<CGCoroData> Data;
- CGCoroInfo();
- ~CGCoroInfo();
- };
- CGCoroInfo CurCoro;
- bool isCoroutine() const {
- return CurCoro.Data != nullptr;
- }
- /// CurGD - The GlobalDecl for the current function being compiled.
- GlobalDecl CurGD;
- /// PrologueCleanupDepth - The cleanup depth enclosing all the
- /// cleanups associated with the parameters.
- EHScopeStack::stable_iterator PrologueCleanupDepth;
- /// ReturnBlock - Unified return block.
- JumpDest ReturnBlock;
- /// ReturnValue - The temporary alloca to hold the return
- /// value. This is invalid iff the function has no return value.
- Address ReturnValue;
- /// Return true if a label was seen in the current scope.
- bool hasLabelBeenSeenInCurrentScope() const {
- if (CurLexicalScope)
- return CurLexicalScope->hasLabels();
- return !LabelMap.empty();
- }
- /// AllocaInsertPoint - This is an instruction in the entry block before which
- /// we prefer to insert allocas.
- llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
- /// \brief API for captured statement code generation.
- class CGCapturedStmtInfo {
- public:
- explicit CGCapturedStmtInfo(CapturedRegionKind K = CR_Default)
- : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {}
- explicit CGCapturedStmtInfo(const CapturedStmt &S,
- CapturedRegionKind K = CR_Default)
- : Kind(K), ThisValue(nullptr), CXXThisFieldDecl(nullptr) {
- RecordDecl::field_iterator Field =
- S.getCapturedRecordDecl()->field_begin();
- for (CapturedStmt::const_capture_iterator I = S.capture_begin(),
- E = S.capture_end();
- I != E; ++I, ++Field) {
- if (I->capturesThis())
- CXXThisFieldDecl = *Field;
- else if (I->capturesVariable())
- CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
- else if (I->capturesVariableByCopy())
- CaptureFields[I->getCapturedVar()->getCanonicalDecl()] = *Field;
- }
- }
- virtual ~CGCapturedStmtInfo();
- CapturedRegionKind getKind() const { return Kind; }
- virtual void setContextValue(llvm::Value *V) { ThisValue = V; }
- // \brief Retrieve the value of the context parameter.
- virtual llvm::Value *getContextValue() const { return ThisValue; }
- /// \brief Lookup the captured field decl for a variable.
- virtual const FieldDecl *lookup(const VarDecl *VD) const {
- return CaptureFields.lookup(VD->getCanonicalDecl());
- }
- bool isCXXThisExprCaptured() const { return getThisFieldDecl() != nullptr; }
- virtual FieldDecl *getThisFieldDecl() const { return CXXThisFieldDecl; }
- static bool classof(const CGCapturedStmtInfo *) {
- return true;
- }
- /// \brief Emit the captured statement body.
- virtual void EmitBody(CodeGenFunction &CGF, const Stmt *S) {
- CGF.incrementProfileCounter(S);
- CGF.EmitStmt(S);
- }
- /// \brief Get the name of the capture helper.
- virtual StringRef getHelperName() const { return "__captured_stmt"; }
- private:
- /// \brief The kind of captured statement being generated.
- CapturedRegionKind Kind;
- /// \brief Keep the map between VarDecl and FieldDecl.
- llvm::SmallDenseMap<const VarDecl *, FieldDecl *> CaptureFields;
- /// \brief The base address of the captured record, passed in as the first
- /// argument of the parallel region function.
- llvm::Value *ThisValue;
- /// \brief Captured 'this' type.
- FieldDecl *CXXThisFieldDecl;
- };
- CGCapturedStmtInfo *CapturedStmtInfo;
- /// \brief RAII for correct setting/restoring of CapturedStmtInfo.
- class CGCapturedStmtRAII {
- private:
- CodeGenFunction &CGF;
- CGCapturedStmtInfo *PrevCapturedStmtInfo;
- public:
- CGCapturedStmtRAII(CodeGenFunction &CGF,
- CGCapturedStmtInfo *NewCapturedStmtInfo)
- : CGF(CGF), PrevCapturedStmtInfo(CGF.CapturedStmtInfo) {
- CGF.CapturedStmtInfo = NewCapturedStmtInfo;
- }
- ~CGCapturedStmtRAII() { CGF.CapturedStmtInfo = PrevCapturedStmtInfo; }
- };
- /// An abstract representation of regular/ObjC call/message targets.
- class AbstractCallee {
- /// The function declaration of the callee.
- const Decl *CalleeDecl;
- public:
- AbstractCallee() : CalleeDecl(nullptr) {}
- AbstractCallee(const FunctionDecl *FD) : CalleeDecl(FD) {}
- AbstractCallee(const ObjCMethodDecl *OMD) : CalleeDecl(OMD) {}
- bool hasFunctionDecl() const {
- return dyn_cast_or_null<FunctionDecl>(CalleeDecl);
- }
- const Decl *getDecl() const { return CalleeDecl; }
- unsigned getNumParams() const {
- if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
- return FD->getNumParams();
- return cast<ObjCMethodDecl>(CalleeDecl)->param_size();
- }
- const ParmVarDecl *getParamDecl(unsigned I) const {
- if (const auto *FD = dyn_cast<FunctionDecl>(CalleeDecl))
- return FD->getParamDecl(I);
- return *(cast<ObjCMethodDecl>(CalleeDecl)->param_begin() + I);
- }
- };
- /// \brief Sanitizers enabled for this function.
- SanitizerSet SanOpts;
- /// \brief True if CodeGen currently emits code implementing sanitizer checks.
- bool IsSanitizerScope;
- /// \brief RAII object to set/unset CodeGenFunction::IsSanitizerScope.
- class SanitizerScope {
- CodeGenFunction *CGF;
- public:
- SanitizerScope(CodeGenFunction *CGF);
- ~SanitizerScope();
- };
- /// In C++, whether we are code generating a thunk. This controls whether we
- /// should emit cleanups.
- bool CurFuncIsThunk;
- /// In ARC, whether we should autorelease the return value.
- bool AutoreleaseResult;
- /// Whether we processed a Microsoft-style asm block during CodeGen. These can
- /// potentially set the return value.
- bool SawAsmBlock;
- const FunctionDecl *CurSEHParent = nullptr;
- /// True if the current function is an outlined SEH helper. This can be a
- /// finally block or filter expression.
- bool IsOutlinedSEHHelper;
- const CodeGen::CGBlockInfo *BlockInfo;
- llvm::Value *BlockPointer;
- llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
- FieldDecl *LambdaThisCaptureField;
- /// \brief A mapping from NRVO variables to the flags used to indicate
- /// when the NRVO has been applied to this variable.
- llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
- EHScopeStack EHStack;
- llvm::SmallVector<char, 256> LifetimeExtendedCleanupStack;
- llvm::SmallVector<const JumpDest *, 2> SEHTryEpilogueStack;
- llvm::Instruction *CurrentFuncletPad = nullptr;
- class CallLifetimeEnd final : public EHScopeStack::Cleanup {
- llvm::Value *Addr;
- llvm::Value *Size;
- public:
- CallLifetimeEnd(Address addr, llvm::Value *size)
- : Addr(addr.getPointer()), Size(size) {}
- void Emit(CodeGenFunction &CGF, Flags flags) override {
- CGF.EmitLifetimeEnd(Size, Addr);
- }
- };
- /// Header for data within LifetimeExtendedCleanupStack.
- struct LifetimeExtendedCleanupHeader {
- /// The size of the following cleanup object.
- unsigned Size;
- /// The kind of cleanup to push: a value from the CleanupKind enumeration.
- CleanupKind Kind;
- size_t getSize() const { return Size; }
- CleanupKind getKind() const { return Kind; }
- };
- /// i32s containing the indexes of the cleanup destinations.
- llvm::AllocaInst *NormalCleanupDest;
- unsigned NextCleanupDestIndex;
- /// FirstBlockInfo - The head of a singly-linked-list of block layouts.
- CGBlockInfo *FirstBlockInfo;
- /// EHResumeBlock - Unified block containing a call to llvm.eh.resume.
- llvm::BasicBlock *EHResumeBlock;
- /// The exception slot. All landing pads write the current exception pointer
- /// into this alloca.
- llvm::Value *ExceptionSlot;
- /// The selector slot. Under the MandatoryCleanup model, all landing pads
- /// write the current selector value into this alloca.
- llvm::AllocaInst *EHSelectorSlot;
- /// A stack of exception code slots. Entering an __except block pushes a slot
- /// on the stack and leaving pops one. The __exception_code() intrinsic loads
- /// a value from the top of the stack.
- SmallVector<Address, 1> SEHCodeSlotStack;
- /// Value returned by __exception_info intrinsic.
- llvm::Value *SEHInfo = nullptr;
- /// Emits a landing pad for the current EH stack.
- llvm::BasicBlock *EmitLandingPad();
- llvm::BasicBlock *getInvokeDestImpl();
- template <class T>
- typename DominatingValue<T>::saved_type saveValueInCond(T value) {
- return DominatingValue<T>::save(*this, value);
- }
- public:
- /// ObjCEHValueStack - Stack of Objective-C exception values, used for
- /// rethrows.
- SmallVector<llvm::Value*, 8> ObjCEHValueStack;
- /// A class controlling the emission of a finally block.
- class FinallyInfo {
- /// Where the catchall's edge through the cleanup should go.
- JumpDest RethrowDest;
- /// A function to call to enter the catch.
- llvm::Constant *BeginCatchFn;
- /// An i1 variable indicating whether or not the @finally is
- /// running for an exception.
- llvm::AllocaInst *ForEHVar;
- /// An i8* variable into which the exception pointer to rethrow
- /// has been saved.
- llvm::AllocaInst *SavedExnVar;
- public:
- void enter(CodeGenFunction &CGF, const Stmt *Finally,
- llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn,
- llvm::Constant *rethrowFn);
- void exit(CodeGenFunction &CGF);
- };
- /// Returns true inside SEH __try blocks.
- bool isSEHTryScope() const { return !SEHTryEpilogueStack.empty(); }
- /// Returns true while emitting a cleanuppad.
- bool isCleanupPadScope() const {
- return CurrentFuncletPad && isa<llvm::CleanupPadInst>(CurrentFuncletPad);
- }
- /// pushFullExprCleanup - Push a cleanup to be run at the end of the
- /// current full-expression. Safe against the possibility that
- /// we're currently inside a conditionally-evaluated expression.
- template <class T, class... As>
- void pushFullExprCleanup(CleanupKind kind, As... A) {
- // If we're not in a conditional branch, or if none of the
- // arguments requires saving, then use the unconditional cleanup.
- if (!isInConditionalBranch())
- return EHStack.pushCleanup<T>(kind, A...);
- // Stash values in a tuple so we can guarantee the order of saves.
- typedef std::tuple<typename DominatingValue<As>::saved_type...> SavedTuple;
- SavedTuple Saved{saveValueInCond(A)...};
- typedef EHScopeStack::ConditionalCleanup<T, As...> CleanupType;
- EHStack.pushCleanupTuple<CleanupType>(kind, Saved);
- initFullExprCleanup();
- }
- /// \brief Queue a cleanup to be pushed after finishing the current
- /// full-expression.
- template <class T, class... As>
- void pushCleanupAfterFullExpr(CleanupKind Kind, As... A) {
- assert(!isInConditionalBranch() && "can't defer conditional cleanup");
- LifetimeExtendedCleanupHeader Header = { sizeof(T), Kind };
- size_t OldSize = LifetimeExtendedCleanupStack.size();
- LifetimeExtendedCleanupStack.resize(
- LifetimeExtendedCleanupStack.size() + sizeof(Header) + Header.Size);
- static_assert(sizeof(Header) % alignof(T) == 0,
- "Cleanup will be allocated on misaligned address");
- char *Buffer = &LifetimeExtendedCleanupStack[OldSize];
- new (Buffer) LifetimeExtendedCleanupHeader(Header);
- new (Buffer + sizeof(Header)) T(A...);
- }
- /// Set up the last cleaup that was pushed as a conditional
- /// full-expression cleanup.
- void initFullExprCleanup();
- /// PushDestructorCleanup - Push a cleanup to call the
- /// complete-object destructor of an object of the given type at the
- /// given address. Does nothing if T is not a C++ class type with a
- /// non-trivial destructor.
- void PushDestructorCleanup(QualType T, Address Addr);
- /// PushDestructorCleanup - Push a cleanup to call the
- /// complete-object variant of the given destructor on the object at
- /// the given address.
- void PushDestructorCleanup(const CXXDestructorDecl *Dtor, Address Addr);
- /// PopCleanupBlock - Will pop the cleanup entry on the stack and
- /// process all branch fixups.
- void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
- /// DeactivateCleanupBlock - Deactivates the given cleanup block.
- /// The block cannot be reactivated. Pops it if it's the top of the
- /// stack.
- ///
- /// \param DominatingIP - An instruction which is known to
- /// dominate the current IP (if set) and which lies along
- /// all paths of execution between the current IP and the
- /// the point at which the cleanup comes into scope.
- void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
- llvm::Instruction *DominatingIP);
- /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
- /// Cannot be used to resurrect a deactivated cleanup.
- ///
- /// \param DominatingIP - An instruction which is known to
- /// dominate the current IP (if set) and which lies along
- /// all paths of execution between the current IP and the
- /// the point at which the cleanup comes into scope.
- void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup,
- llvm::Instruction *DominatingIP);
- /// \brief Enters a new scope for capturing cleanups, all of which
- /// will be executed once the scope is exited.
- class RunCleanupsScope {
- EHScopeStack::stable_iterator CleanupStackDepth;
- size_t LifetimeExtendedCleanupStackSize;
- bool OldDidCallStackSave;
- protected:
- bool PerformCleanup;
- private:
- RunCleanupsScope(const RunCleanupsScope &) = delete;
- void operator=(const RunCleanupsScope &) = delete;
- protected:
- CodeGenFunction& CGF;
- public:
- /// \brief Enter a new cleanup scope.
- explicit RunCleanupsScope(CodeGenFunction &CGF)
- : PerformCleanup(true), CGF(CGF)
- {
- CleanupStackDepth = CGF.EHStack.stable_begin();
- LifetimeExtendedCleanupStackSize =
- CGF.LifetimeExtendedCleanupStack.size();
- OldDidCallStackSave = CGF.DidCallStackSave;
- CGF.DidCallStackSave = false;
- }
- /// \brief Exit this cleanup scope, emitting any accumulated cleanups.
- ~RunCleanupsScope() {
- if (PerformCleanup)
- ForceCleanup();
- }
- /// \brief Determine whether this scope requires any cleanups.
- bool requiresCleanups() const {
- return CGF.EHStack.stable_begin() != CleanupStackDepth;
- }
- /// \brief Force the emission of cleanups now, instead of waiting
- /// until this object is destroyed.
- /// \param ValuesToReload - A list of values that need to be available at
- /// the insertion point after cleanup emission. If cleanup emission created
- /// a shared cleanup block, these value pointers will be rewritten.
- /// Otherwise, they not will be modified.
- void ForceCleanup(std::initializer_list<llvm::Value**> ValuesToReload = {}) {
- assert(PerformCleanup && "Already forced cleanup");
- CGF.DidCallStackSave = OldDidCallStackSave;
- CGF.PopCleanupBlocks(CleanupStackDepth, LifetimeExtendedCleanupStackSize,
- ValuesToReload);
- PerformCleanup = false;
- }
- };
- class LexicalScope : public RunCleanupsScope {
- SourceRange Range;
- SmallVector<const LabelDecl*, 4> Labels;
- LexicalScope *ParentScope;
- LexicalScope(const LexicalScope &) = delete;
- void operator=(const LexicalScope &) = delete;
- public:
- /// \brief Enter a new cleanup scope.
- explicit LexicalScope(CodeGenFunction &CGF, SourceRange Range)
- : RunCleanupsScope(CGF), Range(Range), ParentScope(CGF.CurLexicalScope) {
- CGF.CurLexicalScope = this;
- if (CGDebugInfo *DI = CGF.getDebugInfo())
- DI->EmitLexicalBlockStart(CGF.Builder, Range.getBegin());
- }
- void addLabel(const LabelDecl *label) {
- assert(PerformCleanup && "adding label to dead scope?");
- Labels.push_back(label);
- }
- /// \brief Exit this cleanup scope, emitting any accumulated
- /// cleanups.
- ~LexicalScope() {
- if (CGDebugInfo *DI = CGF.getDebugInfo())
- DI->EmitLexicalBlockEnd(CGF.Builder, Range.getEnd());
- // If we should perform a cleanup, force them now. Note that
- // this ends the cleanup scope before rescoping any labels.
- if (PerformCleanup) {
- ApplyDebugLocation DL(CGF, Range.getEnd());
- ForceCleanup();
- }
- }
- /// \brief Force the emission of cleanups now, instead of waiting
- /// until this object is destroyed.
- void ForceCleanup() {
- CGF.CurLexicalScope = ParentScope;
- RunCleanupsScope::ForceCleanup();
- if (!Labels.empty())
- rescopeLabels();
- }
- bool hasLabels() const {
- return !Labels.empty();
- }
- void rescopeLabels();
- };
- typedef llvm::DenseMap<const Decl *, Address> DeclMapTy;
- /// \brief The scope used to remap some variables as private in the OpenMP
- /// loop body (or other captured region emitted without outlining), and to
- /// restore old vars back on exit.
- class OMPPrivateScope : public RunCleanupsScope {
- DeclMapTy SavedLocals;
- DeclMapTy SavedPrivates;
- private:
- OMPPrivateScope(const OMPPrivateScope &) = delete;
- void operator=(const OMPPrivateScope &) = delete;
- public:
- /// \brief Enter a new OpenMP private scope.
- explicit OMPPrivateScope(CodeGenFunction &CGF) : RunCleanupsScope(CGF) {}
- /// \brief Registers \a LocalVD variable as a private and apply \a
- /// PrivateGen function for it to generate corresponding private variable.
- /// \a PrivateGen returns an address of the generated private variable.
- /// \return true if the variable is registered as private, false if it has
- /// been privatized already.
- bool
- addPrivate(const VarDecl *LocalVD,
- llvm::function_ref<Address()> PrivateGen) {
- assert(PerformCleanup && "adding private to dead scope");
- LocalVD = LocalVD->getCanonicalDecl();
- // Only save it once.
- if (SavedLocals.count(LocalVD)) return false;
- // Copy the existing local entry to SavedLocals.
- auto it = CGF.LocalDeclMap.find(LocalVD);
- if (it != CGF.LocalDeclMap.end()) {
- SavedLocals.insert({LocalVD, it->second});
- } else {
- SavedLocals.insert({LocalVD, Address::invalid()});
- }
- // Generate the private entry.
- Address Addr = PrivateGen();
- QualType VarTy = LocalVD->getType();
- if (VarTy->isReferenceType()) {
- Address Temp = CGF.CreateMemTemp(VarTy);
- CGF.Builder.CreateStore(Addr.getPointer(), Temp);
- Addr = Temp;
- }
- SavedPrivates.insert({LocalVD, Addr});
- return true;
- }
- /// \brief Privatizes local variables previously registered as private.
- /// Registration is separate from the actual privatization to allow
- /// initializers use values of the original variables, not the private one.
- /// This is important, for example, if the private variable is a class
- /// variable initialized by a constructor that references other private
- /// variables. But at initialization original variables must be used, not
- /// private copies.
- /// \return true if at least one variable was privatized, false otherwise.
- bool Privatize() {
- copyInto(SavedPrivates, CGF.LocalDeclMap);
- SavedPrivates.clear();
- return !SavedLocals.empty();
- }
- void ForceCleanup() {
- RunCleanupsScope::ForceCleanup();
- copyInto(SavedLocals, CGF.LocalDeclMap);
- SavedLocals.clear();
- }
- /// \brief Exit scope - all the mapped variables are restored.
- ~OMPPrivateScope() {
- if (PerformCleanup)
- ForceCleanup();
- }
- /// Checks if the global variable is captured in current function.
- bool isGlobalVarCaptured(const VarDecl *VD) const {
- VD = VD->getCanonicalDecl();
- return !VD->isLocalVarDeclOrParm() && CGF.LocalDeclMap.count(VD) > 0;
- }
- private:
- /// Copy all the entries in the source map over the corresponding
- /// entries in the destination, which must exist.
- static void copyInto(const DeclMapTy &src, DeclMapTy &dest) {
- for (auto &pair : src) {
- if (!pair.second.isValid()) {
- dest.erase(pair.first);
- continue;
- }
- auto it = dest.find(pair.first);
- if (it != dest.end()) {
- it->second = pair.second;
- } else {
- dest.insert(pair);
- }
- }
- }
- };
- /// \brief Takes the old cleanup stack size and emits the cleanup blocks
- /// that have been added.
- void
- PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
- std::initializer_list<llvm::Value **> ValuesToReload = {});
- /// \brief Takes the old cleanup stack size and emits the cleanup blocks
- /// that have been added, then adds all lifetime-extended cleanups from
- /// the given position to the stack.
- void
- PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize,
- size_t OldLifetimeExtendedStackSize,
- std::initializer_list<llvm::Value **> ValuesToReload = {});
- void ResolveBranchFixups(llvm::BasicBlock *Target);
- /// The given basic block lies in the current EH scope, but may be a
- /// target of a potentially scope-crossing jump; get a stable handle
- /// to which we can perform this jump later.
- JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
- return JumpDest(Target,
- EHStack.getInnermostNormalCleanup(),
- NextCleanupDestIndex++);
- }
- /// The given basic block lies in the current EH scope, but may be a
- /// target of a potentially scope-crossing jump; get a stable handle
- /// to which we can perform this jump later.
- JumpDest getJumpDestInCurrentScope(StringRef Name = StringRef()) {
- return getJumpDestInCurrentScope(createBasicBlock(Name));
- }
- /// EmitBranchThroughCleanup - Emit a branch from the current insert
- /// block through the normal cleanup handling code (if any) and then
- /// on to \arg Dest.
- void EmitBranchThroughCleanup(JumpDest Dest);
- /// isObviouslyBranchWithoutCleanups - Return true if a branch to the
- /// specified destination obviously has no cleanups to run. 'false' is always
- /// a conservatively correct answer for this method.
- bool isObviouslyBranchWithoutCleanups(JumpDest Dest) const;
- /// popCatchScope - Pops the catch scope at the top of the EHScope
- /// stack, emitting any required code (other than the catch handlers
- /// themselves).
- void popCatchScope();
- llvm::BasicBlock *getEHResumeBlock(bool isCleanup);
- llvm::BasicBlock *getEHDispatchBlock(EHScopeStack::stable_iterator scope);
- llvm::BasicBlock *getMSVCDispatchBlock(EHScopeStack::stable_iterator scope);
- /// An object to manage conditionally-evaluated expressions.
- class ConditionalEvaluation {
- llvm::BasicBlock *StartBB;
- public:
- ConditionalEvaluation(CodeGenFunction &CGF)
- : StartBB(CGF.Builder.GetInsertBlock()) {}
- void begin(CodeGenFunction &CGF) {
- assert(CGF.OutermostConditional != this);
- if (!CGF.OutermostConditional)
- CGF.OutermostConditional = this;
- }
- void end(CodeGenFunction &CGF) {
- assert(CGF.OutermostConditional != nullptr);
- if (CGF.OutermostConditional == this)
- CGF.OutermostConditional = nullptr;
- }
- /// Returns a block which will be executed prior to each
- /// evaluation of the conditional code.
- llvm::BasicBlock *getStartingBlock() const {
- return StartBB;
- }
- };
- /// isInConditionalBranch - Return true if we're currently emitting
- /// one branch or the other of a conditional expression.
- bool isInConditionalBranch() const { return OutermostConditional != nullptr; }
- void setBeforeOutermostConditional(llvm::Value *value, Address addr) {
- assert(isInConditionalBranch());
- llvm::BasicBlock *block = OutermostConditional->getStartingBlock();
- auto store = new llvm::StoreInst(value, addr.getPointer(), &block->back());
- store->setAlignment(addr.getAlignment().getQuantity());
- }
- /// An RAII object to record that we're evaluating a statement
- /// expression.
- class StmtExprEvaluation {
- CodeGenFunction &CGF;
- /// We have to save the outermost conditional: cleanups in a
- /// statement expression aren't conditional just because the
- /// StmtExpr is.
- ConditionalEvaluation *SavedOutermostConditional;
- public:
- StmtExprEvaluation(CodeGenFunction &CGF)
- : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
- CGF.OutermostConditional = nullptr;
- }
- ~StmtExprEvaluation() {
- CGF.OutermostConditional = SavedOutermostConditional;
- CGF.EnsureInsertPoint();
- }
- };
- /// An object which temporarily prevents a value from being
- /// destroyed by aggressive peephole optimizations that assume that
- /// all uses of a value have been realized in the IR.
- class PeepholeProtection {
- llvm::Instruction *Inst;
- friend class CodeGenFunction;
- public:
- PeepholeProtection() : Inst(nullptr) {}
- };
- /// A non-RAII class containing all the information about a bound
- /// opaque value. OpaqueValueMapping, below, is a RAII wrapper for
- /// this which makes individual mappings very simple; using this
- /// class directly is useful when you have a variable number of
- /// opaque values or don't want the RAII functionality for some
- /// reason.
- class OpaqueValueMappingData {
- const OpaqueValueExpr *OpaqueValue;
- bool BoundLValue;
- CodeGenFunction::PeepholeProtection Protection;
- OpaqueValueMappingData(const OpaqueValueExpr *ov,
- bool boundLValue)
- : OpaqueValue(ov), BoundLValue(boundLValue) {}
- public:
- OpaqueValueMappingData() : OpaqueValue(nullptr) {}
- static bool shouldBindAsLValue(const Expr *expr) {
- // gl-values should be bound as l-values for obvious reasons.
- // Records should be bound as l-values because IR generation
- // always keeps them in memory. Expressions of function type
- // act exactly like l-values but are formally required to be
- // r-values in C.
- return expr->isGLValue() ||
- expr->getType()->isFunctionType() ||
- hasAggregateEvaluationKind(expr->getType());
- }
- static OpaqueValueMappingData bind(CodeGenFunction &CGF,
- const OpaqueValueExpr *ov,
- const Expr *e) {
- if (shouldBindAsLValue(ov))
- return bind(CGF, ov, CGF.EmitLValue(e));
- return bind(CGF, ov, CGF.EmitAnyExpr(e));
- }
- static OpaqueValueMappingData bind(CodeGenFunction &CGF,
- const OpaqueValueExpr *ov,
- const LValue &lv) {
- assert(shouldBindAsLValue(ov));
- CGF.OpaqueLValues.insert(std::make_pair(ov, lv));
- return OpaqueValueMappingData(ov, true);
- }
- static OpaqueValueMappingData bind(CodeGenFunction &CGF,
- const OpaqueValueExpr *ov,
- const RValue &rv) {
- assert(!shouldBindAsLValue(ov));
- CGF.OpaqueRValues.insert(std::make_pair(ov, rv));
- OpaqueValueMappingData data(ov, false);
- // Work around an extremely aggressive peephole optimization in
- // EmitScalarConversion which assumes that all other uses of a
- // value are extant.
- data.Protection = CGF.protectFromPeepholes(rv);
- return data;
- }
- bool isValid() const { return OpaqueValue != nullptr; }
- void clear() { OpaqueValue = nullptr; }
- void unbind(CodeGenFunction &CGF) {
- assert(OpaqueValue && "no data to unbind!");
- if (BoundLValue) {
- CGF.OpaqueLValues.erase(OpaqueValue);
- } else {
- CGF.OpaqueRValues.erase(OpaqueValue);
- CGF.unprotectFromPeepholes(Protection);
- }
- }
- };
- /// An RAII object to set (and then clear) a mapping for an OpaqueValueExpr.
- class OpaqueValueMapping {
- CodeGenFunction &CGF;
- OpaqueValueMappingData Data;
- public:
- static bool shouldBindAsLValue(const Expr *expr) {
- return OpaqueValueMappingData::shouldBindAsLValue(expr);
- }
- /// Build the opaque value mapping for the given conditional
- /// operator if it's the GNU ?: extension. This is a common
- /// enough pattern that the convenience operator is really
- /// helpful.
- ///
- OpaqueValueMapping(CodeGenFunction &CGF,
- const AbstractConditionalOperator *op) : CGF(CGF) {
- if (isa<ConditionalOperator>(op))
- // Leave Data empty.
- return;
- const BinaryConditionalOperator *e = cast<BinaryConditionalOperator>(op);
- Data = OpaqueValueMappingData::bind(CGF, e->getOpaqueValue(),
- e->getCommon());
- }
- /// Build the opaque value mapping for an OpaqueValueExpr whose source
- /// expression is set to the expression the OVE represents.
- OpaqueValueMapping(CodeGenFunction &CGF, const OpaqueValueExpr *OV)
- : CGF(CGF) {
- if (OV) {
- assert(OV->getSourceExpr() && "wrong form of OpaqueValueMapping used "
- "for OVE with no source expression");
- Data = OpaqueValueMappingData::bind(CGF, OV, OV->getSourceExpr());
- }
- }
- OpaqueValueMapping(CodeGenFunction &CGF,
- const OpaqueValueExpr *opaqueValue,
- LValue lvalue)
- : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, lvalue)) {
- }
- OpaqueValueMapping(CodeGenFunction &CGF,
- const OpaqueValueExpr *opaqueValue,
- RValue rvalue)
- : CGF(CGF), Data(OpaqueValueMappingData::bind(CGF, opaqueValue, rvalue)) {
- }
- void pop() {
- Data.unbind(CGF);
- Data.clear();
- }
- ~OpaqueValueMapping() {
- if (Data.isValid()) Data.unbind(CGF);
- }
- };
- private:
- CGDebugInfo *DebugInfo;
- bool DisableDebugInfo;
- /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
- /// calling llvm.stacksave for multiple VLAs in the same scope.
- bool DidCallStackSave;
- /// IndirectBranch - The first time an indirect goto is seen we create a block
- /// with an indirect branch. Every time we see the address of a label taken,
- /// we add the label to the indirect goto. Every subsequent indirect goto is
- /// codegen'd as a jump to the IndirectBranch's basic block.
- llvm::IndirectBrInst *IndirectBranch;
- /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
- /// decls.
- DeclMapTy LocalDeclMap;
- /// SizeArguments - If a ParmVarDecl had the pass_object_size attribute, this
- /// will contain a mapping from said ParmVarDecl to its implicit "object_size"
- /// parameter.
- llvm::SmallDenseMap<const ParmVarDecl *, const ImplicitParamDecl *, 2>
- SizeArguments;
- /// Track escaped local variables with auto storage. Used during SEH
- /// outlining to produce a call to llvm.localescape.
- llvm::DenseMap<llvm::AllocaInst *, int> EscapedLocals;
- /// LabelMap - This keeps track of the LLVM basic block for each C label.
- llvm::DenseMap<const LabelDecl*, JumpDest> LabelMap;
- // BreakContinueStack - This keeps track of where break and continue
- // statements should jump to.
- struct BreakContinue {
- BreakContinue(JumpDest Break, JumpDest Continue)
- : BreakBlock(Break), ContinueBlock(Continue) {}
- JumpDest BreakBlock;
- JumpDest ContinueBlock;
- };
- SmallVector<BreakContinue, 8> BreakContinueStack;
- /// Handles cancellation exit points in OpenMP-related constructs.
- class OpenMPCancelExitStack {
- /// Tracks cancellation exit point and join point for cancel-related exit
- /// and normal exit.
- struct CancelExit {
- CancelExit() = default;
- CancelExit(OpenMPDirectiveKind Kind, JumpDest ExitBlock,
- JumpDest ContBlock)
- : Kind(Kind), ExitBlock(ExitBlock), ContBlock(ContBlock) {}
- OpenMPDirectiveKind Kind = OMPD_unknown;
- /// true if the exit block has been emitted already by the special
- /// emitExit() call, false if the default codegen is used.
- bool HasBeenEmitted = false;
- JumpDest ExitBlock;
- JumpDest ContBlock;
- };
- SmallVector<CancelExit, 8> Stack;
- public:
- OpenMPCancelExitStack() : Stack(1) {}
- ~OpenMPCancelExitStack() = default;
- /// Fetches the exit block for the current OpenMP construct.
- JumpDest getExitBlock() const { return Stack.back().ExitBlock; }
- /// Emits exit block with special codegen procedure specific for the related
- /// OpenMP construct + emits code for normal construct cleanup.
- void emitExit(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
- const llvm::function_ref<void(CodeGenFunction &)> &CodeGen) {
- if (Stack.back().Kind == Kind && getExitBlock().isValid()) {
- assert(CGF.getOMPCancelDestination(Kind).isValid());
- assert(CGF.HaveInsertPoint());
- assert(!Stack.back().HasBeenEmitted);
- auto IP = CGF.Builder.saveAndClearIP();
- CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
- CodeGen(CGF);
- CGF.EmitBranch(Stack.back().ContBlock.getBlock());
- CGF.Builder.restoreIP(IP);
- Stack.back().HasBeenEmitted = true;
- }
- CodeGen(CGF);
- }
- /// Enter the cancel supporting \a Kind construct.
- /// \param Kind OpenMP directive that supports cancel constructs.
- /// \param HasCancel true, if the construct has inner cancel directive,
- /// false otherwise.
- void enter(CodeGenFunction &CGF, OpenMPDirectiveKind Kind, bool HasCancel) {
- Stack.push_back({Kind,
- HasCancel ? CGF.getJumpDestInCurrentScope("cancel.exit")
- : JumpDest(),
- HasCancel ? CGF.getJumpDestInCurrentScope("cancel.cont")
- : JumpDest()});
- }
- /// Emits default exit point for the cancel construct (if the special one
- /// has not be used) + join point for cancel/normal exits.
- void exit(CodeGenFunction &CGF) {
- if (getExitBlock().isValid()) {
- assert(CGF.getOMPCancelDestination(Stack.back().Kind).isValid());
- bool HaveIP = CGF.HaveInsertPoint();
- if (!Stack.back().HasBeenEmitted) {
- if (HaveIP)
- CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
- CGF.EmitBlock(Stack.back().ExitBlock.getBlock());
- CGF.EmitBranchThroughCleanup(Stack.back().ContBlock);
- }
- CGF.EmitBlock(Stack.back().ContBlock.getBlock());
- if (!HaveIP) {
- CGF.Builder.CreateUnreachable();
- CGF.Builder.ClearInsertionPoint();
- }
- }
- Stack.pop_back();
- }
- };
- OpenMPCancelExitStack OMPCancelStack;
- CodeGenPGO PGO;
- /// Calculate branch weights appropriate for PGO data
- llvm::MDNode *createProfileWeights(uint64_t TrueCount, uint64_t FalseCount);
- llvm::MDNode *createProfileWeights(ArrayRef<uint64_t> Weights);
- llvm::MDNode *createProfileWeightsForLoop(const Stmt *Cond,
- uint64_t LoopCount);
- public:
- /// Increment the profiler's counter for the given statement by \p StepV.
- /// If \p StepV is null, the default increment is 1.
- void incrementProfileCounter(const Stmt *S, llvm::Value *StepV = nullptr) {
- if (CGM.getCodeGenOpts().hasProfileClangInstr())
- PGO.emitCounterIncrement(Builder, S, StepV);
- PGO.setCurrentStmt(S);
- }
- /// Get the profiler's count for the given statement.
- uint64_t getProfileCount(const Stmt *S) {
- Optional<uint64_t> Count = PGO.getStmtCount(S);
- if (!Count.hasValue())
- return 0;
- return *Count;
- }
- /// Set the profiler's current count.
- void setCurrentProfileCount(uint64_t Count) {
- PGO.setCurrentRegionCount(Count);
- }
- /// Get the profiler's current count. This is generally the count for the most
- /// recently incremented counter.
- uint64_t getCurrentProfileCount() {
- return PGO.getCurrentRegionCount();
- }
- private:
- /// SwitchInsn - This is nearest current switch instruction. It is null if
- /// current context is not in a switch.
- llvm::SwitchInst *SwitchInsn;
- /// The branch weights of SwitchInsn when doing instrumentation based PGO.
- SmallVector<uint64_t, 16> *SwitchWeights;
- /// CaseRangeBlock - This block holds if condition check for last case
- /// statement range in current switch instruction.
- llvm::BasicBlock *CaseRangeBlock;
- /// OpaqueLValues - Keeps track of the current set of opaque value
- /// expressions.
- llvm::DenseMap<const OpaqueValueExpr *, LValue> OpaqueLValues;
- llvm::DenseMap<const OpaqueValueExpr *, RValue> OpaqueRValues;
- // VLASizeMap - This keeps track of the associated size for each VLA type.
- // We track this by the size expression rather than the type itself because
- // in certain situations, like a const qualifier applied to an VLA typedef,
- // multiple VLA types can share the same size expression.
- // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
- // enter/leave scopes.
- llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
- /// A block containing a single 'unreachable' instruction. Created
- /// lazily by getUnreachableBlock().
- llvm::BasicBlock *UnreachableBlock;
- /// Counts of the number return expressions in the function.
- unsigned NumReturnExprs;
- /// Count the number of simple (constant) return expressions in the function.
- unsigned NumSimpleReturnExprs;
- /// The last regular (non-return) debug location (breakpoint) in the function.
- SourceLocation LastStopPoint;
- public:
- /// A scope within which we are constructing the fields of an object which
- /// might use a CXXDefaultInitExpr. This stashes away a 'this' value to use
- /// if we need to evaluate a CXXDefaultInitExpr within the evaluation.
- class FieldConstructionScope {
- public:
- FieldConstructionScope(CodeGenFunction &CGF, Address This)
- : CGF(CGF), OldCXXDefaultInitExprThis(CGF.CXXDefaultInitExprThis) {
- CGF.CXXDefaultInitExprThis = This;
- }
- ~FieldConstructionScope() {
- CGF.CXXDefaultInitExprThis = OldCXXDefaultInitExprThis;
- }
- private:
- CodeGenFunction &CGF;
- Address OldCXXDefaultInitExprThis;
- };
- /// The scope of a CXXDefaultInitExpr. Within this scope, the value of 'this'
- /// is overridden to be the object under construction.
- class CXXDefaultInitExprScope {
- public:
- CXXDefaultInitExprScope(CodeGenFunction &CGF)
- : CGF(CGF), OldCXXThisValue(CGF.CXXThisValue),
- OldCXXThisAlignment(CGF.CXXThisAlignment) {
- CGF.CXXThisValue = CGF.CXXDefaultInitExprThis.getPointer();
- CGF.CXXThisAlignment = CGF.CXXDefaultInitExprThis.getAlignment();
- }
- ~CXXDefaultInitExprScope() {
- CGF.CXXThisValue = OldCXXThisValue;
- CGF.CXXThisAlignment = OldCXXThisAlignment;
- }
- public:
- CodeGenFunction &CGF;
- llvm::Value *OldCXXThisValue;
- CharUnits OldCXXThisAlignment;
- };
- /// The scope of an ArrayInitLoopExpr. Within this scope, the value of the
- /// current loop index is overridden.
- class ArrayInitLoopExprScope {
- public:
- ArrayInitLoopExprScope(CodeGenFunction &CGF, llvm::Value *Index)
- : CGF(CGF), OldArrayInitIndex(CGF.ArrayInitIndex) {
- CGF.ArrayInitIndex = Index;
- }
- ~ArrayInitLoopExprScope() {
- CGF.ArrayInitIndex = OldArrayInitIndex;
- }
- private:
- CodeGenFunction &CGF;
- llvm::Value *OldArrayInitIndex;
- };
- class InlinedInheritingConstructorScope {
- public:
- InlinedInheritingConstructorScope(CodeGenFunction &CGF, GlobalDecl GD)
- : CGF(CGF), OldCurGD(CGF.CurGD), OldCurFuncDecl(CGF.CurFuncDecl),
- OldCurCodeDecl(CGF.CurCodeDecl),
- OldCXXABIThisDecl(CGF.CXXABIThisDecl),
- OldCXXABIThisValue(CGF.CXXABIThisValue),
- OldCXXThisValue(CGF.CXXThisValue),
- OldCXXABIThisAlignment(CGF.CXXABIThisAlignment),
- OldCXXThisAlignment(CGF.CXXThisAlignment),
- OldReturnValue(CGF.ReturnValue), OldFnRetTy(CGF.FnRetTy),
- OldCXXInheritedCtorInitExprArgs(
- std::move(CGF.CXXInheritedCtorInitExprArgs)) {
- CGF.CurGD = GD;
- CGF.CurFuncDecl = CGF.CurCodeDecl =
- cast<CXXConstructorDecl>(GD.getDecl());
- CGF.CXXABIThisDecl = nullptr;
- CGF.CXXABIThisValue = nullptr;
- CGF.CXXThisValue = nullptr;
- CGF.CXXABIThisAlignment = CharUnits();
- CGF.CXXThisAlignment = CharUnits();
- CGF.ReturnValue = Address::invalid();
- CGF.FnRetTy = QualType();
- CGF.CXXInheritedCtorInitExprArgs.clear();
- }
- ~InlinedInheritingConstructorScope() {
- CGF.CurGD = OldCurGD;
- CGF.CurFuncDecl = OldCurFuncDecl;
- CGF.CurCodeDecl = OldCurCodeDecl;
- CGF.CXXABIThisDecl = OldCXXABIThisDecl;
- CGF.CXXABIThisValue = OldCXXABIThisValue;
- CGF.CXXThisValue = OldCXXThisValue;
- CGF.CXXABIThisAlignment = OldCXXABIThisAlignment;
- CGF.CXXThisAlignment = OldCXXThisAlignment;
- CGF.ReturnValue = OldReturnValue;
- CGF.FnRetTy = OldFnRetTy;
- CGF.CXXInheritedCtorInitExprArgs =
- std::move(OldCXXInheritedCtorInitExprArgs);
- }
- private:
- CodeGenFunction &CGF;
- GlobalDecl OldCurGD;
- const Decl *OldCurFuncDecl;
- const Decl *OldCurCodeDecl;
- ImplicitParamDecl *OldCXXABIThisDecl;
- llvm::Value *OldCXXABIThisValue;
- llvm::Value *OldCXXThisValue;
- CharUnits OldCXXABIThisAlignment;
- CharUnits OldCXXThisAlignment;
- Address OldReturnValue;
- QualType OldFnRetTy;
- CallArgList OldCXXInheritedCtorInitExprArgs;
- };
- private:
- /// CXXThisDecl - When generating code for a C++ member function,
- /// this will hold the implicit 'this' declaration.
- ImplicitParamDecl *CXXABIThisDecl;
- llvm::Value *CXXABIThisValue;
- llvm::Value *CXXThisValue;
- CharUnits CXXABIThisAlignment;
- CharUnits CXXThisAlignment;
- /// The value of 'this' to use when evaluating CXXDefaultInitExprs within
- /// this expression.
- Address CXXDefaultInitExprThis = Address::invalid();
- /// The current array initialization index when evaluating an
- /// ArrayInitIndexExpr within an ArrayInitLoopExpr.
- llvm::Value *ArrayInitIndex = nullptr;
- /// The values of function arguments to use when evaluating
- /// CXXInheritedCtorInitExprs within this context.
- CallArgList CXXInheritedCtorInitExprArgs;
- /// CXXStructorImplicitParamDecl - When generating code for a constructor or
- /// destructor, this will hold the implicit argument (e.g. VTT).
- ImplicitParamDecl *CXXStructorImplicitParamDecl;
- llvm::Value *CXXStructorImplicitParamValue;
- /// OutermostConditional - Points to the outermost active
- /// conditional control. This is used so that we know if a
- /// temporary should be destroyed conditionally.
- ConditionalEvaluation *OutermostConditional;
- /// The current lexical scope.
- LexicalScope *CurLexicalScope;
- /// The current source location that should be used for exception
- /// handling code.
- SourceLocation CurEHLocation;
- /// BlockByrefInfos - For each __block variable, contains
- /// information about the layout of the variable.
- llvm::DenseMap<const ValueDecl *, BlockByrefInfo> BlockByrefInfos;
- /// Used by -fsanitize=nullability-return to determine whether the return
- /// value can be checked.
- llvm::Value *RetValNullabilityPrecondition = nullptr;
- /// Check if -fsanitize=nullability-return instrumentation is required for
- /// this function.
- bool requiresReturnValueNullabilityCheck() const {
- return RetValNullabilityPrecondition;
- }
- /// Used to store precise source locations for return statements by the
- /// runtime return value checks.
- Address ReturnLocation = Address::invalid();
- /// Check if the return value of this function requires sanitization.
- bool requiresReturnValueCheck() const {
- return requiresReturnValueNullabilityCheck() ||
- (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
- CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>());
- }
- llvm::BasicBlock *TerminateLandingPad;
- llvm::BasicBlock *TerminateHandler;
- llvm::BasicBlock *TrapBB;
- /// Terminate funclets keyed by parent funclet pad.
- llvm::MapVector<llvm::Value *, llvm::BasicBlock *> TerminateFunclets;
- /// True if we need emit the life-time markers.
- const bool ShouldEmitLifetimeMarkers;
- /// Add OpenCL kernel arg metadata and the kernel attribute meatadata to
- /// the function metadata.
- void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
- llvm::Function *Fn);
- public:
- CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
- ~CodeGenFunction();
- CodeGenTypes &getTypes() const { return CGM.getTypes(); }
- ASTContext &getContext() const { return CGM.getContext(); }
- CGDebugInfo *getDebugInfo() {
- if (DisableDebugInfo)
- return nullptr;
- return DebugInfo;
- }
- void disableDebugInfo() { DisableDebugInfo = true; }
- void enableDebugInfo() { DisableDebugInfo = false; }
- bool shouldUseFusedARCCalls() {
- return CGM.getCodeGenOpts().OptimizationLevel == 0;
- }
- const LangOptions &getLangOpts() const { return CGM.getLangOpts(); }
- /// Returns a pointer to the function's exception object and selector slot,
- /// which is assigned in every landing pad.
- Address getExceptionSlot();
- Address getEHSelectorSlot();
- /// Returns the contents of the function's exception object and selector
- /// slots.
- llvm::Value *getExceptionFromSlot();
- llvm::Value *getSelectorFromSlot();
- Address getNormalCleanupDestSlot();
- llvm::BasicBlock *getUnreachableBlock() {
- if (!UnreachableBlock) {
- UnreachableBlock = createBasicBlock("unreachable");
- new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
- }
- return UnreachableBlock;
- }
- llvm::BasicBlock *getInvokeDest() {
- if (!EHStack.requiresLandingPad()) return nullptr;
- return getInvokeDestImpl();
- }
- bool currentFunctionUsesSEHTry() const { return CurSEHParent != nullptr; }
- const TargetInfo &getTarget() const { return Target; }
- llvm::LLVMContext &getLLVMContext() { return CGM.getLLVMContext(); }
- const TargetCodeGenInfo &getTargetHooks() const {
- return CGM.getTargetCodeGenInfo();
- }
- //===--------------------------------------------------------------------===//
- // Cleanups
- //===--------------------------------------------------------------------===//
- typedef void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty);
- void pushIrregularPartialArrayCleanup(llvm::Value *arrayBegin,
- Address arrayEndPointer,
- QualType elementType,
- CharUnits elementAlignment,
- Destroyer *destroyer);
- void pushRegularPartialArrayCleanup(llvm::Value *arrayBegin,
- llvm::Value *arrayEnd,
- QualType elementType,
- CharUnits elementAlignment,
- Destroyer *destroyer);
- void pushDestroy(QualType::DestructionKind dtorKind,
- Address addr, QualType type);
- void pushEHDestroy(QualType::DestructionKind dtorKind,
- Address addr, QualType type);
- void pushDestroy(CleanupKind kind, Address addr, QualType type,
- Destroyer *destroyer, bool useEHCleanupForArray);
- void pushLifetimeExtendedDestroy(CleanupKind kind, Address addr,
- QualType type, Destroyer *destroyer,
- bool useEHCleanupForArray);
- void pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
- llvm::Value *CompletePtr,
- QualType ElementType);
- void pushStackRestore(CleanupKind kind, Address SPMem);
- void emitDestroy(Address addr, QualType type, Destroyer *destroyer,
- bool useEHCleanupForArray);
- llvm::Function *generateDestroyHelper(Address addr, QualType type,
- Destroyer *destroyer,
- bool useEHCleanupForArray,
- const VarDecl *VD);
- void emitArrayDestroy(llvm::Value *begin, llvm::Value *end,
- QualType elementType, CharUnits elementAlign,
- Destroyer *destroyer,
- bool checkZeroLength, bool useEHCleanup);
- Destroyer *getDestroyer(QualType::DestructionKind destructionKind);
- /// Determines whether an EH cleanup is required to destroy a type
- /// with the given destruction kind.
- bool needsEHCleanup(QualType::DestructionKind kind) {
- switch (kind) {
- case QualType::DK_none:
- return false;
- case QualType::DK_cxx_destructor:
- case QualType::DK_objc_weak_lifetime:
- return getLangOpts().Exceptions;
- case QualType::DK_objc_strong_lifetime:
- return getLangOpts().Exceptions &&
- CGM.getCodeGenOpts().ObjCAutoRefCountExceptions;
- }
- llvm_unreachable("bad destruction kind");
- }
- CleanupKind getCleanupKind(QualType::DestructionKind kind) {
- return (needsEHCleanup(kind) ? NormalAndEHCleanup : NormalCleanup);
- }
- //===--------------------------------------------------------------------===//
- // Objective-C
- //===--------------------------------------------------------------------===//
- void GenerateObjCMethod(const ObjCMethodDecl *OMD);
- void StartObjCMethod(const ObjCMethodDecl *MD, const ObjCContainerDecl *CD);
- /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
- void GenerateObjCGetter(ObjCImplementationDecl *IMP,
- const ObjCPropertyImplDecl *PID);
- void generateObjCGetterBody(const ObjCImplementationDecl *classImpl,
- const ObjCPropertyImplDecl *propImpl,
- const ObjCMethodDecl *GetterMothodDecl,
- llvm::Constant *AtomicHelperFn);
- void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
- ObjCMethodDecl *MD, bool ctor);
- /// GenerateObjCSetter - Synthesize an Objective-C property setter function
- /// for the given property.
- void GenerateObjCSetter(ObjCImplementationDecl *IMP,
- const ObjCPropertyImplDecl *PID);
- void generateObjCSetterBody(const ObjCImplementationDecl *classImpl,
- const ObjCPropertyImplDecl *propImpl,
- llvm::Constant *AtomicHelperFn);
- //===--------------------------------------------------------------------===//
- // Block Bits
- //===--------------------------------------------------------------------===//
- /// Emit block literal.
- /// \return an LLVM value which is a pointer to a struct which contains
- /// information about the block, including the block invoke function, the
- /// captured variables, etc.
- /// \param InvokeF will contain the block invoke function if it is not
- /// nullptr.
- llvm::Value *EmitBlockLiteral(const BlockExpr *,
- llvm::Function **InvokeF = nullptr);
- static void destroyBlockInfos(CGBlockInfo *info);
- llvm::Function *GenerateBlockFunction(GlobalDecl GD,
- const CGBlockInfo &Info,
- const DeclMapTy &ldm,
- bool IsLambdaConversionToBlock,
- bool BuildGlobalBlock);
- llvm::Constant *GenerateCopyHelperFunction(const CGBlockInfo &blockInfo);
- llvm::Constant *GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo);
- llvm::Constant *GenerateObjCAtomicSetterCopyHelperFunction(
- const ObjCPropertyImplDecl *PID);
- llvm::Constant *GenerateObjCAtomicGetterCopyHelperFunction(
- const ObjCPropertyImplDecl *PID);
- llvm::Value *EmitBlockCopyAndAutorelease(llvm::Value *Block, QualType Ty);
- void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags);
- class AutoVarEmission;
- void emitByrefStructureInit(const AutoVarEmission &emission);
- void enterByrefCleanup(const AutoVarEmission &emission);
- void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum,
- llvm::Value *ptr);
- Address LoadBlockStruct();
- Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef);
- /// BuildBlockByrefAddress - Computes the location of the
- /// data in a variable which is declared as __block.
- Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V,
- bool followForward = true);
- Address emitBlockByrefAddress(Address baseAddr,
- const BlockByrefInfo &info,
- bool followForward,
- const llvm::Twine &name);
- const BlockByrefInfo &getBlockByrefInfo(const VarDecl *var);
- QualType BuildFunctionArgList(GlobalDecl GD, FunctionArgList &Args);
- void GenerateCode(GlobalDecl GD, llvm::Function *Fn,
- const CGFunctionInfo &FnInfo);
- /// \brief Emit code for the start of a function.
- /// \param Loc The location to be associated with the function.
- /// \param StartLoc The location of the function body.
- void StartFunction(GlobalDecl GD,
- QualType RetTy,
- llvm::Function *Fn,
- const CGFunctionInfo &FnInfo,
- const FunctionArgList &Args,
- SourceLocation Loc = SourceLocation(),
- SourceLocation StartLoc = SourceLocation());
- static bool IsConstructorDelegationValid(const CXXConstructorDecl *Ctor);
- void EmitConstructorBody(FunctionArgList &Args);
- void EmitDestructorBody(FunctionArgList &Args);
- void emitImplicitAssignmentOperatorBody(FunctionArgList &Args);
- void EmitFunctionBody(FunctionArgList &Args, const Stmt *Body);
- void EmitBlockWithFallThrough(llvm::BasicBlock *BB, const Stmt *S);
- void EmitForwardingCallToLambda(const CXXMethodDecl *LambdaCallOperator,
- CallArgList &CallArgs);
- void EmitLambdaBlockInvokeBody();
- void EmitLambdaDelegatingInvokeBody(const CXXMethodDecl *MD);
- void EmitLambdaStaticInvokeBody(const CXXMethodDecl *MD);
- void EmitAsanPrologueOrEpilogue(bool Prologue);
- /// \brief Emit the unified return block, trying to avoid its emission when
- /// possible.
- /// \return The debug location of the user written return statement if the
- /// return block is is avoided.
- llvm::DebugLoc EmitReturnBlock();
- /// FinishFunction - Complete IR generation of the current function. It is
- /// legal to call this function even if there is no current insertion point.
- void FinishFunction(SourceLocation EndLoc=SourceLocation());
- void StartThunk(llvm::Function *Fn, GlobalDecl GD,
- const CGFunctionInfo &FnInfo);
- void EmitCallAndReturnForThunk(llvm::Constant *Callee,
- const ThunkInfo *Thunk);
- void FinishThunk();
- /// Emit a musttail call for a thunk with a potentially adjusted this pointer.
- void EmitMustTailThunk(const CXXMethodDecl *MD, llvm::Value *AdjustedThisPtr,
- llvm::Value *Callee);
- /// Generate a thunk for the given method.
- void generateThunk(llvm::Function *Fn, const CGFunctionInfo &FnInfo,
- GlobalDecl GD, const ThunkInfo &Thunk);
- llvm::Function *GenerateVarArgsThunk(llvm::Function *Fn,
- const CGFunctionInfo &FnInfo,
- GlobalDecl GD, const ThunkInfo &Thunk);
- void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
- FunctionArgList &Args);
- void EmitInitializerForField(FieldDecl *Field, LValue LHS, Expr *Init);
- /// Struct with all informations about dynamic [sub]class needed to set vptr.
- struct VPtr {
- BaseSubobject Base;
- const CXXRecordDecl *NearestVBase;
- CharUnits OffsetFromNearestVBase;
- const CXXRecordDecl *VTableClass;
- };
- /// Initialize the vtable pointer of the given subobject.
- void InitializeVTablePointer(const VPtr &vptr);
- typedef llvm::SmallVector<VPtr, 4> VPtrsVector;
- typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
- VPtrsVector getVTablePointers(const CXXRecordDecl *VTableClass);
- void getVTablePointers(BaseSubobject Base, const CXXRecordDecl *NearestVBase,
- CharUnits OffsetFromNearestVBase,
- bool BaseIsNonVirtualPrimaryBase,
- const CXXRecordDecl *VTableClass,
- VisitedVirtualBasesSetTy &VBases, VPtrsVector &vptrs);
- void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
- /// GetVTablePtr - Return the Value of the vtable pointer member pointed
- /// to by This.
- llvm::Value *GetVTablePtr(Address This, llvm::Type *VTableTy,
- const CXXRecordDecl *VTableClass);
- enum CFITypeCheckKind {
- CFITCK_VCall,
- CFITCK_NVCall,
- CFITCK_DerivedCast,
- CFITCK_UnrelatedCast,
- CFITCK_ICall,
- };
- /// \brief Derived is the presumed address of an object of type T after a
- /// cast. If T is a polymorphic class type, emit a check that the virtual
- /// table for Derived belongs to a class derived from T.
- void EmitVTablePtrCheckForCast(QualType T, llvm::Value *Derived,
- bool MayBeNull, CFITypeCheckKind TCK,
- SourceLocation Loc);
- /// EmitVTablePtrCheckForCall - Virtual method MD is being called via VTable.
- /// If vptr CFI is enabled, emit a check that VTable is valid.
- void EmitVTablePtrCheckForCall(const CXXRecordDecl *RD, llvm::Value *VTable,
- CFITypeCheckKind TCK, SourceLocation Loc);
- /// EmitVTablePtrCheck - Emit a check that VTable is a valid virtual table for
- /// RD using llvm.type.test.
- void EmitVTablePtrCheck(const CXXRecordDecl *RD, llvm::Value *VTable,
- CFITypeCheckKind TCK, SourceLocation Loc);
- /// If whole-program virtual table optimization is enabled, emit an assumption
- /// that VTable is a member of RD's type identifier. Or, if vptr CFI is
- /// enabled, emit a check that VTable is a member of RD's type identifier.
- void EmitTypeMetadataCodeForVCall(const CXXRecordDecl *RD,
- llvm::Value *VTable, SourceLocation Loc);
- /// Returns whether we should perform a type checked load when loading a
- /// virtual function for virtual calls to members of RD. This is generally
- /// true when both vcall CFI and whole-program-vtables are enabled.
- bool ShouldEmitVTableTypeCheckedLoad(const CXXRecordDecl *RD);
- /// Emit a type checked load from the given vtable.
- llvm::Value *EmitVTableTypeCheckedLoad(const CXXRecordDecl *RD, llvm::Value *VTable,
- uint64_t VTableByteOffset);
- /// EnterDtorCleanups - Enter the cleanups necessary to complete the
- /// given phase of destruction for a destructor. The end result
- /// should call destructors on members and base classes in reverse
- /// order of their construction.
- void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
- /// ShouldInstrumentFunction - Return true if the current function should be
- /// instrumented with __cyg_profile_func_* calls
- bool ShouldInstrumentFunction();
- /// ShouldXRayInstrument - Return true if the current function should be
- /// instrumented with XRay nop sleds.
- bool ShouldXRayInstrumentFunction() const;
- /// AlwaysEmitXRayCustomEvents - Return true if we must unconditionally emit
- /// XRay custom event handling calls.
- bool AlwaysEmitXRayCustomEvents() const;
- /// Encode an address into a form suitable for use in a function prologue.
- llvm::Constant *EncodeAddrForUseInPrologue(llvm::Function *F,
- llvm::Constant *Addr);
- /// Decode an address used in a function prologue, encoded by \c
- /// EncodeAddrForUseInPrologue.
- llvm::Value *DecodeAddrUsedInPrologue(llvm::Value *F,
- llvm::Value *EncodedAddr);
- /// EmitFunctionProlog - Emit the target specific LLVM code to load the
- /// arguments for the given function. This is also responsible for naming the
- /// LLVM function arguments.
- void EmitFunctionProlog(const CGFunctionInfo &FI,
- llvm::Function *Fn,
- const FunctionArgList &Args);
- /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
- /// given temporary.
- void EmitFunctionEpilog(const CGFunctionInfo &FI, bool EmitRetDbgLoc,
- SourceLocation EndLoc);
- /// Emit a test that checks if the return value \p RV is nonnull.
- void EmitReturnValueCheck(llvm::Value *RV);
- /// EmitStartEHSpec - Emit the start of the exception spec.
- void EmitStartEHSpec(const Decl *D);
- /// EmitEndEHSpec - Emit the end of the exception spec.
- void EmitEndEHSpec(const Decl *D);
- /// getTerminateLandingPad - Return a landing pad that just calls terminate.
- llvm::BasicBlock *getTerminateLandingPad();
- /// getTerminateLandingPad - Return a cleanup funclet that just calls
- /// terminate.
- llvm::BasicBlock *getTerminateFunclet();
- /// getTerminateHandler - Return a handler (not a landing pad, just
- /// a catch handler) that just calls terminate. This is used when
- /// a terminate scope encloses a try.
- llvm::BasicBlock *getTerminateHandler();
- llvm::Type *ConvertTypeForMem(QualType T);
- llvm::Type *ConvertType(QualType T);
- llvm::Type *ConvertType(const TypeDecl *T) {
- return ConvertType(getContext().getTypeDeclType(T));
- }
- /// LoadObjCSelf - Load the value of self. This function is only valid while
- /// generating code for an Objective-C method.
- llvm::Value *LoadObjCSelf();
- /// TypeOfSelfObject - Return type of object that this self represents.
- QualType TypeOfSelfObject();
- /// getEvaluationKind - Return the TypeEvaluationKind of QualType \c T.
- static TypeEvaluationKind getEvaluationKind(QualType T);
- static bool hasScalarEvaluationKind(QualType T) {
- return getEvaluationKind(T) == TEK_Scalar;
- }
- static bool hasAggregateEvaluationKind(QualType T) {
- return getEvaluationKind(T) == TEK_Aggregate;
- }
- /// createBasicBlock - Create an LLVM basic block.
- llvm::BasicBlock *createBasicBlock(const Twine &name = "",
- llvm::Function *parent = nullptr,
- llvm::BasicBlock *before = nullptr) {
- #ifdef NDEBUG
- return llvm::BasicBlock::Create(getLLVMContext(), "", parent, before);
- #else
- return llvm::BasicBlock::Create(getLLVMContext(), name, parent, before);
- #endif
- }
- /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
- /// label maps to.
- JumpDest getJumpDestForLabel(const LabelDecl *S);
- /// SimplifyForwardingBlocks - If the given basic block is only a branch to
- /// another basic block, simplify it. This assumes that no other code could
- /// potentially reference the basic block.
- void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
- /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
- /// adding a fall-through branch from the current insert block if
- /// necessary. It is legal to call this function even if there is no current
- /// insertion point.
- ///
- /// IsFinished - If true, indicates that the caller has finished emitting
- /// branches to the given block and does not expect to emit code into it. This
- /// means the block can be ignored if it is unreachable.
- void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
- /// EmitBlockAfterUses - Emit the given block somewhere hopefully
- /// near its uses, and leave the insertion point in it.
- void EmitBlockAfterUses(llvm::BasicBlock *BB);
- /// EmitBranch - Emit a branch to the specified basic block from the current
- /// insert block, taking care to avoid creation of branches from dummy
- /// blocks. It is legal to call this function even if there is no current
- /// insertion point.
- ///
- /// This function clears the current insertion point. The caller should follow
- /// calls to this function with calls to Emit*Block prior to generation new
- /// code.
- void EmitBranch(llvm::BasicBlock *Block);
- /// HaveInsertPoint - True if an insertion point is defined. If not, this
- /// indicates that the current code being emitted is unreachable.
- bool HaveInsertPoint() const {
- return Builder.GetInsertBlock() != nullptr;
- }
- /// EnsureInsertPoint - Ensure that an insertion point is defined so that
- /// emitted IR has a place to go. Note that by definition, if this function
- /// creates a block then that block is unreachable; callers may do better to
- /// detect when no insertion point is defined and simply skip IR generation.
- void EnsureInsertPoint() {
- if (!HaveInsertPoint())
- EmitBlock(createBasicBlock());
- }
- /// ErrorUnsupported - Print out an error that codegen doesn't support the
- /// specified stmt yet.
- void ErrorUnsupported(const Stmt *S, const char *Type);
- //===--------------------------------------------------------------------===//
- // Helpers
- //===--------------------------------------------------------------------===//
- LValue MakeAddrLValue(Address Addr, QualType T,
- AlignmentSource Source = AlignmentSource::Type) {
- return LValue::MakeAddr(Addr, T, getContext(), LValueBaseInfo(Source),
- CGM.getTBAAAccessInfo(T));
- }
- LValue MakeAddrLValue(Address Addr, QualType T, LValueBaseInfo BaseInfo,
- TBAAAccessInfo TBAAInfo) {
- return LValue::MakeAddr(Addr, T, getContext(), BaseInfo, TBAAInfo);
- }
- LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
- AlignmentSource Source = AlignmentSource::Type) {
- return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
- LValueBaseInfo(Source), CGM.getTBAAAccessInfo(T));
- }
- LValue MakeAddrLValue(llvm::Value *V, QualType T, CharUnits Alignment,
- LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo) {
- return LValue::MakeAddr(Address(V, Alignment), T, getContext(),
- BaseInfo, TBAAInfo);
- }
- LValue MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T);
- LValue MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T);
- CharUnits getNaturalTypeAlignment(QualType T,
- LValueBaseInfo *BaseInfo = nullptr,
- TBAAAccessInfo *TBAAInfo = nullptr,
- bool forPointeeType = false);
- CharUnits getNaturalPointeeTypeAlignment(QualType T,
- LValueBaseInfo *BaseInfo = nullptr,
- TBAAAccessInfo *TBAAInfo = nullptr);
- Address EmitLoadOfReference(LValue RefLVal,
- LValueBaseInfo *PointeeBaseInfo = nullptr,
- TBAAAccessInfo *PointeeTBAAInfo = nullptr);
- LValue EmitLoadOfReferenceLValue(LValue RefLVal);
- LValue EmitLoadOfReferenceLValue(Address RefAddr, QualType RefTy,
- AlignmentSource Source =
- AlignmentSource::Type) {
- LValue RefLVal = MakeAddrLValue(RefAddr, RefTy, LValueBaseInfo(Source),
- CGM.getTBAAAccessInfo(RefTy));
- return EmitLoadOfReferenceLValue(RefLVal);
- }
- Address EmitLoadOfPointer(Address Ptr, const PointerType *PtrTy,
- LValueBaseInfo *BaseInfo = nullptr,
- TBAAAccessInfo *TBAAInfo = nullptr);
- LValue EmitLoadOfPointerLValue(Address Ptr, const PointerType *PtrTy);
- /// CreateTempAlloca - This creates an alloca and inserts it into the entry
- /// block if \p ArraySize is nullptr, otherwise inserts it at the current
- /// insertion point of the builder. The caller is responsible for setting an
- /// appropriate alignment on
- /// the alloca.
- ///
- /// \p ArraySize is the number of array elements to be allocated if it
- /// is not nullptr.
- ///
- /// LangAS::Default is the address space of pointers to local variables and
- /// temporaries, as exposed in the source language. In certain
- /// configurations, this is not the same as the alloca address space, and a
- /// cast is needed to lift the pointer from the alloca AS into
- /// LangAS::Default. This can happen when the target uses a restricted
- /// address space for the stack but the source language requires
- /// LangAS::Default to be a generic address space. The latter condition is
- /// common for most programming languages; OpenCL is an exception in that
- /// LangAS::Default is the private address space, which naturally maps
- /// to the stack.
- ///
- /// Because the address of a temporary is often exposed to the program in
- /// various ways, this function will perform the cast by default. The cast
- /// may be avoided by passing false as \p CastToDefaultAddrSpace; this is
- /// more efficient if the caller knows that the address will not be exposed.
- llvm::AllocaInst *CreateTempAlloca(llvm::Type *Ty, const Twine &Name = "tmp",
- llvm::Value *ArraySize = nullptr);
- Address CreateTempAlloca(llvm::Type *Ty, CharUnits align,
- const Twine &Name = "tmp",
- llvm::Value *ArraySize = nullptr,
- bool CastToDefaultAddrSpace = true);
- /// CreateDefaultAlignedTempAlloca - This creates an alloca with the
- /// default ABI alignment of the given LLVM type.
- ///
- /// IMPORTANT NOTE: This is *not* generally the right alignment for
- /// any given AST type that happens to have been lowered to the
- /// given IR type. This should only ever be used for function-local,
- /// IR-driven manipulations like saving and restoring a value. Do
- /// not hand this address off to arbitrary IRGen routines, and especially
- /// do not pass it as an argument to a function that might expect a
- /// properly ABI-aligned value.
- Address CreateDefaultAlignTempAlloca(llvm::Type *Ty,
- const Twine &Name = "tmp");
- /// InitTempAlloca - Provide an initial value for the given alloca which
- /// will be observable at all locations in the function.
- ///
- /// The address should be something that was returned from one of
- /// the CreateTempAlloca or CreateMemTemp routines, and the
- /// initializer must be valid in the entry block (i.e. it must
- /// either be a constant or an argument value).
- void InitTempAlloca(Address Alloca, llvm::Value *Value);
- /// CreateIRTemp - Create a temporary IR object of the given type, with
- /// appropriate alignment. This routine should only be used when an temporary
- /// value needs to be stored into an alloca (for example, to avoid explicit
- /// PHI construction), but the type is the IR type, not the type appropriate
- /// for storing in memory.
- ///
- /// That is, this is exactly equivalent to CreateMemTemp, but calling
- /// ConvertType instead of ConvertTypeForMem.
- Address CreateIRTemp(QualType T, const Twine &Name = "tmp");
- /// CreateMemTemp - Create a temporary memory object of the given type, with
- /// appropriate alignment. Cast it to the default address space if
- /// \p CastToDefaultAddrSpace is true.
- Address CreateMemTemp(QualType T, const Twine &Name = "tmp",
- bool CastToDefaultAddrSpace = true);
- Address CreateMemTemp(QualType T, CharUnits Align, const Twine &Name = "tmp",
- bool CastToDefaultAddrSpace = true);
- /// CreateAggTemp - Create a temporary memory object for the given
- /// aggregate type.
- AggValueSlot CreateAggTemp(QualType T, const Twine &Name = "tmp") {
- return AggValueSlot::forAddr(CreateMemTemp(T, Name),
- T.getQualifiers(),
- AggValueSlot::IsNotDestructed,
- AggValueSlot::DoesNotNeedGCBarriers,
- AggValueSlot::IsNotAliased);
- }
- /// Emit a cast to void* in the appropriate address space.
- llvm::Value *EmitCastToVoidPtr(llvm::Value *value);
- /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
- /// expression and compare the result against zero, returning an Int1Ty value.
- llvm::Value *EvaluateExprAsBool(const Expr *E);
- /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
- void EmitIgnoredExpr(const Expr *E);
- /// EmitAnyExpr - Emit code to compute the specified expression which can have
- /// any type. The result is returned as an RValue struct. If this is an
- /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
- /// the result should be returned.
- ///
- /// \param ignoreResult True if the resulting value isn't used.
- RValue EmitAnyExpr(const Expr *E,
- AggValueSlot aggSlot = AggValueSlot::ignored(),
- bool ignoreResult = false);
- // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
- // or the value of the expression, depending on how va_list is defined.
- Address EmitVAListRef(const Expr *E);
- /// Emit a "reference" to a __builtin_ms_va_list; this is
- /// always the value of the expression, because a __builtin_ms_va_list is a
- /// pointer to a char.
- Address EmitMSVAListRef(const Expr *E);
- /// EmitAnyExprToTemp - Similarly to EmitAnyExpr(), however, the result will
- /// always be accessible even if no aggregate location is provided.
- RValue EmitAnyExprToTemp(const Expr *E);
- /// EmitAnyExprToMem - Emits the code necessary to evaluate an
- /// arbitrary expression into the given memory location.
- void EmitAnyExprToMem(const Expr *E, Address Location,
- Qualifiers Quals, bool IsInitializer);
- void EmitAnyExprToExn(const Expr *E, Address Addr);
- /// EmitExprAsInit - Emits the code necessary to initialize a
- /// location in memory with the given initializer.
- void EmitExprAsInit(const Expr *init, const ValueDecl *D, LValue lvalue,
- bool capturedByInit);
- /// hasVolatileMember - returns true if aggregate type has a volatile
- /// member.
- bool hasVolatileMember(QualType T) {
- if (const RecordType *RT = T->getAs<RecordType>()) {
- const RecordDecl *RD = cast<RecordDecl>(RT->getDecl());
- return RD->hasVolatileMember();
- }
- return false;
- }
- /// EmitAggregateCopy - Emit an aggregate assignment.
- ///
- /// The difference to EmitAggregateCopy is that tail padding is not copied.
- /// This is required for correctness when assigning non-POD structures in C++.
- void EmitAggregateAssign(Address DestPtr, Address SrcPtr,
- QualType EltTy) {
- bool IsVolatile = hasVolatileMember(EltTy);
- EmitAggregateCopy(DestPtr, SrcPtr, EltTy, IsVolatile, true);
- }
- void EmitAggregateCopyCtor(Address DestPtr, Address SrcPtr,
- QualType DestTy, QualType SrcTy) {
- EmitAggregateCopy(DestPtr, SrcPtr, SrcTy, /*IsVolatile=*/false,
- /*IsAssignment=*/false);
- }
- /// EmitAggregateCopy - Emit an aggregate copy.
- ///
- /// \param isVolatile - True iff either the source or the destination is
- /// volatile.
- /// \param isAssignment - If false, allow padding to be copied. This often
- /// yields more efficient.
- void EmitAggregateCopy(Address DestPtr, Address SrcPtr,
- QualType EltTy, bool isVolatile=false,
- bool isAssignment = false);
- /// GetAddrOfLocalVar - Return the address of a local variable.
- Address GetAddrOfLocalVar(const VarDecl *VD) {
- auto it = LocalDeclMap.find(VD);
- assert(it != LocalDeclMap.end() &&
- "Invalid argument to GetAddrOfLocalVar(), no decl!");
- return it->second;
- }
- /// getOpaqueLValueMapping - Given an opaque value expression (which
- /// must be mapped to an l-value), return its mapping.
- const LValue &getOpaqueLValueMapping(const OpaqueValueExpr *e) {
- assert(OpaqueValueMapping::shouldBindAsLValue(e));
- llvm::DenseMap<const OpaqueValueExpr*,LValue>::iterator
- it = OpaqueLValues.find(e);
- assert(it != OpaqueLValues.end() && "no mapping for opaque value!");
- return it->second;
- }
- /// getOpaqueRValueMapping - Given an opaque value expression (which
- /// must be mapped to an r-value), return its mapping.
- const RValue &getOpaqueRValueMapping(const OpaqueValueExpr *e) {
- assert(!OpaqueValueMapping::shouldBindAsLValue(e));
- llvm::DenseMap<const OpaqueValueExpr*,RValue>::iterator
- it = OpaqueRValues.find(e);
- assert(it != OpaqueRValues.end() && "no mapping for opaque value!");
- return it->second;
- }
- /// Get the index of the current ArrayInitLoopExpr, if any.
- llvm::Value *getArrayInitIndex() { return ArrayInitIndex; }
- /// getAccessedFieldNo - Given an encoded value and a result number, return
- /// the input field number being accessed.
- static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
- llvm::BlockAddress *GetAddrOfLabel(const LabelDecl *L);
- llvm::BasicBlock *GetIndirectGotoBlock();
- /// Check if \p E is a C++ "this" pointer wrapped in value-preserving casts.
- static bool IsWrappedCXXThis(const Expr *E);
- /// EmitNullInitialization - Generate code to set a value of the given type to
- /// null, If the type contains data member pointers, they will be initialized
- /// to -1 in accordance with the Itanium C++ ABI.
- void EmitNullInitialization(Address DestPtr, QualType Ty);
- /// Emits a call to an LLVM variable-argument intrinsic, either
- /// \c llvm.va_start or \c llvm.va_end.
- /// \param ArgValue A reference to the \c va_list as emitted by either
- /// \c EmitVAListRef or \c EmitMSVAListRef.
- /// \param IsStart If \c true, emits a call to \c llvm.va_start; otherwise,
- /// calls \c llvm.va_end.
- llvm::Value *EmitVAStartEnd(llvm::Value *ArgValue, bool IsStart);
- /// Generate code to get an argument from the passed in pointer
- /// and update it accordingly.
- /// \param VE The \c VAArgExpr for which to generate code.
- /// \param VAListAddr Receives a reference to the \c va_list as emitted by
- /// either \c EmitVAListRef or \c EmitMSVAListRef.
- /// \returns A pointer to the argument.
- // FIXME: We should be able to get rid of this method and use the va_arg
- // instruction in LLVM instead once it works well enough.
- Address EmitVAArg(VAArgExpr *VE, Address &VAListAddr);
- /// emitArrayLength - Compute the length of an array, even if it's a
- /// VLA, and drill down to the base element type.
- llvm::Value *emitArrayLength(const ArrayType *arrayType,
- QualType &baseType,
- Address &addr);
- /// EmitVLASize - Capture all the sizes for the VLA expressions in
- /// the given variably-modified type and store them in the VLASizeMap.
- ///
- /// This function can be called with a null (unreachable) insert point.
- void EmitVariablyModifiedType(QualType Ty);
- /// getVLASize - Returns an LLVM value that corresponds to the size,
- /// in non-variably-sized elements, of a variable length array type,
- /// plus that largest non-variably-sized element type. Assumes that
- /// the type has already been emitted with EmitVariablyModifiedType.
- std::pair<llvm::Value*,QualType> getVLASize(const VariableArrayType *vla);
- std::pair<llvm::Value*,QualType> getVLASize(QualType vla);
- /// LoadCXXThis - Load the value of 'this'. This function is only valid while
- /// generating code for an C++ member function.
- llvm::Value *LoadCXXThis() {
- assert(CXXThisValue && "no 'this' value for this function");
- return CXXThisValue;
- }
- Address LoadCXXThisAddress();
- /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
- /// virtual bases.
- // FIXME: Every place that calls LoadCXXVTT is something
- // that needs to be abstracted properly.
- llvm::Value *LoadCXXVTT() {
- assert(CXXStructorImplicitParamValue && "no VTT value for this function");
- return CXXStructorImplicitParamValue;
- }
- /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
- /// complete class to the given direct base.
- Address
- GetAddressOfDirectBaseInCompleteClass(Address Value,
- const CXXRecordDecl *Derived,
- const CXXRecordDecl *Base,
- bool BaseIsVirtual);
- static bool ShouldNullCheckClassCastValue(const CastExpr *Cast);
- /// GetAddressOfBaseClass - This function will add the necessary delta to the
- /// load of 'this' and returns address of the base class.
- Address GetAddressOfBaseClass(Address Value,
- const CXXRecordDecl *Derived,
- CastExpr::path_const_iterator PathBegin,
- CastExpr::path_const_iterator PathEnd,
- bool NullCheckValue, SourceLocation Loc);
- Address GetAddressOfDerivedClass(Address Value,
- const CXXRecordDecl *Derived,
- CastExpr::path_const_iterator PathBegin,
- CastExpr::path_const_iterator PathEnd,
- bool NullCheckValue);
- /// GetVTTParameter - Return the VTT parameter that should be passed to a
- /// base constructor/destructor with virtual bases.
- /// FIXME: VTTs are Itanium ABI-specific, so the definition should move
- /// to ItaniumCXXABI.cpp together with all the references to VTT.
- llvm::Value *GetVTTParameter(GlobalDecl GD, bool ForVirtualBase,
- bool Delegating);
- void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
- CXXCtorType CtorType,
- const FunctionArgList &Args,
- SourceLocation Loc);
- // It's important not to confuse this and the previous function. Delegating
- // constructors are the C++0x feature. The constructor delegate optimization
- // is used to reduce duplication in the base and complete consturctors where
- // they are substantially the same.
- void EmitDelegatingCXXConstructorCall(const CXXConstructorDecl *Ctor,
- const FunctionArgList &Args);
- /// Emit a call to an inheriting constructor (that is, one that invokes a
- /// constructor inherited from a base class) by inlining its definition. This
- /// is necessary if the ABI does not support forwarding the arguments to the
- /// base class constructor (because they're variadic or similar).
- void EmitInlinedInheritingCXXConstructorCall(const CXXConstructorDecl *Ctor,
- CXXCtorType CtorType,
- bool ForVirtualBase,
- bool Delegating,
- CallArgList &Args);
- /// Emit a call to a constructor inherited from a base class, passing the
- /// current constructor's arguments along unmodified (without even making
- /// a copy).
- void EmitInheritedCXXConstructorCall(const CXXConstructorDecl *D,
- bool ForVirtualBase, Address This,
- bool InheritedFromVBase,
- const CXXInheritedCtorInitExpr *E);
- void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
- bool ForVirtualBase, bool Delegating,
- Address This, const CXXConstructExpr *E);
- void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
- bool ForVirtualBase, bool Delegating,
- Address This, CallArgList &Args);
- /// Emit assumption load for all bases. Requires to be be called only on
- /// most-derived class and not under construction of the object.
- void EmitVTableAssumptionLoads(const CXXRecordDecl *ClassDecl, Address This);
- /// Emit assumption that vptr load == global vtable.
- void EmitVTableAssumptionLoad(const VPtr &vptr, Address This);
- void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
- Address This, Address Src,
- const CXXConstructExpr *E);
- void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
- const ArrayType *ArrayTy,
- Address ArrayPtr,
- const CXXConstructExpr *E,
- bool ZeroInitialization = false);
- void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
- llvm::Value *NumElements,
- Address ArrayPtr,
- const CXXConstructExpr *E,
- bool ZeroInitialization = false);
- static Destroyer destroyCXXObject;
- void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
- bool ForVirtualBase, bool Delegating,
- Address This);
- void EmitNewArrayInitializer(const CXXNewExpr *E, QualType elementType,
- llvm::Type *ElementTy, Address NewPtr,
- llvm::Value *NumElements,
- llvm::Value *AllocSizeWithoutCookie);
- void EmitCXXTemporary(const CXXTemporary *Temporary, QualType TempType,
- Address Ptr);
- llvm::Value *EmitLifetimeStart(uint64_t Size, llvm::Value *Addr);
- void EmitLifetimeEnd(llvm::Value *Size, llvm::Value *Addr);
- llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
- void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
- void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
- QualType DeleteTy, llvm::Value *NumElements = nullptr,
- CharUnits CookieSize = CharUnits());
- RValue EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
- const Expr *Arg, bool IsDelete);
- llvm::Value *EmitCXXTypeidExpr(const CXXTypeidExpr *E);
- llvm::Value *EmitDynamicCast(Address V, const CXXDynamicCastExpr *DCE);
- Address EmitCXXUuidofExpr(const CXXUuidofExpr *E);
- /// \brief Situations in which we might emit a check for the suitability of a
- /// pointer or glvalue.
- enum TypeCheckKind {
- /// Checking the operand of a load. Must be suitably sized and aligned.
- TCK_Load,
- /// Checking the destination of a store. Must be suitably sized and aligned.
- TCK_Store,
- /// Checking the bound value in a reference binding. Must be suitably sized
- /// and aligned, but is not required to refer to an object (until the
- /// reference is used), per core issue 453.
- TCK_ReferenceBinding,
- /// Checking the object expression in a non-static data member access. Must
- /// be an object within its lifetime.
- TCK_MemberAccess,
- /// Checking the 'this' pointer for a call to a non-static member function.
- /// Must be an object within its lifetime.
- TCK_MemberCall,
- /// Checking the 'this' pointer for a constructor call.
- TCK_ConstructorCall,
- /// Checking the operand of a static_cast to a derived pointer type. Must be
- /// null or an object within its lifetime.
- TCK_DowncastPointer,
- /// Checking the operand of a static_cast to a derived reference type. Must
- /// be an object within its lifetime.
- TCK_DowncastReference,
- /// Checking the operand of a cast to a base object. Must be suitably sized
- /// and aligned.
- TCK_Upcast,
- /// Checking the operand of a cast to a virtual base object. Must be an
- /// object within its lifetime.
- TCK_UpcastToVirtualBase,
- /// Checking the value assigned to a _Nonnull pointer. Must not be null.
- TCK_NonnullAssign,
- /// Checking the operand of a dynamic_cast or a typeid expression. Must be
- /// null or an object within its lifetime.
- TCK_DynamicOperation
- };
- /// Determine whether the pointer type check \p TCK permits null pointers.
- static bool isNullPointerAllowed(TypeCheckKind TCK);
- /// Determine whether the pointer type check \p TCK requires a vptr check.
- static bool isVptrCheckRequired(TypeCheckKind TCK, QualType Ty);
- /// \brief Whether any type-checking sanitizers are enabled. If \c false,
- /// calls to EmitTypeCheck can be skipped.
- bool sanitizePerformTypeCheck() const;
- /// \brief Emit a check that \p V is the address of storage of the
- /// appropriate size and alignment for an object of type \p Type.
- void EmitTypeCheck(TypeCheckKind TCK, SourceLocation Loc, llvm::Value *V,
- QualType Type, CharUnits Alignment = CharUnits::Zero(),
- SanitizerSet SkippedChecks = SanitizerSet());
- /// \brief Emit a check that \p Base points into an array object, which
- /// we can access at index \p Index. \p Accessed should be \c false if we
- /// this expression is used as an lvalue, for instance in "&Arr[Idx]".
- void EmitBoundsCheck(const Expr *E, const Expr *Base, llvm::Value *Index,
- QualType IndexType, bool Accessed);
- llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
- bool isInc, bool isPre);
- ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
- bool isInc, bool isPre);
- void EmitAlignmentAssumption(llvm::Value *PtrValue, unsigned Alignment,
- llvm::Value *OffsetValue = nullptr) {
- Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
- OffsetValue);
- }
- /// Converts Location to a DebugLoc, if debug information is enabled.
- llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Location);
- //===--------------------------------------------------------------------===//
- // Declaration Emission
- //===--------------------------------------------------------------------===//
- /// EmitDecl - Emit a declaration.
- ///
- /// This function can be called with a null (unreachable) insert point.
- void EmitDecl(const Decl &D);
- /// EmitVarDecl - Emit a local variable declaration.
- ///
- /// This function can be called with a null (unreachable) insert point.
- void EmitVarDecl(const VarDecl &D);
- void EmitScalarInit(const Expr *init, const ValueDecl *D, LValue lvalue,
- bool capturedByInit);
- typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
- llvm::Value *Address);
- /// \brief Determine whether the given initializer is trivial in the sense
- /// that it requires no code to be generated.
- bool isTrivialInitializer(const Expr *Init);
- /// EmitAutoVarDecl - Emit an auto variable declaration.
- ///
- /// This function can be called with a null (unreachable) insert point.
- void EmitAutoVarDecl(const VarDecl &D);
- class AutoVarEmission {
- friend class CodeGenFunction;
- const VarDecl *Variable;
- /// The address of the alloca. Invalid if the variable was emitted
- /// as a global constant.
- Address Addr;
- llvm::Value *NRVOFlag;
- /// True if the variable is a __block variable.
- bool IsByRef;
- /// True if the variable is of aggregate type and has a constant
- /// initializer.
- bool IsConstantAggregate;
- /// Non-null if we should use lifetime annotations.
- llvm::Value *SizeForLifetimeMarkers;
- struct Invalid {};
- AutoVarEmission(Invalid) : Variable(nullptr), Addr(Address::invalid()) {}
- AutoVarEmission(const VarDecl &variable)
- : Variable(&variable), Addr(Address::invalid()), NRVOFlag(nullptr),
- IsByRef(false), IsConstantAggregate(false),
- SizeForLifetimeMarkers(nullptr) {}
- bool wasEmittedAsGlobal() const { return !Addr.isValid(); }
- public:
- static AutoVarEmission invalid() { return AutoVarEmission(Invalid()); }
- bool useLifetimeMarkers() const {
- return SizeForLifetimeMarkers != nullptr;
- }
- llvm::Value *getSizeForLifetimeMarkers() const {
- assert(useLifetimeMarkers());
- return SizeForLifetimeMarkers;
- }
- /// Returns the raw, allocated address, which is not necessarily
- /// the address of the object itself.
- Address getAllocatedAddress() const {
- return Addr;
- }
- /// Returns the address of the object within this declaration.
- /// Note that this does not chase the forwarding pointer for
- /// __block decls.
- Address getObjectAddress(CodeGenFunction &CGF) const {
- if (!IsByRef) return Addr;
- return CGF.emitBlockByrefAddress(Addr, Variable, /*forward*/ false);
- }
- };
- AutoVarEmission EmitAutoVarAlloca(const VarDecl &var);
- void EmitAutoVarInit(const AutoVarEmission &emission);
- void EmitAutoVarCleanups(const AutoVarEmission &emission);
- void emitAutoVarTypeCleanup(const AutoVarEmission &emission,
- QualType::DestructionKind dtorKind);
- void EmitStaticVarDecl(const VarDecl &D,
- llvm::GlobalValue::LinkageTypes Linkage);
- class ParamValue {
- llvm::Value *Value;
- unsigned Alignment;
- ParamValue(llvm::Value *V, unsigned A) : Value(V), Alignment(A) {}
- public:
- static ParamValue forDirect(llvm::Value *value) {
- return ParamValue(value, 0);
- }
- static ParamValue forIndirect(Address addr) {
- assert(!addr.getAlignment().isZero());
- return ParamValue(addr.getPointer(), addr.getAlignment().getQuantity());
- }
- bool isIndirect() const { return Alignment != 0; }
- llvm::Value *getAnyValue() const { return Value; }
- llvm::Value *getDirectValue() const {
- assert(!isIndirect());
- return Value;
- }
- Address getIndirectAddress() const {
- assert(isIndirect());
- return Address(Value, CharUnits::fromQuantity(Alignment));
- }
- };
- /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
- void EmitParmDecl(const VarDecl &D, ParamValue Arg, unsigned ArgNo);
- /// protectFromPeepholes - Protect a value that we're intending to
- /// store to the side, but which will probably be used later, from
- /// aggressive peepholing optimizations that might delete it.
- ///
- /// Pass the result to unprotectFromPeepholes to declare that
- /// protection is no longer required.
- ///
- /// There's no particular reason why this shouldn't apply to
- /// l-values, it's just that no existing peepholes work on pointers.
- PeepholeProtection protectFromPeepholes(RValue rvalue);
- void unprotectFromPeepholes(PeepholeProtection protection);
- void EmitAlignmentAssumption(llvm::Value *PtrValue, llvm::Value *Alignment,
- llvm::Value *OffsetValue = nullptr) {
- Builder.CreateAlignmentAssumption(CGM.getDataLayout(), PtrValue, Alignment,
- OffsetValue);
- }
- //===--------------------------------------------------------------------===//
- // Statement Emission
- //===--------------------------------------------------------------------===//
- /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
- void EmitStopPoint(const Stmt *S);
- /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
- /// this function even if there is no current insertion point.
- ///
- /// This function may clear the current insertion point; callers should use
- /// EnsureInsertPoint if they wish to subsequently generate code without first
- /// calling EmitBlock, EmitBranch, or EmitStmt.
- void EmitStmt(const Stmt *S, ArrayRef<const Attr *> Attrs = None);
- /// EmitSimpleStmt - Try to emit a "simple" statement which does not
- /// necessarily require an insertion point or debug information; typically
- /// because the statement amounts to a jump or a container of other
- /// statements.
- ///
- /// \return True if the statement was handled.
- bool EmitSimpleStmt(const Stmt *S);
- Address EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
- AggValueSlot AVS = AggValueSlot::ignored());
- Address EmitCompoundStmtWithoutScope(const CompoundStmt &S,
- bool GetLast = false,
- AggValueSlot AVS =
- AggValueSlot::ignored());
- /// EmitLabel - Emit the block for the given label. It is legal to call this
- /// function even if there is no current insertion point.
- void EmitLabel(const LabelDecl *D); // helper for EmitLabelStmt.
- void EmitLabelStmt(const LabelStmt &S);
- void EmitAttributedStmt(const AttributedStmt &S);
- void EmitGotoStmt(const GotoStmt &S);
- void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
- void EmitIfStmt(const IfStmt &S);
- void EmitWhileStmt(const WhileStmt &S,
- ArrayRef<const Attr *> Attrs = None);
- void EmitDoStmt(const DoStmt &S, ArrayRef<const Attr *> Attrs = None);
- void EmitForStmt(const ForStmt &S,
- ArrayRef<const Attr *> Attrs = None);
- void EmitReturnStmt(const ReturnStmt &S);
- void EmitDeclStmt(const DeclStmt &S);
- void EmitBreakStmt(const BreakStmt &S);
- void EmitContinueStmt(const ContinueStmt &S);
- void EmitSwitchStmt(const SwitchStmt &S);
- void EmitDefaultStmt(const DefaultStmt &S);
- void EmitCaseStmt(const CaseStmt &S);
- void EmitCaseStmtRange(const CaseStmt &S);
- void EmitAsmStmt(const AsmStmt &S);
- void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
- void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
- void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
- void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
- void EmitObjCAutoreleasePoolStmt(const ObjCAutoreleasePoolStmt &S);
- void EmitCoroutineBody(const CoroutineBodyStmt &S);
- void EmitCoreturnStmt(const CoreturnStmt &S);
- RValue EmitCoawaitExpr(const CoawaitExpr &E,
- AggValueSlot aggSlot = AggValueSlot::ignored(),
- bool ignoreResult = false);
- LValue EmitCoawaitLValue(const CoawaitExpr *E);
- RValue EmitCoyieldExpr(const CoyieldExpr &E,
- AggValueSlot aggSlot = AggValueSlot::ignored(),
- bool ignoreResult = false);
- LValue EmitCoyieldLValue(const CoyieldExpr *E);
- RValue EmitCoroutineIntrinsic(const CallExpr *E, unsigned int IID);
- void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
- void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
- void EmitCXXTryStmt(const CXXTryStmt &S);
- void EmitSEHTryStmt(const SEHTryStmt &S);
- void EmitSEHLeaveStmt(const SEHLeaveStmt &S);
- void EnterSEHTryStmt(const SEHTryStmt &S);
- void ExitSEHTryStmt(const SEHTryStmt &S);
- void startOutlinedSEHHelper(CodeGenFunction &ParentCGF, bool IsFilter,
- const Stmt *OutlinedStmt);
- llvm::Function *GenerateSEHFilterFunction(CodeGenFunction &ParentCGF,
- const SEHExceptStmt &Except);
- llvm::Function *GenerateSEHFinallyFunction(CodeGenFunction &ParentCGF,
- const SEHFinallyStmt &Finally);
- void EmitSEHExceptionCodeSave(CodeGenFunction &ParentCGF,
- llvm::Value *ParentFP,
- llvm::Value *EntryEBP);
- llvm::Value *EmitSEHExceptionCode();
- llvm::Value *EmitSEHExceptionInfo();
- llvm::Value *EmitSEHAbnormalTermination();
- /// Emit simple code for OpenMP directives in Simd-only mode.
- void EmitSimpleOMPExecutableDirective(const OMPExecutableDirective &D);
- /// Scan the outlined statement for captures from the parent function. For
- /// each capture, mark the capture as escaped and emit a call to
- /// llvm.localrecover. Insert the localrecover result into the LocalDeclMap.
- void EmitCapturedLocals(CodeGenFunction &ParentCGF, const Stmt *OutlinedStmt,
- bool IsFilter);
- /// Recovers the address of a local in a parent function. ParentVar is the
- /// address of the variable used in the immediate parent function. It can
- /// either be an alloca or a call to llvm.localrecover if there are nested
- /// outlined functions. ParentFP is the frame pointer of the outermost parent
- /// frame.
- Address recoverAddrOfEscapedLocal(CodeGenFunction &ParentCGF,
- Address ParentVar,
- llvm::Value *ParentFP);
- void EmitCXXForRangeStmt(const CXXForRangeStmt &S,
- ArrayRef<const Attr *> Attrs = None);
- /// Controls insertion of cancellation exit blocks in worksharing constructs.
- class OMPCancelStackRAII {
- CodeGenFunction &CGF;
- public:
- OMPCancelStackRAII(CodeGenFunction &CGF, OpenMPDirectiveKind Kind,
- bool HasCancel)
- : CGF(CGF) {
- CGF.OMPCancelStack.enter(CGF, Kind, HasCancel);
- }
- ~OMPCancelStackRAII() { CGF.OMPCancelStack.exit(CGF); }
- };
- /// Returns calculated size of the specified type.
- llvm::Value *getTypeSize(QualType Ty);
- LValue InitCapturedStruct(const CapturedStmt &S);
- llvm::Function *EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K);
- llvm::Function *GenerateCapturedStmtFunction(const CapturedStmt &S);
- Address GenerateCapturedStmtArgument(const CapturedStmt &S);
- llvm::Function *GenerateOpenMPCapturedStmtFunction(const CapturedStmt &S);
- void GenerateOpenMPCapturedVars(const CapturedStmt &S,
- SmallVectorImpl<llvm::Value *> &CapturedVars);
- void emitOMPSimpleStore(LValue LVal, RValue RVal, QualType RValTy,
- SourceLocation Loc);
- /// \brief Perform element by element copying of arrays with type \a
- /// OriginalType from \a SrcAddr to \a DestAddr using copying procedure
- /// generated by \a CopyGen.
- ///
- /// \param DestAddr Address of the destination array.
- /// \param SrcAddr Address of the source array.
- /// \param OriginalType Type of destination and source arrays.
- /// \param CopyGen Copying procedure that copies value of single array element
- /// to another single array element.
- void EmitOMPAggregateAssign(
- Address DestAddr, Address SrcAddr, QualType OriginalType,
- const llvm::function_ref<void(Address, Address)> &CopyGen);
- /// \brief Emit proper copying of data from one variable to another.
- ///
- /// \param OriginalType Original type of the copied variables.
- /// \param DestAddr Destination address.
- /// \param SrcAddr Source address.
- /// \param DestVD Destination variable used in \a CopyExpr (for arrays, has
- /// type of the base array element).
- /// \param SrcVD Source variable used in \a CopyExpr (for arrays, has type of
- /// the base array element).
- /// \param Copy Actual copygin expression for copying data from \a SrcVD to \a
- /// DestVD.
- void EmitOMPCopy(QualType OriginalType,
- Address DestAddr, Address SrcAddr,
- const VarDecl *DestVD, const VarDecl *SrcVD,
- const Expr *Copy);
- /// \brief Emit atomic update code for constructs: \a X = \a X \a BO \a E or
- /// \a X = \a E \a BO \a E.
- ///
- /// \param X Value to be updated.
- /// \param E Update value.
- /// \param BO Binary operation for update operation.
- /// \param IsXLHSInRHSPart true if \a X is LHS in RHS part of the update
- /// expression, false otherwise.
- /// \param AO Atomic ordering of the generated atomic instructions.
- /// \param CommonGen Code generator for complex expressions that cannot be
- /// expressed through atomicrmw instruction.
- /// \returns <true, OldAtomicValue> if simple 'atomicrmw' instruction was
- /// generated, <false, RValue::get(nullptr)> otherwise.
- std::pair<bool, RValue> EmitOMPAtomicSimpleUpdateExpr(
- LValue X, RValue E, BinaryOperatorKind BO, bool IsXLHSInRHSPart,
- llvm::AtomicOrdering AO, SourceLocation Loc,
- const llvm::function_ref<RValue(RValue)> &CommonGen);
- bool EmitOMPFirstprivateClause(const OMPExecutableDirective &D,
- OMPPrivateScope &PrivateScope);
- void EmitOMPPrivateClause(const OMPExecutableDirective &D,
- OMPPrivateScope &PrivateScope);
- void EmitOMPUseDevicePtrClause(
- const OMPClause &C, OMPPrivateScope &PrivateScope,
- const llvm::DenseMap<const ValueDecl *, Address> &CaptureDeviceAddrMap);
- /// \brief Emit code for copyin clause in \a D directive. The next code is
- /// generated at the start of outlined functions for directives:
- /// \code
- /// threadprivate_var1 = master_threadprivate_var1;
- /// operator=(threadprivate_var2, master_threadprivate_var2);
- /// ...
- /// __kmpc_barrier(&loc, global_tid);
- /// \endcode
- ///
- /// \param D OpenMP directive possibly with 'copyin' clause(s).
- /// \returns true if at least one copyin variable is found, false otherwise.
- bool EmitOMPCopyinClause(const OMPExecutableDirective &D);
- /// \brief Emit initial code for lastprivate variables. If some variable is
- /// not also firstprivate, then the default initialization is used. Otherwise
- /// initialization of this variable is performed by EmitOMPFirstprivateClause
- /// method.
- ///
- /// \param D Directive that may have 'lastprivate' directives.
- /// \param PrivateScope Private scope for capturing lastprivate variables for
- /// proper codegen in internal captured statement.
- ///
- /// \returns true if there is at least one lastprivate variable, false
- /// otherwise.
- bool EmitOMPLastprivateClauseInit(const OMPExecutableDirective &D,
- OMPPrivateScope &PrivateScope);
- /// \brief Emit final copying of lastprivate values to original variables at
- /// the end of the worksharing or simd directive.
- ///
- /// \param D Directive that has at least one 'lastprivate' directives.
- /// \param IsLastIterCond Boolean condition that must be set to 'i1 true' if
- /// it is the last iteration of the loop code in associated directive, or to
- /// 'i1 false' otherwise. If this item is nullptr, no final check is required.
- void EmitOMPLastprivateClauseFinal(const OMPExecutableDirective &D,
- bool NoFinals,
- llvm::Value *IsLastIterCond = nullptr);
- /// Emit initial code for linear clauses.
- void EmitOMPLinearClause(const OMPLoopDirective &D,
- CodeGenFunction::OMPPrivateScope &PrivateScope);
- /// Emit final code for linear clauses.
- /// \param CondGen Optional conditional code for final part of codegen for
- /// linear clause.
- void EmitOMPLinearClauseFinal(
- const OMPLoopDirective &D,
- const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
- /// \brief Emit initial code for reduction variables. Creates reduction copies
- /// and initializes them with the values according to OpenMP standard.
- ///
- /// \param D Directive (possibly) with the 'reduction' clause.
- /// \param PrivateScope Private scope for capturing reduction variables for
- /// proper codegen in internal captured statement.
- ///
- void EmitOMPReductionClauseInit(const OMPExecutableDirective &D,
- OMPPrivateScope &PrivateScope);
- /// \brief Emit final update of reduction values to original variables at
- /// the end of the directive.
- ///
- /// \param D Directive that has at least one 'reduction' directives.
- /// \param ReductionKind The kind of reduction to perform.
- void EmitOMPReductionClauseFinal(const OMPExecutableDirective &D,
- const OpenMPDirectiveKind ReductionKind);
- /// \brief Emit initial code for linear variables. Creates private copies
- /// and initializes them with the values according to OpenMP standard.
- ///
- /// \param D Directive (possibly) with the 'linear' clause.
- /// \return true if at least one linear variable is found that should be
- /// initialized with the value of the original variable, false otherwise.
- bool EmitOMPLinearClauseInit(const OMPLoopDirective &D);
- typedef const llvm::function_ref<void(CodeGenFunction & /*CGF*/,
- llvm::Value * /*OutlinedFn*/,
- const OMPTaskDataTy & /*Data*/)>
- TaskGenTy;
- void EmitOMPTaskBasedDirective(const OMPExecutableDirective &S,
- const RegionCodeGenTy &BodyGen,
- const TaskGenTy &TaskGen, OMPTaskDataTy &Data);
- struct OMPTargetDataInfo {
- Address BasePointersArray = Address::invalid();
- Address PointersArray = Address::invalid();
- Address SizesArray = Address::invalid();
- unsigned NumberOfTargetItems = 0;
- explicit OMPTargetDataInfo() = default;
- OMPTargetDataInfo(Address BasePointersArray, Address PointersArray,
- Address SizesArray, unsigned NumberOfTargetItems)
- : BasePointersArray(BasePointersArray), PointersArray(PointersArray),
- SizesArray(SizesArray), NumberOfTargetItems(NumberOfTargetItems) {}
- };
- void EmitOMPTargetTaskBasedDirective(const OMPExecutableDirective &S,
- const RegionCodeGenTy &BodyGen,
- OMPTargetDataInfo &InputInfo);
- void EmitOMPParallelDirective(const OMPParallelDirective &S);
- void EmitOMPSimdDirective(const OMPSimdDirective &S);
- void EmitOMPForDirective(const OMPForDirective &S);
- void EmitOMPForSimdDirective(const OMPForSimdDirective &S);
- void EmitOMPSectionsDirective(const OMPSectionsDirective &S);
- void EmitOMPSectionDirective(const OMPSectionDirective &S);
- void EmitOMPSingleDirective(const OMPSingleDirective &S);
- void EmitOMPMasterDirective(const OMPMasterDirective &S);
- void EmitOMPCriticalDirective(const OMPCriticalDirective &S);
- void EmitOMPParallelForDirective(const OMPParallelForDirective &S);
- void EmitOMPParallelForSimdDirective(const OMPParallelForSimdDirective &S);
- void EmitOMPParallelSectionsDirective(const OMPParallelSectionsDirective &S);
- void EmitOMPTaskDirective(const OMPTaskDirective &S);
- void EmitOMPTaskyieldDirective(const OMPTaskyieldDirective &S);
- void EmitOMPBarrierDirective(const OMPBarrierDirective &S);
- void EmitOMPTaskwaitDirective(const OMPTaskwaitDirective &S);
- void EmitOMPTaskgroupDirective(const OMPTaskgroupDirective &S);
- void EmitOMPFlushDirective(const OMPFlushDirective &S);
- void EmitOMPOrderedDirective(const OMPOrderedDirective &S);
- void EmitOMPAtomicDirective(const OMPAtomicDirective &S);
- void EmitOMPTargetDirective(const OMPTargetDirective &S);
- void EmitOMPTargetDataDirective(const OMPTargetDataDirective &S);
- void EmitOMPTargetEnterDataDirective(const OMPTargetEnterDataDirective &S);
- void EmitOMPTargetExitDataDirective(const OMPTargetExitDataDirective &S);
- void EmitOMPTargetUpdateDirective(const OMPTargetUpdateDirective &S);
- void EmitOMPTargetParallelDirective(const OMPTargetParallelDirective &S);
- void
- EmitOMPTargetParallelForDirective(const OMPTargetParallelForDirective &S);
- void EmitOMPTeamsDirective(const OMPTeamsDirective &S);
- void
- EmitOMPCancellationPointDirective(const OMPCancellationPointDirective &S);
- void EmitOMPCancelDirective(const OMPCancelDirective &S);
- void EmitOMPTaskLoopBasedDirective(const OMPLoopDirective &S);
- void EmitOMPTaskLoopDirective(const OMPTaskLoopDirective &S);
- void EmitOMPTaskLoopSimdDirective(const OMPTaskLoopSimdDirective &S);
- void EmitOMPDistributeDirective(const OMPDistributeDirective &S);
- void EmitOMPDistributeParallelForDirective(
- const OMPDistributeParallelForDirective &S);
- void EmitOMPDistributeParallelForSimdDirective(
- const OMPDistributeParallelForSimdDirective &S);
- void EmitOMPDistributeSimdDirective(const OMPDistributeSimdDirective &S);
- void EmitOMPTargetParallelForSimdDirective(
- const OMPTargetParallelForSimdDirective &S);
- void EmitOMPTargetSimdDirective(const OMPTargetSimdDirective &S);
- void EmitOMPTeamsDistributeDirective(const OMPTeamsDistributeDirective &S);
- void
- EmitOMPTeamsDistributeSimdDirective(const OMPTeamsDistributeSimdDirective &S);
- void EmitOMPTeamsDistributeParallelForSimdDirective(
- const OMPTeamsDistributeParallelForSimdDirective &S);
- void EmitOMPTeamsDistributeParallelForDirective(
- const OMPTeamsDistributeParallelForDirective &S);
- void EmitOMPTargetTeamsDirective(const OMPTargetTeamsDirective &S);
- void EmitOMPTargetTeamsDistributeDirective(
- const OMPTargetTeamsDistributeDirective &S);
- void EmitOMPTargetTeamsDistributeParallelForDirective(
- const OMPTargetTeamsDistributeParallelForDirective &S);
- void EmitOMPTargetTeamsDistributeParallelForSimdDirective(
- const OMPTargetTeamsDistributeParallelForSimdDirective &S);
- void EmitOMPTargetTeamsDistributeSimdDirective(
- const OMPTargetTeamsDistributeSimdDirective &S);
- /// Emit device code for the target directive.
- static void EmitOMPTargetDeviceFunction(CodeGenModule &CGM,
- StringRef ParentName,
- const OMPTargetDirective &S);
- static void
- EmitOMPTargetParallelDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetParallelDirective &S);
- /// Emit device code for the target parallel for directive.
- static void EmitOMPTargetParallelForDeviceFunction(
- CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetParallelForDirective &S);
- /// Emit device code for the target parallel for simd directive.
- static void EmitOMPTargetParallelForSimdDeviceFunction(
- CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetParallelForSimdDirective &S);
- /// Emit device code for the target teams directive.
- static void
- EmitOMPTargetTeamsDeviceFunction(CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetTeamsDirective &S);
- /// Emit device code for the target teams distribute directive.
- static void EmitOMPTargetTeamsDistributeDeviceFunction(
- CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetTeamsDistributeDirective &S);
- /// Emit device code for the target teams distribute simd directive.
- static void EmitOMPTargetTeamsDistributeSimdDeviceFunction(
- CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetTeamsDistributeSimdDirective &S);
- /// Emit device code for the target simd directive.
- static void EmitOMPTargetSimdDeviceFunction(CodeGenModule &CGM,
- StringRef ParentName,
- const OMPTargetSimdDirective &S);
- static void EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
- CodeGenModule &CGM, StringRef ParentName,
- const OMPTargetTeamsDistributeParallelForDirective &S);
- /// \brief Emit inner loop of the worksharing/simd construct.
- ///
- /// \param S Directive, for which the inner loop must be emitted.
- /// \param RequiresCleanup true, if directive has some associated private
- /// variables.
- /// \param LoopCond Bollean condition for loop continuation.
- /// \param IncExpr Increment expression for loop control variable.
- /// \param BodyGen Generator for the inner body of the inner loop.
- /// \param PostIncGen Genrator for post-increment code (required for ordered
- /// loop directvies).
- void EmitOMPInnerLoop(
- const Stmt &S, bool RequiresCleanup, const Expr *LoopCond,
- const Expr *IncExpr,
- const llvm::function_ref<void(CodeGenFunction &)> &BodyGen,
- const llvm::function_ref<void(CodeGenFunction &)> &PostIncGen);
- JumpDest getOMPCancelDestination(OpenMPDirectiveKind Kind);
- /// Emit initial code for loop counters of loop-based directives.
- void EmitOMPPrivateLoopCounters(const OMPLoopDirective &S,
- OMPPrivateScope &LoopScope);
- /// Helper for the OpenMP loop directives.
- void EmitOMPLoopBody(const OMPLoopDirective &D, JumpDest LoopExit);
- /// \brief Emit code for the worksharing loop-based directive.
- /// \return true, if this construct has any lastprivate clause, false -
- /// otherwise.
- bool EmitOMPWorksharingLoop(const OMPLoopDirective &S, Expr *EUB,
- const CodeGenLoopBoundsTy &CodeGenLoopBounds,
- const CodeGenDispatchBoundsTy &CGDispatchBounds);
- /// Emit code for the distribute loop-based directive.
- void EmitOMPDistributeLoop(const OMPLoopDirective &S,
- const CodeGenLoopTy &CodeGenLoop, Expr *IncExpr);
- /// Helpers for the OpenMP loop directives.
- void EmitOMPSimdInit(const OMPLoopDirective &D, bool IsMonotonic = false);
- void EmitOMPSimdFinal(
- const OMPLoopDirective &D,
- const llvm::function_ref<llvm::Value *(CodeGenFunction &)> &CondGen);
- /// Emits the lvalue for the expression with possibly captured variable.
- LValue EmitOMPSharedLValue(const Expr *E);
- private:
- /// Helpers for blocks. Returns invoke function by \p InvokeF if it is not
- /// nullptr. It should be called without \p InvokeF if the caller does not
- /// need invoke function to be returned.
- llvm::Value *EmitBlockLiteral(const CGBlockInfo &Info,
- llvm::Function **InvokeF = nullptr);
- /// struct with the values to be passed to the OpenMP loop-related functions
- struct OMPLoopArguments {
- /// loop lower bound
- Address LB = Address::invalid();
- /// loop upper bound
- Address UB = Address::invalid();
- /// loop stride
- Address ST = Address::invalid();
- /// isLastIteration argument for runtime functions
- Address IL = Address::invalid();
- /// Chunk value generated by sema
- llvm::Value *Chunk = nullptr;
- /// EnsureUpperBound
- Expr *EUB = nullptr;
- /// IncrementExpression
- Expr *IncExpr = nullptr;
- /// Loop initialization
- Expr *Init = nullptr;
- /// Loop exit condition
- Expr *Cond = nullptr;
- /// Update of LB after a whole chunk has been executed
- Expr *NextLB = nullptr;
- /// Update of UB after a whole chunk has been executed
- Expr *NextUB = nullptr;
- OMPLoopArguments() = default;
- OMPLoopArguments(Address LB, Address UB, Address ST, Address IL,
- llvm::Value *Chunk = nullptr, Expr *EUB = nullptr,
- Expr *IncExpr = nullptr, Expr *Init = nullptr,
- Expr *Cond = nullptr, Expr *NextLB = nullptr,
- Expr *NextUB = nullptr)
- : LB(LB), UB(UB), ST(ST), IL(IL), Chunk(Chunk), EUB(EUB),
- IncExpr(IncExpr), Init(Init), Cond(Cond), NextLB(NextLB),
- NextUB(NextUB) {}
- };
- void EmitOMPOuterLoop(bool DynamicOrOrdered, bool IsMonotonic,
- const OMPLoopDirective &S, OMPPrivateScope &LoopScope,
- const OMPLoopArguments &LoopArgs,
- const CodeGenLoopTy &CodeGenLoop,
- const CodeGenOrderedTy &CodeGenOrdered);
- void EmitOMPForOuterLoop(const OpenMPScheduleTy &ScheduleKind,
- bool IsMonotonic, const OMPLoopDirective &S,
- OMPPrivateScope &LoopScope, bool Ordered,
- const OMPLoopArguments &LoopArgs,
- const CodeGenDispatchBoundsTy &CGDispatchBounds);
- void EmitOMPDistributeOuterLoop(OpenMPDistScheduleClauseKind ScheduleKind,
- const OMPLoopDirective &S,
- OMPPrivateScope &LoopScope,
- const OMPLoopArguments &LoopArgs,
- const CodeGenLoopTy &CodeGenLoopContent);
- /// \brief Emit code for sections directive.
- void EmitSections(const OMPExecutableDirective &S);
- public:
- //===--------------------------------------------------------------------===//
- // LValue Expression Emission
- //===--------------------------------------------------------------------===//
- /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
- RValue GetUndefRValue(QualType Ty);
- /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
- /// and issue an ErrorUnsupported style diagnostic (using the
- /// provided Name).
- RValue EmitUnsupportedRValue(const Expr *E,
- const char *Name);
- /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
- /// an ErrorUnsupported style diagnostic (using the provided Name).
- LValue EmitUnsupportedLValue(const Expr *E,
- const char *Name);
- /// EmitLValue - Emit code to compute a designator that specifies the location
- /// of the expression.
- ///
- /// This can return one of two things: a simple address or a bitfield
- /// reference. In either case, the LLVM Value* in the LValue structure is
- /// guaranteed to be an LLVM pointer type.
- ///
- /// If this returns a bitfield reference, nothing about the pointee type of
- /// the LLVM value is known: For example, it may not be a pointer to an
- /// integer.
- ///
- /// If this returns a normal address, and if the lvalue's C type is fixed
- /// size, this method guarantees that the returned pointer type will point to
- /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
- /// variable length type, this is not possible.
- ///
- LValue EmitLValue(const Expr *E);
- /// \brief Same as EmitLValue but additionally we generate checking code to
- /// guard against undefined behavior. This is only suitable when we know
- /// that the address will be used to access the object.
- LValue EmitCheckedLValue(const Expr *E, TypeCheckKind TCK);
- RValue convertTempToRValue(Address addr, QualType type,
- SourceLocation Loc);
- void EmitAtomicInit(Expr *E, LValue lvalue);
- bool LValueIsSuitableForInlineAtomic(LValue Src);
- RValue EmitAtomicLoad(LValue LV, SourceLocation SL,
- AggValueSlot Slot = AggValueSlot::ignored());
- RValue EmitAtomicLoad(LValue lvalue, SourceLocation loc,
- llvm::AtomicOrdering AO, bool IsVolatile = false,
- AggValueSlot slot = AggValueSlot::ignored());
- void EmitAtomicStore(RValue rvalue, LValue lvalue, bool isInit);
- void EmitAtomicStore(RValue rvalue, LValue lvalue, llvm::AtomicOrdering AO,
- bool IsVolatile, bool isInit);
- std::pair<RValue, llvm::Value *> EmitAtomicCompareExchange(
- LValue Obj, RValue Expected, RValue Desired, SourceLocation Loc,
- llvm::AtomicOrdering Success =
- llvm::AtomicOrdering::SequentiallyConsistent,
- llvm::AtomicOrdering Failure =
- llvm::AtomicOrdering::SequentiallyConsistent,
- bool IsWeak = false, AggValueSlot Slot = AggValueSlot::ignored());
- void EmitAtomicUpdate(LValue LVal, llvm::AtomicOrdering AO,
- const llvm::function_ref<RValue(RValue)> &UpdateOp,
- bool IsVolatile);
- /// EmitToMemory - Change a scalar value from its value
- /// representation to its in-memory representation.
- llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
- /// EmitFromMemory - Change a scalar value from its memory
- /// representation to its value representation.
- llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
- /// Check if the scalar \p Value is within the valid range for the given
- /// type \p Ty.
- ///
- /// Returns true if a check is needed (even if the range is unknown).
- bool EmitScalarRangeCheck(llvm::Value *Value, QualType Ty,
- SourceLocation Loc);
- /// EmitLoadOfScalar - Load a scalar value from an address, taking
- /// care to appropriately convert from the memory representation to
- /// the LLVM value representation.
- llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
- SourceLocation Loc,
- AlignmentSource Source = AlignmentSource::Type,
- bool isNontemporal = false) {
- return EmitLoadOfScalar(Addr, Volatile, Ty, Loc, LValueBaseInfo(Source),
- CGM.getTBAAAccessInfo(Ty), isNontemporal);
- }
- llvm::Value *EmitLoadOfScalar(Address Addr, bool Volatile, QualType Ty,
- SourceLocation Loc, LValueBaseInfo BaseInfo,
- TBAAAccessInfo TBAAInfo,
- bool isNontemporal = false);
- /// EmitLoadOfScalar - Load a scalar value from an address, taking
- /// care to appropriately convert from the memory representation to
- /// the LLVM value representation. The l-value must be a simple
- /// l-value.
- llvm::Value *EmitLoadOfScalar(LValue lvalue, SourceLocation Loc);
- /// EmitStoreOfScalar - Store a scalar value to an address, taking
- /// care to appropriately convert from the memory representation to
- /// the LLVM value representation.
- void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
- bool Volatile, QualType Ty,
- AlignmentSource Source = AlignmentSource::Type,
- bool isInit = false, bool isNontemporal = false) {
- EmitStoreOfScalar(Value, Addr, Volatile, Ty, LValueBaseInfo(Source),
- CGM.getTBAAAccessInfo(Ty), isInit, isNontemporal);
- }
- void EmitStoreOfScalar(llvm::Value *Value, Address Addr,
- bool Volatile, QualType Ty,
- LValueBaseInfo BaseInfo, TBAAAccessInfo TBAAInfo,
- bool isInit = false, bool isNontemporal = false);
- /// EmitStoreOfScalar - Store a scalar value to an address, taking
- /// care to appropriately convert from the memory representation to
- /// the LLVM value representation. The l-value must be a simple
- /// l-value. The isInit flag indicates whether this is an initialization.
- /// If so, atomic qualifiers are ignored and the store is always non-atomic.
- void EmitStoreOfScalar(llvm::Value *value, LValue lvalue, bool isInit=false);
- /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
- /// this method emits the address of the lvalue, then loads the result as an
- /// rvalue, returning the rvalue.
- RValue EmitLoadOfLValue(LValue V, SourceLocation Loc);
- RValue EmitLoadOfExtVectorElementLValue(LValue V);
- RValue EmitLoadOfBitfieldLValue(LValue LV, SourceLocation Loc);
- RValue EmitLoadOfGlobalRegLValue(LValue LV);
- /// EmitStoreThroughLValue - Store the specified rvalue into the specified
- /// lvalue, where both are guaranteed to the have the same type, and that type
- /// is 'Ty'.
- void EmitStoreThroughLValue(RValue Src, LValue Dst, bool isInit = false);
- void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst);
- void EmitStoreThroughGlobalRegLValue(RValue Src, LValue Dst);
- /// EmitStoreThroughBitfieldLValue - Store Src into Dst with same constraints
- /// as EmitStoreThroughLValue.
- ///
- /// \param Result [out] - If non-null, this will be set to a Value* for the
- /// bit-field contents after the store, appropriate for use as the result of
- /// an assignment to the bit-field.
- void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst,
- llvm::Value **Result=nullptr);
- /// Emit an l-value for an assignment (simple or compound) of complex type.
- LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
- LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
- LValue EmitScalarCompoundAssignWithComplex(const CompoundAssignOperator *E,
- llvm::Value *&Result);
- // Note: only available for agg return types
- LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
- LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
- // Note: only available for agg return types
- LValue EmitCallExprLValue(const CallExpr *E);
- // Note: only available for agg return types
- LValue EmitVAArgExprLValue(const VAArgExpr *E);
- LValue EmitDeclRefLValue(const DeclRefExpr *E);
- LValue EmitStringLiteralLValue(const StringLiteral *E);
- LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
- LValue EmitPredefinedLValue(const PredefinedExpr *E);
- LValue EmitUnaryOpLValue(const UnaryOperator *E);
- LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E,
- bool Accessed = false);
- LValue EmitOMPArraySectionExpr(const OMPArraySectionExpr *E,
- bool IsLowerBound = true);
- LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
- LValue EmitMemberExpr(const MemberExpr *E);
- LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
- LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
- LValue EmitInitListLValue(const InitListExpr *E);
- LValue EmitConditionalOperatorLValue(const AbstractConditionalOperator *E);
- LValue EmitCastLValue(const CastExpr *E);
- LValue EmitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *E);
- LValue EmitOpaqueValueLValue(const OpaqueValueExpr *e);
- Address EmitExtVectorElementLValue(LValue V);
- RValue EmitRValueForField(LValue LV, const FieldDecl *FD, SourceLocation Loc);
- Address EmitArrayToPointerDecay(const Expr *Array,
- LValueBaseInfo *BaseInfo = nullptr,
- TBAAAccessInfo *TBAAInfo = nullptr);
- class ConstantEmission {
- llvm::PointerIntPair<llvm::Constant*, 1, bool> ValueAndIsReference;
- ConstantEmission(llvm::Constant *C, bool isReference)
- : ValueAndIsReference(C, isReference) {}
- public:
- ConstantEmission() {}
- static ConstantEmission forReference(llvm::Constant *C) {
- return ConstantEmission(C, true);
- }
- static ConstantEmission forValue(llvm::Constant *C) {
- return ConstantEmission(C, false);
- }
- explicit operator bool() const {
- return ValueAndIsReference.getOpaqueValue() != nullptr;
- }
- bool isReference() const { return ValueAndIsReference.getInt(); }
- LValue getReferenceLValue(CodeGenFunction &CGF, Expr *refExpr) const {
- assert(isReference());
- return CGF.MakeNaturalAlignAddrLValue(ValueAndIsReference.getPointer(),
- refExpr->getType());
- }
- llvm::Constant *getValue() const {
- assert(!isReference());
- return ValueAndIsReference.getPointer();
- }
- };
- ConstantEmission tryEmitAsConstant(DeclRefExpr *refExpr);
- ConstantEmission tryEmitAsConstant(const MemberExpr *ME);
- RValue EmitPseudoObjectRValue(const PseudoObjectExpr *e,
- AggValueSlot slot = AggValueSlot::ignored());
- LValue EmitPseudoObjectLValue(const PseudoObjectExpr *e);
- llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
- const ObjCIvarDecl *Ivar);
- LValue EmitLValueForField(LValue Base, const FieldDecl* Field);
- LValue EmitLValueForLambdaField(const FieldDecl *Field);
- /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
- /// if the Field is a reference, this will return the address of the reference
- /// and not the address of the value stored in the reference.
- LValue EmitLValueForFieldInitialization(LValue Base,
- const FieldDecl* Field);
- LValue EmitLValueForIvar(QualType ObjectTy,
- llvm::Value* Base, const ObjCIvarDecl *Ivar,
- unsigned CVRQualifiers);
- LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
- LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
- LValue EmitLambdaLValue(const LambdaExpr *E);
- LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
- LValue EmitCXXUuidofLValue(const CXXUuidofExpr *E);
- LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
- LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
- LValue EmitStmtExprLValue(const StmtExpr *E);
- LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
- LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
- void EmitDeclRefExprDbgValue(const DeclRefExpr *E, const APValue &Init);
- //===--------------------------------------------------------------------===//
- // Scalar Expression Emission
- //===--------------------------------------------------------------------===//
- /// EmitCall - Generate a call of the given function, expecting the given
- /// result type, and using the given argument list which specifies both the
- /// LLVM arguments and the types they were derived from.
- RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
- ReturnValueSlot ReturnValue, const CallArgList &Args,
- llvm::Instruction **callOrInvoke, SourceLocation Loc);
- RValue EmitCall(const CGFunctionInfo &CallInfo, const CGCallee &Callee,
- ReturnValueSlot ReturnValue, const CallArgList &Args,
- llvm::Instruction **callOrInvoke = nullptr) {
- return EmitCall(CallInfo, Callee, ReturnValue, Args, callOrInvoke,
- SourceLocation());
- }
- RValue EmitCall(QualType FnType, const CGCallee &Callee, const CallExpr *E,
- ReturnValueSlot ReturnValue, llvm::Value *Chain = nullptr);
- RValue EmitCallExpr(const CallExpr *E,
- ReturnValueSlot ReturnValue = ReturnValueSlot());
- RValue EmitSimpleCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
- CGCallee EmitCallee(const Expr *E);
- void checkTargetFeatures(const CallExpr *E, const FunctionDecl *TargetDecl);
- llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
- const Twine &name = "");
- llvm::CallInst *EmitRuntimeCall(llvm::Value *callee,
- ArrayRef<llvm::Value*> args,
- const Twine &name = "");
- llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
- const Twine &name = "");
- llvm::CallInst *EmitNounwindRuntimeCall(llvm::Value *callee,
- ArrayRef<llvm::Value*> args,
- const Twine &name = "");
- llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
- ArrayRef<llvm::Value *> Args,
- const Twine &Name = "");
- llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
- ArrayRef<llvm::Value*> args,
- const Twine &name = "");
- llvm::CallSite EmitRuntimeCallOrInvoke(llvm::Value *callee,
- const Twine &name = "");
- void EmitNoreturnRuntimeCallOrInvoke(llvm::Value *callee,
- ArrayRef<llvm::Value*> args);
- CGCallee BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
- NestedNameSpecifier *Qual,
- llvm::Type *Ty);
- CGCallee BuildAppleKextVirtualDestructorCall(const CXXDestructorDecl *DD,
- CXXDtorType Type,
- const CXXRecordDecl *RD);
- RValue
- EmitCXXMemberOrOperatorCall(const CXXMethodDecl *Method,
- const CGCallee &Callee,
- ReturnValueSlot ReturnValue, llvm::Value *This,
- llvm::Value *ImplicitParam,
- QualType ImplicitParamTy, const CallExpr *E,
- CallArgList *RtlArgs);
- RValue EmitCXXDestructorCall(const CXXDestructorDecl *DD,
- const CGCallee &Callee,
- llvm::Value *This, llvm::Value *ImplicitParam,
- QualType ImplicitParamTy, const CallExpr *E,
- StructorType Type);
- RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
- ReturnValueSlot ReturnValue);
- RValue EmitCXXMemberOrOperatorMemberCallExpr(const CallExpr *CE,
- const CXXMethodDecl *MD,
- ReturnValueSlot ReturnValue,
- bool HasQualifier,
- NestedNameSpecifier *Qualifier,
- bool IsArrow, const Expr *Base);
- // Compute the object pointer.
- Address EmitCXXMemberDataPointerAddress(const Expr *E, Address base,
- llvm::Value *memberPtr,
- const MemberPointerType *memberPtrType,
- LValueBaseInfo *BaseInfo = nullptr,
- TBAAAccessInfo *TBAAInfo = nullptr);
- RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
- ReturnValueSlot ReturnValue);
- RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
- const CXXMethodDecl *MD,
- ReturnValueSlot ReturnValue);
- RValue EmitCXXPseudoDestructorExpr(const CXXPseudoDestructorExpr *E);
- RValue EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
- ReturnValueSlot ReturnValue);
- RValue EmitNVPTXDevicePrintfCallExpr(const CallExpr *E,
- ReturnValueSlot ReturnValue);
- RValue EmitBuiltinExpr(const FunctionDecl *FD,
- unsigned BuiltinID, const CallExpr *E,
- ReturnValueSlot ReturnValue);
- /// Emit IR for __builtin_os_log_format.
- RValue emitBuiltinOSLogFormat(const CallExpr &E);
- llvm::Function *generateBuiltinOSLogHelperFunction(
- const analyze_os_log::OSLogBufferLayout &Layout,
- CharUnits BufferAlignment);
- RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
- /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
- /// is unhandled by the current target.
- llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- llvm::Value *EmitAArch64CompareBuiltinExpr(llvm::Value *Op, llvm::Type *Ty,
- const llvm::CmpInst::Predicate Fp,
- const llvm::CmpInst::Predicate Ip,
- const llvm::Twine &Name = "");
- llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E,
- llvm::Triple::ArchType Arch);
- llvm::Value *EmitCommonNeonBuiltinExpr(unsigned BuiltinID,
- unsigned LLVMIntrinsic,
- unsigned AltLLVMIntrinsic,
- const char *NameHint,
- unsigned Modifier,
- const CallExpr *E,
- SmallVectorImpl<llvm::Value *> &Ops,
- Address PtrOp0, Address PtrOp1,
- llvm::Triple::ArchType Arch);
- llvm::Function *LookupNeonLLVMIntrinsic(unsigned IntrinsicID,
- unsigned Modifier, llvm::Type *ArgTy,
- const CallExpr *E);
- llvm::Value *EmitNeonCall(llvm::Function *F,
- SmallVectorImpl<llvm::Value*> &O,
- const char *name,
- unsigned shift = 0, bool rightshift = false);
- llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
- llvm::Value *EmitNeonShiftVector(llvm::Value *V, llvm::Type *Ty,
- bool negateForRightShift);
- llvm::Value *EmitNeonRShiftImm(llvm::Value *Vec, llvm::Value *Amt,
- llvm::Type *Ty, bool usgn, const char *name);
- llvm::Value *vectorWrapScalar16(llvm::Value *Op);
- llvm::Value *EmitAArch64BuiltinExpr(unsigned BuiltinID, const CallExpr *E,
- llvm::Triple::ArchType Arch);
- llvm::Value *BuildVector(ArrayRef<llvm::Value*> Ops);
- llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- llvm::Value *EmitAMDGPUBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- llvm::Value *EmitSystemZBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- llvm::Value *EmitNVPTXBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- llvm::Value *EmitWebAssemblyBuiltinExpr(unsigned BuiltinID,
- const CallExpr *E);
- llvm::Value *EmitHexagonBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
- private:
- enum class MSVCIntrin;
- public:
- llvm::Value *EmitMSVCBuiltinExpr(MSVCIntrin BuiltinID, const CallExpr *E);
- llvm::Value *EmitBuiltinAvailable(ArrayRef<llvm::Value *> Args);
- llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
- llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
- llvm::Value *EmitObjCBoxedExpr(const ObjCBoxedExpr *E);
- llvm::Value *EmitObjCArrayLiteral(const ObjCArrayLiteral *E);
- llvm::Value *EmitObjCDictionaryLiteral(const ObjCDictionaryLiteral *E);
- llvm::Value *EmitObjCCollectionLiteral(const Expr *E,
- const ObjCMethodDecl *MethodWithObjects);
- llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
- RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
- ReturnValueSlot Return = ReturnValueSlot());
- /// Retrieves the default cleanup kind for an ARC cleanup.
- /// Except under -fobjc-arc-eh, ARC cleanups are normal-only.
- CleanupKind getARCCleanupKind() {
- return CGM.getCodeGenOpts().ObjCAutoRefCountExceptions
- ? NormalAndEHCleanup : NormalCleanup;
- }
- // ARC primitives.
- void EmitARCInitWeak(Address addr, llvm::Value *value);
- void EmitARCDestroyWeak(Address addr);
- llvm::Value *EmitARCLoadWeak(Address addr);
- llvm::Value *EmitARCLoadWeakRetained(Address addr);
- llvm::Value *EmitARCStoreWeak(Address addr, llvm::Value *value, bool ignored);
- void EmitARCCopyWeak(Address dst, Address src);
- void EmitARCMoveWeak(Address dst, Address src);
- llvm::Value *EmitARCRetainAutorelease(QualType type, llvm::Value *value);
- llvm::Value *EmitARCRetainAutoreleaseNonBlock(llvm::Value *value);
- llvm::Value *EmitARCStoreStrong(LValue lvalue, llvm::Value *value,
- bool resultIgnored);
- llvm::Value *EmitARCStoreStrongCall(Address addr, llvm::Value *value,
- bool resultIgnored);
- llvm::Value *EmitARCRetain(QualType type, llvm::Value *value);
- llvm::Value *EmitARCRetainNonBlock(llvm::Value *value);
- llvm::Value *EmitARCRetainBlock(llvm::Value *value, bool mandatory);
- void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise);
- void EmitARCRelease(llvm::Value *value, ARCPreciseLifetime_t precise);
- llvm::Value *EmitARCAutorelease(llvm::Value *value);
- llvm::Value *EmitARCAutoreleaseReturnValue(llvm::Value *value);
- llvm::Value *EmitARCRetainAutoreleaseReturnValue(llvm::Value *value);
- llvm::Value *EmitARCRetainAutoreleasedReturnValue(llvm::Value *value);
- llvm::Value *EmitARCUnsafeClaimAutoreleasedReturnValue(llvm::Value *value);
- std::pair<LValue,llvm::Value*>
- EmitARCStoreAutoreleasing(const BinaryOperator *e);
- std::pair<LValue,llvm::Value*>
- EmitARCStoreStrong(const BinaryOperator *e, bool ignored);
- std::pair<LValue,llvm::Value*>
- EmitARCStoreUnsafeUnretained(const BinaryOperator *e, bool ignored);
- llvm::Value *EmitObjCThrowOperand(const Expr *expr);
- llvm::Value *EmitObjCConsumeObject(QualType T, llvm::Value *Ptr);
- llvm::Value *EmitObjCExtendObjectLifetime(QualType T, llvm::Value *Ptr);
- llvm::Value *EmitARCExtendBlockObject(const Expr *expr);
- llvm::Value *EmitARCReclaimReturnedObject(const Expr *e,
- bool allowUnsafeClaim);
- llvm::Value *EmitARCRetainScalarExpr(const Expr *expr);
- llvm::Value *EmitARCRetainAutoreleaseScalarExpr(const Expr *expr);
- llvm::Value *EmitARCUnsafeUnretainedScalarExpr(const Expr *expr);
- void EmitARCIntrinsicUse(ArrayRef<llvm::Value*> values);
- static Destroyer destroyARCStrongImprecise;
- static Destroyer destroyARCStrongPrecise;
- static Destroyer destroyARCWeak;
- static Destroyer emitARCIntrinsicUse;
- void EmitObjCAutoreleasePoolPop(llvm::Value *Ptr);
- llvm::Value *EmitObjCAutoreleasePoolPush();
- llvm::Value *EmitObjCMRRAutoreleasePoolPush();
- void EmitObjCAutoreleasePoolCleanup(llvm::Value *Ptr);
- void EmitObjCMRRAutoreleasePoolPop(llvm::Value *Ptr);
- /// \brief Emits a reference binding to the passed in expression.
- RValue EmitReferenceBindingToExpr(const Expr *E);
- //===--------------------------------------------------------------------===//
- // Expression Emission
- //===--------------------------------------------------------------------===//
- // Expressions are broken into three classes: scalar, complex, aggregate.
- /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
- /// scalar type, returning the result.
- llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
- /// Emit a conversion from the specified type to the specified destination
- /// type, both of which are LLVM scalar types.
- llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
- QualType DstTy, SourceLocation Loc);
- /// Emit a conversion from the specified complex type to the specified
- /// destination type, where the destination type is an LLVM scalar type.
- llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
- QualType DstTy,
- SourceLocation Loc);
- /// EmitAggExpr - Emit the computation of the specified expression
- /// of aggregate type. The result is computed into the given slot,
- /// which may be null to indicate that the value is not needed.
- void EmitAggExpr(const Expr *E, AggValueSlot AS);
- /// EmitAggExprToLValue - Emit the computation of the specified expression of
- /// aggregate type into a temporary LValue.
- LValue EmitAggExprToLValue(const Expr *E);
- /// EmitExtendGCLifetime - Given a pointer to an Objective-C object,
- /// make sure it survives garbage collection until this point.
- void EmitExtendGCLifetime(llvm::Value *object);
- /// EmitComplexExpr - Emit the computation of the specified expression of
- /// complex type, returning the result.
- ComplexPairTy EmitComplexExpr(const Expr *E,
- bool IgnoreReal = false,
- bool IgnoreImag = false);
- /// EmitComplexExprIntoLValue - Emit the given expression of complex
- /// type and place its result into the specified l-value.
- void EmitComplexExprIntoLValue(const Expr *E, LValue dest, bool isInit);
- /// EmitStoreOfComplex - Store a complex number into the specified l-value.
- void EmitStoreOfComplex(ComplexPairTy V, LValue dest, bool isInit);
- /// EmitLoadOfComplex - Load a complex number from the specified l-value.
- ComplexPairTy EmitLoadOfComplex(LValue src, SourceLocation loc);
- Address emitAddrOfRealComponent(Address complex, QualType complexType);
- Address emitAddrOfImagComponent(Address complex, QualType complexType);
- /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
- /// global variable that has already been created for it. If the initializer
- /// has a different type than GV does, this may free GV and return a different
- /// one. Otherwise it just returns GV.
- llvm::GlobalVariable *
- AddInitializerToStaticVarDecl(const VarDecl &D,
- llvm::GlobalVariable *GV);
- /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
- /// variable with global storage.
- void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr,
- bool PerformInit);
- llvm::Constant *createAtExitStub(const VarDecl &VD, llvm::Constant *Dtor,
- llvm::Constant *Addr);
- /// Call atexit() with a function that passes the given argument to
- /// the given function.
- void registerGlobalDtorWithAtExit(const VarDecl &D, llvm::Constant *fn,
- llvm::Constant *addr);
- /// Emit code in this function to perform a guarded variable
- /// initialization. Guarded initializations are used when it's not
- /// possible to prove that an initialization will be done exactly
- /// once, e.g. with a static local variable or a static data member
- /// of a class template.
- void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr,
- bool PerformInit);
- enum class GuardKind { VariableGuard, TlsGuard };
- /// Emit a branch to select whether or not to perform guarded initialization.
- void EmitCXXGuardedInitBranch(llvm::Value *NeedsInit,
- llvm::BasicBlock *InitBlock,
- llvm::BasicBlock *NoInitBlock,
- GuardKind Kind, const VarDecl *D);
- /// GenerateCXXGlobalInitFunc - Generates code for initializing global
- /// variables.
- void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
- ArrayRef<llvm::Function *> CXXThreadLocals,
- Address Guard = Address::invalid());
- /// GenerateCXXGlobalDtorsFunc - Generates code for destroying global
- /// variables.
- void GenerateCXXGlobalDtorsFunc(
- llvm::Function *Fn,
- const std::vector<std::pair<llvm::WeakTrackingVH, llvm::Constant *>>
- &DtorsAndObjects);
- void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn,
- const VarDecl *D,
- llvm::GlobalVariable *Addr,
- bool PerformInit);
- void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
- void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp);
- void enterFullExpression(const ExprWithCleanups *E) {
- if (E->getNumObjects() == 0) return;
- enterNonTrivialFullExpression(E);
- }
- void enterNonTrivialFullExpression(const ExprWithCleanups *E);
- void EmitCXXThrowExpr(const CXXThrowExpr *E, bool KeepInsertionPoint = true);
- void EmitLambdaExpr(const LambdaExpr *E, AggValueSlot Dest);
- RValue EmitAtomicExpr(AtomicExpr *E);
- //===--------------------------------------------------------------------===//
- // Annotations Emission
- //===--------------------------------------------------------------------===//
- /// Emit an annotation call (intrinsic or builtin).
- llvm::Value *EmitAnnotationCall(llvm::Value *AnnotationFn,
- llvm::Value *AnnotatedVal,
- StringRef AnnotationStr,
- SourceLocation Location);
- /// Emit local annotations for the local variable V, declared by D.
- void EmitVarAnnotations(const VarDecl *D, llvm::Value *V);
- /// Emit field annotations for the given field & value. Returns the
- /// annotation result.
- Address EmitFieldAnnotations(const FieldDecl *D, Address V);
- //===--------------------------------------------------------------------===//
- // Internal Helpers
- //===--------------------------------------------------------------------===//
- /// ContainsLabel - Return true if the statement contains a label in it. If
- /// this statement is not executed normally, it not containing a label means
- /// that we can just remove the code.
- static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
- /// containsBreak - Return true if the statement contains a break out of it.
- /// If the statement (recursively) contains a switch or loop with a break
- /// inside of it, this is fine.
- static bool containsBreak(const Stmt *S);
- /// Determine if the given statement might introduce a declaration into the
- /// current scope, by being a (possibly-labelled) DeclStmt.
- static bool mightAddDeclToScope(const Stmt *S);
- /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
- /// to a constant, or if it does but contains a label, return false. If it
- /// constant folds return true and set the boolean result in Result.
- bool ConstantFoldsToSimpleInteger(const Expr *Cond, bool &Result,
- bool AllowLabels = false);
- /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
- /// to a constant, or if it does but contains a label, return false. If it
- /// constant folds return true and set the folded value.
- bool ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &Result,
- bool AllowLabels = false);
- /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
- /// if statement) to the specified blocks. Based on the condition, this might
- /// try to simplify the codegen of the conditional based on the branch.
- /// TrueCount should be the number of times we expect the condition to
- /// evaluate to true based on PGO data.
- void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
- llvm::BasicBlock *FalseBlock, uint64_t TrueCount);
- /// Given an assignment `*LHS = RHS`, emit a test that checks if \p RHS is
- /// nonnull, if \p LHS is marked _Nonnull.
- void EmitNullabilityCheck(LValue LHS, llvm::Value *RHS, SourceLocation Loc);
- /// An enumeration which makes it easier to specify whether or not an
- /// operation is a subtraction.
- enum { NotSubtraction = false, IsSubtraction = true };
- /// Same as IRBuilder::CreateInBoundsGEP, but additionally emits a check to
- /// detect undefined behavior when the pointer overflow sanitizer is enabled.
- /// \p SignedIndices indicates whether any of the GEP indices are signed.
- /// \p IsSubtraction indicates whether the expression used to form the GEP
- /// is a subtraction.
- llvm::Value *EmitCheckedInBoundsGEP(llvm::Value *Ptr,
- ArrayRef<llvm::Value *> IdxList,
- bool SignedIndices,
- bool IsSubtraction,
- SourceLocation Loc,
- const Twine &Name = "");
- /// Specifies which type of sanitizer check to apply when handling a
- /// particular builtin.
- enum BuiltinCheckKind {
- BCK_CTZPassedZero,
- BCK_CLZPassedZero,
- };
- /// Emits an argument for a call to a builtin. If the builtin sanitizer is
- /// enabled, a runtime check specified by \p Kind is also emitted.
- llvm::Value *EmitCheckedArgForBuiltin(const Expr *E, BuiltinCheckKind Kind);
- /// \brief Emit a description of a type in a format suitable for passing to
- /// a runtime sanitizer handler.
- llvm::Constant *EmitCheckTypeDescriptor(QualType T);
- /// \brief Convert a value into a format suitable for passing to a runtime
- /// sanitizer handler.
- llvm::Value *EmitCheckValue(llvm::Value *V);
- /// \brief Emit a description of a source location in a format suitable for
- /// passing to a runtime sanitizer handler.
- llvm::Constant *EmitCheckSourceLocation(SourceLocation Loc);
- /// \brief Create a basic block that will call a handler function in a
- /// sanitizer runtime with the provided arguments, and create a conditional
- /// branch to it.
- void EmitCheck(ArrayRef<std::pair<llvm::Value *, SanitizerMask>> Checked,
- SanitizerHandler Check, ArrayRef<llvm::Constant *> StaticArgs,
- ArrayRef<llvm::Value *> DynamicArgs);
- /// \brief Emit a slow path cross-DSO CFI check which calls __cfi_slowpath
- /// if Cond if false.
- void EmitCfiSlowPathCheck(SanitizerMask Kind, llvm::Value *Cond,
- llvm::ConstantInt *TypeId, llvm::Value *Ptr,
- ArrayRef<llvm::Constant *> StaticArgs);
- /// Emit a reached-unreachable diagnostic if \p Loc is valid and runtime
- /// checking is enabled. Otherwise, just emit an unreachable instruction.
- void EmitUnreachable(SourceLocation Loc);
- /// \brief Create a basic block that will call the trap intrinsic, and emit a
- /// conditional branch to it, for the -ftrapv checks.
- void EmitTrapCheck(llvm::Value *Checked);
- /// \brief Emit a call to trap or debugtrap and attach function attribute
- /// "trap-func-name" if specified.
- llvm::CallInst *EmitTrapCall(llvm::Intrinsic::ID IntrID);
- /// \brief Emit a stub for the cross-DSO CFI check function.
- void EmitCfiCheckStub();
- /// \brief Emit a cross-DSO CFI failure handling function.
- void EmitCfiCheckFail();
- /// \brief Create a check for a function parameter that may potentially be
- /// declared as non-null.
- void EmitNonNullArgCheck(RValue RV, QualType ArgType, SourceLocation ArgLoc,
- AbstractCallee AC, unsigned ParmNum);
- /// EmitCallArg - Emit a single call argument.
- void EmitCallArg(CallArgList &args, const Expr *E, QualType ArgType);
- /// EmitDelegateCallArg - We are performing a delegate call; that
- /// is, the current function is delegating to another one. Produce
- /// a r-value suitable for passing the given parameter.
- void EmitDelegateCallArg(CallArgList &args, const VarDecl *param,
- SourceLocation loc);
- /// SetFPAccuracy - Set the minimum required accuracy of the given floating
- /// point operation, expressed as the maximum relative error in ulp.
- void SetFPAccuracy(llvm::Value *Val, float Accuracy);
- private:
- llvm::MDNode *getRangeForLoadFromType(QualType Ty);
- void EmitReturnOfRValue(RValue RV, QualType Ty);
- void deferPlaceholderReplacement(llvm::Instruction *Old, llvm::Value *New);
- llvm::SmallVector<std::pair<llvm::Instruction *, llvm::Value *>, 4>
- DeferredReplacements;
- /// Set the address of a local variable.
- void setAddrOfLocalVar(const VarDecl *VD, Address Addr) {
- assert(!LocalDeclMap.count(VD) && "Decl already exists in LocalDeclMap!");
- LocalDeclMap.insert({VD, Addr});
- }
- /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
- /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
- ///
- /// \param AI - The first function argument of the expansion.
- void ExpandTypeFromArgs(QualType Ty, LValue Dst,
- SmallVectorImpl<llvm::Value *>::iterator &AI);
- /// ExpandTypeToArgs - Expand an RValue \arg RV, with the LLVM type for \arg
- /// Ty, into individual arguments on the provided vector \arg IRCallArgs,
- /// starting at index \arg IRCallArgPos. See ABIArgInfo::Expand.
- void ExpandTypeToArgs(QualType Ty, RValue RV, llvm::FunctionType *IRFuncTy,
- SmallVectorImpl<llvm::Value *> &IRCallArgs,
- unsigned &IRCallArgPos);
- llvm::Value* EmitAsmInput(const TargetInfo::ConstraintInfo &Info,
- const Expr *InputExpr, std::string &ConstraintStr);
- llvm::Value* EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
- LValue InputValue, QualType InputType,
- std::string &ConstraintStr,
- SourceLocation Loc);
- /// \brief Attempts to statically evaluate the object size of E. If that
- /// fails, emits code to figure the size of E out for us. This is
- /// pass_object_size aware.
- ///
- /// If EmittedExpr is non-null, this will use that instead of re-emitting E.
- llvm::Value *evaluateOrEmitBuiltinObjectSize(const Expr *E, unsigned Type,
- llvm::IntegerType *ResType,
- llvm::Value *EmittedE);
- /// \brief Emits the size of E, as required by __builtin_object_size. This
- /// function is aware of pass_object_size parameters, and will act accordingly
- /// if E is a parameter with the pass_object_size attribute.
- llvm::Value *emitBuiltinObjectSize(const Expr *E, unsigned Type,
- llvm::IntegerType *ResType,
- llvm::Value *EmittedE);
- public:
- #ifndef NDEBUG
- // Determine whether the given argument is an Objective-C method
- // that may have type parameters in its signature.
- static bool isObjCMethodWithTypeParams(const ObjCMethodDecl *method) {
- const DeclContext *dc = method->getDeclContext();
- if (const ObjCInterfaceDecl *classDecl= dyn_cast<ObjCInterfaceDecl>(dc)) {
- return classDecl->getTypeParamListAsWritten();
- }
- if (const ObjCCategoryDecl *catDecl = dyn_cast<ObjCCategoryDecl>(dc)) {
- return catDecl->getTypeParamList();
- }
- return false;
- }
- template<typename T>
- static bool isObjCMethodWithTypeParams(const T *) { return false; }
- #endif
- enum class EvaluationOrder {
- ///! No language constraints on evaluation order.
- Default,
- ///! Language semantics require left-to-right evaluation.
- ForceLeftToRight,
- ///! Language semantics require right-to-left evaluation.
- ForceRightToLeft
- };
- /// EmitCallArgs - Emit call arguments for a function.
- template <typename T>
- void EmitCallArgs(CallArgList &Args, const T *CallArgTypeInfo,
- llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
- AbstractCallee AC = AbstractCallee(),
- unsigned ParamsToSkip = 0,
- EvaluationOrder Order = EvaluationOrder::Default) {
- SmallVector<QualType, 16> ArgTypes;
- CallExpr::const_arg_iterator Arg = ArgRange.begin();
- assert((ParamsToSkip == 0 || CallArgTypeInfo) &&
- "Can't skip parameters if type info is not provided");
- if (CallArgTypeInfo) {
- #ifndef NDEBUG
- bool isGenericMethod = isObjCMethodWithTypeParams(CallArgTypeInfo);
- #endif
- // First, use the argument types that the type info knows about
- for (auto I = CallArgTypeInfo->param_type_begin() + ParamsToSkip,
- E = CallArgTypeInfo->param_type_end();
- I != E; ++I, ++Arg) {
- assert(Arg != ArgRange.end() && "Running over edge of argument list!");
- assert((isGenericMethod ||
- ((*I)->isVariablyModifiedType() ||
- (*I).getNonReferenceType()->isObjCRetainableType() ||
- getContext()
- .getCanonicalType((*I).getNonReferenceType())
- .getTypePtr() ==
- getContext()
- .getCanonicalType((*Arg)->getType())
- .getTypePtr())) &&
- "type mismatch in call argument!");
- ArgTypes.push_back(*I);
- }
- }
- // Either we've emitted all the call args, or we have a call to variadic
- // function.
- assert((Arg == ArgRange.end() || !CallArgTypeInfo ||
- CallArgTypeInfo->isVariadic()) &&
- "Extra arguments in non-variadic function!");
- // If we still have any arguments, emit them using the type of the argument.
- for (auto *A : llvm::make_range(Arg, ArgRange.end()))
- ArgTypes.push_back(CallArgTypeInfo ? getVarArgType(A) : A->getType());
- EmitCallArgs(Args, ArgTypes, ArgRange, AC, ParamsToSkip, Order);
- }
- void EmitCallArgs(CallArgList &Args, ArrayRef<QualType> ArgTypes,
- llvm::iterator_range<CallExpr::const_arg_iterator> ArgRange,
- AbstractCallee AC = AbstractCallee(),
- unsigned ParamsToSkip = 0,
- EvaluationOrder Order = EvaluationOrder::Default);
- /// EmitPointerWithAlignment - Given an expression with a pointer type,
- /// emit the value and compute our best estimate of the alignment of the
- /// pointee.
- ///
- /// \param BaseInfo - If non-null, this will be initialized with
- /// information about the source of the alignment and the may-alias
- /// attribute. Note that this function will conservatively fall back on
- /// the type when it doesn't recognize the expression and may-alias will
- /// be set to false.
- ///
- /// One reasonable way to use this information is when there's a language
- /// guarantee that the pointer must be aligned to some stricter value, and
- /// we're simply trying to ensure that sufficiently obvious uses of under-
- /// aligned objects don't get miscompiled; for example, a placement new
- /// into the address of a local variable. In such a case, it's quite
- /// reasonable to just ignore the returned alignment when it isn't from an
- /// explicit source.
- Address EmitPointerWithAlignment(const Expr *Addr,
- LValueBaseInfo *BaseInfo = nullptr,
- TBAAAccessInfo *TBAAInfo = nullptr);
- /// If \p E references a parameter with pass_object_size info or a constant
- /// array size modifier, emit the object size divided by the size of \p EltTy.
- /// Otherwise return null.
- llvm::Value *LoadPassedObjectSize(const Expr *E, QualType EltTy);
- void EmitSanitizerStatReport(llvm::SanitizerStatKind SSK);
- private:
- QualType getVarArgType(const Expr *Arg);
- void EmitDeclMetadata();
- BlockByrefHelpers *buildByrefHelpers(llvm::StructType &byrefType,
- const AutoVarEmission &emission);
- void AddObjCARCExceptionMetadata(llvm::Instruction *Inst);
- llvm::Value *GetValueForARMHint(unsigned BuiltinID);
- llvm::Value *EmitX86CpuIs(const CallExpr *E);
- llvm::Value *EmitX86CpuIs(StringRef CPUStr);
- llvm::Value *EmitX86CpuSupports(const CallExpr *E);
- llvm::Value *EmitX86CpuSupports(ArrayRef<StringRef> FeatureStrs);
- llvm::Value *EmitX86CpuInit();
- };
- /// Helper class with most of the code for saving a value for a
- /// conditional expression cleanup.
- struct DominatingLLVMValue {
- typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
- /// Answer whether the given value needs extra work to be saved.
- static bool needsSaving(llvm::Value *value) {
- // If it's not an instruction, we don't need to save.
- if (!isa<llvm::Instruction>(value)) return false;
- // If it's an instruction in the entry block, we don't need to save.
- llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
- return (block != &block->getParent()->getEntryBlock());
- }
- /// Try to save the given value.
- static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
- if (!needsSaving(value)) return saved_type(value, false);
- // Otherwise, we need an alloca.
- auto align = CharUnits::fromQuantity(
- CGF.CGM.getDataLayout().getPrefTypeAlignment(value->getType()));
- Address alloca =
- CGF.CreateTempAlloca(value->getType(), align, "cond-cleanup.save");
- CGF.Builder.CreateStore(value, alloca);
- return saved_type(alloca.getPointer(), true);
- }
- static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
- // If the value says it wasn't saved, trust that it's still dominating.
- if (!value.getInt()) return value.getPointer();
- // Otherwise, it should be an alloca instruction, as set up in save().
- auto alloca = cast<llvm::AllocaInst>(value.getPointer());
- return CGF.Builder.CreateAlignedLoad(alloca, alloca->getAlignment());
- }
- };
- /// A partial specialization of DominatingValue for llvm::Values that
- /// might be llvm::Instructions.
- template <class T> struct DominatingPointer<T,true> : DominatingLLVMValue {
- typedef T *type;
- static type restore(CodeGenFunction &CGF, saved_type value) {
- return static_cast<T*>(DominatingLLVMValue::restore(CGF, value));
- }
- };
- /// A specialization of DominatingValue for Address.
- template <> struct DominatingValue<Address> {
- typedef Address type;
- struct saved_type {
- DominatingLLVMValue::saved_type SavedValue;
- CharUnits Alignment;
- };
- static bool needsSaving(type value) {
- return DominatingLLVMValue::needsSaving(value.getPointer());
- }
- static saved_type save(CodeGenFunction &CGF, type value) {
- return { DominatingLLVMValue::save(CGF, value.getPointer()),
- value.getAlignment() };
- }
- static type restore(CodeGenFunction &CGF, saved_type value) {
- return Address(DominatingLLVMValue::restore(CGF, value.SavedValue),
- value.Alignment);
- }
- };
- /// A specialization of DominatingValue for RValue.
- template <> struct DominatingValue<RValue> {
- typedef RValue type;
- class saved_type {
- enum Kind { ScalarLiteral, ScalarAddress, AggregateLiteral,
- AggregateAddress, ComplexAddress };
- llvm::Value *Value;
- unsigned K : 3;
- unsigned Align : 29;
- saved_type(llvm::Value *v, Kind k, unsigned a = 0)
- : Value(v), K(k), Align(a) {}
- public:
- static bool needsSaving(RValue value);
- static saved_type save(CodeGenFunction &CGF, RValue value);
- RValue restore(CodeGenFunction &CGF);
- // implementations in CGCleanup.cpp
- };
- static bool needsSaving(type value) {
- return saved_type::needsSaving(value);
- }
- static saved_type save(CodeGenFunction &CGF, type value) {
- return saved_type::save(CGF, value);
- }
- static type restore(CodeGenFunction &CGF, saved_type value) {
- return value.restore(CGF);
- }
- };
- } // end namespace CodeGen
- } // end namespace clang
- #endif
|