123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631 |
- ///////////////////////////////////////////////////////////////////////////////
- // //
- // DxilValidation.cpp //
- // Copyright (C) Microsoft Corporation. All rights reserved. //
- // This file is distributed under the University of Illinois Open Source //
- // License. See LICENSE.TXT for details. //
- // //
- // This file provides support for validating DXIL shaders. //
- // //
- ///////////////////////////////////////////////////////////////////////////////
- #include "dxc/HLSL/DxilValidation.h"
- #include "dxc/HLSL/DxilGenerationPass.h"
- #include "dxc/HLSL/DxilOperations.h"
- #include "dxc/HLSL/DxilModule.h"
- #include "dxc/HLSL/DxilShaderModel.h"
- #include "dxc/HLSL/DxilContainer.h"
- #include "dxc/hlsl/DxilFunctionProps.h"
- #include "dxc/Support/Global.h"
- #include "dxc/HLSL/DxilUtil.h"
- #include "dxc/HLSL/DxilInstructions.h"
- #include "dxc/HLSL/ReducibilityAnalysis.h"
- #include "dxc/Support/WinIncludes.h"
- #include "dxc/Support/FileIOHelper.h"
- #include "DxilEntryProps.h"
- #include "llvm/ADT/ArrayRef.h"
- #include "llvm/Analysis/CallGraph.h"
- #include "llvm/IR/LLVMContext.h"
- #include "llvm/IR/Module.h"
- #include "llvm/IR/Type.h"
- #include "llvm/IR/Operator.h"
- #include "llvm/IR/Instructions.h"
- #include "llvm/IR/InstIterator.h"
- #include "llvm/IR/Constants.h"
- #include "llvm/IR/DiagnosticInfo.h"
- #include "llvm/IR/DiagnosticPrinter.h"
- #include "llvm/ADT/BitVector.h"
- #include "llvm/Support/raw_ostream.h"
- #include "llvm/Support/MemoryBuffer.h"
- #include "llvm/Bitcode/ReaderWriter.h"
- #include <unordered_set>
- #include "llvm/Analysis/LoopInfo.h"
- #include "llvm/IR/Dominators.h"
- #include "llvm/Analysis/PostDominators.h"
- #include "dxc/HLSL/DxilSpanAllocator.h"
- #include "dxc/HLSL/DxilSignatureAllocator.h"
- #include "dxc/HLSL/DxilRootSignature.h"
- #include <algorithm>
- #include <deque>
- using namespace llvm;
- using namespace std;
- ///////////////////////////////////////////////////////////////////////////////
- // Error messages.
- const char *hlsl::GetValidationRuleText(ValidationRule value) {
- /* <py::lines('VALRULE-TEXT')>hctdb_instrhelp.get_valrule_text()</py>*/
- // VALRULE-TEXT:BEGIN
- switch(value) {
- case hlsl::ValidationRule::BitcodeValid: return "Module bitcode is invalid";
- case hlsl::ValidationRule::ContainerPartMatches: return "Container part '%0' does not match expected for module.";
- case hlsl::ValidationRule::ContainerPartRepeated: return "More than one container part '%0'.";
- case hlsl::ValidationRule::ContainerPartMissing: return "Missing part '%0' required by module.";
- case hlsl::ValidationRule::ContainerPartInvalid: return "Unknown part '%0' found in DXIL container.";
- case hlsl::ValidationRule::ContainerRootSignatureIncompatible: return "Root Signature in DXIL container is not compatible with shader.";
- case hlsl::ValidationRule::MetaRequired: return "TODO - Required metadata missing";
- case hlsl::ValidationRule::MetaKnown: return "Named metadata '%0' is unknown";
- case hlsl::ValidationRule::MetaUsed: return "All metadata must be used by dxil";
- case hlsl::ValidationRule::MetaTarget: return "Unknown target triple '%0'";
- case hlsl::ValidationRule::MetaWellFormed: return "TODO - Metadata must be well-formed in operand count and types";
- case hlsl::ValidationRule::MetaSemanticLen: return "Semantic length must be at least 1 and at most 64";
- case hlsl::ValidationRule::MetaInterpModeValid: return "Invalid interpolation mode for '%0'";
- case hlsl::ValidationRule::MetaSemaKindValid: return "Semantic kind for '%0' is invalid";
- case hlsl::ValidationRule::MetaNoSemanticOverlap: return "Semantic '%0' overlap at %1";
- case hlsl::ValidationRule::MetaSemaKindMatchesName: return "Semantic name %0 does not match System Value kind %1";
- case hlsl::ValidationRule::MetaDuplicateSysValue: return "System value %0 appears more than once in the same signature.";
- case hlsl::ValidationRule::MetaSemanticIndexMax: return "%0 semantic index exceeds maximum (%1)";
- case hlsl::ValidationRule::MetaSystemValueRows: return "rows for system value semantic %0 must be 1";
- case hlsl::ValidationRule::MetaSemanticShouldBeAllocated: return "%0 Semantic '%1' should have a valid packing location";
- case hlsl::ValidationRule::MetaSemanticShouldNotBeAllocated: return "%0 Semantic '%1' should have a packing location of -1";
- case hlsl::ValidationRule::MetaValueRange: return "Metadata value must be within range";
- case hlsl::ValidationRule::MetaFlagsUsage: return "Flags must match usage";
- case hlsl::ValidationRule::MetaDenseResIDs: return "Resource identifiers must be zero-based and dense";
- case hlsl::ValidationRule::MetaSignatureOverlap: return "signature element %0 at location (%1,%2) size (%3,%4) overlaps another signature element.";
- case hlsl::ValidationRule::MetaSignatureOutOfRange: return "signature element %0 at location (%1,%2) size (%3,%4) is out of range.";
- case hlsl::ValidationRule::MetaSignatureIndexConflict: return "signature element %0 at location (%1,%2) size (%3,%4) has an indexing conflict with another signature element packed into the same row.";
- case hlsl::ValidationRule::MetaSignatureIllegalComponentOrder: return "signature element %0 at location (%1,%2) size (%3,%4) violates component ordering rule (arb < sv < sgv).";
- case hlsl::ValidationRule::MetaSignatureDataWidth: return "signature element %0 at location (%1, %2) size (%3, %4) has data width that differs from another element packed into the same row.";
- case hlsl::ValidationRule::MetaIntegerInterpMode: return "signature element %0 specifies invalid interpolation mode for integer component type.";
- case hlsl::ValidationRule::MetaInterpModeInOneRow: return "signature element %0 at location (%1,%2) size (%3,%4) has interpolation mode that differs from another element packed into the same row.";
- case hlsl::ValidationRule::MetaSemanticCompType: return "%0 must be %1";
- case hlsl::ValidationRule::MetaClipCullMaxRows: return "ClipDistance and CullDistance occupy more than the maximum of 2 rows combined.";
- case hlsl::ValidationRule::MetaClipCullMaxComponents: return "ClipDistance and CullDistance use more than the maximum of 8 components combined.";
- case hlsl::ValidationRule::MetaSignatureCompType: return "signature %0 specifies unrecognized or invalid component type";
- case hlsl::ValidationRule::MetaTessellatorPartition: return "Invalid Tessellator Partitioning specified. Must be integer, pow2, fractional_odd or fractional_even.";
- case hlsl::ValidationRule::MetaTessellatorOutputPrimitive: return "Invalid Tessellator Output Primitive specified. Must be point, line, triangleCW or triangleCCW.";
- case hlsl::ValidationRule::MetaMaxTessFactor: return "Hull Shader MaxTessFactor must be [%0..%1]. %2 specified";
- case hlsl::ValidationRule::MetaValidSamplerMode: return "Invalid sampler mode on sampler ";
- case hlsl::ValidationRule::MetaFunctionAnnotation: return "Cannot find function annotation for %0";
- case hlsl::ValidationRule::MetaGlcNotOnAppendConsume: return "globallycoherent cannot be used with append/consume buffers";
- case hlsl::ValidationRule::MetaStructBufAlignment: return "structured buffer element size must be a multiple of %0 bytes (actual size %1 bytes)";
- case hlsl::ValidationRule::MetaStructBufAlignmentOutOfBound: return "structured buffer elements cannot be larger than %0 bytes (actual size %1 bytes)";
- case hlsl::ValidationRule::MetaEntryFunction: return "entrypoint not found";
- case hlsl::ValidationRule::MetaInvalidControlFlowHint: return "Invalid control flow hint";
- case hlsl::ValidationRule::MetaBranchFlatten: return "Can't use branch and flatten attributes together";
- case hlsl::ValidationRule::MetaForceCaseOnSwitch: return "Attribute forcecase only works for switch";
- case hlsl::ValidationRule::MetaControlFlowHintNotOnControlFlow: return "Control flow hint only works on control flow inst";
- case hlsl::ValidationRule::MetaTextureType: return "elements of typed buffers and textures must fit in four 32-bit quantities";
- case hlsl::ValidationRule::MetaBarycentricsInterpolation: return "SV_Barycentrics cannot be used with 'nointerpolation' type";
- case hlsl::ValidationRule::MetaBarycentricsFloat3: return "only 'float3' type is allowed for SV_Barycentrics.";
- case hlsl::ValidationRule::MetaBarycentricsTwoPerspectives: return "There can only be up to two input attributes of SV_Barycentrics with different perspective interpolation mode.";
- case hlsl::ValidationRule::MetaNoEntryPropsForEntry: return "EntryPoints must have entry properties.";
- case hlsl::ValidationRule::InstrOload: return "DXIL intrinsic overload must be valid";
- case hlsl::ValidationRule::InstrCallOload: return "Call to DXIL intrinsic '%0' does not match an allowed overload signature";
- case hlsl::ValidationRule::InstrPtrBitCast: return "Pointer type bitcast must be have same size";
- case hlsl::ValidationRule::InstrMinPrecisonBitCast: return "Bitcast on minprecison types is not allowed";
- case hlsl::ValidationRule::InstrStructBitCast: return "Bitcast on struct types is not allowed";
- case hlsl::ValidationRule::InstrStatus: return "Resource status should only used by CheckAccessFullyMapped";
- case hlsl::ValidationRule::InstrCheckAccessFullyMapped: return "CheckAccessFullyMapped should only used on resource status";
- case hlsl::ValidationRule::InstrOpConst: return "%0 of %1 must be an immediate constant";
- case hlsl::ValidationRule::InstrAllowed: return "Instructions must be of an allowed type";
- case hlsl::ValidationRule::InstrOpCodeReserved: return "Instructions must not reference reserved opcodes";
- case hlsl::ValidationRule::InstrOperandRange: return "expect %0 between %1, got %2";
- case hlsl::ValidationRule::InstrNoReadingUninitialized: return "Instructions should not read uninitialized value";
- case hlsl::ValidationRule::InstrNoGenericPtrAddrSpaceCast: return "Address space cast between pointer types must have one part to be generic address space";
- case hlsl::ValidationRule::InstrInBoundsAccess: return "Access to out-of-bounds memory is disallowed";
- case hlsl::ValidationRule::InstrOpConstRange: return "Constant values must be in-range for operation";
- case hlsl::ValidationRule::InstrImmBiasForSampleB: return "bias amount for sample_b must be in the range [%0,%1], but %2 was specified as an immediate";
- case hlsl::ValidationRule::InstrNoIndefiniteLog: return "No indefinite logarithm";
- case hlsl::ValidationRule::InstrNoIndefiniteAsin: return "No indefinite arcsine";
- case hlsl::ValidationRule::InstrNoIndefiniteAcos: return "No indefinite arccosine";
- case hlsl::ValidationRule::InstrNoIDivByZero: return "No signed integer division by zero";
- case hlsl::ValidationRule::InstrNoUDivByZero: return "No unsigned integer division by zero";
- case hlsl::ValidationRule::InstrNoIndefiniteDsxy: return "No indefinite derivative calculation";
- case hlsl::ValidationRule::InstrMinPrecisionNotPrecise: return "Instructions marked precise may not refer to minprecision values";
- case hlsl::ValidationRule::InstrOnlyOneAllocConsume: return "RWStructuredBuffers may increment or decrement their counters, but not both.";
- case hlsl::ValidationRule::InstrTextureOffset: return "offset texture instructions must take offset which can resolve to integer literal in the range -8 to 7";
- case hlsl::ValidationRule::InstrCannotPullPosition: return "%0 does not support pull-model evaluation of position";
- case hlsl::ValidationRule::InstrEvalInterpolationMode: return "Interpolation mode on %0 used with eval_* instruction must be linear, linear_centroid, linear_noperspective, linear_noperspective_centroid, linear_sample or linear_noperspective_sample";
- case hlsl::ValidationRule::InstrResourceCoordinateMiss: return "coord uninitialized";
- case hlsl::ValidationRule::InstrResourceCoordinateTooMany: return "out of bound coord must be undef";
- case hlsl::ValidationRule::InstrResourceOffsetMiss: return "offset uninitialized";
- case hlsl::ValidationRule::InstrResourceOffsetTooMany: return "out of bound offset must be undef";
- case hlsl::ValidationRule::InstrUndefResultForGetDimension: return "GetDimensions used undef dimension %0 on %1";
- case hlsl::ValidationRule::InstrSamplerModeForLOD: return "lod instruction requires sampler declared in default mode";
- case hlsl::ValidationRule::InstrSamplerModeForSample: return "sample/_l/_d/_cl_s/gather instruction requires sampler declared in default mode";
- case hlsl::ValidationRule::InstrSamplerModeForSampleC: return "sample_c_*/gather_c instructions require sampler declared in comparison mode";
- case hlsl::ValidationRule::InstrSampleCompType: return "sample_* instructions require resource to be declared to return UNORM, SNORM or FLOAT.";
- case hlsl::ValidationRule::InstrBarrierModeUselessUGroup: return "sync can't specify both _ugroup and _uglobal. If both are needed, just specify _uglobal.";
- case hlsl::ValidationRule::InstrBarrierModeNoMemory: return "sync must include some form of memory barrier - _u (UAV) and/or _g (Thread Group Shared Memory). Only _t (thread group sync) is optional. ";
- case hlsl::ValidationRule::InstrBarrierModeForNonCS: return "sync in a non-Compute Shader must only sync UAV (sync_uglobal)";
- case hlsl::ValidationRule::InstrWriteMaskForTypedUAVStore: return "store on typed uav must write to all four components of the UAV";
- case hlsl::ValidationRule::InstrResourceKindForCalcLOD: return "lod requires resource declared as texture1D/2D/3D/Cube/CubeArray/1DArray/2DArray";
- case hlsl::ValidationRule::InstrResourceKindForSample: return "sample/_l/_d requires resource declared as texture1D/2D/3D/Cube/1DArray/2DArray/CubeArray";
- case hlsl::ValidationRule::InstrResourceKindForSampleC: return "samplec requires resource declared as texture1D/2D/Cube/1DArray/2DArray/CubeArray";
- case hlsl::ValidationRule::InstrResourceKindForGather: return "gather requires resource declared as texture/2D/Cube/2DArray/CubeArray";
- case hlsl::ValidationRule::InstrWriteMaskMatchValueForUAVStore: return "uav store write mask must match store value mask, write mask is %0 and store value mask is %1";
- case hlsl::ValidationRule::InstrResourceKindForBufferLoadStore: return "buffer load/store only works on Raw/Typed/StructuredBuffer";
- case hlsl::ValidationRule::InstrResourceKindForTextureStore: return "texture store only works on Texture1D/1DArray/2D/2DArray/3D";
- case hlsl::ValidationRule::InstrResourceKindForGetDim: return "Invalid resource kind on GetDimensions";
- case hlsl::ValidationRule::InstrResourceKindForTextureLoad: return "texture load only works on Texture1D/1DArray/2D/2DArray/3D/MS2D/MS2DArray";
- case hlsl::ValidationRule::InstrResourceClassForSamplerGather: return "sample, lod and gather should on srv resource.";
- case hlsl::ValidationRule::InstrResourceClassForUAVStore: return "store should on uav resource.";
- case hlsl::ValidationRule::InstrResourceClassForLoad: return "load can only run on UAV/SRV resource";
- case hlsl::ValidationRule::InstrOffsetOnUAVLoad: return "uav load don't support offset";
- case hlsl::ValidationRule::InstrMipOnUAVLoad: return "uav load don't support mipLevel/sampleIndex";
- case hlsl::ValidationRule::InstrSampleIndexForLoad2DMS: return "load on Texture2DMS/2DMSArray require sampleIndex";
- case hlsl::ValidationRule::InstrCoordinateCountForRawTypedBuf: return "raw/typed buffer don't need 2 coordinates";
- case hlsl::ValidationRule::InstrCoordinateCountForStructBuf: return "structured buffer require 2 coordinates";
- case hlsl::ValidationRule::InstrMipLevelForGetDimension: return "Use mip level on buffer when GetDimensions";
- case hlsl::ValidationRule::InstrDxilStructUser: return "Dxil struct types should only used by ExtractValue";
- case hlsl::ValidationRule::InstrDxilStructUserOutOfBound: return "Index out of bound when extract value from dxil struct types";
- case hlsl::ValidationRule::InstrHandleNotFromCreateHandle: return "Resource handle should returned by createHandle";
- case hlsl::ValidationRule::InstrBufferUpdateCounterOnUAV: return "BufferUpdateCounter valid only on UAV";
- case hlsl::ValidationRule::InstrCBufferOutOfBound: return "Cbuffer access out of bound";
- case hlsl::ValidationRule::InstrCBufferClassForCBufferHandle: return "Expect Cbuffer for CBufferLoad handle";
- case hlsl::ValidationRule::InstrFailToResloveTGSMPointer: return "TGSM pointers must originate from an unambiguous TGSM global variable.";
- case hlsl::ValidationRule::InstrExtractValue: return "ExtractValue should only be used on dxil struct types and cmpxchg";
- case hlsl::ValidationRule::InstrTGSMRaceCond: return "Race condition writing to shared memory detected, consider making this write conditional";
- case hlsl::ValidationRule::InstrAttributeAtVertexNoInterpolation: return "Attribute %0 must have nointerpolation mode in order to use GetAttributeAtVertex function.";
- case hlsl::ValidationRule::InstrCreateHandleImmRangeID: return "Local resource must map to global resource.";
- case hlsl::ValidationRule::InstrSignatureOperationNotInEntry: return "Dxil operation for input output signature must be in entryPoints.";
- case hlsl::ValidationRule::TypesNoVector: return "Vector type '%0' is not allowed";
- case hlsl::ValidationRule::TypesDefined: return "Type '%0' is not defined on DXIL primitives";
- case hlsl::ValidationRule::TypesIntWidth: return "Int type '%0' has an invalid width";
- case hlsl::ValidationRule::TypesNoMultiDim: return "Only one dimension allowed for array type";
- case hlsl::ValidationRule::TypesI8: return "I8 can only used as immediate value for intrinsic";
- case hlsl::ValidationRule::SmName: return "Unknown shader model '%0'";
- case hlsl::ValidationRule::SmDxilVersion: return "Shader model requires Dxil Version %0,%1";
- case hlsl::ValidationRule::SmOpcode: return "Opcode %0 not valid in shader model %1";
- case hlsl::ValidationRule::SmOperand: return "Operand must be defined in target shader model";
- case hlsl::ValidationRule::SmSemantic: return "Semantic '%0' is invalid as %1 %2";
- case hlsl::ValidationRule::SmNoInterpMode: return "Interpolation mode for '%0' is set but should be undefined";
- case hlsl::ValidationRule::SmNoPSOutputIdx: return "Pixel shader output registers are not indexable.";
- case hlsl::ValidationRule::SmPSConsistentInterp: return "Interpolation mode for PS input position must be linear_noperspective_centroid or linear_noperspective_sample when outputting oDepthGE or oDepthLE and not running at sample frequency (which is forced by inputting SV_SampleIndex or declaring an input linear_sample or linear_noperspective_sample)";
- case hlsl::ValidationRule::SmThreadGroupChannelRange: return "Declared Thread Group %0 size %1 outside valid range [%2..%3]";
- case hlsl::ValidationRule::SmMaxTheadGroup: return "Declared Thread Group Count %0 (X*Y*Z) is beyond the valid maximum of %1";
- case hlsl::ValidationRule::SmMaxTGSMSize: return "Total Thread Group Shared Memory storage is %0, exceeded %1";
- case hlsl::ValidationRule::SmROVOnlyInPS: return "RasterizerOrdered objects are only allowed in 5.0+ pixel shaders";
- case hlsl::ValidationRule::SmTessFactorForDomain: return "Required TessFactor for domain not found declared anywhere in Patch Constant data";
- case hlsl::ValidationRule::SmTessFactorSizeMatchDomain: return "TessFactor rows, columns (%0, %1) invalid for domain %2. Expected %3 rows and 1 column.";
- case hlsl::ValidationRule::SmInsideTessFactorSizeMatchDomain: return "InsideTessFactor rows, columns (%0, %1) invalid for domain %2. Expected %3 rows and 1 column.";
- case hlsl::ValidationRule::SmDomainLocationIdxOOB: return "DomainLocation component index out of bounds for the domain.";
- case hlsl::ValidationRule::SmHullPassThruControlPointCountMatch: return "For pass thru hull shader, input control point count must match output control point count";
- case hlsl::ValidationRule::SmOutputControlPointsTotalScalars: return "Total number of scalars across all HS output control points must not exceed ";
- case hlsl::ValidationRule::SmIsoLineOutputPrimitiveMismatch: return "Hull Shader declared with IsoLine Domain must specify output primitive point or line. Triangle_cw or triangle_ccw output are not compatible with the IsoLine Domain.";
- case hlsl::ValidationRule::SmTriOutputPrimitiveMismatch: return "Hull Shader declared with Tri Domain must specify output primitive point, triangle_cw or triangle_ccw. Line output is not compatible with the Tri domain";
- case hlsl::ValidationRule::SmValidDomain: return "Invalid Tessellator Domain specified. Must be isoline, tri or quad";
- case hlsl::ValidationRule::SmPatchConstantOnlyForHSDS: return "patch constant signature only valid in HS and DS";
- case hlsl::ValidationRule::SmStreamIndexRange: return "Stream index (%0) must between 0 and %1";
- case hlsl::ValidationRule::SmPSOutputSemantic: return "Pixel Shader allows output semantics to be SV_Target, SV_Depth, SV_DepthGreaterEqual, SV_DepthLessEqual, SV_Coverage or SV_StencilRef, %0 found";
- case hlsl::ValidationRule::SmPSMultipleDepthSemantic: return "Pixel Shader only allows one type of depth semantic to be declared";
- case hlsl::ValidationRule::SmPSTargetIndexMatchesRow: return "SV_Target semantic index must match packed row location";
- case hlsl::ValidationRule::SmPSTargetCol0: return "SV_Target packed location must start at column 0";
- case hlsl::ValidationRule::SmPSCoverageAndInnerCoverage: return "InnerCoverage and Coverage are mutually exclusive.";
- case hlsl::ValidationRule::SmGSOutputVertexCountRange: return "GS output vertex count must be [0..%0]. %1 specified";
- case hlsl::ValidationRule::SmGSInstanceCountRange: return "GS instance count must be [1..%0]. %1 specified";
- case hlsl::ValidationRule::SmDSInputControlPointCountRange: return "DS input control point count must be [0..%0]. %1 specified";
- case hlsl::ValidationRule::SmHSInputControlPointCountRange: return "HS input control point count must be [0..%0]. %1 specified";
- case hlsl::ValidationRule::SmZeroHSInputControlPointWithInput: return "When HS input control point count is 0, no input signature should exist";
- case hlsl::ValidationRule::SmOutputControlPointCountRange: return "output control point count must be [0..%0]. %1 specified";
- case hlsl::ValidationRule::SmGSValidInputPrimitive: return "GS input primitive unrecognized";
- case hlsl::ValidationRule::SmGSValidOutputPrimitiveTopology: return "GS output primitive topology unrecognized";
- case hlsl::ValidationRule::SmAppendAndConsumeOnSameUAV: return "BufferUpdateCounter inc and dec on a given UAV (%d) cannot both be in the same shader for shader model less than 5.1.";
- case hlsl::ValidationRule::SmInvalidTextureKindOnUAV: return "Texture2DMS[Array] or TextureCube[Array] resources are not supported with UAVs";
- case hlsl::ValidationRule::SmInvalidResourceKind: return "Invalid resources kind";
- case hlsl::ValidationRule::SmInvalidResourceCompType: return "Invalid resource return type";
- case hlsl::ValidationRule::SmSampleCountOnlyOn2DMS: return "Only Texture2DMS/2DMSArray could has sample count";
- case hlsl::ValidationRule::SmCounterOnlyOnStructBuf: return "BufferUpdateCounter valid only on structured buffers";
- case hlsl::ValidationRule::SmGSTotalOutputVertexDataRange: return "Declared output vertex count (%0) multiplied by the total number of declared scalar components of output data (%1) equals %2. This value cannot be greater than %3";
- case hlsl::ValidationRule::SmMultiStreamMustBePoint: return "Multiple GS output streams are used but '%0' is not pointlist";
- case hlsl::ValidationRule::SmCompletePosition: return "Not all elements of SV_Position were written";
- case hlsl::ValidationRule::SmUndefinedOutput: return "Not all elements of output %0 were written";
- case hlsl::ValidationRule::SmCSNoReturn: return "Compute shaders can't return values, outputs must be written in writable resources (UAVs).";
- case hlsl::ValidationRule::SmCBufferTemplateTypeMustBeStruct: return "D3D12 constant/texture buffer template element can only be a struct";
- case hlsl::ValidationRule::SmResourceRangeOverlap: return "Resource %0 with base %1 size %2 overlap with other resource with base %3 size %4 in space %5";
- case hlsl::ValidationRule::SmCBufferOffsetOverlap: return "CBuffer %0 has offset overlaps at %1";
- case hlsl::ValidationRule::SmCBufferElementOverflow: return "CBuffer %0 size insufficient for element at offset %1";
- case hlsl::ValidationRule::SmOpcodeInInvalidFunction: return "opcode '%0' should only be used in '%1'";
- case hlsl::ValidationRule::SmViewIDNeedsSlot: return "Pixel shader input signature lacks available space for ViewID";
- case hlsl::ValidationRule::UniNoWaveSensitiveGradient: return "Gradient operations are not affected by wave-sensitive data or control flow.";
- case hlsl::ValidationRule::FlowReducible: return "Execution flow must be reducible";
- case hlsl::ValidationRule::FlowNoRecusion: return "Recursion is not permitted";
- case hlsl::ValidationRule::FlowDeadLoop: return "Loop must have break";
- case hlsl::ValidationRule::FlowFunctionCall: return "Function %0 with parameter is not permitted, it should be inlined";
- case hlsl::ValidationRule::DeclDxilNsReserved: return "Declaration '%0' uses a reserved prefix";
- case hlsl::ValidationRule::DeclDxilFnExtern: return "External function '%0' is not a DXIL function";
- case hlsl::ValidationRule::DeclUsedInternal: return "Internal declaration '%0' is unused";
- case hlsl::ValidationRule::DeclNotUsedExternal: return "External declaration '%0' is unused";
- case hlsl::ValidationRule::DeclUsedExternalFunction: return "External function '%0' is unused";
- case hlsl::ValidationRule::DeclFnIsCalled: return "Function '%0' is used for something other than calling";
- case hlsl::ValidationRule::DeclFnFlattenParam: return "Type '%0' is a struct type but is used as a parameter in function '%1'";
- case hlsl::ValidationRule::DeclFnAttribute: return "Function '%0' contains invalid attribute '%1' with value '%2'";
- }
- // VALRULE-TEXT:END
- llvm_unreachable("invalid value");
- return "<unknown>";
- }
- namespace {
- // Utility class for setting and restoring the diagnostic context so we may capture errors/warnings
- struct DiagRestore {
- LLVMContext &Ctx;
- void *OrigDiagContext;
- LLVMContext::DiagnosticHandlerTy OrigHandler;
- DiagRestore(llvm::LLVMContext &Ctx, void *DiagContext) : Ctx(Ctx) {
- OrigHandler = Ctx.getDiagnosticHandler();
- OrigDiagContext = Ctx.getDiagnosticContext();
- Ctx.setDiagnosticHandler(
- hlsl::PrintDiagnosticContext::PrintDiagnosticHandler, DiagContext);
- }
- ~DiagRestore() {
- Ctx.setDiagnosticHandler(OrigHandler, OrigDiagContext);
- }
- };
- class DxilErrorDiagnosticInfo : public DiagnosticInfo {
- private:
- const char *m_message;
- public:
- DxilErrorDiagnosticInfo(const char *str)
- : DiagnosticInfo(DK_FirstPluginKind, DiagnosticSeverity::DS_Error),
- m_message(str) { }
- void print(DiagnosticPrinter &DP) const override {
- DP << m_message;
- }
- };
- static void emitDxilDiag(const LLVMContext &Ctx, const char *str) {
- // diagnose doesn't actually mutate anything.
- LLVMContext &diagCtx = const_cast<LLVMContext &>(Ctx);
- diagCtx.diagnose(DxilErrorDiagnosticInfo(str));
- }
- } // anon namespace
- namespace hlsl {
- // PrintDiagnosticContext methods.
- PrintDiagnosticContext::PrintDiagnosticContext(DiagnosticPrinter &printer)
- : m_Printer(printer), m_errorsFound(false), m_warningsFound(false) {}
- bool PrintDiagnosticContext::HasErrors() const { return m_errorsFound; }
- bool PrintDiagnosticContext::HasWarnings() const { return m_warningsFound; }
- void PrintDiagnosticContext::Handle(const DiagnosticInfo &DI) {
- DI.print(m_Printer);
- switch (DI.getSeverity()) {
- case llvm::DiagnosticSeverity::DS_Error:
- m_errorsFound = true;
- break;
- case llvm::DiagnosticSeverity::DS_Warning:
- m_warningsFound = true;
- break;
- default:
- break;
- }
- m_Printer << "\n";
- }
- void PrintDiagnosticContext::PrintDiagnosticHandler(const DiagnosticInfo &DI, void *Context) {
- reinterpret_cast<hlsl::PrintDiagnosticContext *>(Context)->Handle(DI);
- }
- struct PSExecutionInfo {
- bool SuperSampling = false;
- DXIL::SemanticKind OutputDepthKind = DXIL::SemanticKind::Invalid;
- const InterpolationMode *PositionInterpolationMode = nullptr;
- };
- // Save status like output write for entries.
- struct EntryStatus {
- bool hasOutputPosition[DXIL::kNumOutputStreams];
- unsigned OutputPositionMask[DXIL::kNumOutputStreams];
- std::vector<unsigned> outputCols;
- std::vector<unsigned> patchConstCols;
- bool m_bCoverageIn, m_bInnerCoverageIn;
- bool hasViewID;
- unsigned domainLocSize;
- EntryStatus(DxilEntryProps &entryProps)
- : m_bCoverageIn(false), m_bInnerCoverageIn(false), hasViewID(false) {
- for (unsigned i = 0; i < DXIL::kNumOutputStreams; i++) {
- hasOutputPosition[i] = false;
- OutputPositionMask[i] = 0;
- }
- outputCols.resize(entryProps.sig.OutputSignature.GetElements().size(), 0);
- patchConstCols.resize(
- entryProps.sig.PatchConstantSignature.GetElements().size(), 0);
- }
- };
- struct ValidationContext {
- bool Failed = false;
- Module &M;
- Module *pDebugModule;
- DxilModule &DxilMod;
- const DataLayout &DL;
- DiagnosticPrinterRawOStream &DiagPrinter;
- DebugLoc LastDebugLocEmit;
- ValidationRule LastRuleEmit;
- std::unordered_set<Function *> entryFuncCallSet;
- std::unordered_set<Function *> patchConstFuncCallSet;
- std::unordered_map<unsigned, bool> UavCounterIncMap;
- // TODO: save resource map for each createHandle/createHandleForLib.
- std::unordered_map<Type *, DxilResourceBase *> ResTypeMap;
- std::unordered_map<MDNode *, std::unique_ptr<DxilResourceBase>> ResInParam;
- std::unordered_map<Function *, std::vector<Function*>> PatchConstantFuncMap;
- std::unordered_map<Function *, std::unique_ptr<EntryStatus>> entryStatusMap;
- bool isLibProfile;
- const unsigned kDxilControlFlowHintMDKind;
- const unsigned kDxilPreciseMDKind;
- const unsigned kDxilNonUniformMDKind;
- const unsigned kLLVMLoopMDKind;
- unsigned m_DxilMajor, m_DxilMinor;
- ValidationContext(Module &llvmModule, Module *DebugModule,
- DxilModule &dxilModule,
- DiagnosticPrinterRawOStream &DiagPrn)
- : M(llvmModule), pDebugModule(DebugModule), DxilMod(dxilModule),
- DL(llvmModule.getDataLayout()), DiagPrinter(DiagPrn),
- LastRuleEmit((ValidationRule)-1),
- kDxilControlFlowHintMDKind(llvmModule.getContext().getMDKindID(
- DxilMDHelper::kDxilControlFlowHintMDName)),
- kDxilPreciseMDKind(llvmModule.getContext().getMDKindID(
- DxilMDHelper::kDxilPreciseAttributeMDName)),
- kDxilNonUniformMDKind(llvmModule.getContext().getMDKindID(
- DxilMDHelper::kDxilNonUniformAttributeMDName)),
- kLLVMLoopMDKind(llvmModule.getContext().getMDKindID("llvm.loop")) {
- DxilMod.GetDxilVersion(m_DxilMajor, m_DxilMinor);
- for (Function &F : llvmModule.functions()) {
- if (DxilMod.HasDxilEntryProps(&F)) {
- DxilEntryProps &entryProps = DxilMod.GetDxilEntryProps(&F);
- entryStatusMap[&F] = llvm::make_unique<EntryStatus>(entryProps);
- }
- }
- isLibProfile = dxilModule.GetShaderModel()->IsLib();
- if (isLibProfile) {
- auto collectResTy = [&](auto &ResTab) {
- for (auto &Res : ResTab) {
- Type *Ty = Res->GetGlobalSymbol()->getType()->getPointerElementType();
- Ty = dxilutil::GetArrayEltTy(Ty);
- ResTypeMap[Ty] = Res.get();
- }
- };
- collectResTy(DxilMod.GetCBuffers());
- collectResTy(DxilMod.GetUAVs());
- collectResTy(DxilMod.GetSRVs());
- collectResTy(DxilMod.GetSamplers());
- }
- // Collect patch constant map.
- if (isLibProfile) {
- for (Function &F : dxilModule.GetModule()->functions()) {
- if (dxilModule.HasDxilEntryProps(&F)) {
- DxilEntryProps &entryProps = dxilModule.GetDxilEntryProps(&F);
- DxilFunctionProps &props = entryProps.props;
- if (props.IsHS()) {
- PatchConstantFuncMap[props.ShaderProps.HS.patchConstantFunc].emplace_back(&F);
- }
- }
- }
- } else {
- Function *Entry = dxilModule.GetEntryFunction();
- if (!dxilModule.HasDxilEntryProps(Entry)) {
- // must have props.
- EmitError(ValidationRule::MetaNoEntryPropsForEntry);
- return;
- }
- DxilEntryProps &entryProps = dxilModule.GetDxilEntryProps(Entry);
- DxilFunctionProps &props = entryProps.props;
- if (props.IsHS()) {
- PatchConstantFuncMap[props.ShaderProps.HS.patchConstantFunc].emplace_back(Entry);
- }
- }
- }
- bool HasEntryStatus(Function *F) {
- return entryStatusMap.find(F) != entryStatusMap.end();
- }
- EntryStatus &GetEntryStatus(Function *F) { return *entryStatusMap[F]; }
- DxilResourceBase *GetResFromTy(Type *Ty) {
- auto it = ResTypeMap.find(Ty);
- if (it == ResTypeMap.end())
- return nullptr;
- else
- return it->second;
- }
- DxilResourceBase *GetResourceFromMetadata(MDNode *Node) {
- auto it = ResInParam.find(Node);
- if (it != ResInParam.end())
- return it->second.get();
- DxilResourceBase Res(DxilResource::Class::Invalid);
- DxilMod.LoadDxilResourceBaseFromMDNode(Node, Res);
- std::unique_ptr<DxilResourceBase> ResBasePtr = nullptr;
- switch (Res.GetClass()) {
- case DXIL::ResourceClass::CBuffer: {
- std::unique_ptr<DxilCBuffer> ResPtr = llvm::make_unique<DxilCBuffer>();
- // TODO: set more field.
- ResPtr->SetKind(Res.GetKind());
- ResBasePtr = std::unique_ptr<DxilResourceBase>(ResPtr.release());
- } break;
- case DXIL::ResourceClass::Sampler: {
- DxilSampler Res;
- DxilMod.LoadDxilSamplerFromMDNode(Node, Res);
- std::unique_ptr<DxilSampler> ResPtr = llvm::make_unique<DxilSampler>();
- // TODO: set more field.
- ResPtr->SetKind(Res.GetKind());
- ResPtr->SetSamplerKind(Res.GetSamplerKind());
- ResBasePtr = std::unique_ptr<DxilResourceBase>(ResPtr.release());
- } break;
- case DXIL::ResourceClass::SRV: {
- DxilResource Res;
- DxilMod.LoadDxilResourceFromMDNode(Node, Res);
- std::unique_ptr<DxilResource> ResPtr = llvm::make_unique<DxilResource>();
- // TODO: set more field.
- ResPtr->SetKind(Res.GetKind());
- ResPtr->SetRW(false);
- ResBasePtr = std::unique_ptr<DxilResourceBase>(ResPtr.release());
- } break;
- case DXIL::ResourceClass::UAV: {
- DxilResource Res;
- DxilMod.LoadDxilResourceFromMDNode(Node, Res);
- std::unique_ptr<DxilResource> ResPtr = llvm::make_unique<DxilResource>();
- // TODO: set more field.
- ResPtr->SetKind(Res.GetKind());
- ResPtr->SetRW(true);
- ResPtr->SetHasCounter(Res.HasCounter());
- ResBasePtr = std::unique_ptr<DxilResourceBase>(ResPtr.release());
- } break;
- default:
- return nullptr;
- }
- DxilResourceBase *Ptr = ResBasePtr.get();
- ResInParam[Node] = std::move(ResBasePtr);
- return Ptr;
- }
- DxilResourceBase *GetResourceFromResPtr(Value *resVal,
- std::deque<unsigned> &offsets);
- DxilResourceBase *GetResourceFromVal(Value *resVal);
- // Provide direct access to the raw_ostream in DiagPrinter.
- raw_ostream &DiagStream() {
- struct DiagnosticPrinterRawOStream_Pub : public DiagnosticPrinterRawOStream {
- public:
- raw_ostream &DiagStream() { return Stream; }
- };
- DiagnosticPrinterRawOStream_Pub* p = (DiagnosticPrinterRawOStream_Pub*)&DiagPrinter;
- return p->DiagStream();
- }
- void EmitGlobalValueError(GlobalValue *GV, ValidationRule rule) {
- EmitFormatError(rule, { GV->getName().str() });
- }
- // This is the least desirable mechanism, as it has no context.
- void EmitError(ValidationRule rule) {
- DiagPrinter << GetValidationRuleText(rule) << '\n';
- Failed = true;
- }
- void FormatRuleText(std::string &ruleText, ArrayRef<StringRef> args) {
- // Consider changing const char * to StringRef
- for (unsigned i = 0; i < args.size(); i++) {
- std::string argIdx = "%" + std::to_string(i);
- StringRef pArg = args[i];
- if (pArg == "")
- pArg = "<null>";
- std::string::size_type offset = ruleText.find(argIdx);
- if (offset == std::string::npos)
- continue;
- unsigned size = argIdx.size();
- ruleText.replace(offset, size, args[i]);
- }
- }
- void EmitFormatError(ValidationRule rule, ArrayRef<StringRef> args) {
- std::string ruleText = GetValidationRuleText(rule);
- FormatRuleText(ruleText, args);
- DiagPrinter << ruleText << '\n';
- Failed = true;
- }
- void EmitMetaError(Metadata *Meta, ValidationRule rule) {
- DiagPrinter << GetValidationRuleText(rule);
- Meta->print(DiagStream(), &M);
- DiagPrinter << '\n';
- Failed = true;
- }
- void EmitResourceError(const hlsl::DxilResourceBase *Res, ValidationRule rule) {
- DiagPrinter << GetValidationRuleText(rule);
- DiagPrinter << '\'' << Res->GetGlobalName() << '\'';
- DiagPrinter << '\n';
- Failed = true;
- }
- void EmitResourceFormatError(const hlsl::DxilResourceBase *Res,
- ValidationRule rule,
- ArrayRef<StringRef> args) {
- std::string ruleText = GetValidationRuleText(rule);
- FormatRuleText(ruleText, args);
- DiagPrinter << ruleText;
- DiagPrinter << '\'' << Res->GetGlobalName() << '\'';
- DiagPrinter << '\n';
- Failed = true;
- }
- bool IsDebugFunctionCall(Instruction *I) {
- CallInst *CI = dyn_cast<CallInst>(I);
- return CI && CI->getCalledFunction()->getName().startswith("llvm.dbg.");
- }
- DebugLoc GetDebugLoc(Instruction *I) {
- DXASSERT_NOMSG(I);
- if (pDebugModule) {
- // Look up the matching instruction in the debug module.
- llvm::Function *Fn = I->getParent()->getParent();
- llvm::Function *DbgFn = pDebugModule->getFunction(Fn->getName());
- if (DbgFn) {
- // Linear lookup, but then again, failing validation is rare.
- inst_iterator it = inst_begin(Fn);
- inst_iterator dbg_it = inst_begin(DbgFn);
- while (IsDebugFunctionCall(&*dbg_it)) ++dbg_it;
- while (&*it != I) {
- ++it;
- ++dbg_it;
- while (IsDebugFunctionCall(&*dbg_it)) ++dbg_it;
- }
- return dbg_it->getDebugLoc();
- }
- }
- return I->getDebugLoc();
- }
- bool EmitInstrLoc(Instruction *I, ValidationRule Rule) {
- const DebugLoc &L = GetDebugLoc(I);
- if (L) {
- // Instructions that get scalarized will likely hit
- // this case. Avoid redundant diagnostic messages.
- if (Rule == LastRuleEmit && L == LastDebugLocEmit) {
- return false;
- }
- LastRuleEmit = Rule;
- LastDebugLocEmit = L;
- L.print(DiagStream());
- DiagPrinter << ' ';
- return true;
- }
- BasicBlock *BB = I->getParent();
- Function *F = BB->getParent();
- DiagPrinter << "at " << I;
- DiagPrinter << " inside block ";
- if (!BB->getName().empty()) {
- DiagPrinter << BB->getName();
- }
- else {
- unsigned idx = 0;
- for (auto i = F->getBasicBlockList().begin(),
- e = F->getBasicBlockList().end(); i != e; ++i) {
- if (BB == &(*i)) {
- break;
- }
- }
- DiagPrinter << "#" << idx;
- }
- DiagPrinter << " of function " << *F << ' ';
- return true;
- }
- void EmitInstrError(Instruction *I, ValidationRule rule) {
- if (!EmitInstrLoc(I, rule)) return;
- DiagPrinter << GetValidationRuleText(rule);
- DiagPrinter << '\n';
- Failed = true;
- }
- void EmitInstrFormatError(Instruction *I, ValidationRule rule, ArrayRef<StringRef> args) {
- if (!EmitInstrLoc(I, rule)) return;
- std::string ruleText = GetValidationRuleText(rule);
- FormatRuleText(ruleText, args);
- DiagPrinter << ruleText;
- DiagPrinter << '\n';
- Failed = true;
- }
- void EmitOperandOutOfRange(Instruction *I, StringRef name, StringRef range, StringRef v) {
- if (!EmitInstrLoc(I, ValidationRule::InstrOperandRange)) return;
- std::string ruleText = GetValidationRuleText(ValidationRule::InstrOperandRange);
- FormatRuleText(ruleText, {name, range, v});
- DiagPrinter << ruleText;
- DiagPrinter << '\n';
- Failed = true;
- }
- void EmitSignatureError(DxilSignatureElement *SE, ValidationRule rule) {
- EmitFormatError(rule, { SE->GetName() });
- }
- void EmitTypeError(Type *Ty, ValidationRule rule) {
- std::string O;
- raw_string_ostream OSS(O);
- Ty->print(OSS);
- EmitFormatError(rule, { OSS.str() });
- }
- void EmitFnAttributeError(Function *F, StringRef Kind, StringRef Value) {
- EmitFormatError(ValidationRule::DeclFnAttribute, { F->getName(), Kind, Value });
- }
- };
- static bool ValidateOpcodeInProfile(DXIL::OpCode opcode,
- const ShaderModel *pSM) {
- unsigned op = (unsigned)opcode;
- /* <py::lines('VALOPCODESM-TEXT')>hctdb_instrhelp.get_valopcode_sm_text()</py>*/
- // VALOPCODESM-TEXT:BEGIN
- // Instructions: ThreadId=93, GroupId=94, ThreadIdInGroup=95,
- // FlattenedThreadIdInGroup=96
- if ((93 <= op && op <= 96))
- return (pSM->IsCS());
- // Instructions: DomainLocation=105
- if (op == 105)
- return (pSM->IsDS());
- // Instructions: LoadOutputControlPoint=103, LoadPatchConstant=104
- if ((103 <= op && op <= 104))
- return (pSM->IsDS() || pSM->IsHS());
- // Instructions: EmitStream=97, CutStream=98, EmitThenCutStream=99,
- // GSInstanceID=100
- if ((97 <= op && op <= 100))
- return (pSM->IsGS());
- // Instructions: PrimitiveID=108
- if (op == 108)
- return (pSM->IsGS() || pSM->IsDS() || pSM->IsHS());
- // Instructions: StorePatchConstant=106, OutputControlPointID=107
- if ((106 <= op && op <= 107))
- return (pSM->IsHS());
- // Instructions: Sample=60, SampleBias=61, SampleCmp=64, CalculateLOD=81,
- // DerivCoarseX=83, DerivCoarseY=84, DerivFineX=85, DerivFineY=86
- if ((60 <= op && op <= 61) || op == 64 || op == 81 || (83 <= op && op <= 86))
- return (pSM->IsLib() || pSM->IsPS());
- // Instructions: RenderTargetGetSamplePosition=76,
- // RenderTargetGetSampleCount=77, Discard=82, EvalSnapped=87,
- // EvalSampleIndex=88, EvalCentroid=89, SampleIndex=90, Coverage=91,
- // InnerCoverage=92
- if ((76 <= op && op <= 77) || op == 82 || (87 <= op && op <= 92))
- return (pSM->IsPS());
- // Instructions: AttributeAtVertex=137
- if (op == 137)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 1))
- && (pSM->IsPS());
- // Instructions: ViewID=138
- if (op == 138)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 1))
- && (pSM->IsVS() || pSM->IsHS() || pSM->IsDS() || pSM->IsGS() || pSM->IsPS());
- // Instructions: RawBufferLoad=139, RawBufferStore=140
- if ((139 <= op && op <= 140))
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 2));
- // Instructions: CreateHandleForLib=160
- if (op == 160)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3));
- // Instructions: IgnoreHit=155, AcceptHitAndEndSearch=156
- if ((155 <= op && op <= 156))
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::AnyHit);
- // Instructions: CallShader=159
- if (op == 159)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::ClosestHit || pSM->GetKind() == DXIL::ShaderKind::RayGeneration || pSM->GetKind() == DXIL::ShaderKind::Miss || pSM->GetKind() == DXIL::ShaderKind::Callable);
- // Instructions: ReportHit=158
- if (op == 158)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::Intersection);
- // Instructions: InstanceID=141, InstanceIndex=142, HitKind=143,
- // ObjectRayOrigin=149, ObjectRayDirection=150, ObjectToWorld=151,
- // WorldToObject=152, PrimitiveIndex=161
- if ((141 <= op && op <= 143) || (149 <= op && op <= 152) || op == 161)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::Intersection || pSM->GetKind() == DXIL::ShaderKind::AnyHit || pSM->GetKind() == DXIL::ShaderKind::ClosestHit);
- // Instructions: RayFlags=144, WorldRayOrigin=147, WorldRayDirection=148,
- // RayTMin=153, RayTCurrent=154
- if (op == 144 || (147 <= op && op <= 148) || (153 <= op && op <= 154))
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::Intersection || pSM->GetKind() == DXIL::ShaderKind::AnyHit || pSM->GetKind() == DXIL::ShaderKind::ClosestHit || pSM->GetKind() == DXIL::ShaderKind::Miss);
- // Instructions: TraceRay=157
- if (op == 157)
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::RayGeneration || pSM->GetKind() == DXIL::ShaderKind::ClosestHit || pSM->GetKind() == DXIL::ShaderKind::Miss);
- // Instructions: DispatchRaysIndex=145, DispatchRaysDimensions=146
- if ((145 <= op && op <= 146))
- return (pSM->GetMajor() > 6 || (pSM->GetMajor() == 6 && pSM->GetMinor() >= 3))
- && (pSM->IsLib() || pSM->GetKind() == DXIL::ShaderKind::RayGeneration || pSM->GetKind() == DXIL::ShaderKind::Intersection || pSM->GetKind() == DXIL::ShaderKind::AnyHit || pSM->GetKind() == DXIL::ShaderKind::ClosestHit || pSM->GetKind() == DXIL::ShaderKind::Miss || pSM->GetKind() == DXIL::ShaderKind::Callable);
- return true;
- // VALOPCODESM-TEXT:END
- }
- static unsigned ValidateSignatureRowCol(Instruction *I,
- DxilSignatureElement &SE, Value *rowVal,
- Value *colVal, EntryStatus &Status,
- ValidationContext &ValCtx) {
- if (ConstantInt *constRow = dyn_cast<ConstantInt>(rowVal)) {
- unsigned row = constRow->getLimitedValue();
- if (row >= SE.GetRows()) {
- ValCtx.EmitInstrError(I, ValidationRule::InstrOperandRange);
- }
- }
- if (!isa<ConstantInt>(colVal)) {
- // col must be const
- ValCtx.EmitInstrFormatError(I, ValidationRule::InstrOpConst,
- {"Col", "LoadInput/StoreOutput"});
- return 0;
- }
- unsigned col = cast<ConstantInt>(colVal)->getLimitedValue();
- if (col > SE.GetCols()) {
- ValCtx.EmitInstrError(I, ValidationRule::InstrOperandRange);
- } else {
- if (SE.IsOutput())
- Status.outputCols[SE.GetID()] |= 1 << col;
- if (SE.IsPatchConstant())
- Status.patchConstCols[SE.GetID()] |= 1 << col;
- }
- return col;
- }
- static DxilSignatureElement *
- ValidateSignatureAccess(Instruction *I, DxilSignature &sig, Value *sigID,
- Value *rowVal, Value *colVal, EntryStatus &Status,
- ValidationContext &ValCtx) {
- if (!isa<ConstantInt>(sigID)) {
- // inputID must be const
- ValCtx.EmitInstrFormatError(I, ValidationRule::InstrOpConst,
- {"SignatureID", "LoadInput/StoreOutput"});
- return nullptr;
- }
- unsigned SEIdx = cast<ConstantInt>(sigID)->getLimitedValue();
- if (sig.GetElements().size() <= SEIdx) {
- ValCtx.EmitInstrError(I, ValidationRule::InstrOpConstRange);
- return nullptr;
- }
- DxilSignatureElement &SE = sig.GetElement(SEIdx);
- bool isOutput = sig.IsOutput();
- unsigned col = ValidateSignatureRowCol(I, SE, rowVal, colVal, Status, ValCtx);
- if (isOutput && SE.GetSemantic()->GetKind() == DXIL::SemanticKind::Position) {
- unsigned mask = Status.OutputPositionMask[SE.GetOutputStream()];
- mask |= 1 << col;
- if (SE.GetOutputStream() < DXIL::kNumOutputStreams)
- Status.OutputPositionMask[SE.GetOutputStream()] = mask;
- }
- return &SE;
- }
- static CallInst *GetHandleFromValue(Value *V, DenseSet<Value *> &Checked);
- static CallInst *GetHandleFromPhi(PHINode *Phi, DenseSet<Value *> &Checked) {
- // TODO: validate all incoming values for phi is same kind and class.
- for (Value *V : Phi->incoming_values()) {
- if (CallInst *CI = GetHandleFromValue(V, Checked))
- return CI;
- }
- return nullptr;
- }
- static CallInst *GetHandleFromSelect(SelectInst *Sel, DenseSet<Value *> &Checked) {
- // TODO: validate all incoming values for select is same kind and class.
- for (Value *V = Sel->getTrueValue(), *F = Sel->getFalseValue(); V != F; V = F) {
- if (CallInst *CI = GetHandleFromValue(V, Checked))
- return CI;
- }
- return nullptr;
- }
- static CallInst *GetHandleFromValue(Value *V, DenseSet<Value *> &Checked) {
- if (!Checked.count(V)) {
- Checked.insert(V);
- if (CallInst *CI = dyn_cast<CallInst>(V)) {
- return CI;
- }
- else if (PHINode *P = dyn_cast<PHINode>(V)) {
- if (CallInst *CI = GetHandleFromPhi(P, Checked)) {
- return CI;
- }
- }
- else if (SelectInst *S = dyn_cast<SelectInst>(V)) {
- if (CallInst *CI = GetHandleFromSelect(S, Checked)) {
- return CI;
- }
- }
- }
- return nullptr;
- }
- static DXIL::SamplerKind GetSamplerKind(Value *samplerHandle,
- ValidationContext &ValCtx) {
- if (!isa<CallInst>(samplerHandle)) {
- DenseSet<Value *> Checked;
- if (CallInst *CI = GetHandleFromValue(samplerHandle, Checked)) {
- samplerHandle = CI;
- } else {
- ValCtx.EmitError(ValidationRule::InstrHandleNotFromCreateHandle);
- return DXIL::SamplerKind::Invalid;
- }
- }
- DxilInst_CreateHandle createHandle(cast<CallInst>(samplerHandle));
- if (!createHandle) {
- auto EmitError = [&]() -> DXIL::SamplerKind {
- ValCtx.EmitInstrError(cast<CallInst>(samplerHandle),
- ValidationRule::InstrHandleNotFromCreateHandle);
- return DXIL::SamplerKind::Invalid;
- };
- if (!ValCtx.isLibProfile) {
- return EmitError();
- }
- DxilInst_CreateHandleForLib createHandleFromRes(
- cast<CallInst>(samplerHandle));
- if (!createHandleFromRes) {
- return EmitError();
- }
- DxilResourceBase *Res =
- ValCtx.GetResFromTy(createHandleFromRes.get_Resource()->getType());
- if (!Res) {
- Res = ValCtx.GetResourceFromVal(createHandleFromRes.get_Resource());
- if (!Res)
- return EmitError();
- }
- if (Res->GetClass() == DXIL::ResourceClass::Sampler) {
- DxilSampler *S = (DxilSampler *)(Res);
- return S->GetSamplerKind();
- } else {
- return EmitError();
- }
- }
- Value *resClass = createHandle.get_resourceClass();
- if (!isa<ConstantInt>(resClass)) {
- return DXIL::SamplerKind::Invalid;
- }
- if (createHandle.get_resourceClass_val() != static_cast<unsigned>(DXIL::ResourceClass::Sampler)) {
- // must be sampler.
- return DXIL::SamplerKind::Invalid;
- }
- Value *rangeIndex = createHandle.get_rangeId();
- if (!isa<ConstantInt>(rangeIndex)) {
- // must be constant
- return DXIL::SamplerKind::Invalid;
- }
- unsigned samplerIndex = cast<ConstantInt>(rangeIndex)->getLimitedValue();
- auto &samplers = ValCtx.DxilMod.GetSamplers();
- if (samplerIndex >= samplers.size()) {
- return DXIL::SamplerKind::Invalid;
- }
- DxilSampler *sampler = samplers[samplerIndex].get();
- Value *index = createHandle.get_index();
- ConstantInt *cIndex = dyn_cast<ConstantInt>(index);
- if (!sampler->GetGlobalSymbol()->getType()->getPointerElementType()->isArrayTy()) {
- if (!cIndex) {
- // index must be 0 for none array resource.
- return DXIL::SamplerKind::Invalid;
- }
- }
- if (cIndex) {
- unsigned index = cIndex->getLimitedValue();
- if (index < sampler->GetLowerBound() || index > sampler->GetUpperBound()) {
- // index out of range.
- return DXIL::SamplerKind::Invalid;
- }
- }
- return sampler->GetSamplerKind();
- }
- static DXIL::ResourceKind GetResourceKindAndCompTy(Value *handle, DXIL::ComponentType &CompTy, DXIL::ResourceClass &ResClass,
- unsigned &resIndex,
- ValidationContext &ValCtx) {
- CompTy = DXIL::ComponentType::Invalid;
- ResClass = DXIL::ResourceClass::Invalid;
- if (!isa<CallInst>(handle)) {
- DenseSet<Value *> Checked;
- if (CallInst *CI = GetHandleFromValue(handle, Checked)) {
- handle = CI;
- } else {
- ValCtx.EmitError(ValidationRule::InstrHandleNotFromCreateHandle);
- return DXIL::ResourceKind::Invalid;
- }
- }
- // TODO: validate ROV is used only in PS.
- DxilInst_CreateHandle createHandle(cast<CallInst>(handle));
- if (!createHandle) {
- auto EmitError = [&]() -> DXIL::ResourceKind {
- ValCtx.EmitInstrError(cast<CallInst>(handle),
- ValidationRule::InstrHandleNotFromCreateHandle);
- return DXIL::ResourceKind::Invalid;
- };
- if (!ValCtx.isLibProfile) {
- return EmitError();
- }
- DxilInst_CreateHandleForLib createHandleFromRes(
- cast<CallInst>(handle));
- if (!createHandleFromRes) {
- return EmitError();
- }
- DxilResourceBase *res =
- ValCtx.GetResFromTy(createHandleFromRes.get_Resource()->getType());
- if (!res) {
- res = ValCtx.GetResourceFromVal(createHandleFromRes.get_Resource());
- if (!res)
- return EmitError();
- }
- // TODO: resIndex for Uav Counter.
- if (res->GetClass() == DXIL::ResourceClass::UAV ||
- res->GetClass() == DXIL::ResourceClass::SRV) {
- DxilResource *Res = (DxilResource*)(res);
- CompTy = Res->GetCompType().GetKind();
- } else {
- return EmitError();
- }
- ResClass = res->GetClass();
- return res->GetKind();
- }
- Value *resourceClass = createHandle.get_resourceClass();
- if (!isa<ConstantInt>(resourceClass)) {
- return DXIL::ResourceKind::Invalid;
- }
- ResClass = static_cast<DXIL::ResourceClass>(createHandle.get_resourceClass_val());
- switch (ResClass) {
- case DXIL::ResourceClass::SRV:
- case DXIL::ResourceClass::UAV:
- break;
- case DXIL::ResourceClass::CBuffer:
- return DXIL::ResourceKind::CBuffer;
- case DXIL::ResourceClass::Sampler:
- return DXIL::ResourceKind::Sampler;
- default:
- // Emit invalid res class
- return DXIL::ResourceKind::Invalid;
- }
- Value *rangeIndex = createHandle.get_rangeId();
- if (!isa<ConstantInt>(rangeIndex)) {
- ValCtx.EmitInstrError(cast<CallInst>(handle),
- ValidationRule::InstrCreateHandleImmRangeID);
- // must be constant
- return DXIL::ResourceKind::Invalid;
- }
- resIndex = cast<ConstantInt>(rangeIndex)->getLimitedValue();
- DxilResource *res = nullptr;
- if (ResClass == DXIL::ResourceClass::UAV) {
- auto &resources = ValCtx.DxilMod.GetUAVs();
- if (resIndex >= resources.size()) {
- return DXIL::ResourceKind::Invalid;
- }
- res = resources[resIndex].get();
- } else {
- if (ResClass != DXIL::ResourceClass::SRV) {
- return DXIL::ResourceKind::Invalid;
- }
- auto &resources = ValCtx.DxilMod.GetSRVs();
- if (resIndex >= resources.size()) {
- return DXIL::ResourceKind::Invalid;
- }
- res = resources[resIndex].get();
- }
- CompTy = res->GetCompType().GetKind();
- Value *index = createHandle.get_index();
- ConstantInt *cIndex = dyn_cast<ConstantInt>(index);
- if (!res->GetGlobalSymbol()->getType()->getPointerElementType()->isArrayTy()) {
- if (!cIndex) {
- // index must be 0 for none array resource.
- return DXIL::ResourceKind::Invalid;
- }
- }
- if (cIndex) {
- unsigned index = cIndex->getLimitedValue();
- if (index < res->GetLowerBound() || index > res->GetUpperBound()) {
- // index out of range.
- return DXIL::ResourceKind::Invalid;
- }
- }
- return res->GetKind();
- }
- DxilFieldAnnotation *GetFieldAnnotation(Type *Ty,
- DxilTypeSystem &typeSys,
- std::deque<unsigned> &offsets) {
- unsigned CurIdx = 1;
- unsigned LastIdx = offsets.size() - 1;
- DxilStructAnnotation *StructAnnot = nullptr;
- for (; CurIdx < offsets.size(); ++CurIdx) {
- if (const StructType *EltST = dyn_cast<StructType>(Ty)) {
- if (DxilStructAnnotation *EltAnnot = typeSys.GetStructAnnotation(EltST)) {
- StructAnnot = EltAnnot;
- Ty = EltST->getElementType(offsets[CurIdx]);
- if (CurIdx == LastIdx) {
- return &StructAnnot->GetFieldAnnotation(offsets[CurIdx]);
- }
- } else {
- return nullptr;
- }
- } else if (const ArrayType *AT = dyn_cast<ArrayType>(Ty)) {
- Ty = AT->getElementType();
- StructAnnot = nullptr;
- } else {
- if (StructAnnot)
- return &StructAnnot->GetFieldAnnotation(offsets[CurIdx]);
- }
- }
- return nullptr;
- }
- DxilResourceBase *
- ValidationContext::GetResourceFromResPtr(Value *resPtr,
- std::deque<unsigned> &offsets) {
- if (GlobalVariable *GV = dyn_cast<GlobalVariable>(resPtr)) {
- auto FindRes = [&](auto &ResTab) -> DxilResourceBase * {
- for (auto &UAV : ResTab) {
- if (UAV->GetGlobalSymbol() == GV) {
- return UAV.get();
- }
- }
- return nullptr;
- };
- DxilResourceBase *Res = FindRes(DxilMod.GetUAVs());
- if (Res)
- return Res;
- Res = FindRes(DxilMod.GetSRVs());
- if (Res)
- return Res;
- Res = FindRes(DxilMod.GetCBuffers());
- if (Res)
- return Res;
- return FindRes(DxilMod.GetSamplers());
- } else if (Argument *Arg = dyn_cast<Argument>(resPtr)) {
- Function *F = Arg->getParent();
- auto &typeSys = DxilMod.GetTypeSystem();
- if (auto *FunctionAnnot = typeSys.GetFunctionAnnotation(F)) {
- FunctionType *FT = F->getFunctionType();
- auto &ParamAnnot = FunctionAnnot->GetParameterAnnotation(Arg->getArgNo());
- if (offsets.size() == 1) {
- MDNode *Node = ParamAnnot.GetResourceAttribute();
- if (!Node)
- return nullptr;
- return GetResourceFromMetadata(Node);
- } else {
- Type *Ty = FT->getParamType(Arg->getArgNo());
- if (!isa<PointerType>(Ty))
- return nullptr;
- Ty = Ty->getPointerElementType();
- if (!isa<StructType>(Ty))
- return nullptr;
- if (DxilFieldAnnotation *fieldAnnot =
- GetFieldAnnotation(Ty, typeSys, offsets)) {
- MDNode *Node = fieldAnnot->GetResourceAttribute();
- if (!Node)
- return nullptr;
- return GetResourceFromMetadata(Node);
- } else {
- return nullptr;
- }
- }
- } else {
- return nullptr;
- }
- } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(resPtr)) {
- auto it = GEP->idx_begin();
- auto end = GEP->idx_end();
- // Skip first 0.
- it++;
- for (; it != end; it++) {
- if (ConstantInt *idx = dyn_cast<ConstantInt>(*it)) {
- offsets.emplace_back(idx->getLimitedValue());
- } else {
- offsets.emplace_back(0);
- }
- }
- return GetResourceFromResPtr(GEP->getPointerOperand(), offsets);
- } else if (AllocaInst *AI = dyn_cast<AllocaInst>(resPtr)) {
- Type *Ty = AI->getAllocatedType();
- auto &typeSys = DxilMod.GetTypeSystem();
- while (isa<ArrayType>(Ty)) {
- Ty = Ty->getArrayElementType();
- offsets.pop_front();
- }
- if (offsets.size() == 1) {
- // Try to find info from function call.
- // Assume alloca of resource must be used by a function call.
- for (User *U : AI->users()) {
- if (CallInst *CI = dyn_cast<CallInst>(U)) {
- for (unsigned i = 0; i < CI->getNumArgOperands(); i++) {
- if (CI->getArgOperand(i) == AI) {
- Function *F = CI->getCalledFunction();
- if (auto *FunctionAnnot = typeSys.GetFunctionAnnotation(F)) {
- auto &ParamAnnot = FunctionAnnot->GetParameterAnnotation(i);
- if (offsets.size() == 1) {
- MDNode *Node = ParamAnnot.GetResourceAttribute();
- if (!Node)
- return nullptr;
- return GetResourceFromMetadata(Node);
- }
- }
- break;
- }
- }
- }
- }
- return nullptr;
- } else if (DxilFieldAnnotation *fieldAnnot =
- GetFieldAnnotation(Ty, typeSys, offsets)) {
- MDNode *Node = fieldAnnot->GetResourceAttribute();
- if (!Node)
- return nullptr;
- return GetResourceFromMetadata(Node);
- } else {
- return nullptr;
- }
- } else {
- return nullptr;
- }
- }
- DxilResourceBase *ValidationContext::GetResourceFromVal(Value *resVal) {
- if (LoadInst *LI = dyn_cast<LoadInst>(resVal)) {
- // Add the first 0 for pointer.
- std::deque<unsigned> offsets(1, 0);
- DxilResourceBase *Res = GetResourceFromResPtr(LI->getPointerOperand(), offsets);
- if (Res)
- ResTypeMap[LI->getType()] = Res;
- return Res;
- } else {
- return nullptr;
- }
- }
- static DxilResource *GetResource(Value *handle, ValidationContext &ValCtx) {
- if (!isa<CallInst>(handle)) {
- DenseSet<Value *> Checked;
- if (CallInst *CI = GetHandleFromValue(handle, Checked)) {
- handle = CI;
- } else {
- ValCtx.EmitError(ValidationRule::InstrHandleNotFromCreateHandle);
- return nullptr;
- }
- }
- DxilInst_CreateHandle createHandle(cast<CallInst>(handle));
- if (!createHandle) {
- auto EmitError = [&]() -> DXIL::ResourceKind {
- ValCtx.EmitInstrError(cast<CallInst>(handle),
- ValidationRule::InstrHandleNotFromCreateHandle);
- return DXIL::ResourceKind::Invalid;
- };
- if (!ValCtx.isLibProfile) {
- EmitError();
- return nullptr;
- }
- DxilInst_CreateHandleForLib createHandleFromRes(cast<CallInst>(handle));
- if (!createHandleFromRes) {
- EmitError();
- return nullptr;
- }
- Value *resVal = createHandleFromRes.get_Resource();
- return (DxilResource*)ValCtx.GetResourceFromVal(resVal);
- }
- Value *resourceClass = createHandle.get_resourceClass();
- if (!isa<ConstantInt>(resourceClass)) {
- return nullptr;
- }
- DXIL::ResourceClass ResClass =
- static_cast<DXIL::ResourceClass>(createHandle.get_resourceClass_val());
- switch (ResClass) {
- case DXIL::ResourceClass::SRV:
- case DXIL::ResourceClass::UAV:
- break;
- case DXIL::ResourceClass::CBuffer:
- return nullptr;
- case DXIL::ResourceClass::Sampler:
- return nullptr;
- default:
- // Emit invalid res class
- return nullptr;
- }
- Value *rangeIndex = createHandle.get_rangeId();
- if (!isa<ConstantInt>(rangeIndex)) {
- ValCtx.EmitInstrError(cast<CallInst>(handle),
- ValidationRule::InstrCreateHandleImmRangeID);
- // must be constant
- return nullptr;
- }
- unsigned resIndex = cast<ConstantInt>(rangeIndex)->getLimitedValue();
- DxilResource *res = nullptr;
- if (ResClass == DXIL::ResourceClass::UAV) {
- auto &resources = ValCtx.DxilMod.GetUAVs();
- if (resIndex >= resources.size()) {
- return nullptr;
- }
- res = resources[resIndex].get();
- } else {
- if (ResClass != DXIL::ResourceClass::SRV) {
- return nullptr;
- }
- auto &resources = ValCtx.DxilMod.GetSRVs();
- if (resIndex >= resources.size()) {
- return nullptr;
- }
- res = resources[resIndex].get();
- }
- return res;
- }
- struct ResRetUsage {
- bool x;
- bool y;
- bool z;
- bool w;
- bool status;
- ResRetUsage() : x(false), y(false), z(false), w(false), status(false) {}
- };
- static void CollectGetDimResRetUsage(ResRetUsage &usage, Instruction *ResRet,
- ValidationContext &ValCtx) {
- for (User *U : ResRet->users()) {
- if (ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(U)) {
- for (unsigned idx : EVI->getIndices()) {
- switch (idx) {
- case 0:
- usage.x = true;
- break;
- case 1:
- usage.y = true;
- break;
- case 2:
- usage.z = true;
- break;
- case 3:
- usage.w = true;
- break;
- case DXIL::kResRetStatusIndex:
- usage.status = true;
- break;
- default:
- // Emit index out of bound.
- ValCtx.EmitInstrError(EVI,
- ValidationRule::InstrDxilStructUserOutOfBound);
- break;
- }
- }
- } else if (PHINode *PHI = dyn_cast<PHINode>(U)) {
- CollectGetDimResRetUsage(usage, PHI, ValCtx);
- } else {
- Instruction *User = cast<Instruction>(U);
- ValCtx.EmitInstrError(User, ValidationRule::InstrDxilStructUser);
- }
- }
- }
- static void ValidateResourceCoord(CallInst *CI, DXIL::ResourceKind resKind,
- ArrayRef<Value *> coords,
- ValidationContext &ValCtx) {
- const unsigned kMaxNumCoords = 4;
- unsigned numCoords = DxilResource::GetNumCoords(resKind);
- for (unsigned i = 0; i < kMaxNumCoords; i++) {
- if (i < numCoords) {
- if (isa<UndefValue>(coords[i])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceCoordinateMiss);
- }
- } else {
- if (!isa<UndefValue>(coords[i])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceCoordinateTooMany);
- }
- }
- }
- }
- static void ValidateCalcLODResourceDimensionCoord(CallInst *CI, DXIL::ResourceKind resKind,
- ArrayRef<Value *> coords,
- ValidationContext &ValCtx) {
- const unsigned kMaxNumDimCoords = 3;
- unsigned numCoords = DxilResource::GetNumDimensionsForCalcLOD(resKind);
- for (unsigned i = 0; i < kMaxNumDimCoords; i++) {
- if (i < numCoords) {
- if (isa<UndefValue>(coords[i])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceCoordinateMiss);
- }
- } else {
- if (!isa<UndefValue>(coords[i])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceCoordinateTooMany);
- }
- }
- }
- }
- static void ValidateResourceOffset(CallInst *CI, DXIL::ResourceKind resKind,
- ArrayRef<Value *> offsets,
- ValidationContext &ValCtx) {
- const unsigned kMaxNumOffsets = 3;
- unsigned numOffsets = DxilResource::GetNumOffsets(resKind);
- bool hasOffset = !isa<UndefValue>(offsets[0]);
- auto validateOffset = [&](Value *offset) {
- if (ConstantInt *cOffset = dyn_cast<ConstantInt>(offset)) {
- int offset = cOffset->getValue().getSExtValue();
- if (offset > 7 || offset < -8) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrTextureOffset);
- }
- } else {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrTextureOffset);
- }
- };
- if (hasOffset) {
- validateOffset(offsets[0]);
- }
- for (unsigned i = 1; i < kMaxNumOffsets; i++) {
- if (i < numOffsets) {
- if (hasOffset) {
- if (isa<UndefValue>(offsets[i]))
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceOffsetMiss);
- else
- validateOffset(offsets[i]);
- }
- } else {
- if (!isa<UndefValue>(offsets[i])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceOffsetTooMany);
- }
- }
- }
- }
- static void ValidateSampleInst(CallInst *CI, Value *srvHandle, Value *samplerHandle,
- ArrayRef<Value *> coords,
- ArrayRef<Value *> offsets,
- bool IsSampleC,
- ValidationContext &ValCtx) {
- if (!IsSampleC) {
- if (GetSamplerKind(samplerHandle, ValCtx) != DXIL::SamplerKind::Default) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSamplerModeForSample);
- }
- } else {
- if (GetSamplerKind(samplerHandle, ValCtx) !=
- DXIL::SamplerKind::Comparison) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSamplerModeForSampleC);
- }
- }
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind =
- GetResourceKindAndCompTy(srvHandle, compTy, resClass, resIndex, ValCtx);
- bool isSampleCompTy = compTy == DXIL::ComponentType::F32;
- isSampleCompTy |= compTy == DXIL::ComponentType::SNormF32;
- isSampleCompTy |= compTy == DXIL::ComponentType::UNormF32;
- if (!isSampleCompTy) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSampleCompType);
- }
- if (resClass != DXIL::ResourceClass::SRV) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceClassForSamplerGather);
- }
- ValidationRule rule = ValidationRule::InstrResourceKindForSample;
- if (IsSampleC) {
- rule = ValidationRule::InstrResourceKindForSampleC;
- }
- switch (resKind) {
- case DXIL::ResourceKind::Texture1D:
- case DXIL::ResourceKind::Texture1DArray:
- case DXIL::ResourceKind::Texture2D:
- case DXIL::ResourceKind::Texture2DArray:
- case DXIL::ResourceKind::TextureCube:
- case DXIL::ResourceKind::TextureCubeArray:
- break;
- case DXIL::ResourceKind::Texture3D:
- if (IsSampleC) {
- ValCtx.EmitInstrError(CI, rule);
- }
- break;
- default:
- ValCtx.EmitInstrError(CI, rule);
- return;
- }
- // Coord match resource kind.
- ValidateResourceCoord(CI, resKind, coords, ValCtx);
- // Offset match resource kind.
- ValidateResourceOffset(CI, resKind, offsets, ValCtx);
- }
- static void ValidateGather(CallInst *CI, Value *srvHandle, Value *samplerHandle,
- ArrayRef<Value *> coords,
- ArrayRef<Value *> offsets,
- bool IsSampleC,
- ValidationContext &ValCtx) {
- if (!IsSampleC) {
- if (GetSamplerKind(samplerHandle, ValCtx) != DXIL::SamplerKind::Default) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSamplerModeForSample);
- }
- } else {
- if (GetSamplerKind(samplerHandle, ValCtx) !=
- DXIL::SamplerKind::Comparison) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSamplerModeForSampleC);
- }
- }
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind =
- GetResourceKindAndCompTy(srvHandle, compTy, resClass, resIndex, ValCtx);
- if (resClass != DXIL::ResourceClass::SRV) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceClassForSamplerGather);
- return;
- }
- // Coord match resource kind.
- ValidateResourceCoord(CI, resKind, coords, ValCtx);
- // Offset match resource kind.
- switch (resKind) {
- case DXIL::ResourceKind::Texture2D:
- case DXIL::ResourceKind::Texture2DArray: {
- bool hasOffset = !isa<UndefValue>(offsets[0]);
- if (hasOffset) {
- if (isa<UndefValue>(offsets[1])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceOffsetMiss);
- }
- }
- } break;
- case DXIL::ResourceKind::TextureCube:
- case DXIL::ResourceKind::TextureCubeArray: {
- if (!isa<UndefValue>(offsets[0])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceOffsetTooMany);
- }
- if (!isa<UndefValue>(offsets[1])) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceOffsetTooMany);
- }
- } break;
- default:
- // Invalid resource type for gather.
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceKindForGather);
- break;
- }
- }
- static unsigned StoreValueToMask(ArrayRef<Value *> vals) {
- unsigned mask = 0;
- for (unsigned i = 0; i < 4; i++) {
- if (!isa<UndefValue>(vals[i])) {
- mask |= 1<<i;
- }
- }
- return mask;
- }
- static int GetCBufSize(Value *cbHandle, ValidationContext &ValCtx) {
- if (!isa<CallInst>(cbHandle)) {
- DenseSet<Value *> Checked;
- if (CallInst *CI = GetHandleFromValue(cbHandle, Checked)) {
- cbHandle = CI;
- } else {
- ValCtx.EmitError(ValidationRule::InstrHandleNotFromCreateHandle);
- return -1;
- }
- }
- DxilInst_CreateHandle createHandle(cast<CallInst>(cbHandle));
- if (!createHandle) {
- auto EmitError = [&]() -> int {
- ValCtx.EmitInstrError(cast<CallInst>(cbHandle),
- ValidationRule::InstrHandleNotFromCreateHandle);
- return -1;
- };
- if (!ValCtx.isLibProfile) {
- return EmitError();
- }
- DxilInst_CreateHandleForLib createHandleFromRes(
- cast<CallInst>(cbHandle));
- if (!createHandleFromRes) {
- return EmitError();
- }
- DxilResourceBase *Res =
- ValCtx.GetResFromTy(createHandleFromRes.get_Resource()->getType());
- if (!Res) {
- Res = ValCtx.GetResourceFromVal(createHandleFromRes.get_Resource());
- if (!Res)
- return EmitError();
- }
- if (Res->GetClass() == DXIL::ResourceClass::CBuffer) {
- DxilCBuffer *CB = (DxilCBuffer *)(Res);
- return CB->GetSize();
- } else {
- return EmitError();
- }
- }
- Value *resourceClass = createHandle.get_resourceClass();
- if (!isa<ConstantInt>(resourceClass)) {
- ValCtx.EmitInstrError(cast<CallInst>(cbHandle),
- ValidationRule::InstrOpConstRange);
- return -1;
- }
- if (static_cast<DXIL::ResourceClass>(createHandle.get_resourceClass_val()) !=
- DXIL::ResourceClass::CBuffer) {
- ValCtx.EmitInstrError(cast<CallInst>(cbHandle), ValidationRule::InstrCBufferClassForCBufferHandle);
- return -1;
- }
- Value *rangeIndex = createHandle.get_rangeId();
- if (!isa<ConstantInt>(rangeIndex)) {
- ValCtx.EmitInstrError(cast<CallInst>(cbHandle),
- ValidationRule::InstrOpConstRange);
- return -1;
- }
- DxilCBuffer &CB = ValCtx.DxilMod.GetCBuffer(
- cast<ConstantInt>(rangeIndex)->getLimitedValue());
- return CB.GetSize();
- }
- static unsigned GetNumVertices(DXIL::InputPrimitive inputPrimitive) {
- const unsigned InputPrimitiveVertexTab[] = {
- 0, // Undefined = 0,
- 1, // Point = 1,
- 2, // Line = 2,
- 3, // Triangle = 3,
- 0, // Reserved4 = 4,
- 0, // Reserved5 = 5,
- 4, // LineWithAdjacency = 6,
- 6, // TriangleWithAdjacency = 7,
- 1, // ControlPointPatch1 = 8,
- 2, // ControlPointPatch2 = 9,
- 3, // ControlPointPatch3 = 10,
- 4, // ControlPointPatch4 = 11,
- 5, // ControlPointPatch5 = 12,
- 6, // ControlPointPatch6 = 13,
- 7, // ControlPointPatch7 = 14,
- 8, // ControlPointPatch8 = 15,
- 9, // ControlPointPatch9 = 16,
- 10, // ControlPointPatch10 = 17,
- 11, // ControlPointPatch11 = 18,
- 12, // ControlPointPatch12 = 19,
- 13, // ControlPointPatch13 = 20,
- 14, // ControlPointPatch14 = 21,
- 15, // ControlPointPatch15 = 22,
- 16, // ControlPointPatch16 = 23,
- 17, // ControlPointPatch17 = 24,
- 18, // ControlPointPatch18 = 25,
- 19, // ControlPointPatch19 = 26,
- 20, // ControlPointPatch20 = 27,
- 21, // ControlPointPatch21 = 28,
- 22, // ControlPointPatch22 = 29,
- 23, // ControlPointPatch23 = 30,
- 24, // ControlPointPatch24 = 31,
- 25, // ControlPointPatch25 = 32,
- 26, // ControlPointPatch26 = 33,
- 27, // ControlPointPatch27 = 34,
- 28, // ControlPointPatch28 = 35,
- 29, // ControlPointPatch29 = 36,
- 30, // ControlPointPatch30 = 37,
- 31, // ControlPointPatch31 = 38,
- 32, // ControlPointPatch32 = 39,
- 0, // LastEntry,
- };
- unsigned primitiveIdx = static_cast<unsigned>(inputPrimitive);
- return InputPrimitiveVertexTab[primitiveIdx];
- }
- static void ValidateSignatureDxilOp(CallInst *CI, DXIL::OpCode opcode,
- ValidationContext &ValCtx) {
- Function *F = CI->getParent()->getParent();
- DxilModule &DM = ValCtx.DxilMod;
- bool bIsPatchConstantFunc = false;
- if (!DM.HasDxilEntryProps(F)) {
- auto it = ValCtx.PatchConstantFuncMap.find(F);
- if (it == ValCtx.PatchConstantFuncMap.end()) {
- // Missing entry props.
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrSignatureOperationNotInEntry);
- return;
- }
- // Use hull entry instead of patch constant function.
- F = it->second.front();
- bIsPatchConstantFunc = true;
- }
- if (!ValCtx.HasEntryStatus(F)) {
- return;
- }
- EntryStatus &Status = ValCtx.GetEntryStatus(F);
- DxilEntryProps &EntryProps = DM.GetDxilEntryProps(F);
- DxilFunctionProps &props = EntryProps.props;
- DxilEntrySignature &S = EntryProps.sig;
- switch (opcode) {
- case DXIL::OpCode::LoadInput: {
- Value *inputID = CI->getArgOperand(DXIL::OperandIndex::kLoadInputIDOpIdx);
- DxilSignature &inputSig = S.InputSignature;
- Value *row = CI->getArgOperand(DXIL::OperandIndex::kLoadInputRowOpIdx);
- Value *col = CI->getArgOperand(DXIL::OperandIndex::kLoadInputColOpIdx);
- ValidateSignatureAccess(CI, inputSig, inputID, row, col, Status, ValCtx);
- // Check vertexID in ps/vs. and none array input.
- Value *vertexID =
- CI->getArgOperand(DXIL::OperandIndex::kLoadInputVertexIDOpIdx);
- bool usedVertexID = vertexID && !isa<UndefValue>(vertexID);
- if (props.IsVS() || props.IsPS()) {
- if (usedVertexID) {
- // use vertexID in VS/PS input.
- ValCtx.EmitInstrError(CI, ValidationRule::SmOperand);
- return;
- }
- } else {
- if (ConstantInt *cVertexID = dyn_cast<ConstantInt>(vertexID)) {
- int immVertexID = cVertexID->getValue().getLimitedValue();
- if (cVertexID->getValue().isNegative()) {
- immVertexID = cVertexID->getValue().getSExtValue();
- }
- const int low = 0;
- int high = 0;
- if (props.IsGS()) {
- DXIL::InputPrimitive inputPrimitive =
- props.ShaderProps.GS.inputPrimitive;
- high = GetNumVertices(inputPrimitive);
- } else if (props.IsDS()) {
- high = props.ShaderProps.DS.inputControlPoints;
- } else if (props.IsHS()) {
- high = props.ShaderProps.HS.inputControlPoints;
- } else {
- ValCtx.EmitFormatError(ValidationRule::SmOpcodeInInvalidFunction,
- {"LoadInput", "VS/HS/DS/GS/PS"});
- }
- if (immVertexID < low || immVertexID >= high) {
- std::string range = std::to_string(low) + "~" + std::to_string(high);
- ValCtx.EmitOperandOutOfRange(CI, "VertexID", range,
- std::to_string(immVertexID));
- }
- }
- }
- } break;
- case DXIL::OpCode::DomainLocation: {
- Value *colValue =
- CI->getArgOperand(DXIL::OperandIndex::kDomainLocationColOpIdx);
- if (!isa<ConstantInt>(colValue)) {
- // col must be const
- ValCtx.EmitInstrFormatError(CI, ValidationRule::InstrOpConst,
- {"Col", "DomainLocation"});
- } else {
- unsigned col = cast<ConstantInt>(colValue)->getLimitedValue();
- if (col >= Status.domainLocSize) {
- ValCtx.EmitError(ValidationRule::SmDomainLocationIdxOOB);
- }
- }
- } break;
- case DXIL::OpCode::StoreOutput: {
- Value *outputID =
- CI->getArgOperand(DXIL::OperandIndex::kStoreOutputIDOpIdx);
- DxilSignature &outputSig = S.OutputSignature;
- Value *row = CI->getArgOperand(DXIL::OperandIndex::kStoreOutputRowOpIdx);
- Value *col = CI->getArgOperand(DXIL::OperandIndex::kStoreOutputColOpIdx);
- ValidateSignatureAccess(CI, outputSig, outputID, row, col, Status, ValCtx);
- } break;
- case DXIL::OpCode::OutputControlPointID: {
- // Only used in hull shader.
- Function *func = CI->getParent()->getParent();
- // Make sure this is inside hs shader entry function.
- if (!(props.IsHS() && F == func)) {
- ValCtx.EmitFormatError(ValidationRule::SmOpcodeInInvalidFunction,
- {"OutputControlPointID", "hull function"});
- }
- } break;
- case DXIL::OpCode::LoadOutputControlPoint: {
- // Only used in patch constant function.
- Function *func = CI->getParent()->getParent();
- if (ValCtx.entryFuncCallSet.count(func) > 0) {
- ValCtx.EmitFormatError(
- ValidationRule::SmOpcodeInInvalidFunction,
- {"LoadOutputControlPoint", "PatchConstant function"});
- }
- Value *outputID =
- CI->getArgOperand(DXIL::OperandIndex::kStoreOutputIDOpIdx);
- DxilSignature &outputSig = S.OutputSignature;
- Value *row = CI->getArgOperand(DXIL::OperandIndex::kStoreOutputRowOpIdx);
- Value *col = CI->getArgOperand(DXIL::OperandIndex::kStoreOutputColOpIdx);
- ValidateSignatureAccess(CI, outputSig, outputID, row, col, Status, ValCtx);
- } break;
- case DXIL::OpCode::StorePatchConstant: {
- // Only used in patch constant function.
- Function *func = CI->getParent()->getParent();
- if (!bIsPatchConstantFunc) {
- ValCtx.EmitFormatError(ValidationRule::SmOpcodeInInvalidFunction,
- {"StorePatchConstant", "PatchConstant function"});
- } else {
- auto &hullShaders = ValCtx.PatchConstantFuncMap[func];
- for (Function *F : hullShaders) {
- EntryStatus &Status = ValCtx.GetEntryStatus(F);
- DxilEntryProps &EntryProps = DM.GetDxilEntryProps(F);
- DxilEntrySignature &S = EntryProps.sig;
- Value *outputID =
- CI->getArgOperand(DXIL::OperandIndex::kStoreOutputIDOpIdx);
- DxilSignature &outputSig = S.PatchConstantSignature;
- Value *row =
- CI->getArgOperand(DXIL::OperandIndex::kStoreOutputRowOpIdx);
- Value *col =
- CI->getArgOperand(DXIL::OperandIndex::kStoreOutputColOpIdx);
- ValidateSignatureAccess(CI, outputSig, outputID, row, col, Status,
- ValCtx);
- }
- }
- } break;
- case DXIL::OpCode::Coverage:
- Status.m_bCoverageIn = true;
- break;
- case DXIL::OpCode::InnerCoverage:
- Status.m_bInnerCoverageIn = true;
- break;
- case DXIL::OpCode::ViewID:
- Status.hasViewID = true;
- break;
- case DXIL::OpCode::EvalCentroid:
- case DXIL::OpCode::EvalSampleIndex:
- case DXIL::OpCode::EvalSnapped: {
- // Eval* share same operand index with load input.
- Value *inputID = CI->getArgOperand(DXIL::OperandIndex::kLoadInputIDOpIdx);
- DxilSignature &inputSig = S.InputSignature;
- Value *row = CI->getArgOperand(DXIL::OperandIndex::kLoadInputRowOpIdx);
- Value *col = CI->getArgOperand(DXIL::OperandIndex::kLoadInputColOpIdx);
- DxilSignatureElement *pSE =
- ValidateSignatureAccess(CI, inputSig, inputID, row, col, Status, ValCtx);
- if (pSE) {
- switch (pSE->GetInterpolationMode()->GetKind()) {
- case DXIL::InterpolationMode::Linear:
- case DXIL::InterpolationMode::LinearNoperspective:
- case DXIL::InterpolationMode::LinearCentroid:
- case DXIL::InterpolationMode::LinearNoperspectiveCentroid:
- case DXIL::InterpolationMode::LinearSample:
- case DXIL::InterpolationMode::LinearNoperspectiveSample:
- break;
- default:
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrEvalInterpolationMode, {pSE->GetName()});
- break;
- }
- if (pSE->GetSemantic()->GetKind() == DXIL::SemanticKind::Position) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrCannotPullPosition,
- {ValCtx.DxilMod.GetShaderModel()->GetName()});
- }
- }
- } break;
- case DXIL::OpCode::AttributeAtVertex: {
- Value *Attribute = CI->getArgOperand(DXIL::OperandIndex::kBinarySrc0OpIdx);
- DxilSignature &inputSig = S.InputSignature;
- Value *row = CI->getArgOperand(DXIL::OperandIndex::kLoadInputRowOpIdx);
- Value *col = CI->getArgOperand(DXIL::OperandIndex::kLoadInputColOpIdx);
- DxilSignatureElement *pSE =
- ValidateSignatureAccess(CI, inputSig, Attribute, row, col, Status, ValCtx);
- if (pSE && pSE->GetInterpolationMode()->GetKind() !=
- hlsl::InterpolationMode::Kind::Constant) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrAttributeAtVertexNoInterpolation,
- {pSE->GetName()});
- }
- } break;
- case DXIL::OpCode::CutStream:
- case DXIL::OpCode::EmitThenCutStream:
- case DXIL::OpCode::EmitStream: {
- if (props.IsGS()) {
- auto &GS = props.ShaderProps.GS;
- unsigned streamMask = 0;
- for (size_t i = 0; i < _countof(GS.streamPrimitiveTopologies); ++i) {
- if (GS.streamPrimitiveTopologies[i] !=
- DXIL::PrimitiveTopology::Undefined) {
- streamMask |= 1 << i;
- }
- }
- Value *streamID =
- CI->getArgOperand(DXIL::OperandIndex::kStreamEmitCutIDOpIdx);
- if (ConstantInt *cStreamID = dyn_cast<ConstantInt>(streamID)) {
- int immStreamID = cStreamID->getValue().getLimitedValue();
- if (cStreamID->getValue().isNegative() || immStreamID >= 4) {
- ValCtx.EmitOperandOutOfRange(CI, "StreamID","0~4",
- std::to_string(immStreamID));
- } else {
- unsigned immMask = 1 << immStreamID;
- if ((streamMask & immMask) == 0) {
- std::string range;
- for (unsigned i = 0; i < 4; i++) {
- if (streamMask & (1 << i)) {
- range += std::to_string(i) + " ";
- }
- }
- ValCtx.EmitOperandOutOfRange(CI, "StreamID", range,
- std::to_string(immStreamID));
- }
- }
- } else {
- ValCtx.EmitInstrFormatError(CI, ValidationRule::InstrOpConst,
- {"StreamID", "Emit/CutStream"});
- }
- } else {
- ValCtx.EmitInstrFormatError(CI, ValidationRule::SmOpcodeInInvalidFunction,
- {"Emit/CutStream", "Geometry shader"});
- }
- } break;
- default:
- break;
- }
- if (Status.m_bCoverageIn && Status.m_bInnerCoverageIn) {
- ValCtx.EmitError(ValidationRule::SmPSCoverageAndInnerCoverage);
- }
- }
- static void ValidateImmOperandForMathDxilOp(CallInst *CI, DXIL::OpCode opcode,
- ValidationContext &ValCtx) {
- switch (opcode) {
- // Imm input value validation.
- case DXIL::OpCode::Asin: {
- DxilInst_Asin I(CI);
- if (ConstantFP *imm = dyn_cast<ConstantFP>(I.get_value())) {
- if (imm->getValueAPF().isInfinity()) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrNoIndefiniteAsin);
- }
- }
- } break;
- case DXIL::OpCode::Acos: {
- DxilInst_Acos I(CI);
- if (ConstantFP *imm = dyn_cast<ConstantFP>(I.get_value())) {
- if (imm->getValueAPF().isInfinity()) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrNoIndefiniteAcos);
- }
- }
- } break;
- case DXIL::OpCode::Log: {
- DxilInst_Log I(CI);
- if (ConstantFP *imm = dyn_cast<ConstantFP>(I.get_value())) {
- if (imm->getValueAPF().isInfinity()) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrNoIndefiniteLog);
- }
- }
- } break;
- case DXIL::OpCode::DerivFineX:
- case DXIL::OpCode::DerivFineY:
- case DXIL::OpCode::DerivCoarseX:
- case DXIL::OpCode::DerivCoarseY: {
- Value *V = CI->getArgOperand(DXIL::OperandIndex::kUnarySrc0OpIdx);
- if (ConstantFP *imm = dyn_cast<ConstantFP>(V)) {
- if (imm->getValueAPF().isInfinity()) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrNoIndefiniteDsxy);
- }
- }
- } break;
- default:
- break;
- }
- }
- static void ValidateResourceDxilOp(CallInst *CI, DXIL::OpCode opcode,
- ValidationContext &ValCtx) {
- switch (opcode) {
- case DXIL::OpCode::GetDimensions: {
- DxilInst_GetDimensions getDim(CI);
- Value *handle = getDim.get_handle();
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind =
- GetResourceKindAndCompTy(handle, compTy, resClass, resIndex, ValCtx);
- // Check the result component use.
- ResRetUsage usage;
- CollectGetDimResRetUsage(usage, CI, ValCtx);
- // Mip level only for texture.
- switch (resKind) {
- case DXIL::ResourceKind::Texture1D:
- if (usage.y) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"y", "Texture1D"});
- }
- if (usage.z) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"z", "Texture1D"});
- }
- break;
- case DXIL::ResourceKind::Texture1DArray:
- if (usage.z) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"z", "Texture1DArray"});
- }
- break;
- case DXIL::ResourceKind::Texture2D:
- if (usage.z) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"z", "Texture2D"});
- }
- break;
- case DXIL::ResourceKind::Texture2DArray:
- break;
- case DXIL::ResourceKind::Texture2DMS:
- if (usage.z) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"z", "Texture2DMS"});
- }
- break;
- case DXIL::ResourceKind::Texture2DMSArray:
- break;
- case DXIL::ResourceKind::Texture3D:
- break;
- case DXIL::ResourceKind::TextureCube:
- if (usage.z) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"z", "TextureCube"});
- }
- break;
- case DXIL::ResourceKind::TextureCubeArray:
- break;
- case DXIL::ResourceKind::StructuredBuffer:
- case DXIL::ResourceKind::RawBuffer:
- case DXIL::ResourceKind::TypedBuffer:
- case DXIL::ResourceKind::TBuffer: {
- Value *mip = getDim.get_mipLevel();
- if (!isa<UndefValue>(mip)) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrMipLevelForGetDimension);
- }
- if (resKind != DXIL::ResourceKind::Invalid) {
- if (usage.y || usage.z || usage.w) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"invalid", "resource"});
- }
- }
- } break;
- default: {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceKindForGetDim);
- } break;
- }
- if (usage.status) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrUndefResultForGetDimension,
- {"invalid", "resource"});
- }
- } break;
- case DXIL::OpCode::CalculateLOD: {
- DxilInst_CalculateLOD lod(CI);
- Value *samplerHandle = lod.get_sampler();
- if (GetSamplerKind(samplerHandle, ValCtx) != DXIL::SamplerKind::Default) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSamplerModeForLOD);
- }
- Value *handle = lod.get_handle();
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind =
- GetResourceKindAndCompTy(handle, compTy, resClass, resIndex, ValCtx);
- if (resClass != DXIL::ResourceClass::SRV) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrResourceClassForSamplerGather);
- return;
- }
- // Coord match resource.
- ValidateCalcLODResourceDimensionCoord(
- CI, resKind, {lod.get_coord0(), lod.get_coord1(), lod.get_coord2()},
- ValCtx);
- switch (resKind) {
- case DXIL::ResourceKind::Texture1D:
- case DXIL::ResourceKind::Texture1DArray:
- case DXIL::ResourceKind::Texture2D:
- case DXIL::ResourceKind::Texture2DArray:
- case DXIL::ResourceKind::Texture3D:
- case DXIL::ResourceKind::TextureCube:
- case DXIL::ResourceKind::TextureCubeArray:
- break;
- default:
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceKindForCalcLOD);
- break;
- }
- } break;
- case DXIL::OpCode::TextureGather: {
- DxilInst_TextureGather gather(CI);
- ValidateGather(CI, gather.get_srv(), gather.get_sampler(),
- {gather.get_coord0(), gather.get_coord1(),
- gather.get_coord2(), gather.get_coord3()},
- {gather.get_offset0(), gather.get_offset1()},
- /*IsSampleC*/ false, ValCtx);
- } break;
- case DXIL::OpCode::TextureGatherCmp: {
- DxilInst_TextureGatherCmp gather(CI);
- ValidateGather(CI, gather.get_srv(), gather.get_sampler(),
- {gather.get_coord0(), gather.get_coord1(),
- gather.get_coord2(), gather.get_coord3()},
- {gather.get_offset0(), gather.get_offset1()},
- /*IsSampleC*/ true, ValCtx);
- } break;
- case DXIL::OpCode::Sample: {
- DxilInst_Sample sample(CI);
- ValidateSampleInst(
- CI, sample.get_srv(), sample.get_sampler(),
- {sample.get_coord0(), sample.get_coord1(), sample.get_coord2(),
- sample.get_coord3()},
- {sample.get_offset0(), sample.get_offset1(), sample.get_offset2()},
- /*IsSampleC*/ false, ValCtx);
- } break;
- case DXIL::OpCode::SampleCmp: {
- DxilInst_SampleCmp sample(CI);
- ValidateSampleInst(
- CI, sample.get_srv(), sample.get_sampler(),
- {sample.get_coord0(), sample.get_coord1(), sample.get_coord2(),
- sample.get_coord3()},
- {sample.get_offset0(), sample.get_offset1(), sample.get_offset2()},
- /*IsSampleC*/ true, ValCtx);
- } break;
- case DXIL::OpCode::SampleCmpLevelZero: {
- // sampler must be comparison mode.
- DxilInst_SampleCmpLevelZero sample(CI);
- ValidateSampleInst(
- CI, sample.get_srv(), sample.get_sampler(),
- {sample.get_coord0(), sample.get_coord1(), sample.get_coord2(),
- sample.get_coord3()},
- {sample.get_offset0(), sample.get_offset1(), sample.get_offset2()},
- /*IsSampleC*/ true, ValCtx);
- } break;
- case DXIL::OpCode::SampleBias: {
- DxilInst_SampleBias sample(CI);
- Value *bias = sample.get_bias();
- if (ConstantFP *cBias = dyn_cast<ConstantFP>(bias)) {
- float fBias = cBias->getValueAPF().convertToFloat();
- if (fBias < DXIL::kMinMipLodBias || fBias > DXIL::kMaxMipLodBias) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrImmBiasForSampleB,
- {std::to_string(DXIL::kMinMipLodBias),
- std::to_string(DXIL::kMaxMipLodBias),
- std::to_string(cBias->getValueAPF().convertToFloat())});
- }
- }
- ValidateSampleInst(
- CI, sample.get_srv(), sample.get_sampler(),
- {sample.get_coord0(), sample.get_coord1(), sample.get_coord2(),
- sample.get_coord3()},
- {sample.get_offset0(), sample.get_offset1(), sample.get_offset2()},
- /*IsSampleC*/ false, ValCtx);
- } break;
- case DXIL::OpCode::SampleGrad: {
- DxilInst_SampleGrad sample(CI);
- ValidateSampleInst(
- CI, sample.get_srv(), sample.get_sampler(),
- {sample.get_coord0(), sample.get_coord1(), sample.get_coord2(),
- sample.get_coord3()},
- {sample.get_offset0(), sample.get_offset1(), sample.get_offset2()},
- /*IsSampleC*/ false, ValCtx);
- } break;
- case DXIL::OpCode::SampleLevel: {
- DxilInst_SampleLevel sample(CI);
- ValidateSampleInst(
- CI, sample.get_srv(), sample.get_sampler(),
- {sample.get_coord0(), sample.get_coord1(), sample.get_coord2(),
- sample.get_coord3()},
- {sample.get_offset0(), sample.get_offset1(), sample.get_offset2()},
- /*IsSampleC*/ false, ValCtx);
- } break;
- case DXIL::OpCode::CheckAccessFullyMapped: {
- Value *Src = CI->getArgOperand(DXIL::OperandIndex::kUnarySrc0OpIdx);
- ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(Src);
- if (!EVI) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrCheckAccessFullyMapped);
- } else {
- Value *V = EVI->getOperand(0);
- bool isLegal = EVI->getNumIndices() == 1 &&
- EVI->getIndices()[0] == DXIL::kResRetStatusIndex &&
- ValCtx.DxilMod.GetOP()->IsResRetType(V->getType());
- if (!isLegal) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrCheckAccessFullyMapped);
- }
- }
- } break;
- case DXIL::OpCode::BufferStore: {
- DxilInst_BufferStore bufSt(CI);
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind = GetResourceKindAndCompTy(
- bufSt.get_uav(), compTy, resClass, resIndex, ValCtx);
- if (resClass != DXIL::ResourceClass::UAV) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceClassForUAVStore);
- }
- ConstantInt *mask = dyn_cast<ConstantInt>(bufSt.get_mask());
- if (!mask) {
- // Mask for buffer store should be immediate.
- ValCtx.EmitInstrFormatError(CI, ValidationRule::InstrOpConst,
- {"Mask", "BufferStore"});
- return;
- }
- unsigned uMask = mask->getLimitedValue();
- unsigned stValMask =
- StoreValueToMask({bufSt.get_value0(), bufSt.get_value1(),
- bufSt.get_value2(), bufSt.get_value3()});
- if (stValMask != uMask) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrWriteMaskMatchValueForUAVStore,
- {std::to_string(uMask), std::to_string(stValMask)});
- }
- Value *offset = bufSt.get_coord1();
- switch (resKind) {
- case DXIL::ResourceKind::RawBuffer:
- if (!isa<UndefValue>(offset)) {
- ValCtx.EmitInstrError(
- CI, ValidationRule::InstrCoordinateCountForRawTypedBuf);
- }
- break;
- case DXIL::ResourceKind::TypedBuffer:
- case DXIL::ResourceKind::TBuffer:
- if (!isa<UndefValue>(offset)) {
- ValCtx.EmitInstrError(
- CI, ValidationRule::InstrCoordinateCountForRawTypedBuf);
- }
- if (uMask != 0xf) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrWriteMaskForTypedUAVStore);
- }
- break;
- case DXIL::ResourceKind::StructuredBuffer:
- if (isa<UndefValue>(offset)) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrCoordinateCountForStructBuf);
- }
- break;
- default:
- ValCtx.EmitInstrError(
- CI, ValidationRule::InstrResourceKindForBufferLoadStore);
- break;
- }
- } break;
- case DXIL::OpCode::TextureStore: {
- DxilInst_TextureStore texSt(CI);
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind = GetResourceKindAndCompTy(
- texSt.get_srv(), compTy, resClass, resIndex, ValCtx);
- if (resClass != DXIL::ResourceClass::UAV) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceClassForUAVStore);
- }
- ConstantInt *mask = dyn_cast<ConstantInt>(texSt.get_mask());
- if (!mask) {
- // Mask for buffer store should be immediate.
- ValCtx.EmitInstrFormatError(CI, ValidationRule::InstrOpConst,
- {"Mask", "TextureStore"});
- return;
- }
- unsigned uMask = mask->getLimitedValue();
- if (uMask != 0xf) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrWriteMaskForTypedUAVStore);
- }
- unsigned stValMask =
- StoreValueToMask({texSt.get_value0(), texSt.get_value1(),
- texSt.get_value2(), texSt.get_value3()});
- if (stValMask != uMask) {
- ValCtx.EmitInstrFormatError(
- CI, ValidationRule::InstrWriteMaskMatchValueForUAVStore,
- {std::to_string(uMask), std::to_string(stValMask)});
- }
- switch (resKind) {
- case DXIL::ResourceKind::Texture1D:
- case DXIL::ResourceKind::Texture1DArray:
- case DXIL::ResourceKind::Texture2D:
- case DXIL::ResourceKind::Texture2DArray:
- case DXIL::ResourceKind::Texture3D:
- break;
- default:
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrResourceKindForTextureStore);
- break;
- }
- } break;
- case DXIL::OpCode::BufferLoad: {
- DxilInst_BufferLoad bufLd(CI);
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind = GetResourceKindAndCompTy(
- bufLd.get_srv(), compTy, resClass, resIndex, ValCtx);
- if (resClass != DXIL::ResourceClass::SRV &&
- resClass != DXIL::ResourceClass::UAV) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceClassForLoad);
- }
- Value *offset = bufLd.get_wot();
- switch (resKind) {
- case DXIL::ResourceKind::RawBuffer:
- case DXIL::ResourceKind::TypedBuffer:
- case DXIL::ResourceKind::TBuffer:
- if (!isa<UndefValue>(offset)) {
- ValCtx.EmitInstrError(
- CI, ValidationRule::InstrCoordinateCountForRawTypedBuf);
- }
- break;
- case DXIL::ResourceKind::StructuredBuffer:
- if (isa<UndefValue>(offset)) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrCoordinateCountForStructBuf);
- }
- break;
- default:
- ValCtx.EmitInstrError(
- CI, ValidationRule::InstrResourceKindForBufferLoadStore);
- break;
- }
- } break;
- case DXIL::OpCode::TextureLoad: {
- DxilInst_TextureLoad texLd(CI);
- DXIL::ComponentType compTy;
- DXIL::ResourceClass resClass;
- unsigned resIndex;
- DXIL::ResourceKind resKind = GetResourceKindAndCompTy(
- texLd.get_srv(), compTy, resClass, resIndex, ValCtx);
- Value *mipLevel = texLd.get_mipLevelOrSampleCount();
- if (resClass == DXIL::ResourceClass::UAV) {
- bool noOffset = isa<UndefValue>(texLd.get_offset0());
- noOffset &= isa<UndefValue>(texLd.get_offset1());
- noOffset &= isa<UndefValue>(texLd.get_offset2());
- if (!noOffset) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrOffsetOnUAVLoad);
- }
- if (!isa<UndefValue>(mipLevel)) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrMipOnUAVLoad);
- }
- } else {
- if (resClass != DXIL::ResourceClass::SRV) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrResourceClassForLoad);
- }
- }
- switch (resKind) {
- case DXIL::ResourceKind::Texture1D:
- case DXIL::ResourceKind::Texture1DArray:
- case DXIL::ResourceKind::Texture2D:
- case DXIL::ResourceKind::Texture2DArray:
- case DXIL::ResourceKind::Texture3D:
- break;
- case DXIL::ResourceKind::Texture2DMS:
- case DXIL::ResourceKind::Texture2DMSArray: {
- if (isa<UndefValue>(mipLevel)) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrSampleIndexForLoad2DMS);
- }
- } break;
- default:
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrResourceKindForTextureLoad);
- break;
- }
- } break;
- case DXIL::OpCode::CBufferLoad: {
- DxilInst_CBufferLoad CBLoad(CI);
- Value *regIndex = CBLoad.get_byteOffset();
- if (ConstantInt *cIndex = dyn_cast<ConstantInt>(regIndex)) {
- int offset = cIndex->getLimitedValue();
- int size = GetCBufSize(CBLoad.get_handle(), ValCtx);
- if (size > 0 && offset >= size) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrCBufferOutOfBound);
- }
- }
- } break;
- case DXIL::OpCode::CBufferLoadLegacy: {
- DxilInst_CBufferLoadLegacy CBLoad(CI);
- Value *regIndex = CBLoad.get_regIndex();
- if (ConstantInt *cIndex = dyn_cast<ConstantInt>(regIndex)) {
- int offset = cIndex->getLimitedValue() * 16; // 16 bytes align
- int size = GetCBufSize(CBLoad.get_handle(), ValCtx);
- if (size > 0 && offset >= size) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrCBufferOutOfBound);
- }
- }
- } break;
- default:
- break;
- }
- }
- static void ValidateDxilOperationCallInProfile(CallInst *CI,
- DXIL::OpCode opcode,
- const ShaderModel *pSM,
- ValidationContext &ValCtx) {
- switch (opcode) {
- // Imm input value validation.
- case DXIL::OpCode::Asin:
- case DXIL::OpCode::Acos:
- case DXIL::OpCode::Log:
- case DXIL::OpCode::DerivFineX:
- case DXIL::OpCode::DerivFineY:
- case DXIL::OpCode::DerivCoarseX:
- case DXIL::OpCode::DerivCoarseY:
- ValidateImmOperandForMathDxilOp(CI, opcode, ValCtx);
- break;
- // Resource validation.
- case DXIL::OpCode::GetDimensions:
- case DXIL::OpCode::CalculateLOD:
- case DXIL::OpCode::TextureGather:
- case DXIL::OpCode::TextureGatherCmp:
- case DXIL::OpCode::Sample:
- case DXIL::OpCode::SampleCmp:
- case DXIL::OpCode::SampleCmpLevelZero:
- case DXIL::OpCode::SampleBias:
- case DXIL::OpCode::SampleGrad:
- case DXIL::OpCode::SampleLevel:
- case DXIL::OpCode::CheckAccessFullyMapped:
- case DXIL::OpCode::BufferStore:
- case DXIL::OpCode::TextureStore:
- case DXIL::OpCode::BufferLoad:
- case DXIL::OpCode::TextureLoad:
- case DXIL::OpCode::CBufferLoad:
- case DXIL::OpCode::CBufferLoadLegacy:
- ValidateResourceDxilOp(CI, opcode, ValCtx);
- break;
- // Input output.
- case DXIL::OpCode::LoadInput:
- case DXIL::OpCode::DomainLocation:
- case DXIL::OpCode::StoreOutput:
- case DXIL::OpCode::OutputControlPointID:
- case DXIL::OpCode::LoadOutputControlPoint:
- case DXIL::OpCode::StorePatchConstant:
- case DXIL::OpCode::Coverage:
- case DXIL::OpCode::InnerCoverage:
- case DXIL::OpCode::ViewID:
- case DXIL::OpCode::EvalCentroid:
- case DXIL::OpCode::EvalSampleIndex:
- case DXIL::OpCode::EvalSnapped:
- case DXIL::OpCode::AttributeAtVertex:
- case DXIL::OpCode::EmitStream:
- case DXIL::OpCode::EmitThenCutStream:
- case DXIL::OpCode::CutStream:
- ValidateSignatureDxilOp(CI, opcode, ValCtx);
- break;
- // Special.
- case DXIL::OpCode::BufferUpdateCounter: {
- DxilInst_BufferUpdateCounter updateCounter(CI);
- DxilResource *res = GetResource(updateCounter.get_uav(), ValCtx);
- if (!res) {
- return;
- }
- if (res->GetClass() != DXIL::ResourceClass::UAV) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrBufferUpdateCounterOnUAV);
- }
- if (res->GetKind() != DXIL::ResourceKind::StructuredBuffer) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::SmCounterOnlyOnStructBuf);
- }
- if (!res->HasCounter()) {
- // TODO: Must has counter to run UpdateCounter.
- }
- Value *inc = updateCounter.get_inc();
- if (ConstantInt *cInc = dyn_cast<ConstantInt>(inc)) {
- bool isInc = cInc->getLimitedValue() == 1;
- if (!ValCtx.isLibProfile) {
- unsigned resIndex = res->GetLowerBound();
- if (ValCtx.UavCounterIncMap.count(resIndex)) {
- if (isInc != ValCtx.UavCounterIncMap[resIndex]) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrOnlyOneAllocConsume);
- }
- } else {
- ValCtx.UavCounterIncMap[resIndex] = isInc;
- }
- } else {
- // TODO: validate ValidationRule::InstrOnlyOneAllocConsume for lib
- // profile.
- }
- } else {
- ValCtx.EmitInstrFormatError(CI, ValidationRule::InstrOpConst, {"inc", "BufferUpdateCounter"});
- }
- } break;
- case DXIL::OpCode::Barrier: {
- DxilInst_Barrier barrier(CI);
- Value *mode = barrier.get_barrierMode();
- ConstantInt *cMode = dyn_cast<ConstantInt>(mode);
- if (!cMode) {
- ValCtx.EmitInstrFormatError(CI, ValidationRule::InstrOpConst,
- {"Mode", "Barrier"});
- return;
- }
- const unsigned uglobal =
- static_cast<unsigned>(DXIL::BarrierMode::UAVFenceGlobal);
- const unsigned g = static_cast<unsigned>(DXIL::BarrierMode::TGSMFence);
- const unsigned t =
- static_cast<unsigned>(DXIL::BarrierMode::SyncThreadGroup);
- const unsigned ut =
- static_cast<unsigned>(DXIL::BarrierMode::UAVFenceThreadGroup);
- unsigned barrierMode = cMode->getLimitedValue();
- if (ValCtx.DxilMod.GetShaderModel()->IsCS()) {
- bool bHasUGlobal = barrierMode & uglobal;
- bool bHasGroup = barrierMode & g;
- bool bHasUGroup = barrierMode & ut;
- if (bHasUGlobal && bHasUGroup) {
- ValCtx.EmitInstrError(CI,
- ValidationRule::InstrBarrierModeUselessUGroup);
- }
- if (!bHasUGlobal && !bHasGroup && !bHasUGroup) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrBarrierModeNoMemory);
- }
- } else if (!ValCtx.isLibProfile) {
- if (uglobal != barrierMode) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrBarrierModeForNonCS);
- }
- }
- } break;
- case DXIL::OpCode::QuadOp:
- if (!pSM->IsPS() && !ValCtx.isLibProfile)
- ValCtx.EmitFormatError(ValidationRule::SmOpcodeInInvalidFunction,
- {"QuadReadAcross", "Pixel Shader"});
- break;
- case DXIL::OpCode::QuadReadLaneAt:
- if (!pSM->IsPS() && !ValCtx.isLibProfile)
- ValCtx.EmitFormatError(ValidationRule::SmOpcodeInInvalidFunction,
- {"QuadReadLaneAt", "Pixel Shader"});
- break;
- case DXIL::OpCode::CreateHandleForLib:
- if (!ValCtx.isLibProfile) {
- ValCtx.EmitFormatError(ValidationRule::SmOpcodeInInvalidFunction,
- {"CreateHandleForLib", "Library"});
- }
- break;
- default:
- // TODO: make sure every opcode is checked.
- // Skip opcodes don't need special check.
- break;
- }
- }
- static bool IsDxilFunction(llvm::Function *F) {
- unsigned argSize = F->arg_size();
- if (argSize < 1) {
- // Cannot be a DXIL operation.
- return false;
- }
- return OP::IsDxilOpFunc(F);
- }
- static void ValidateExternalFunction(Function *F, ValidationContext &ValCtx) {
- if (!IsDxilFunction(F) && !ValCtx.isLibProfile) {
- ValCtx.EmitGlobalValueError(F, ValidationRule::DeclDxilFnExtern);
- return;
- }
- if (F->use_empty()) {
- ValCtx.EmitGlobalValueError(F, ValidationRule::DeclUsedExternalFunction);
- return;
- }
- const ShaderModel *pSM = ValCtx.DxilMod.GetShaderModel();
- OP *hlslOP = ValCtx.DxilMod.GetOP();
- bool isDxilOp = OP::IsDxilOpFunc(F);
- Type *voidTy = Type::getVoidTy(F->getContext());
- for (User *user : F->users()) {
- CallInst *CI = dyn_cast<CallInst>(user);
- if (!CI) {
- ValCtx.EmitGlobalValueError(F, ValidationRule::DeclFnIsCalled);
- continue;
- }
- // Skip call to external user defined function
- if (!isDxilOp)
- continue;
- Value *argOpcode = CI->getArgOperand(0);
- ConstantInt *constOpcode = dyn_cast<ConstantInt>(argOpcode);
- if (!constOpcode) {
- // opcode not immediate; function body will validate this error.
- continue;
- }
- unsigned opcode = constOpcode->getLimitedValue();
- if (opcode >= (unsigned)DXIL::OpCode::NumOpCodes) {
- // invalid opcode; function body will validate this error.
- continue;
- }
- DXIL::OpCode dxilOpcode = (DXIL::OpCode)opcode;
- // In some cases, no overloads are provided (void is exclusive to others)
- Function *dxilFunc;
- if (hlslOP->IsOverloadLegal(dxilOpcode, voidTy)) {
- dxilFunc = hlslOP->GetOpFunc(dxilOpcode, voidTy);
- }
- else {
- Type *Ty = hlslOP->GetOverloadType(dxilOpcode, CI->getCalledFunction());
- try {
- if (!hlslOP->IsOverloadLegal(dxilOpcode, Ty)) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrOload);
- continue;
- }
- }
- catch (...) {
- ValCtx.EmitInstrError(CI, ValidationRule::InstrOload);
- continue;
- }
- dxilFunc = hlslOP->GetOpFunc(dxilOpcode, Ty->getScalarType());
- }
- if (!dxilFunc) {
- // Cannot find dxilFunction based on opcode and type.
- ValCtx.EmitInstrError(CI, ValidationRule::InstrOload);
- continue;
- }
- if (dxilFunc->getFunctionType() != F->getFunctionType()) {
- ValCtx.EmitGlobalValueError(dxilFunc, ValidationRule::InstrCallOload);
- continue;
- }
- if (!ValCtx.isLibProfile && !ValidateOpcodeInProfile(dxilOpcode, pSM)) {
- // Opcode not available in profile.
- ValCtx.EmitInstrFormatError(CI, ValidationRule::SmOpcode,
- {hlslOP->GetOpCodeName(dxilOpcode),
- pSM->GetName()});
- continue;
- }
- // Check more detail.
- ValidateDxilOperationCallInProfile(CI, dxilOpcode, pSM, ValCtx);
- }
- }
- ///////////////////////////////////////////////////////////////////////////////
- // Instruction validation functions. //
- static bool IsLLVMInstructionAllowed(llvm::Instruction &I) {
- unsigned op = I.getOpcode();
- /* <py::lines('OPCODE-ALLOWED')>hctdb_instrhelp.get_instrs_pred("op", lambda i: not i.is_dxil_op and i.is_allowed, "llvm_id")</py>*/
- // OPCODE-ALLOWED:BEGIN
- // Instructions: Ret=1, Br=2, Switch=3, Add=8, FAdd=9, Sub=10, FSub=11, Mul=12,
- // FMul=13, UDiv=14, SDiv=15, FDiv=16, URem=17, SRem=18, FRem=19, Shl=20,
- // LShr=21, AShr=22, And=23, Or=24, Xor=25, Alloca=26, Load=27, Store=28,
- // GetElementPtr=29, AtomicCmpXchg=31, AtomicRMW=32, Trunc=33, ZExt=34,
- // SExt=35, FPToUI=36, FPToSI=37, UIToFP=38, SIToFP=39, FPTrunc=40, FPExt=41,
- // BitCast=44, AddrSpaceCast=45, ICmp=46, FCmp=47, PHI=48, Call=49, Select=50,
- // ExtractValue=57
- return (1 <= op && op <= 3) || (8 <= op && op <= 29) || (31 <= op && op <= 41) || (44 <= op && op <= 50) || op == 57;
- // OPCODE-ALLOWED:END
- }
- static bool IsDxilBuiltinStructType(StructType *ST, hlsl::OP *hlslOP) {
- if (ST == hlslOP->GetBinaryWithCarryType())
- return true;
- if (ST == hlslOP->GetBinaryWithTwoOutputsType())
- return true;
- if (ST == hlslOP->GetInt4Type())
- return true;
- if (ST == hlslOP->GetDimensionsType())
- return true;
- if (ST == hlslOP->GetHandleType())
- return true;
- if (ST == hlslOP->GetSamplePosType())
- return true;
- if (ST == hlslOP->GetSplitDoubleType())
- return true;
- unsigned EltNum = ST->getNumElements();
- switch (EltNum) {
- case 2:
- case 4:
- case 8: { // 2 for doubles, 8 for halfs.
- Type *EltTy = ST->getElementType(0);
- return ST == hlslOP->GetCBufferRetType(EltTy);
- } break;
- case 5: {
- Type *EltTy = ST->getElementType(0);
- return ST == hlslOP->GetResRetType(EltTy);
- } break;
- default:
- return false;
- }
- }
- static bool ValidateType(Type *Ty, ValidationContext &ValCtx) {
- DXASSERT_NOMSG(Ty != nullptr);
- if (Ty->isPointerTy()) {
- return ValidateType(Ty->getPointerElementType(), ValCtx);
- }
- if (Ty->isArrayTy()) {
- Type *EltTy = Ty->getArrayElementType();
- if (isa<ArrayType>(EltTy)) {
- ValCtx.EmitTypeError(Ty, ValidationRule::TypesNoMultiDim);
- return false;
- }
- return ValidateType(EltTy, ValCtx);
- }
- if (Ty->isStructTy()) {
- bool result = true;
- StructType *ST = cast<StructType>(Ty);
- StringRef Name = ST->getName();
- if (Name.startswith("dx.")) {
- hlsl::OP *hlslOP = ValCtx.DxilMod.GetOP();
- if (IsDxilBuiltinStructType(ST, hlslOP)) {
- ValCtx.EmitTypeError(Ty, ValidationRule::InstrDxilStructUser);
- result = false;
- }
- ValCtx.EmitTypeError(Ty, ValidationRule::DeclDxilNsReserved);
- result = false;
- }
- for (auto e : ST->elements()) {
- if (!ValidateType(e, ValCtx)) {
- result = false;
- }
- }
- return result;
- }
- if (Ty->isFloatTy() || Ty->isHalfTy() || Ty->isDoubleTy()) {
- return true;
- }
- if (Ty->isIntegerTy()) {
- unsigned width = Ty->getIntegerBitWidth();
- if (width != 1 && width != 8 && width != 16 && width != 32 && width != 64) {
- ValCtx.EmitTypeError(Ty, ValidationRule::TypesIntWidth);
- return false;
- }
- return true;
- }
- // Lib profile allow all types except those hit ValidationRule::InstrDxilStructUser.
- if (ValCtx.isLibProfile)
- return true;
- if (Ty->isVectorTy()) {
- ValCtx.EmitTypeError(Ty, ValidationRule::TypesNoVector);
- return false;
- }
- ValCtx.EmitTypeError(Ty, ValidationRule::TypesDefined);
- return false;
- }
- static bool GetNodeOperandAsInt(ValidationContext &ValCtx, MDNode *pMD, unsigned index, uint64_t *pValue) {
- *pValue = 0;
- if (pMD->getNumOperands() < index) {
- ValCtx.EmitMetaError(pMD, ValidationRule::MetaWellFormed);
- return false;
- }
- ConstantAsMetadata *C = dyn_cast<ConstantAsMetadata>(pMD->getOperand(index));
- if (C == nullptr) {
- ValCtx.EmitMetaError(pMD, ValidationRule::MetaWellFormed);
- return false;
- }
- ConstantInt *CI = dyn_cast<ConstantInt>(C->getValue());
- if (CI == nullptr) {
- ValCtx.EmitMetaError(pMD, ValidationRule::MetaWellFormed);
- return false;
- }
- *pValue = CI->getValue().getZExtValue();
- return true;
- }
- static bool IsPrecise(Instruction &I, ValidationContext &ValCtx) {
- MDNode *pMD = I.getMetadata(DxilMDHelper::kDxilPreciseAttributeMDName);
- if (pMD == nullptr) {
- return false;
- }
- if (pMD->getNumOperands() != 1) {
- ValCtx.EmitMetaError(pMD, ValidationRule::MetaWellFormed);
- return false;
- }
- uint64_t val;
- if (!GetNodeOperandAsInt(ValCtx, pMD, 0, &val)) {
- return false;
- }
- if (val == 1) {
- return true;
- }
- if (val != 0) {
- ValCtx.EmitMetaError(pMD, ValidationRule::MetaValueRange);
- }
- return false;
- }
- static bool IsValueMinPrec(DxilModule &DxilMod, Value *V) {
- DXASSERT(DxilMod.GetGlobalFlags() & DXIL::kEnableMinPrecision,
- "else caller didn't check - currently this path should never be hit "
- "otherwise");
- (void)(DxilMod);
- Type *Ty = V->getType();
- if (Ty->isIntegerTy()) {
- return 16 == Ty->getIntegerBitWidth();
- }
- return Ty->isHalfTy();
- }
- static void ValidateGradientOps(Function *F, ArrayRef<CallInst *> ops, ArrayRef<CallInst *> barriers, ValidationContext &ValCtx) {
- // In the absence of wave operations, the wave validation effect need not happen.
- // We haven't verified this is true at this point, but validation will fail
- // later if the flags don't match in any case. Given that most shaders will
- // not be using these wave operations, it's a reasonable cost saving.
- if (!ValCtx.DxilMod.m_ShaderFlags.GetWaveOps()) {
- return;
- }
- std::unique_ptr<WaveSensitivityAnalysis> WaveVal(WaveSensitivityAnalysis::create());
- WaveVal->Analyze(F);
- for (CallInst *op : ops) {
- if (WaveVal->IsWaveSensitive(op)) {
- ValCtx.EmitInstrError(op, ValidationRule::UniNoWaveSensitiveGradient);
- }
- }
- }
- static void ValidateControlFlowHint(BasicBlock &bb, ValidationContext &ValCtx) {
- // Validate controlflow hint.
- TerminatorInst *TI = bb.getTerminator();
- if (!TI)
- return;
- MDNode *pNode = TI->getMetadata(DxilMDHelper::kDxilControlFlowHintMDName);
- if (!pNode)
- return;
- if (pNode->getNumOperands() < 3)
- return;
- bool bHasBranch = false;
- bool bHasFlatten = false;
- bool bForceCase = false;
- for (unsigned i = 2; i < pNode->getNumOperands(); i++) {
- uint64_t value = 0;
- if (GetNodeOperandAsInt(ValCtx, pNode, i, &value)) {
- DXIL::ControlFlowHint hint = static_cast<DXIL::ControlFlowHint>(value);
- switch (hint) {
- case DXIL::ControlFlowHint::Flatten:
- bHasFlatten = true;
- break;
- case DXIL::ControlFlowHint::Branch:
- bHasBranch = true;
- break;
- case DXIL::ControlFlowHint::ForceCase:
- bForceCase = true;
- break;
- default:
- ValCtx.EmitMetaError(pNode,
- ValidationRule::MetaInvalidControlFlowHint);
- }
- }
- }
- if (bHasBranch && bHasFlatten) {
- ValCtx.EmitMetaError(pNode, ValidationRule::MetaBranchFlatten);
- }
- if (bForceCase && !isa<SwitchInst>(TI)) {
- ValCtx.EmitMetaError(pNode, ValidationRule::MetaForceCaseOnSwitch);
- }
- }
- static void ValidateTBAAMetadata(MDNode *Node, ValidationContext &ValCtx) {
- switch (Node->getNumOperands()) {
- case 1: {
- if (Node->getOperand(0)->getMetadataID() != Metadata::MDStringKind) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- }
- } break;
- case 2: {
- MDNode *rootNode = dyn_cast<MDNode>(Node->getOperand(1));
- if (!rootNode) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- } else {
- ValidateTBAAMetadata(rootNode, ValCtx);
- }
- } break;
- case 3: {
- MDNode *rootNode = dyn_cast<MDNode>(Node->getOperand(1));
- if (!rootNode) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- } else {
- ValidateTBAAMetadata(rootNode, ValCtx);
- }
- ConstantAsMetadata *pointsToConstMem = dyn_cast<ConstantAsMetadata>(Node->getOperand(2));
- if (!pointsToConstMem) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- } else {
- ConstantInt *isConst = dyn_cast<ConstantInt>(pointsToConstMem->getValue());
- if (!isConst) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- } else if (isConst->getValue().getLimitedValue() > 1) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- }
- }
- } break;
- default:
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- }
- }
- static void ValidateLoopMetadata(MDNode *Node, ValidationContext &ValCtx) {
- if (Node->getNumOperands() == 0 || Node->getNumOperands() > 2) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- return;
- }
- if (Node != Node->getOperand(0).get()) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- return;
- }
- if (Node->getNumOperands() == 1) {
- return;
- }
- MDNode *LoopNode = dyn_cast<MDNode>(Node->getOperand(1).get());
- if (!LoopNode) {
- ValCtx.EmitMetaError(Node, ValidationRule::MetaWellFormed);
- return;
- }
- if (LoopNode->getNumOperands() < 1 || LoopNode->getNumOperands() > 2) {
- ValCtx.EmitMetaError(LoopNode, ValidationRule::MetaWellFormed);
- return;
- }
- if (LoopNode->getOperand(0) == LoopNode) {
- ValidateLoopMetadata(LoopNode, ValCtx);
- return;
- }
- MDString *LoopStr = dyn_cast<MDString>(LoopNode->getOperand(0));
- if (!LoopStr) {
- ValCtx.EmitMetaError(LoopNode, ValidationRule::MetaWellFormed);
- return;
- }
- StringRef Name = LoopStr->getString();
- if (Name != "llvm.loop.unroll.full" && Name != "llvm.loop.unroll.disable" &&
- Name != "llvm.loop.unroll.count") {
- ValCtx.EmitMetaError(LoopNode, ValidationRule::MetaWellFormed);
- return;
- }
- if (Name == "llvm.loop.unroll.count") {
- if (LoopNode->getNumOperands() != 2) {
- ValCtx.EmitMetaError(LoopNode, ValidationRule::MetaWellFormed);
- return;
- }
- ConstantAsMetadata *CountNode =
- dyn_cast<ConstantAsMetadata>(LoopNode->getOperand(1));
- if (!CountNode) {
- ValCtx.EmitMetaError(LoopNode, ValidationRule::MetaWellFormed);
- } else {
- ConstantInt *Count = dyn_cast<ConstantInt>(CountNode->getValue());
- if (!Count) {
- ValCtx.EmitMetaError(CountNode, ValidationRule::MetaWellFormed);
- }
- }
- }
- }
- static void ValidateInstructionMetadata(Instruction *I,
- ValidationContext &ValCtx) {
- SmallVector<std::pair<unsigned, MDNode *>, 2> MDNodes;
- I->getAllMetadataOtherThanDebugLoc(MDNodes);
- for (auto &MD : MDNodes) {
- if (MD.first == ValCtx.kDxilControlFlowHintMDKind) {
- if (!isa<TerminatorInst>(I)) {
- ValCtx.EmitInstrError(
- I, ValidationRule::MetaControlFlowHintNotOnControlFlow);
- }
- } else if (MD.first == ValCtx.kDxilPreciseMDKind) {
- // Validated in IsPrecise.
- } else if (MD.first == ValCtx.kLLVMLoopMDKind) {
- ValidateLoopMetadata(MD.second, ValCtx);
- } else if (MD.first == LLVMContext::MD_tbaa) {
- ValidateTBAAMetadata(MD.second, ValCtx);
- } else if (MD.first == LLVMContext::MD_range) {
- // Validated in Verifier.cpp.
- } else if (MD.first == LLVMContext::MD_noalias ||
- MD.first == LLVMContext::MD_alias_scope) {
- // noalias for DXIL validator >= 1.2
- } else {
- ValCtx.EmitMetaError(MD.second, ValidationRule::MetaUsed);
- }
- }
- }
- static void ValidateFunctionAttribute(Function *F, ValidationContext &ValCtx) {
- AttributeSet attrSet = F->getAttributes().getFnAttributes();
- // fp32-denorm-mode
- if (attrSet.hasAttribute(AttributeSet::FunctionIndex,
- DXIL::kFP32DenormKindString)) {
- Attribute attr = attrSet.getAttribute(AttributeSet::FunctionIndex,
- DXIL::kFP32DenormKindString);
- StringRef value = attr.getValueAsString();
- if (!value.equals(DXIL::kFP32DenormValueAnyString) &&
- !value.equals(DXIL::kFP32DenormValueFtzString) &&
- !value.equals(DXIL::kFP32DenormValuePreserveString)) {
- ValCtx.EmitFnAttributeError(F, attr.getKindAsString(),
- attr.getValueAsString());
- }
- }
- // TODO: If validating libraries, we should remove all unknown function attributes.
- // For each attribute, check if it is a known attribute
- for (unsigned I = 0, E = attrSet.getNumSlots(); I != E; ++I) {
- for (auto AttrIter = attrSet.begin(I), AttrEnd = attrSet.end(I);
- AttrIter != AttrEnd; ++AttrIter) {
- if (!AttrIter->isStringAttribute()) {
- continue;
- }
- StringRef kind = AttrIter->getKindAsString();
- if (!kind.equals(DXIL::kFP32DenormKindString)) {
- ValCtx.EmitFnAttributeError(F, AttrIter->getKindAsString(),
- AttrIter->getValueAsString());
- }
- }
- }
- }
- static void ValidateFunctionMetadata(Function *F, ValidationContext &ValCtx) {
- SmallVector<std::pair<unsigned, MDNode *>, 2> MDNodes;
- F->getAllMetadata(MDNodes);
- for (auto &MD : MDNodes) {
- ValCtx.EmitMetaError(MD.second, ValidationRule::MetaUsed);
- }
- }
- static bool IsLLVMInstructionAllowedForLib(Instruction &I, ValidationContext &ValCtx) {
- if (!ValCtx.isLibProfile)
- return false;
- switch (I.getOpcode()) {
- case Instruction::InsertElement:
- case Instruction::ExtractElement:
- case Instruction::ShuffleVector:
- return true;
- case Instruction::Unreachable:
- if (Instruction *Prev = I.getPrevNode()) {
- if (CallInst *CI = dyn_cast<CallInst>(Prev)) {
- Function *F = CI->getCalledFunction();
- if (IsDxilFunction(F) &&
- F->hasFnAttribute(Attribute::AttrKind::NoReturn)) {
- return true;
- }
- }
- }
- return false;
- default:
- return false;
- }
- }
- static void ValidateFunctionBody(Function *F, ValidationContext &ValCtx) {
- bool SupportsMinPrecision =
- ValCtx.DxilMod.GetGlobalFlags() & DXIL::kEnableMinPrecision;
- SmallVector<CallInst *, 16> gradientOps;
- SmallVector<CallInst *, 16> barriers;
- for (auto b = F->begin(), bend = F->end(); b != bend; ++b) {
- for (auto i = b->begin(), iend = b->end(); i != iend; ++i) {
- llvm::Instruction &I = *i;
- if (I.hasMetadata()) {
- ValidateInstructionMetadata(&I, ValCtx);
- }
- // Instructions must be allowed.
- if (!IsLLVMInstructionAllowed(I)) {
- if (!IsLLVMInstructionAllowedForLib(I, ValCtx)) {
- ValCtx.EmitInstrError(&I, ValidationRule::InstrAllowed);
- continue;
- }
- }
- // Instructions marked precise may not have minprecision arguments.
- if (SupportsMinPrecision) {
- if (IsPrecise(I, ValCtx)) {
- for (auto &O : I.operands()) {
- if (IsValueMinPrec(ValCtx.DxilMod, O)) {
- ValCtx.EmitInstrError(
- &I, ValidationRule::InstrMinPrecisionNotPrecise);
- break;
- }
- }
- }
- }
- // Calls to external functions.
- CallInst *CI = dyn_cast<CallInst>(&I);
- if (CI) {
- Function *FCalled = CI->getCalledFunction();
- if (FCalled->isDeclaration()) {
- // External function validation will diagnose.
- if (!IsDxilFunction(FCalled)) {
- continue;
- }
- Value *opcodeVal = CI->getOperand(0);
- ConstantInt *OpcodeConst = dyn_cast<ConstantInt>(opcodeVal);
- if (OpcodeConst == nullptr) {
- ValCtx.EmitInstrFormatError(&I, ValidationRule::InstrOpConst,
- {"Opcode", "DXIL operation"});
- continue;
- }
- unsigned opcode = OpcodeConst->getLimitedValue();
- DXIL::OpCode dxilOpcode = (DXIL::OpCode)opcode;
- if (OP::IsDxilOpGradient(dxilOpcode)) {
- gradientOps.push_back(CI);
- }
- if (dxilOpcode == DXIL::OpCode::Barrier) {
- barriers.push_back(CI);
- }
- // External function validation will check the parameter
- // list. This function will check that the call does not
- // violate any rules.
- }
- continue;
- }
- for (Value *op : I.operands()) {
- if (isa<UndefValue>(op)) {
- bool legalUndef = isa<PHINode>(&I);
- if (InsertElementInst *InsertInst = dyn_cast<InsertElementInst>(&I)) {
- legalUndef = op == I.getOperand(0);
- }
- if (ShuffleVectorInst *Shuf = dyn_cast<ShuffleVectorInst>(&I)) {
- legalUndef = op == I.getOperand(1);
- }
- if (!legalUndef)
- ValCtx.EmitInstrError(&I,
- ValidationRule::InstrNoReadingUninitialized);
- } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(op)) {
- for (Value *opCE : CE->operands()) {
- if (isa<UndefValue>(opCE)) {
- ValCtx.EmitInstrError(
- &I, ValidationRule::InstrNoReadingUninitialized);
- }
- }
- }
- if (IntegerType *IT = dyn_cast<IntegerType>(op->getType())) {
- if (IT->getBitWidth() == 8) {
- ValCtx.EmitInstrError(&I, ValidationRule::TypesI8);
- }
- }
- }
- Type *Ty = I.getType();
- if (isa<PointerType>(Ty))
- Ty = Ty->getPointerElementType();
- while (isa<ArrayType>(Ty))
- Ty = Ty->getArrayElementType();
- if (IntegerType *IT = dyn_cast<IntegerType>(Ty)) {
- if (IT->getBitWidth() == 8) {
- ValCtx.EmitInstrError(&I, ValidationRule::TypesI8);
- }
- }
- unsigned opcode = I.getOpcode();
- switch (opcode) {
- case Instruction::Alloca: {
- AllocaInst *AI = cast<AllocaInst>(&I);
- // TODO: validate address space and alignment
- Type *Ty = AI->getAllocatedType();
- if (!ValidateType(Ty, ValCtx)) {
- continue;
- }
- } break;
- case Instruction::ExtractValue: {
- ExtractValueInst *EV = cast<ExtractValueInst>(&I);
- Type *Ty = EV->getAggregateOperand()->getType();
- if (StructType *ST = dyn_cast<StructType>(Ty)) {
- Value *Agg = EV->getAggregateOperand();
- if (!isa<AtomicCmpXchgInst>(Agg) &&
- !IsDxilBuiltinStructType(ST, ValCtx.DxilMod.GetOP())) {
- ValCtx.EmitInstrError(EV, ValidationRule::InstrExtractValue);
- }
- } else {
- ValCtx.EmitInstrError(EV, ValidationRule::InstrExtractValue);
- }
- } break;
- case Instruction::Load: {
- Type *Ty = I.getType();
- if (!ValidateType(Ty, ValCtx)) {
- continue;
- }
- } break;
- case Instruction::Store: {
- StoreInst *SI = cast<StoreInst>(&I);
- Type *Ty = SI->getValueOperand()->getType();
- if (!ValidateType(Ty, ValCtx)) {
- continue;
- }
- } break;
- case Instruction::GetElementPtr: {
- Type *Ty = I.getType()->getPointerElementType();
- if (!ValidateType(Ty, ValCtx)) {
- continue;
- }
- GetElementPtrInst *GEP = cast<GetElementPtrInst>(&I);
- bool allImmIndex = true;
- for (auto Idx = GEP->idx_begin(), E = GEP->idx_end(); Idx != E; Idx++) {
- if (!isa<ConstantInt>(Idx)) {
- allImmIndex = false;
- break;
- }
- }
- if (allImmIndex) {
- const DataLayout &DL = ValCtx.DL;
- Value *Ptr = GEP->getPointerOperand();
- unsigned size =
- DL.getTypeAllocSize(Ptr->getType()->getPointerElementType());
- unsigned valSize = DL.getTypeAllocSize(GEP->getType()->getPointerElementType());
- SmallVector<Value *, 8> Indices(GEP->idx_begin(), GEP->idx_end());
- unsigned offset =
- DL.getIndexedOffset(GEP->getPointerOperandType(), Indices);
- if ((offset + valSize) > size) {
- ValCtx.EmitInstrError(GEP, ValidationRule::InstrInBoundsAccess);
- }
- }
- } break;
- case Instruction::SDiv: {
- BinaryOperator *BO = cast<BinaryOperator>(&I);
- Value *V = BO->getOperand(1);
- if (ConstantInt *imm = dyn_cast<ConstantInt>(V)) {
- if (imm->getValue().getLimitedValue() == 0) {
- ValCtx.EmitInstrError(BO, ValidationRule::InstrNoIDivByZero);
- }
- }
- } break;
- case Instruction::UDiv: {
- BinaryOperator *BO = cast<BinaryOperator>(&I);
- Value *V = BO->getOperand(1);
- if (ConstantInt *imm = dyn_cast<ConstantInt>(V)) {
- if (imm->getValue().getLimitedValue() == 0) {
- ValCtx.EmitInstrError(BO, ValidationRule::InstrNoUDivByZero);
- }
- }
- } break;
- case Instruction::AddrSpaceCast: {
- AddrSpaceCastInst *Cast = cast<AddrSpaceCastInst>(&I);
- unsigned ToAddrSpace = Cast->getType()->getPointerAddressSpace();
- unsigned FromAddrSpace = Cast->getOperand(0)->getType()->getPointerAddressSpace();
- if (ToAddrSpace != DXIL::kGenericPointerAddrSpace &&
- FromAddrSpace != DXIL::kGenericPointerAddrSpace) {
- ValCtx.EmitInstrError(Cast, ValidationRule::InstrNoGenericPtrAddrSpaceCast);
- }
- } break;
- case Instruction::BitCast: {
- BitCastInst *Cast = cast<BitCastInst>(&I);
- Type *FromTy = Cast->getOperand(0)->getType();
- Type *ToTy = Cast->getType();
- if (isa<PointerType>(FromTy)) {
- FromTy = FromTy->getPointerElementType();
- ToTy = ToTy->getPointerElementType();
- unsigned FromSize = ValCtx.DL.getTypeAllocSize(FromTy);
- unsigned ToSize = ValCtx.DL.getTypeAllocSize(ToTy);
- if (FromSize != ToSize) {
- ValCtx.EmitInstrError(Cast, ValidationRule::InstrPtrBitCast);
- continue;
- }
- while (isa<ArrayType>(FromTy)) {
- FromTy = FromTy->getArrayElementType();
- }
- while (isa<ArrayType>(ToTy)) {
- ToTy = ToTy->getArrayElementType();
- }
- }
- if ((isa<StructType>(FromTy) || isa<StructType>(ToTy)) && !ValCtx.isLibProfile) {
- ValCtx.EmitInstrError(Cast, ValidationRule::InstrStructBitCast);
- continue;
- }
- bool IsMinPrecisionTy =
- (ValCtx.DL.getTypeStoreSize(FromTy) < 4 ||
- ValCtx.DL.getTypeStoreSize(ToTy) < 4) &&
- ValCtx.DxilMod.GetUseMinPrecision();
- if (IsMinPrecisionTy) {
- ValCtx.EmitInstrError(Cast, ValidationRule::InstrMinPrecisonBitCast);
- }
- } break;
- }
- if (PointerType *PT = dyn_cast<PointerType>(I.getType())) {
- if (PT->getAddressSpace() == DXIL::kTGSMAddrSpace) {
- if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(&I)) {
- Value *Ptr = GEP->getPointerOperand();
- if (!isa<GlobalVariable>(Ptr)) {
- ValCtx.EmitInstrError(
- &I, ValidationRule::InstrFailToResloveTGSMPointer);
- }
- } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(&I)) {
- Value *Ptr = BCI->getOperand(0);
- if (!isa<GetElementPtrInst>(Ptr) && !isa<GlobalVariable>(Ptr)) {
- ValCtx.EmitInstrError(
- &I, ValidationRule::InstrFailToResloveTGSMPointer);
- }
- } else {
- ValCtx.EmitInstrError(
- &I, ValidationRule::InstrFailToResloveTGSMPointer);
- }
- }
- }
- }
- ValidateControlFlowHint(*b, ValCtx);
- }
- if (!gradientOps.empty()) {
- ValidateGradientOps(F, gradientOps, barriers, ValCtx);
- }
- }
- static void ValidateFunction(Function &F, ValidationContext &ValCtx) {
- if (F.isDeclaration()) {
- ValidateExternalFunction(&F, ValCtx);
- } else {
- bool isNoArgEntry = ValCtx.DxilMod.HasDxilFunctionProps(&F);
- if (isNoArgEntry) {
- switch (ValCtx.DxilMod.GetDxilFunctionProps(&F).shaderKind) {
- case DXIL::ShaderKind::AnyHit:
- case DXIL::ShaderKind::Callable:
- case DXIL::ShaderKind::ClosestHit:
- case DXIL::ShaderKind::Miss:
- isNoArgEntry = false;
- break;
- default:
- isNoArgEntry = true;
- break;
- }
- } else {
- isNoArgEntry = &F == ValCtx.DxilMod.GetEntryFunction();
- isNoArgEntry |= &F == ValCtx.DxilMod.GetPatchConstantFunction();
- }
- // Entry function should not have parameter.
- if (!F.arg_empty() && isNoArgEntry)
- ValCtx.EmitFormatError(ValidationRule::FlowFunctionCall,
- {F.getName().str()});
- DxilFunctionAnnotation *funcAnnotation =
- ValCtx.DxilMod.GetTypeSystem().GetFunctionAnnotation(&F);
- if (!funcAnnotation) {
- ValCtx.EmitFormatError(ValidationRule::MetaFunctionAnnotation,
- {F.getName().str()});
- return;
- }
- // Validate parameter type.
- for (auto &arg : F.args()) {
- Type *argTy = arg.getType();
- if (argTy->isPointerTy())
- argTy = argTy->getPointerElementType();
- while (argTy->isArrayTy()) {
- argTy = argTy->getArrayElementType();
- }
- if (argTy->isStructTy() && !ValCtx.isLibProfile) {
- if (arg.hasName())
- ValCtx.EmitFormatError(
- ValidationRule::DeclFnFlattenParam,
- {arg.getName().str(), F.getName().str()});
- else
- ValCtx.EmitFormatError(ValidationRule::DeclFnFlattenParam,
- {std::to_string(arg.getArgNo()),
- F.getName().str()});
- break;
- }
- }
- ValidateFunctionBody(&F, ValCtx);
- }
- // TODO: Remove attribute for lib?
- if (!ValCtx.isLibProfile)
- ValidateFunctionAttribute(&F, ValCtx);
- if (F.hasMetadata()) {
- ValidateFunctionMetadata(&F, ValCtx);
- }
- }
- static void ValidateGlobalVariable(GlobalVariable &GV,
- ValidationContext &ValCtx) {
- bool isInternalGV =
- dxilutil::IsStaticGlobal(&GV) || dxilutil::IsSharedMemoryGlobal(&GV);
- if (ValCtx.isLibProfile) {
- auto isResourceGlobal = [&](auto &ResTab) -> bool {
- for (auto &Res : ResTab) {
- if (Res->GetGlobalSymbol() == &GV)
- return true;
- }
- return false;
- };
- bool isRes = isResourceGlobal(ValCtx.DxilMod.GetCBuffers());
- isRes |= isResourceGlobal(ValCtx.DxilMod.GetUAVs());
- isRes |= isResourceGlobal(ValCtx.DxilMod.GetSRVs());
- isRes |= isResourceGlobal(ValCtx.DxilMod.GetSamplers());
- isInternalGV |= isRes;
- }
- if (!isInternalGV) {
- if (!GV.user_empty()) {
- bool hasInstructionUser = false;
- for (User *U : GV.users()) {
- if (isa<Instruction>(U)) {
- hasInstructionUser = true;
- break;
- }
- }
- // External GV should not have instruction user.
- if (hasInstructionUser) {
- ValCtx.EmitGlobalValueError(&GV, ValidationRule::DeclNotUsedExternal);
- }
- }
- // Must have metadata description for each variable.
- } else {
- // Internal GV must have user.
- if (GV.user_empty()) {
- ValCtx.EmitGlobalValueError(&GV, ValidationRule::DeclUsedInternal);
- }
- // Validate type for internal globals.
- if (dxilutil::IsStaticGlobal(&GV) || dxilutil::IsSharedMemoryGlobal(&GV)) {
- Type *Ty = GV.getType()->getPointerElementType();
- ValidateType(Ty, ValCtx);
- }
- }
- }
- static void CollectFixAddressAccess(Value *V,
- std::vector<StoreInst *> &fixAddrTGSMList) {
- for (User *U : V->users()) {
- if (GEPOperator *GEP = dyn_cast<GEPOperator>(U)) {
- if (isa<ConstantExpr>(GEP) || GEP->hasAllConstantIndices()) {
- CollectFixAddressAccess(GEP, fixAddrTGSMList);
- }
- } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
- fixAddrTGSMList.emplace_back(SI);
- }
- }
- }
- static bool IsDivergent(Value *V) {
- // TODO: return correct result.
- return false;
- }
- static void ValidateTGSMRaceCondition(std::vector<StoreInst *> &fixAddrTGSMList,
- ValidationContext &ValCtx) {
- std::unordered_set<Function *> fixAddrTGSMFuncSet;
- for (StoreInst *I : fixAddrTGSMList) {
- BasicBlock *BB = I->getParent();
- fixAddrTGSMFuncSet.insert(BB->getParent());
- }
- for (auto &F : ValCtx.DxilMod.GetModule()->functions()) {
- if (F.isDeclaration() || !fixAddrTGSMFuncSet.count(&F))
- continue;
- PostDominatorTree PDT;
- PDT.runOnFunction(F);
- BasicBlock *Entry = &F.getEntryBlock();
- for (StoreInst *SI : fixAddrTGSMList) {
- BasicBlock *BB = SI->getParent();
- if (BB->getParent() == &F) {
- if (PDT.dominates(BB, Entry)) {
- if (IsDivergent(SI->getValueOperand()))
- ValCtx.EmitInstrError(SI, ValidationRule::InstrTGSMRaceCond);
- }
- }
- }
- }
- }
- static void ValidateGlobalVariables(ValidationContext &ValCtx) {
- DxilModule &M = ValCtx.DxilMod;
- unsigned TGSMSize = 0;
- std::vector<StoreInst*> fixAddrTGSMList;
- const DataLayout &DL = M.GetModule()->getDataLayout();
- for (GlobalVariable &GV : M.GetModule()->globals()) {
- ValidateGlobalVariable(GV, ValCtx);
- if (GV.getType()->getAddressSpace() == DXIL::kTGSMAddrSpace) {
- TGSMSize += DL.getTypeAllocSize(GV.getType()->getElementType());
- CollectFixAddressAccess(&GV, fixAddrTGSMList);
- }
- }
- if (TGSMSize > DXIL::kMaxTGSMSize) {
- ValCtx.EmitFormatError(ValidationRule::SmMaxTGSMSize,
- {std::to_string(TGSMSize),
- std::to_string(DXIL::kMaxTGSMSize)});
- }
- if (!fixAddrTGSMList.empty()) {
- ValidateTGSMRaceCondition(fixAddrTGSMList, ValCtx);
- }
- }
- static void ValidateValidatorVersion(ValidationContext &ValCtx) {
- Module *pModule = &ValCtx.M;
- NamedMDNode *pNode = pModule->getNamedMetadata("dx.valver");
- if (pNode == nullptr) {
- return;
- }
- if (pNode->getNumOperands() == 1) {
- MDTuple *pVerValues = dyn_cast<MDTuple>(pNode->getOperand(0));
- if (pVerValues != nullptr && pVerValues->getNumOperands() == 2) {
- uint64_t majorVer, minorVer;
- if (GetNodeOperandAsInt(ValCtx, pVerValues, 0, &majorVer) &&
- GetNodeOperandAsInt(ValCtx, pVerValues, 1, &minorVer)) {
- unsigned curMajor, curMinor;
- GetValidationVersion(&curMajor, &curMinor);
- // This will need to be updated as major/minor versions evolve,
- // depending on the degree of compat across versions.
- if (majorVer == curMajor && minorVer <= curMinor) {
- return;
- }
- }
- }
- }
- ValCtx.EmitError(ValidationRule::MetaWellFormed);
- }
- static void ValidateDxilVersion(ValidationContext &ValCtx) {
- Module *pModule = &ValCtx.M;
- NamedMDNode *pNode = pModule->getNamedMetadata("dx.version");
- if (pNode && pNode->getNumOperands() == 1) {
- MDTuple *pVerValues = dyn_cast<MDTuple>(pNode->getOperand(0));
- if (pVerValues != nullptr && pVerValues->getNumOperands() == 2) {
- uint64_t majorVer, minorVer;
- if (GetNodeOperandAsInt(ValCtx, pVerValues, 0, &majorVer) &&
- GetNodeOperandAsInt(ValCtx, pVerValues, 1, &minorVer)) {
- // This will need to be updated as dxil major/minor versions evolve,
- // depending on the degree of compat across versions.
- if ((majorVer == 1 && minorVer < 4) &&
- (majorVer == ValCtx.m_DxilMajor && minorVer == ValCtx.m_DxilMinor)) {
- return;
- }
- }
- }
- }
- ValCtx.EmitError(ValidationRule::MetaWellFormed);
- }
- static void ValidateTypeAnnotation(ValidationContext &ValCtx) {
- if (ValCtx.m_DxilMajor == 1 && ValCtx.m_DxilMinor >= 2) {
- Module *pModule = &ValCtx.M;
- NamedMDNode *TA = pModule->getNamedMetadata("dx.typeAnnotations");
- if (TA == nullptr)
- return;
- for (unsigned i = 0, end = TA->getNumOperands(); i < end; ++i) {
- MDTuple *TANode = dyn_cast<MDTuple>(TA->getOperand(i));
- if (TANode->getNumOperands() < 3) {
- ValCtx.EmitMetaError(TANode, ValidationRule::MetaWellFormed);
- return;
- }
- ConstantInt *tag = mdconst::extract<ConstantInt>(TANode->getOperand(0));
- uint64_t tagValue = tag->getZExtValue();
- if (tagValue != DxilMDHelper::kDxilTypeSystemStructTag &&
- tagValue != DxilMDHelper::kDxilTypeSystemFunctionTag) {
- ValCtx.EmitMetaError(TANode, ValidationRule::MetaWellFormed);
- return;
- }
- }
- }
- }
- static void ValidateMetadata(ValidationContext &ValCtx) {
- Module *pModule = &ValCtx.M;
- const std::string &target = pModule->getTargetTriple();
- if (target != "dxil-ms-dx") {
- ValCtx.EmitFormatError(ValidationRule::MetaTarget, {target});
- }
- // The llvm.dbg.(cu/contents/defines/mainFileName/arg) named metadata nodes
- // are only available in debug modules, not in the validated ones.
- // llvm.bitsets is also disallowed.
- //
- // These are verified in lib/IR/Verifier.cpp.
- StringMap<bool> llvmNamedMeta;
- llvmNamedMeta["llvm.ident"];
- llvmNamedMeta["llvm.module.flags"];
- for (auto &NamedMetaNode : pModule->named_metadata()) {
- if (!DxilModule::IsKnownNamedMetaData(NamedMetaNode)) {
- StringRef name = NamedMetaNode.getName();
- if (!name.startswith_lower("llvm.")) {
- ValCtx.EmitFormatError(ValidationRule::MetaKnown, {name.str()});
- }
- else {
- if (llvmNamedMeta.count(name) == 0) {
- ValCtx.EmitFormatError(ValidationRule::MetaKnown,
- {name.str()});
- }
- }
- }
- }
- const hlsl::ShaderModel *SM = ValCtx.DxilMod.GetShaderModel();
- if (!SM->IsValidForDxil()) {
- ValCtx.EmitFormatError(ValidationRule::SmName,
- {ValCtx.DxilMod.GetShaderModel()->GetName()});
- }
- if (SM->GetMajor() == 6) {
- // Make sure DxilVersion matches the shader model.
- unsigned SMDxilMajor, SMDxilMinor;
- SM->GetDxilVersion(SMDxilMajor, SMDxilMinor);
- if (ValCtx.m_DxilMajor != SMDxilMajor || ValCtx.m_DxilMinor != SMDxilMinor) {
- ValCtx.EmitFormatError(ValidationRule::SmDxilVersion,
- {std::to_string(SMDxilMajor),
- std::to_string(SMDxilMinor)});
- }
- }
- ValidateDxilVersion(ValCtx);
- ValidateValidatorVersion(ValCtx);
- ValidateTypeAnnotation(ValCtx);
- }
- static void ValidateResourceOverlap(
- hlsl::DxilResourceBase &res,
- SpacesAllocator<unsigned, DxilResourceBase> &spaceAllocator,
- ValidationContext &ValCtx) {
- unsigned base = res.GetLowerBound();
- if (ValCtx.isLibProfile && !res.IsAllocated()) {
- // Skip unallocated resource for library.
- return;
- }
- unsigned size = res.GetRangeSize();
- unsigned space = res.GetSpaceID();
- auto &allocator = spaceAllocator.Get(space);
- unsigned end = base + size - 1;
- // unbounded
- if (end < base)
- end = size;
- const DxilResourceBase *conflictRes = allocator.Insert(&res, base, end);
- if (conflictRes) {
- ValCtx.EmitFormatError(
- ValidationRule::SmResourceRangeOverlap,
- {res.GetGlobalName(), std::to_string(base),
- std::to_string(size),
- std::to_string(conflictRes->GetLowerBound()),
- std::to_string(conflictRes->GetRangeSize()),
- std::to_string(space)});
- }
- }
- static void ValidateResource(hlsl::DxilResource &res,
- ValidationContext &ValCtx) {
- switch (res.GetKind()) {
- case DXIL::ResourceKind::RawBuffer:
- case DXIL::ResourceKind::TypedBuffer:
- case DXIL::ResourceKind::TBuffer:
- case DXIL::ResourceKind::StructuredBuffer:
- case DXIL::ResourceKind::Texture1D:
- case DXIL::ResourceKind::Texture1DArray:
- case DXIL::ResourceKind::Texture2D:
- case DXIL::ResourceKind::Texture2DArray:
- case DXIL::ResourceKind::Texture3D:
- case DXIL::ResourceKind::TextureCube:
- case DXIL::ResourceKind::TextureCubeArray:
- if (res.GetSampleCount() > 0) {
- ValCtx.EmitResourceError(&res, ValidationRule::SmSampleCountOnlyOn2DMS);
- }
- break;
- case DXIL::ResourceKind::Texture2DMS:
- case DXIL::ResourceKind::Texture2DMSArray:
- break;
- case DXIL::ResourceKind::RTAccelerationStructure:
- // TODO: check profile.
- break;
- default:
- ValCtx.EmitResourceError(&res, ValidationRule::SmInvalidResourceKind);
- break;
- }
- switch (res.GetCompType().GetKind()) {
- case DXIL::ComponentType::F32:
- case DXIL::ComponentType::SNormF32:
- case DXIL::ComponentType::UNormF32:
- case DXIL::ComponentType::F64:
- case DXIL::ComponentType::I32:
- case DXIL::ComponentType::I64:
- case DXIL::ComponentType::U32:
- case DXIL::ComponentType::U64:
- case DXIL::ComponentType::F16:
- case DXIL::ComponentType::I16:
- case DXIL::ComponentType::U16:
- break;
- default:
- if (!res.IsStructuredBuffer() && !res.IsRawBuffer())
- ValCtx.EmitResourceError(&res, ValidationRule::SmInvalidResourceCompType);
- break;
- }
- if (res.IsStructuredBuffer()) {
- unsigned stride = res.GetElementStride();
- bool alignedTo4Bytes = (stride & 3) == 0;
- if (!alignedTo4Bytes && ValCtx.M.GetDxilModule().GetUseMinPrecision()) {
- ValCtx.EmitResourceFormatError(
- &res, ValidationRule::MetaStructBufAlignment,
- {std::to_string(4), std::to_string(stride)});
- }
- if (stride > DXIL::kMaxStructBufferStride) {
- ValCtx.EmitResourceFormatError(
- &res, ValidationRule::MetaStructBufAlignmentOutOfBound,
- {std::to_string(DXIL::kMaxStructBufferStride),
- std::to_string(stride)});
- }
- }
- if (res.IsAnyTexture() || res.IsTypedBuffer()) {
- Type *RetTy = res.GetRetType();
- unsigned size = ValCtx.DxilMod.GetModule()->getDataLayout().getTypeAllocSize(RetTy);
- if (size > 4*4) {
- ValCtx.EmitResourceError(&res, ValidationRule::MetaTextureType);
- }
- }
- }
- static void
- CollectCBufferRanges(DxilStructAnnotation *annotation,
- SpanAllocator<unsigned, DxilFieldAnnotation> &constAllocator,
- unsigned base, DxilTypeSystem &typeSys, StringRef cbName,
- ValidationContext &ValCtx) {
- unsigned cbSize = annotation->GetCBufferSize();
- const StructType *ST = annotation->GetStructType();
- for (int i = annotation->GetNumFields() - 1; i >= 0; i--) {
- DxilFieldAnnotation &fieldAnnotation = annotation->GetFieldAnnotation(i);
- Type *EltTy = ST->getElementType(i);
- unsigned offset = fieldAnnotation.GetCBufferOffset();
- unsigned EltSize = dxilutil::GetLegacyCBufferFieldElementSize(
- fieldAnnotation, EltTy, typeSys);
- bool bOutOfBound = false;
- if (!EltTy->isAggregateType()) {
- bOutOfBound = (offset + EltSize) > cbSize;
- if (!bOutOfBound) {
- if (constAllocator.Insert(&fieldAnnotation, base + offset,
- base + offset + EltSize - 1)) {
- ValCtx.EmitFormatError(
- ValidationRule::SmCBufferOffsetOverlap,
- {cbName, std::to_string(base + offset)});
- }
- }
- } else if (isa<ArrayType>(EltTy)) {
- unsigned arrayCount = 1;
- while (isa<ArrayType>(EltTy)) {
- arrayCount *= EltTy->getArrayNumElements();
- EltTy = EltTy->getArrayElementType();
- }
- unsigned arrayBase = base + offset;
- DxilStructAnnotation *EltAnnotation = nullptr;
- if (StructType *EltST = dyn_cast<StructType>(EltTy))
- EltAnnotation = typeSys.GetStructAnnotation(EltST);
- for (unsigned idx = 0; idx < arrayCount; idx++) {
- // 16 bytes align except last component.
- if (idx < (arrayCount - 1)) {
- arrayBase = (arrayBase + 15) & ~(0xf);
- }
- if (arrayBase > (base + cbSize)) {
- bOutOfBound = true;
- break;
- }
- if (!EltAnnotation) {
- if (constAllocator.Insert(&fieldAnnotation, arrayBase,
- arrayBase + EltSize - 1)) {
- ValCtx.EmitFormatError(
- ValidationRule::SmCBufferOffsetOverlap,
- {cbName, std::to_string(base + offset)});
- }
- } else {
- CollectCBufferRanges(EltAnnotation,
- constAllocator, arrayBase, typeSys,
- cbName, ValCtx);
- }
- arrayBase += EltSize;
- }
- } else {
- cast<StructType>(EltTy);
- bOutOfBound = (offset + EltSize) > cbSize;
- }
- if (bOutOfBound) {
- ValCtx.EmitFormatError(ValidationRule::SmCBufferElementOverflow,
- {cbName, std::to_string(base + offset)});
- }
- }
- }
- static void ValidateCBuffer(DxilCBuffer &cb, ValidationContext &ValCtx) {
- Type *Ty = cb.GetGlobalSymbol()->getType()->getPointerElementType();
- if (cb.GetRangeSize() != 1) {
- Ty = Ty->getArrayElementType();
- }
- if (!isa<StructType>(Ty)) {
- ValCtx.EmitResourceError(&cb,
- ValidationRule::SmCBufferTemplateTypeMustBeStruct);
- return;
- }
- StructType *ST = cast<StructType>(Ty);
- DxilTypeSystem &typeSys = ValCtx.DxilMod.GetTypeSystem();
- DxilStructAnnotation *annotation = typeSys.GetStructAnnotation(ST);
- if (!annotation)
- return;
- // Collect constant ranges.
- std::vector<std::pair<unsigned, unsigned>> constRanges;
- SpanAllocator<unsigned, DxilFieldAnnotation> constAllocator(0,
- // 4096 * 16 bytes.
- DXIL::kMaxCBufferSize << 4);
- CollectCBufferRanges(annotation, constAllocator,
- 0, typeSys,
- cb.GetGlobalName(), ValCtx);
- }
- static void ValidateResources(ValidationContext &ValCtx) {
- const vector<unique_ptr<DxilResource>> &uavs = ValCtx.DxilMod.GetUAVs();
- SpacesAllocator<unsigned, DxilResourceBase> uavAllocator;
- for (auto &uav : uavs) {
- if (uav->IsROV()) {
- if (!ValCtx.DxilMod.GetShaderModel()->IsPS() && !ValCtx.isLibProfile) {
- ValCtx.EmitResourceError(uav.get(), ValidationRule::SmROVOnlyInPS);
- }
- }
- switch (uav->GetKind()) {
- case DXIL::ResourceKind::Texture2DMS:
- case DXIL::ResourceKind::Texture2DMSArray:
- case DXIL::ResourceKind::TextureCube:
- case DXIL::ResourceKind::TextureCubeArray:
- ValCtx.EmitResourceError(uav.get(),
- ValidationRule::SmInvalidTextureKindOnUAV);
- break;
- default:
- break;
- }
- if (uav->HasCounter() && !uav->IsStructuredBuffer()) {
- ValCtx.EmitResourceError(uav.get(),
- ValidationRule::SmCounterOnlyOnStructBuf);
- }
- if (uav->HasCounter() && uav->IsGloballyCoherent())
- ValCtx.EmitResourceError(uav.get(),
- ValidationRule::MetaGlcNotOnAppendConsume);
- ValidateResource(*uav, ValCtx);
- ValidateResourceOverlap(*uav, uavAllocator, ValCtx);
- }
- SpacesAllocator<unsigned, DxilResourceBase> srvAllocator;
- const vector<unique_ptr<DxilResource>> &srvs = ValCtx.DxilMod.GetSRVs();
- for (auto &srv : srvs) {
- ValidateResource(*srv, ValCtx);
- ValidateResourceOverlap(*srv, srvAllocator, ValCtx);
- }
- hlsl::DxilResourceBase *pNonDense;
- if (!AreDxilResourcesDense(&ValCtx.M, &pNonDense)) {
- ValCtx.EmitResourceError(pNonDense, ValidationRule::MetaDenseResIDs);
- }
- SpacesAllocator<unsigned, DxilResourceBase> samplerAllocator;
- for (auto &sampler : ValCtx.DxilMod.GetSamplers()) {
- if (sampler->GetSamplerKind() == DXIL::SamplerKind::Invalid) {
- ValCtx.EmitResourceError(sampler.get(),
- ValidationRule::MetaValidSamplerMode);
- }
- ValidateResourceOverlap(*sampler, samplerAllocator, ValCtx);
- }
- SpacesAllocator<unsigned, DxilResourceBase> cbufferAllocator;
- for (auto &cbuffer : ValCtx.DxilMod.GetCBuffers()) {
- ValidateCBuffer(*cbuffer, ValCtx);
- ValidateResourceOverlap(*cbuffer, cbufferAllocator, ValCtx);
- }
- }
- static void ValidateShaderFlags(ValidationContext &ValCtx) {
- // TODO: validate flags foreach entry.
- if (ValCtx.isLibProfile)
- return;
- ShaderFlags calcFlags;
- ValCtx.DxilMod.CollectShaderFlagsForModule(calcFlags);
- const uint64_t mask = ShaderFlags::GetShaderFlagsRawForCollection();
- uint64_t declaredFlagsRaw = ValCtx.DxilMod.m_ShaderFlags.GetShaderFlagsRaw();
- uint64_t calcFlagsRaw = calcFlags.GetShaderFlagsRaw();
- declaredFlagsRaw &= mask;
- calcFlagsRaw &= mask;
- if (declaredFlagsRaw == calcFlagsRaw) {
- return;
- }
- ValCtx.EmitError(ValidationRule::MetaFlagsUsage);
- ValCtx.DiagStream() << "Flags declared=" << declaredFlagsRaw
- << ", actual=" << calcFlagsRaw << "\n";
- }
- static void ValidateSignatureElement(DxilSignatureElement &SE,
- ValidationContext &ValCtx) {
- DXIL::SemanticKind semanticKind = SE.GetSemantic()->GetKind();
- CompType::Kind compKind = SE.GetCompType().GetKind();
- DXIL::InterpolationMode Mode = SE.GetInterpolationMode()->GetKind();
- StringRef Name = SE.GetName();
- if (Name.size() < 1 || Name.size() > 64) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::MetaSemanticLen);
- }
- if (semanticKind > DXIL::SemanticKind::Arbitrary && semanticKind < DXIL::SemanticKind::Invalid) {
- if (semanticKind != Semantic::GetByName(SE.GetName())->GetKind()) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemaKindMatchesName,
- {SE.GetName(), SE.GetSemantic()->GetName()});
- }
- }
- unsigned compWidth = 0;
- bool compFloat = false;
- bool compInt = false;
- bool compBool = false;
- switch (compKind) {
- case CompType::Kind::U64: compWidth = 64; compInt = true; break;
- case CompType::Kind::I64: compWidth = 64; compInt = true; break;
- case CompType::Kind::U32: compWidth = 32; compInt = true; break;
- case CompType::Kind::I32: compWidth = 32; compInt = true; break;
- case CompType::Kind::U16: compWidth = 16; compInt = true; break;
- case CompType::Kind::I16: compWidth = 16; compInt = true; break;
- case CompType::Kind::I1: compWidth = 1; compBool = true; break;
- case CompType::Kind::F64: compWidth = 64; compFloat = true; break;
- case CompType::Kind::F32: compWidth = 32; compFloat = true; break;
- case CompType::Kind::F16: compWidth = 16; compFloat = true; break;
- case CompType::Kind::SNormF64: compWidth = 64; compFloat = true; break;
- case CompType::Kind::SNormF32: compWidth = 32; compFloat = true; break;
- case CompType::Kind::SNormF16: compWidth = 16; compFloat = true; break;
- case CompType::Kind::UNormF64: compWidth = 64; compFloat = true; break;
- case CompType::Kind::UNormF32: compWidth = 32; compFloat = true; break;
- case CompType::Kind::UNormF16: compWidth = 16; compFloat = true; break;
- case CompType::Kind::Invalid:
- default:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureCompType, { SE.GetName() });
- break;
- }
- if (compInt || compBool) {
- switch (Mode) {
- case DXIL::InterpolationMode::Linear:
- case DXIL::InterpolationMode::LinearCentroid:
- case DXIL::InterpolationMode::LinearNoperspective:
- case DXIL::InterpolationMode::LinearNoperspectiveCentroid:
- case DXIL::InterpolationMode::LinearSample:
- case DXIL::InterpolationMode::LinearNoperspectiveSample: {
- ValCtx.EmitFormatError(ValidationRule::MetaIntegerInterpMode, {SE.GetName()});
- } break;
- default:
- break;
- }
- }
- // Elements that should not appear in the Dxil signature:
- bool bAllowedInSig = true;
- bool bShouldBeAllocated = true;
- switch (SE.GetInterpretation()) {
- case DXIL::SemanticInterpretationKind::NA:
- case DXIL::SemanticInterpretationKind::NotInSig:
- case DXIL::SemanticInterpretationKind::Invalid:
- bAllowedInSig = false;
- __fallthrough;
- case DXIL::SemanticInterpretationKind::NotPacked:
- case DXIL::SemanticInterpretationKind::Shadow:
- bShouldBeAllocated = false;
- break;
- default:
- break;
- }
- const char *inputOutput = nullptr;
- if (SE.IsInput())
- inputOutput = "Input";
- else if (SE.IsOutput())
- inputOutput = "Output";
- else
- inputOutput = "PatchConstant";
- if (!bAllowedInSig) {
- ValCtx.EmitFormatError(
- ValidationRule::SmSemantic,
- {SE.GetName(), ValCtx.DxilMod.GetShaderModel()->GetKindName(), inputOutput});
- } else if (bShouldBeAllocated && !SE.IsAllocated()) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticShouldBeAllocated,
- {inputOutput, SE.GetName()});
- } else if (!bShouldBeAllocated && SE.IsAllocated()) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticShouldNotBeAllocated,
- {inputOutput, SE.GetName()});
- }
- bool bIsClipCull = false;
- bool bIsTessfactor = false;
- bool bIsBarycentric = false;
- switch (semanticKind) {
- case DXIL::SemanticKind::Depth:
- case DXIL::SemanticKind::DepthGreaterEqual:
- case DXIL::SemanticKind::DepthLessEqual:
- if (!compFloat || compWidth > 32 || SE.GetCols() != 1) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "float"});
- }
- break;
- case DXIL::SemanticKind::Coverage:
- DXASSERT(!SE.IsInput() || !bAllowedInSig, "else internal inconsistency between semantic interpretation table and validation code");
- __fallthrough;
- case DXIL::SemanticKind::InnerCoverage:
- case DXIL::SemanticKind::OutputControlPointID:
- if (compKind != CompType::Kind::U32 || SE.GetCols() != 1) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "uint"});
- }
- break;
- case DXIL::SemanticKind::Position:
- if (!compFloat || compWidth > 32 || SE.GetCols() != 4) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "float4"});
- }
- break;
- case DXIL::SemanticKind::Target:
- if (compWidth > 32) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "float/int/uint"});
- }
- break;
- case DXIL::SemanticKind::ClipDistance:
- case DXIL::SemanticKind::CullDistance:
- bIsClipCull = true;
- if (!compFloat || compWidth > 32) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "float"});
- }
- // NOTE: clip cull distance size is checked at ValidateSignature.
- break;
- case DXIL::SemanticKind::IsFrontFace: {
- if (!(compInt && compWidth == 32) || SE.GetCols() != 1) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "uint"});
- }
- } break;
- case DXIL::SemanticKind::RenderTargetArrayIndex:
- case DXIL::SemanticKind::ViewPortArrayIndex:
- case DXIL::SemanticKind::VertexID:
- case DXIL::SemanticKind::PrimitiveID:
- case DXIL::SemanticKind::InstanceID:
- case DXIL::SemanticKind::GSInstanceID:
- case DXIL::SemanticKind::SampleIndex:
- case DXIL::SemanticKind::StencilRef:
- if ((compKind != CompType::Kind::U32 && compKind != CompType::Kind::U16) || SE.GetCols() != 1) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "uint"});
- }
- break;
- case DXIL::SemanticKind::TessFactor:
- case DXIL::SemanticKind::InsideTessFactor:
- // NOTE: the size check is at CheckPatchConstantSemantic.
- bIsTessfactor = true;
- if (!compFloat || compWidth > 32) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType,
- {SE.GetSemantic()->GetName(), "float"});
- }
- break;
- case DXIL::SemanticKind::Arbitrary:
- break;
- case DXIL::SemanticKind::DomainLocation:
- case DXIL::SemanticKind::Invalid:
- DXASSERT(!bAllowedInSig, "else internal inconsistency between semantic interpretation table and validation code");
- break;
- case DXIL::SemanticKind::Barycentrics:
- bIsBarycentric = true;
- if (!compFloat || compWidth > 32) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticCompType, {SE.GetSemantic()->GetName(), "float"});
- }
- if (Mode != InterpolationMode::Kind::Linear &&
- Mode != InterpolationMode::Kind::LinearCentroid &&
- Mode != InterpolationMode::Kind::LinearNoperspective &&
- Mode != InterpolationMode::Kind::LinearNoperspectiveCentroid &&
- Mode != InterpolationMode::Kind::LinearNoperspectiveSample &&
- Mode != InterpolationMode::Kind::LinearSample) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::MetaBarycentricsInterpolation);
- }
- if (SE.GetCols() != 3) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::MetaBarycentricsFloat3);
- }
- break;
- default:
- ValCtx.EmitSignatureError(&SE, ValidationRule::MetaSemaKindValid);
- break;
- }
- if (ValCtx.DxilMod.GetShaderModel()->IsGS() && SE.IsOutput()) {
- if (SE.GetOutputStream() >= DXIL::kNumOutputStreams) {
- ValCtx.EmitFormatError(ValidationRule::SmStreamIndexRange,
- {std::to_string(SE.GetOutputStream()),
- std::to_string(DXIL::kNumOutputStreams - 1)});
- }
- } else {
- if (SE.GetOutputStream() > 0) {
- ValCtx.EmitFormatError(ValidationRule::SmStreamIndexRange,
- {std::to_string(SE.GetOutputStream()),
- "0"});
- }
- }
- if (ValCtx.DxilMod.GetShaderModel()->IsGS()) {
- if (SE.GetOutputStream() != 0) {
- if (ValCtx.DxilMod.GetStreamPrimitiveTopology() !=
- DXIL::PrimitiveTopology::PointList) {
- ValCtx.EmitSignatureError(&SE,
- ValidationRule::SmMultiStreamMustBePoint);
- }
- }
- }
- if (semanticKind == DXIL::SemanticKind::Target) {
- // Verify packed row == semantic index
- unsigned row = SE.GetStartRow();
- for (unsigned i : SE.GetSemanticIndexVec()) {
- if (row != i) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::SmPSTargetIndexMatchesRow);
- }
- ++row;
- }
- // Verify packed col is 0
- if (SE.GetStartCol() != 0) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::SmPSTargetCol0);
- }
- // Verify max row used < 8
- if (SE.GetStartRow() + SE.GetRows() > 8) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticIndexMax, {"SV_Target", "7"});
- }
- } else if (bAllowedInSig && semanticKind != DXIL::SemanticKind::Arbitrary) {
- if (bIsBarycentric) {
- if (SE.GetSemanticStartIndex() > 1) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticIndexMax, { SE.GetSemantic()->GetName(), "1" });
- }
- }
- else if (!bIsClipCull && SE.GetSemanticStartIndex() > 0) {
- ValCtx.EmitFormatError(ValidationRule::MetaSemanticIndexMax, {SE.GetSemantic()->GetName(), "0"});
- }
- // Maximum rows is 1 for system values other than Target
- // with the exception of tessfactors, which are validated in CheckPatchConstantSemantic
- if (!bIsTessfactor && SE.GetRows() > 1) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::MetaSystemValueRows);
- }
- }
- if (SE.GetCols() + (SE.IsAllocated() ? SE.GetStartCol() : 0) > 4) {
- unsigned size = (SE.GetRows() - 1) * 4 + SE.GetCols();
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureOutOfRange,
- {SE.GetName(),
- std::to_string(SE.GetStartRow()),
- std::to_string(SE.GetStartCol()),
- std::to_string(size)});
- }
- if (!SE.GetInterpolationMode()->IsValid()) {
- ValCtx.EmitSignatureError(&SE, ValidationRule::MetaInterpModeValid);
- }
- }
- static void ValidateSignatureOverlap(
- DxilSignatureElement &E, unsigned maxScalars,
- DxilSignatureAllocator &allocator,
- ValidationContext &ValCtx) {
- // Skip entries that are not or should not be allocated. Validation occurs in ValidateSignatureElement.
- if (!E.IsAllocated())
- return;
- switch (E.GetInterpretation()) {
- case DXIL::SemanticInterpretationKind::NA:
- case DXIL::SemanticInterpretationKind::NotInSig:
- case DXIL::SemanticInterpretationKind::Invalid:
- case DXIL::SemanticInterpretationKind::NotPacked:
- case DXIL::SemanticInterpretationKind::Shadow:
- return;
- default:
- break;
- }
- DxilPackElement PE(&E, allocator.UseMinPrecision());
- DxilSignatureAllocator::ConflictType conflict = allocator.DetectRowConflict(&PE, E.GetStartRow());
- if (conflict == DxilSignatureAllocator::kNoConflict || conflict == DxilSignatureAllocator::kInsufficientFreeComponents)
- conflict = allocator.DetectColConflict(&PE, E.GetStartRow(), E.GetStartCol());
- switch (conflict) {
- case DxilSignatureAllocator::kNoConflict:
- allocator.PlaceElement(&PE, E.GetStartRow(), E.GetStartCol());
- break;
- case DxilSignatureAllocator::kConflictsWithIndexed:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureIndexConflict,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- case DxilSignatureAllocator::kConflictsWithIndexedTessFactor:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureIndexConflict,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- case DxilSignatureAllocator::kConflictsWithInterpolationMode:
- ValCtx.EmitFormatError(ValidationRule::MetaInterpModeInOneRow,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- case DxilSignatureAllocator::kInsufficientFreeComponents:
- DXASSERT(false, "otherwise, conflict not translated");
- break;
- case DxilSignatureAllocator::kOverlapElement:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureOverlap,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- case DxilSignatureAllocator::kIllegalComponentOrder:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureIllegalComponentOrder,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- case DxilSignatureAllocator::kConflictFit:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureOutOfRange,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- case DxilSignatureAllocator::kConflictDataWidth:
- ValCtx.EmitFormatError(ValidationRule::MetaSignatureDataWidth,
- {E.GetName(),
- std::to_string(E.GetStartRow()),
- std::to_string(E.GetStartCol()),
- std::to_string(E.GetRows()),
- std::to_string(E.GetCols())});
- break;
- default:
- DXASSERT(false, "otherwise, unrecognized conflict type from DxilSignatureAllocator");
- }
- }
- static void ValidateSignature(ValidationContext &ValCtx, const DxilSignature &S,
- EntryStatus &Status,
- unsigned maxScalars) {
- DxilSignatureAllocator allocator[DXIL::kNumOutputStreams] = {
- {32, ValCtx.DxilMod.GetUseMinPrecision()},
- {32, ValCtx.DxilMod.GetUseMinPrecision()},
- {32, ValCtx.DxilMod.GetUseMinPrecision()},
- {32, ValCtx.DxilMod.GetUseMinPrecision()}};
- unordered_set<unsigned> semanticUsageSet[DXIL::kNumOutputStreams];
- StringMap<unordered_set<unsigned>> semanticIndexMap[DXIL::kNumOutputStreams];
- unordered_set<unsigned> clipcullRowSet[DXIL::kNumOutputStreams];
- unsigned clipcullComponents[DXIL::kNumOutputStreams] = {0, 0, 0, 0};
- bool isOutput = S.IsOutput();
- unsigned TargetMask = 0;
- DXIL::SemanticKind DepthKind = DXIL::SemanticKind::Invalid;
- const InterpolationMode *prevBaryInterpMode = nullptr;
- unsigned numBarycentrics = 0;
- for (auto &E : S.GetElements()) {
- DXIL::SemanticKind semanticKind = E->GetSemantic()->GetKind();
- ValidateSignatureElement(*E, ValCtx);
- // Avoid OOB indexing on streamId.
- unsigned streamId = E->GetOutputStream();
- if (streamId >= DXIL::kNumOutputStreams ||
- !isOutput ||
- !ValCtx.DxilMod.GetShaderModel()->IsGS()) {
- streamId = 0;
- }
- // Semantic index overlap check, keyed by name.
- std::string nameUpper(E->GetName());
- std::transform(nameUpper.begin(), nameUpper.end(), nameUpper.begin(), ::toupper);
- unordered_set<unsigned> &semIdxSet = semanticIndexMap[streamId][nameUpper];
- for (unsigned semIdx : E->GetSemanticIndexVec()) {
- if (semIdxSet.count(semIdx) > 0) {
- ValCtx.EmitFormatError(ValidationRule::MetaNoSemanticOverlap,
- {E->GetName(), std::to_string(semIdx)});
- return;
- } else
- semIdxSet.insert(semIdx);
- }
- // SV_Target has special rules
- if (semanticKind == DXIL::SemanticKind::Target) {
- // Validate target overlap
- if (E->GetStartRow() + E->GetRows() <= 8) {
- unsigned mask = ((1 << E->GetRows()) - 1) << E->GetStartRow();
- if (TargetMask & mask) {
- ValCtx.EmitFormatError(ValidationRule::MetaNoSemanticOverlap,
- {"SV_Target", std::to_string(E->GetStartRow())});
- }
- TargetMask = TargetMask | mask;
- }
- if (E->GetRows() > 1) {
- ValCtx.EmitError(ValidationRule::SmNoPSOutputIdx);
- }
- continue;
- }
- if (E->GetSemantic()->IsInvalid())
- continue;
- // validate system value semantic rules
- switch (semanticKind) {
- case DXIL::SemanticKind::Arbitrary:
- break;
- case DXIL::SemanticKind::ClipDistance:
- case DXIL::SemanticKind::CullDistance:
- // Validate max 8 components across 2 rows (registers)
- clipcullRowSet[streamId].insert(E->GetStartRow());
- if (clipcullRowSet[streamId].size() > 2) {
- ValCtx.EmitError(ValidationRule::MetaClipCullMaxRows);
- }
- clipcullComponents[streamId] += E->GetCols();
- if (clipcullComponents[streamId] > 8) {
- ValCtx.EmitError(ValidationRule::MetaClipCullMaxComponents);
- }
- break;
- case DXIL::SemanticKind::Depth:
- case DXIL::SemanticKind::DepthGreaterEqual:
- case DXIL::SemanticKind::DepthLessEqual:
- if (DepthKind != DXIL::SemanticKind::Invalid) {
- ValCtx.EmitError(ValidationRule::SmPSMultipleDepthSemantic);
- }
- DepthKind = semanticKind;
- break;
- case DXIL::SemanticKind::Barycentrics: {
- // There can only be up to two SV_Barycentrics
- // with differeent perspective interpolation modes.
- if (numBarycentrics++ > 1) {
- ValCtx.EmitError(ValidationRule::MetaBarycentricsTwoPerspectives);
- break;
- }
- const InterpolationMode *mode = E->GetInterpolationMode();
- if (prevBaryInterpMode) {
- if ((mode->IsAnyNoPerspective() && prevBaryInterpMode->IsAnyNoPerspective())
- || (!mode->IsAnyNoPerspective() && !prevBaryInterpMode->IsAnyNoPerspective())) {
- ValCtx.EmitError(ValidationRule::MetaBarycentricsTwoPerspectives);
- }
- }
- prevBaryInterpMode = mode;
- break;
- }
- default:
- if (semanticUsageSet[streamId].count(static_cast<unsigned>(semanticKind)) > 0) {
- ValCtx.EmitFormatError(ValidationRule::MetaDuplicateSysValue,
- {E->GetSemantic()->GetName()});
- }
- semanticUsageSet[streamId].insert(static_cast<unsigned>(semanticKind));
- break;
- }
- // Packed element overlap check.
- ValidateSignatureOverlap(*E.get(), maxScalars, allocator[streamId], ValCtx);
- if (isOutput && semanticKind == DXIL::SemanticKind::Position) {
- Status.hasOutputPosition[E->GetOutputStream()] = true;
- }
- }
- if (Status.hasViewID && S.IsInput() && ValCtx.DxilMod.GetShaderModel()->GetKind() == DXIL::ShaderKind::Pixel) {
- // Ensure sufficient space for ViewID:
- DxilSignatureAllocator::DummyElement viewID;
- viewID.rows = 1;
- viewID.cols = 1;
- viewID.kind = DXIL::SemanticKind::Arbitrary;
- viewID.interpolation = DXIL::InterpolationMode::Constant;
- viewID.interpretation = DXIL::SemanticInterpretationKind::SGV;
- allocator[0].PackNext(&viewID, 0, 32);
- if (!viewID.IsAllocated()) {
- ValCtx.EmitError(ValidationRule::SmViewIDNeedsSlot);
- }
- }
- }
- static void ValidateNoInterpModeSignature(ValidationContext &ValCtx, const DxilSignature &S) {
- for (auto &E : S.GetElements()) {
- if (!E->GetInterpolationMode()->IsUndefined()) {
- ValCtx.EmitSignatureError(E.get(), ValidationRule::SmNoInterpMode);
- }
- }
- }
- static void ValidateEntrySignatures(ValidationContext &ValCtx,
- const DxilEntryProps &entryProps,
- EntryStatus &Status) {
- const DxilFunctionProps &props = entryProps.props;
- if (props.IsRay()) {
- // TODO: validate ray entry props.
- return;
- }
- const DxilEntrySignature &S = entryProps.sig;
- bool isPS = props.IsPS();
- bool isVS = props.IsVS();
- bool isGS = props.IsGS();
- bool isCS = props.IsCS();
- if (isPS) {
- // PS output no interp mode.
- ValidateNoInterpModeSignature(ValCtx, S.OutputSignature);
- } else if (isVS) {
- // VS input no interp mode.
- ValidateNoInterpModeSignature(ValCtx, S.InputSignature);
- }
- // patch constant no interp mode.
- ValidateNoInterpModeSignature(ValCtx, S.PatchConstantSignature);
- unsigned maxInputScalars = DXIL::kMaxInputTotalScalars;
- unsigned maxOutputScalars = 0;
- unsigned maxPatchConstantScalars = 0;
- switch (props.shaderKind) {
- case DXIL::ShaderKind::Compute:
- break;
- case DXIL::ShaderKind::Vertex:
- case DXIL::ShaderKind::Geometry:
- case DXIL::ShaderKind::Pixel:
- maxOutputScalars = DXIL::kMaxOutputTotalScalars;
- break;
- case DXIL::ShaderKind::Hull:
- case DXIL::ShaderKind::Domain:
- maxOutputScalars = DXIL::kMaxOutputTotalScalars;
- maxPatchConstantScalars = DXIL::kMaxHSOutputPatchConstantTotalScalars;
- break;
- default:
- break;
- }
- ValidateSignature(ValCtx, S.InputSignature, Status, maxInputScalars);
- ValidateSignature(ValCtx, S.OutputSignature, Status, maxOutputScalars);
- ValidateSignature(ValCtx, S.PatchConstantSignature, Status,
- maxPatchConstantScalars);
- if (isPS) {
- // Gather execution information.
- hlsl::PSExecutionInfo PSExec;
- for (auto &E :S.InputSignature.GetElements()) {
- if (E->GetKind() == DXIL::SemanticKind::SampleIndex) {
- PSExec.SuperSampling = true;
- continue;
- }
- const InterpolationMode *IM = E->GetInterpolationMode();
- if (IM->IsLinearSample() || IM->IsLinearNoperspectiveSample()) {
- PSExec.SuperSampling = true;
- }
- if (E->GetKind() == DXIL::SemanticKind::Position) {
- PSExec.PositionInterpolationMode = IM;
- }
- }
- for (auto &E : S.OutputSignature.GetElements()) {
- if (E->IsAnyDepth()) {
- PSExec.OutputDepthKind = E->GetKind();
- break;
- }
- }
- if (!PSExec.SuperSampling &&
- PSExec.OutputDepthKind != DXIL::SemanticKind::Invalid &&
- PSExec.OutputDepthKind != DXIL::SemanticKind::Depth) {
- if (PSExec.PositionInterpolationMode != nullptr) {
- if (!PSExec.PositionInterpolationMode->IsUndefined() &&
- !PSExec.PositionInterpolationMode->IsLinearNoperspectiveCentroid() &&
- !PSExec.PositionInterpolationMode->IsLinearNoperspectiveSample()) {
- ValCtx.EmitError(ValidationRule::SmPSConsistentInterp);
- }
- }
- }
- // Validate PS output semantic.
- const DxilSignature &outputSig = S.OutputSignature;
- for (auto &SE : outputSig.GetElements()) {
- Semantic::Kind semanticKind = SE->GetSemantic()->GetKind();
- switch (semanticKind) {
- case Semantic::Kind::Target:
- case Semantic::Kind::Coverage:
- case Semantic::Kind::Depth:
- case Semantic::Kind::DepthGreaterEqual:
- case Semantic::Kind::DepthLessEqual:
- case Semantic::Kind::StencilRef:
- break;
- default: {
- ValCtx.EmitFormatError(ValidationRule::SmPSOutputSemantic, {SE->GetName()});
- } break;
- }
- }
- }
- if (isGS) {
- unsigned maxVertexCount = props.ShaderProps.GS.maxVertexCount;
- unsigned outputScalarCount = 0;
- const DxilSignature &outSig = S.OutputSignature;
- for (auto &SE : outSig.GetElements()) {
- outputScalarCount += SE->GetRows() * SE->GetCols();
- }
- unsigned totalOutputScalars = maxVertexCount * outputScalarCount;
- if (totalOutputScalars > DXIL::kMaxGSOutputTotalScalars) {
- ValCtx.EmitFormatError(
- ValidationRule::SmGSTotalOutputVertexDataRange,
- {std::to_string(maxVertexCount),
- std::to_string(outputScalarCount),
- std::to_string(totalOutputScalars),
- std::to_string(DXIL::kMaxGSOutputTotalScalars)});
- }
- }
- if (isCS) {
- if (!S.OutputSignature.GetElements().empty() ||
- !S.PatchConstantSignature.GetElements().empty()) {
- ValCtx.EmitError(ValidationRule::SmCSNoReturn);
- }
- }
- }
- static void ValidateEntrySignatures(ValidationContext &ValCtx) {
- DxilModule &DM = ValCtx.DxilMod;
- if (ValCtx.isLibProfile) {
- for (Function &F : DM.GetModule()->functions()) {
- if (DM.HasDxilEntryProps(&F)) {
- DxilEntryProps &entryProps = DM.GetDxilEntryProps(&F);
- EntryStatus &Status = ValCtx.GetEntryStatus(&F);
- ValidateEntrySignatures(ValCtx, entryProps, Status);
- }
- }
- } else {
- Function *Entry = DM.GetEntryFunction();
- if (!DM.HasDxilEntryProps(Entry)) {
- // must have props.
- ValCtx.EmitError(ValidationRule::MetaNoEntryPropsForEntry);
- return;
- }
- EntryStatus &Status = ValCtx.GetEntryStatus(Entry);
- DxilEntryProps &entryProps = DM.GetDxilEntryProps(Entry);
- ValidateEntrySignatures(ValCtx, entryProps, Status);
- }
- }
- static void CheckPatchConstantSemantic(ValidationContext &ValCtx,
- const DxilEntryProps &EntryProps,
- EntryStatus &Status) {
- const DxilFunctionProps &props = EntryProps.props;
- bool isHS = props.IsHS();
- DXIL::TessellatorDomain domain =
- isHS ? props.ShaderProps.HS.domain : props.ShaderProps.DS.domain;
- const DxilSignature &patchConstantSig = EntryProps.sig.PatchConstantSignature;
- const unsigned kQuadEdgeSize = 4;
- const unsigned kQuadInsideSize = 2;
- const unsigned kQuadDomainLocSize = 2;
- const unsigned kTriEdgeSize = 3;
- const unsigned kTriInsideSize = 1;
- const unsigned kTriDomainLocSize = 3;
- const unsigned kIsolineEdgeSize = 2;
- const unsigned kIsolineInsideSize = 0;
- const unsigned kIsolineDomainLocSize = 3;
- const char *domainName = "";
- DXIL::SemanticKind kEdgeSemantic = DXIL::SemanticKind::TessFactor;
- unsigned edgeSize = 0;
- DXIL::SemanticKind kInsideSemantic = DXIL::SemanticKind::InsideTessFactor;
- unsigned insideSize = 0;
- Status.domainLocSize = 0;
- switch (domain) {
- case DXIL::TessellatorDomain::IsoLine:
- domainName = "IsoLine";
- edgeSize = kIsolineEdgeSize;
- insideSize = kIsolineInsideSize;
- Status.domainLocSize = kIsolineDomainLocSize;
- break;
- case DXIL::TessellatorDomain::Tri:
- domainName = "Tri";
- edgeSize = kTriEdgeSize;
- insideSize = kTriInsideSize;
- Status.domainLocSize = kTriDomainLocSize;
- break;
- case DXIL::TessellatorDomain::Quad:
- domainName = "Quad";
- edgeSize = kQuadEdgeSize;
- insideSize = kQuadInsideSize;
- Status.domainLocSize = kQuadDomainLocSize;
- break;
- default:
- // Don't bother with other tests if domain is invalid
- return;
- }
- bool bFoundEdgeSemantic = false;
- bool bFoundInsideSemantic = false;
- for (auto &SE : patchConstantSig.GetElements()) {
- Semantic::Kind kind = SE->GetSemantic()->GetKind();
- if (kind == kEdgeSemantic) {
- bFoundEdgeSemantic = true;
- if (SE->GetRows() != edgeSize || SE->GetCols() > 1) {
- ValCtx.EmitFormatError(ValidationRule::SmTessFactorSizeMatchDomain,
- {std::to_string(SE->GetRows()),
- std::to_string(SE->GetCols()), domainName,
- std::to_string(edgeSize)});
- }
- } else if (kind == kInsideSemantic) {
- bFoundInsideSemantic = true;
- if (SE->GetRows() != insideSize || SE->GetCols() > 1) {
- ValCtx.EmitFormatError(
- ValidationRule::SmInsideTessFactorSizeMatchDomain,
- {std::to_string(SE->GetRows()), std::to_string(SE->GetCols()),
- domainName, std::to_string(insideSize)});
- }
- }
- }
- if (isHS) {
- if (!bFoundEdgeSemantic) {
- ValCtx.EmitError(ValidationRule::SmTessFactorForDomain);
- }
- if (!bFoundInsideSemantic && domain != DXIL::TessellatorDomain::IsoLine) {
- ValCtx.EmitError(ValidationRule::SmTessFactorForDomain);
- }
- }
- }
- static void ValidatePassThruHS(ValidationContext &ValCtx,
- const DxilEntryProps &entryProps, Function *F) {
- // Check pass thru HS.
- if (F->isDeclaration()) {
- const auto &props = entryProps.props;
- if (props.IsHS()) {
- const auto &HS = props.ShaderProps.HS;
- if (HS.inputControlPoints < HS.outputControlPoints) {
- ValCtx.EmitError(ValidationRule::SmHullPassThruControlPointCountMatch);
- }
- // Check declared control point outputs storage amounts are ok to pass
- // through (less output storage than input for control points).
- const DxilSignature &outSig = entryProps.sig.OutputSignature;
- unsigned totalOutputCPScalars = 0;
- for (auto &SE : outSig.GetElements()) {
- totalOutputCPScalars += SE->GetRows() * SE->GetCols();
- }
- if (totalOutputCPScalars * HS.outputControlPoints >
- DXIL::kMaxHSOutputControlPointsTotalScalars) {
- ValCtx.EmitError(ValidationRule::SmOutputControlPointsTotalScalars);
- }
- } else {
- ValCtx.EmitError(ValidationRule::MetaEntryFunction);
- }
- }
- }
- static void ValidateEntryProps(ValidationContext &ValCtx,
- const DxilEntryProps &entryProps,
- EntryStatus &Status) {
- const DxilFunctionProps &props = entryProps.props;
- DXIL::ShaderKind ShaderType = props.shaderKind;
- if (ShaderType == DXIL::ShaderKind::Compute) {
- const auto &CS = props.ShaderProps.CS;
- unsigned x = CS.numThreads[0];
- unsigned y = CS.numThreads[1];
- unsigned z = CS.numThreads[2];
- unsigned threadsInGroup = x * y * z;
- if ((x < DXIL::kMinCSThreadGroupX) || (x > DXIL::kMaxCSThreadGroupX)) {
- ValCtx.EmitFormatError(ValidationRule::SmThreadGroupChannelRange,
- {"X", std::to_string(x),
- std::to_string(DXIL::kMinCSThreadGroupX),
- std::to_string(DXIL::kMaxCSThreadGroupX)});
- }
- if ((y < DXIL::kMinCSThreadGroupY) || (y > DXIL::kMaxCSThreadGroupY)) {
- ValCtx.EmitFormatError(ValidationRule::SmThreadGroupChannelRange,
- {"Y", std::to_string(y),
- std::to_string(DXIL::kMinCSThreadGroupY),
- std::to_string(DXIL::kMaxCSThreadGroupY)});
- }
- if ((z < DXIL::kMinCSThreadGroupZ) || (z > DXIL::kMaxCSThreadGroupZ)) {
- ValCtx.EmitFormatError(ValidationRule::SmThreadGroupChannelRange,
- {"Z", std::to_string(z),
- std::to_string(DXIL::kMinCSThreadGroupZ),
- std::to_string(DXIL::kMaxCSThreadGroupZ)});
- }
- if (threadsInGroup > DXIL::kMaxCSThreadsPerGroup) {
- ValCtx.EmitFormatError(ValidationRule::SmMaxTheadGroup,
- {std::to_string(threadsInGroup),
- std::to_string(DXIL::kMaxCSThreadsPerGroup)});
- }
- // type of threadID, thread group ID take care by DXIL operation overload
- // check.
- } else if (ShaderType == DXIL::ShaderKind::Domain) {
- const auto &DS = props.ShaderProps.DS;
- DXIL::TessellatorDomain domain = DS.domain;
- if (domain >= DXIL::TessellatorDomain::LastEntry)
- domain = DXIL::TessellatorDomain::Undefined;
- unsigned inputControlPointCount = DS.inputControlPoints;
- if (inputControlPointCount > DXIL::kMaxIAPatchControlPointCount) {
- ValCtx.EmitFormatError(
- ValidationRule::SmDSInputControlPointCountRange,
- {std::to_string(DXIL::kMaxIAPatchControlPointCount),
- std::to_string(inputControlPointCount)});
- }
- if (domain == DXIL::TessellatorDomain::Undefined) {
- ValCtx.EmitError(ValidationRule::SmValidDomain);
- }
- CheckPatchConstantSemantic(ValCtx, entryProps, Status);
- } else if (ShaderType == DXIL::ShaderKind::Hull) {
- const auto &HS = props.ShaderProps.HS;
- DXIL::TessellatorDomain domain = HS.domain;
- if (domain >= DXIL::TessellatorDomain::LastEntry)
- domain = DXIL::TessellatorDomain::Undefined;
- unsigned inputControlPointCount = HS.inputControlPoints;
- if (inputControlPointCount == 0) {
- const DxilSignature &inputSig = entryProps.sig.InputSignature;
- if (!inputSig.GetElements().empty()) {
- ValCtx.EmitError(ValidationRule::SmZeroHSInputControlPointWithInput);
- }
- } else if (inputControlPointCount > DXIL::kMaxIAPatchControlPointCount) {
- ValCtx.EmitFormatError(
- ValidationRule::SmHSInputControlPointCountRange,
- {std::to_string(DXIL::kMaxIAPatchControlPointCount),
- std::to_string(inputControlPointCount)});
- }
- unsigned outputControlPointCount = HS.outputControlPoints;
- if (outputControlPointCount > DXIL::kMaxIAPatchControlPointCount) {
- ValCtx.EmitFormatError(
- ValidationRule::SmOutputControlPointCountRange,
- {std::to_string(DXIL::kMaxIAPatchControlPointCount),
- std::to_string(outputControlPointCount)});
- }
- if (domain == DXIL::TessellatorDomain::Undefined) {
- ValCtx.EmitError(ValidationRule::SmValidDomain);
- }
- DXIL::TessellatorPartitioning partition = HS.partition;
- if (partition == DXIL::TessellatorPartitioning::Undefined) {
- ValCtx.EmitError(ValidationRule::MetaTessellatorPartition);
- }
- DXIL::TessellatorOutputPrimitive tessOutputPrimitive = HS.outputPrimitive;
- if (tessOutputPrimitive == DXIL::TessellatorOutputPrimitive::Undefined ||
- tessOutputPrimitive == DXIL::TessellatorOutputPrimitive::LastEntry) {
- ValCtx.EmitError(ValidationRule::MetaTessellatorOutputPrimitive);
- }
- float maxTessFactor = HS.maxTessFactor;
- if (maxTessFactor < DXIL::kHSMaxTessFactorLowerBound ||
- maxTessFactor > DXIL::kHSMaxTessFactorUpperBound) {
- ValCtx.EmitFormatError(ValidationRule::MetaMaxTessFactor,
- {std::to_string(DXIL::kHSMaxTessFactorLowerBound),
- std::to_string(DXIL::kHSMaxTessFactorUpperBound),
- std::to_string(maxTessFactor)});
- }
- // Domain and OutPrimivtive match.
- switch (domain) {
- case DXIL::TessellatorDomain::IsoLine:
- switch (tessOutputPrimitive) {
- case DXIL::TessellatorOutputPrimitive::TriangleCW:
- case DXIL::TessellatorOutputPrimitive::TriangleCCW:
- ValCtx.EmitError(ValidationRule::SmIsoLineOutputPrimitiveMismatch);
- break;
- default:
- break;
- }
- break;
- case DXIL::TessellatorDomain::Tri:
- switch (tessOutputPrimitive) {
- case DXIL::TessellatorOutputPrimitive::Line:
- ValCtx.EmitError(ValidationRule::SmTriOutputPrimitiveMismatch);
- break;
- default:
- break;
- }
- break;
- case DXIL::TessellatorDomain::Quad:
- switch (tessOutputPrimitive) {
- case DXIL::TessellatorOutputPrimitive::Line:
- ValCtx.EmitError(ValidationRule::SmTriOutputPrimitiveMismatch);
- break;
- default:
- break;
- }
- break;
- default:
- ValCtx.EmitError(ValidationRule::SmValidDomain);
- break;
- }
- CheckPatchConstantSemantic(ValCtx, entryProps, Status);
- } else if (ShaderType == DXIL::ShaderKind::Geometry) {
- const auto &GS = props.ShaderProps.GS;
- unsigned maxVertexCount = GS.maxVertexCount;
- if (maxVertexCount > DXIL::kMaxGSOutputVertexCount) {
- ValCtx.EmitFormatError(ValidationRule::SmGSOutputVertexCountRange,
- {std::to_string(DXIL::kMaxGSOutputVertexCount),
- std::to_string(maxVertexCount)});
- }
- unsigned instanceCount = GS.instanceCount;
- if (instanceCount > DXIL::kMaxGSInstanceCount || instanceCount < 1) {
- ValCtx.EmitFormatError(ValidationRule::SmGSInstanceCountRange,
- {std::to_string(DXIL::kMaxGSInstanceCount),
- std::to_string(instanceCount)});
- }
- DXIL::PrimitiveTopology topo = DXIL::PrimitiveTopology::Undefined;
- bool bTopoMismatch = false;
- for (size_t i = 0; i < _countof(GS.streamPrimitiveTopologies); ++i) {
- if (GS.streamPrimitiveTopologies[i] !=
- DXIL::PrimitiveTopology::Undefined) {
- if (topo == DXIL::PrimitiveTopology::Undefined)
- topo = GS.streamPrimitiveTopologies[i];
- else if (topo != GS.streamPrimitiveTopologies[i]) {
- bTopoMismatch = true;
- break;
- }
- }
- }
- if (bTopoMismatch)
- topo = DXIL::PrimitiveTopology::Undefined;
- switch (topo) {
- case DXIL::PrimitiveTopology::PointList:
- case DXIL::PrimitiveTopology::LineStrip:
- case DXIL::PrimitiveTopology::TriangleStrip:
- break;
- default: {
- ValCtx.EmitError(ValidationRule::SmGSValidOutputPrimitiveTopology);
- } break;
- }
- DXIL::InputPrimitive inputPrimitive = GS.inputPrimitive;
- unsigned VertexCount = GetNumVertices(inputPrimitive);
- if (VertexCount == 0 && inputPrimitive != DXIL::InputPrimitive::Undefined) {
- ValCtx.EmitError(ValidationRule::SmGSValidInputPrimitive);
- }
- }
- }
- static void ValidateShaderState(ValidationContext &ValCtx) {
- DxilModule &DM = ValCtx.DxilMod;
- if (ValCtx.isLibProfile) {
- for (Function &F : DM.GetModule()->functions()) {
- if (DM.HasDxilEntryProps(&F)) {
- DxilEntryProps &entryProps = DM.GetDxilEntryProps(&F);
- EntryStatus &Status = ValCtx.GetEntryStatus(&F);
- ValidateEntryProps(ValCtx, entryProps, Status);
- ValidatePassThruHS(ValCtx, entryProps, &F);
- }
- }
- } else {
- Function *Entry = DM.GetEntryFunction();
- if (!DM.HasDxilEntryProps(Entry)) {
- // must have props.
- ValCtx.EmitError(ValidationRule::MetaNoEntryPropsForEntry);
- return;
- }
- EntryStatus &Status = ValCtx.GetEntryStatus(Entry);
- DxilEntryProps &entryProps = DM.GetDxilEntryProps(Entry);
- ValidateEntryProps(ValCtx, entryProps, Status);
- ValidatePassThruHS(ValCtx, entryProps, Entry);
- }
- }
- static bool
- CalculateCallDepth(CallGraphNode *node,
- std::unordered_map<CallGraphNode *, unsigned> &depthMap,
- std::unordered_set<CallGraphNode *> &callStack,
- std::unordered_set<Function *> &funcSet) {
- unsigned depth = callStack.size();
- funcSet.insert(node->getFunction());
- for (auto it = node->begin(), ei = node->end(); it != ei; it++) {
- CallGraphNode *toNode = it->second;
- if (callStack.insert(toNode).second == false) {
- // Recursive.
- return true;
- }
- if (depthMap[toNode] < depth)
- depthMap[toNode] = depth;
- if (CalculateCallDepth(toNode, depthMap, callStack, funcSet)) {
- // Recursive
- return true;
- }
- callStack.erase(toNode);
- }
- return false;
- }
- static void ValidateCallGraph(ValidationContext &ValCtx) {
- // Build CallGraph.
- CallGraph CG(*ValCtx.DxilMod.GetModule());
- std::unordered_map<CallGraphNode*, unsigned> depthMap;
- std::unordered_set<CallGraphNode*> callStack;
- CallGraphNode *entryNode = CG[ValCtx.DxilMod.GetEntryFunction()];
- depthMap[entryNode] = 0;
- bool bRecursive = CalculateCallDepth(entryNode, depthMap, callStack, ValCtx.entryFuncCallSet);
- if (ValCtx.DxilMod.GetShaderModel()->IsHS()) {
- CallGraphNode *patchConstantNode = CG[ValCtx.DxilMod.GetPatchConstantFunction()];
- depthMap[patchConstantNode] = 0;
- callStack.clear();
- bRecursive |= CalculateCallDepth(patchConstantNode, depthMap, callStack, ValCtx.patchConstFuncCallSet);
- }
- if (bRecursive) {
- ValCtx.EmitError(ValidationRule::FlowNoRecusion);
- }
- }
- static void ValidateFlowControl(ValidationContext &ValCtx) {
- bool reducible =
- IsReducible(*ValCtx.DxilMod.GetModule(), IrreducibilityAction::Ignore);
- if (!reducible) {
- ValCtx.EmitError(ValidationRule::FlowReducible);
- return;
- }
- ValidateCallGraph(ValCtx);
- for (auto &F : ValCtx.DxilMod.GetModule()->functions()) {
- if (F.isDeclaration())
- continue;
- DominatorTreeAnalysis DTA;
- DominatorTree DT = DTA.run(F);
- LoopInfo LI;
- LI.Analyze(DT);
- for (auto loopIt = LI.begin(); loopIt != LI.end(); loopIt++) {
- Loop *loop = *loopIt;
- SmallVector<BasicBlock *, 4> exitBlocks;
- loop->getExitBlocks(exitBlocks);
- if (exitBlocks.empty())
- ValCtx.EmitError(ValidationRule::FlowDeadLoop);
- }
- }
- // fxc has ERR_CONTINUE_INSIDE_SWITCH to disallow continue in switch.
- // Not do it for now.
- }
- static void ValidateUninitializedOutput(ValidationContext &ValCtx,
- const DxilEntryProps &entryProps,
- EntryStatus &Status) {
- const DxilFunctionProps &props = entryProps.props;
- // For HS only need to check Tessfactor which is in patch constant sig.
- if (props.IsHS()) {
- std::vector<unsigned> &patchConstCols = Status.patchConstCols;
- const DxilSignature &patchConstSig = entryProps.sig.PatchConstantSignature;
- for (auto &E : patchConstSig.GetElements()) {
- unsigned mask = patchConstCols[E->GetID()];
- unsigned requireMask = (1 << E->GetCols()) - 1;
- // TODO: check other case uninitialized output is allowed.
- if (mask != requireMask && !E->GetSemantic()->IsArbitrary()) {
- ValCtx.EmitFormatError(ValidationRule::SmUndefinedOutput,
- {E->GetName()});
- }
- }
- return;
- }
- const DxilSignature &outSig = entryProps.sig.OutputSignature;
- std::vector<unsigned> &outputCols = Status.outputCols;
- for (auto &E : outSig.GetElements()) {
- unsigned mask = outputCols[E->GetID()];
- unsigned requireMask = (1 << E->GetCols()) - 1;
- // TODO: check other case uninitialized output is allowed.
- if (mask != requireMask && !E->GetSemantic()->IsArbitrary() &&
- E->GetSemantic()->GetKind() != Semantic::Kind::Target) {
- ValCtx.EmitFormatError(ValidationRule::SmUndefinedOutput, {E->GetName()});
- }
- }
- if (!props.IsGS()) {
- unsigned posMask = Status.OutputPositionMask[0];
- if (posMask != 0xf && Status.hasOutputPosition[0]) {
- ValCtx.EmitError(ValidationRule::SmCompletePosition);
- }
- } else {
- const auto &GS = props.ShaderProps.GS;
- unsigned streamMask = 0;
- for (size_t i = 0; i < _countof(GS.streamPrimitiveTopologies); ++i) {
- if (GS.streamPrimitiveTopologies[i] !=
- DXIL::PrimitiveTopology::Undefined) {
- streamMask |= 1<<i;
- }
- }
- for (unsigned i = 0; i < DXIL::kNumOutputStreams; i++) {
- if (streamMask & (1 << i)) {
- unsigned posMask = Status.OutputPositionMask[i];
- if (posMask != 0xf && Status.hasOutputPosition[i]) {
- ValCtx.EmitError(ValidationRule::SmCompletePosition);
- }
- }
- }
- }
- }
- static void ValidateUninitializedOutput(ValidationContext &ValCtx) {
- DxilModule &DM = ValCtx.DxilMod;
- if (ValCtx.isLibProfile) {
- for (Function &F : DM.GetModule()->functions()) {
- if (DM.HasDxilEntryProps(&F)) {
- DxilEntryProps &entryProps = DM.GetDxilEntryProps(&F);
- EntryStatus &Status = ValCtx.GetEntryStatus(&F);
- ValidateUninitializedOutput(ValCtx, entryProps, Status);
- }
- }
- } else {
- Function *Entry = DM.GetEntryFunction();
- if (!DM.HasDxilEntryProps(Entry)) {
- // must have props.
- ValCtx.EmitError(ValidationRule::MetaNoEntryPropsForEntry);
- return;
- }
- EntryStatus &Status = ValCtx.GetEntryStatus(Entry);
- DxilEntryProps &entryProps = DM.GetDxilEntryProps(Entry);
- ValidateUninitializedOutput(ValCtx, entryProps, Status);
- }
- }
- void GetValidationVersion(_Out_ unsigned *pMajor, _Out_ unsigned *pMinor) {
- // 1.0 is the first validator.
- // 1.1 adds:
- // - ILDN container part support
- // 1.2 adds:
- // - Metadata for floating point denorm mode
- // 1.3 adds:
- // TODO: add comment
- *pMajor = 1;
- *pMinor = 3;
- }
- _Use_decl_annotations_ HRESULT
- ValidateDxilModule(llvm::Module *pModule, llvm::Module *pDebugModule) {
- std::string diagStr;
- raw_string_ostream diagStream(diagStr);
- DiagnosticPrinterRawOStream DiagPrinter(diagStream);
- DxilModule *pDxilModule = DxilModule::TryGetDxilModule(pModule);
- if (!pDxilModule) {
- return DXC_E_IR_VERIFICATION_FAILED;
- }
- ValidationContext ValCtx(*pModule, pDebugModule, *pDxilModule, DiagPrinter);
- ValidateMetadata(ValCtx);
- ValidateShaderState(ValCtx);
- ValidateGlobalVariables(ValCtx);
- ValidateResources(ValCtx);
- // Validate control flow and collect function call info.
- // If has recursive call, call info collection will not finish.
- ValidateFlowControl(ValCtx);
- // Validate functions.
- for (Function &F : pModule->functions()) {
- ValidateFunction(F, ValCtx);
- }
- ValidateShaderFlags(ValCtx);
- ValidateEntrySignatures(ValCtx);
- ValidateUninitializedOutput(ValCtx);
- // Ensure error messages are flushed out on error.
- if (ValCtx.Failed) {
- emitDxilDiag(pModule->getContext(), diagStream.str().c_str());
- return DXC_E_IR_VERIFICATION_FAILED;
- }
- return S_OK;
- }
- // DXIL Container Verification Functions
- static void VerifyBlobPartMatches(_In_ ValidationContext &ValCtx,
- _In_ LPCSTR pName,
- DxilPartWriter *pWriter,
- _In_reads_bytes_opt_(Size) const void *pData,
- _In_ uint32_t Size) {
- if (!pData && pWriter->size()) {
- // No blob part, but writer says non-zero size is expected.
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMissing, {pName});
- return;
- }
- // Compare sizes
- if (pWriter->size() != Size) {
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMatches, {pName});
- return;
- }
- if (Size == 0) {
- return;
- }
- CComPtr<AbstractMemoryStream> pOutputStream;
- IFT(CreateMemoryStream(DxcGetThreadMallocNoRef(), &pOutputStream));
- pOutputStream->Reserve(Size);
- pWriter->write(pOutputStream);
- DXASSERT(pOutputStream->GetPtrSize() == Size, "otherwise, DxilPartWriter misreported size");
- if (memcmp(pData, pOutputStream->GetPtr(), Size)) {
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMatches, {pName});
- return;
- }
- return;
- }
- static void VerifySignatureMatches(_In_ ValidationContext &ValCtx,
- DXIL::SignatureKind SigKind,
- _In_reads_bytes_opt_(SigSize) const void *pSigData,
- _In_ uint32_t SigSize) {
- // Generate corresponding signature from module and memcmp
- const char *pName = nullptr;
- switch (SigKind)
- {
- case hlsl::DXIL::SignatureKind::Input:
- pName = "Program Input Signature";
- break;
- case hlsl::DXIL::SignatureKind::Output:
- pName = "Program Output Signature";
- break;
- case hlsl::DXIL::SignatureKind::PatchConstant:
- pName = "Program Patch Constant Signature";
- break;
- default:
- break;
- }
- unique_ptr<DxilPartWriter> pWriter(NewProgramSignatureWriter(ValCtx.DxilMod, SigKind));
- VerifyBlobPartMatches(ValCtx, pName, pWriter.get(), pSigData, SigSize);
- }
- _Use_decl_annotations_
- bool VerifySignatureMatches(llvm::Module *pModule,
- DXIL::SignatureKind SigKind,
- const void *pSigData,
- uint32_t SigSize) {
- std::string diagStr;
- raw_string_ostream diagStream(diagStr);
- DiagnosticPrinterRawOStream DiagPrinter(diagStream);
- ValidationContext ValCtx(*pModule, nullptr, pModule->GetOrCreateDxilModule(), DiagPrinter);
- VerifySignatureMatches(ValCtx, SigKind, pSigData, SigSize);
- if (ValCtx.Failed) {
- emitDxilDiag(pModule->getContext(), diagStream.str().c_str());
- }
- return !ValCtx.Failed;
- }
- static void VerifyPSVMatches(_In_ ValidationContext &ValCtx,
- _In_reads_bytes_(PSVSize) const void *pPSVData,
- _In_ uint32_t PSVSize) {
- uint32_t PSVVersion = 1; // This should be set to the newest version
- unique_ptr<DxilPartWriter> pWriter(NewPSVWriter(ValCtx.DxilMod, PSVVersion));
- // Try each version in case an earlier version matches module
- while (PSVVersion && pWriter->size() != PSVSize) {
- PSVVersion --;
- pWriter.reset(NewPSVWriter(ValCtx.DxilMod, PSVVersion));
- }
- // generate PSV data from module and memcmp
- VerifyBlobPartMatches(ValCtx, "Pipeline State Validation", pWriter.get(), pPSVData, PSVSize);
- }
- _Use_decl_annotations_
- bool VerifyPSVMatches(llvm::Module *pModule,
- const void *pPSVData,
- uint32_t PSVSize) {
- std::string diagStr;
- raw_string_ostream diagStream(diagStr);
- DiagnosticPrinterRawOStream DiagPrinter(diagStream);
- ValidationContext ValCtx(*pModule, nullptr, pModule->GetOrCreateDxilModule(), DiagPrinter);
- VerifyPSVMatches(ValCtx, pPSVData, PSVSize);
- if (ValCtx.Failed) {
- emitDxilDiag(pModule->getContext(), diagStream.str().c_str());
- }
- return !ValCtx.Failed;
- }
- static void VerifyFeatureInfoMatches(_In_ ValidationContext &ValCtx,
- _In_reads_bytes_(FeatureInfoSize) const void *pFeatureInfoData,
- _In_ uint32_t FeatureInfoSize) {
- // generate Feature Info data from module and memcmp
- unique_ptr<DxilPartWriter> pWriter(NewFeatureInfoWriter(ValCtx.DxilMod));
- VerifyBlobPartMatches(ValCtx, "Feature Info", pWriter.get(), pFeatureInfoData, FeatureInfoSize);
- }
- _Use_decl_annotations_
- bool VerifyFeatureInfoMatches(llvm::Module *pModule,
- const void *pFeatureInfoData,
- uint32_t FeatureInfoSize) {
- std::string diagStr;
- raw_string_ostream diagStream(diagStr);
- DiagnosticPrinterRawOStream DiagPrinter(diagStream);
- ValidationContext ValCtx(*pModule, nullptr, pModule->GetOrCreateDxilModule(), DiagPrinter);
- VerifyFeatureInfoMatches(ValCtx, pFeatureInfoData, FeatureInfoSize);
- if (ValCtx.Failed) {
- emitDxilDiag(pModule->getContext(), diagStream.str().c_str());
- }
- return !ValCtx.Failed;
- }
- _Use_decl_annotations_
- HRESULT ValidateDxilContainerParts(llvm::Module *pModule,
- llvm::Module *pDebugModule,
- const DxilContainerHeader *pContainer,
- uint32_t ContainerSize) {
- DXASSERT_NOMSG(pModule);
- if (!pContainer || !IsValidDxilContainer(pContainer, ContainerSize)) {
- return DXC_E_CONTAINER_INVALID;
- }
- DxilModule *pDxilModule = DxilModule::TryGetDxilModule(pModule);
- if (!pDxilModule) {
- return DXC_E_IR_VERIFICATION_FAILED;
- }
- std::string diagStr;
- raw_string_ostream DiagStream(diagStr);
- DiagnosticPrinterRawOStream DiagPrinter(DiagStream);
- ValidationContext ValCtx(*pModule, pDebugModule, *pDxilModule, DiagPrinter);
- DXIL::ShaderKind ShaderKind = pDxilModule->GetShaderModel()->GetKind();
- bool bTess = ShaderKind == DXIL::ShaderKind::Hull || ShaderKind == DXIL::ShaderKind::Domain;
- std::unordered_set<uint32_t> FourCCFound;
- const DxilPartHeader *pRootSignaturePart = nullptr;
- const DxilPartHeader *pPSVPart = nullptr;
- for (auto it = begin(pContainer), itEnd = end(pContainer); it != itEnd; ++it) {
- const DxilPartHeader *pPart = *it;
- char szFourCC[5];
- PartKindToCharArray(pPart->PartFourCC, szFourCC);
- if (FourCCFound.find(pPart->PartFourCC) != FourCCFound.end()) {
- // Two parts with same FourCC found
- ValCtx.EmitFormatError(ValidationRule::ContainerPartRepeated, {szFourCC});
- continue;
- }
- FourCCFound.insert(pPart->PartFourCC);
- switch (pPart->PartFourCC)
- {
- case DFCC_InputSignature:
- VerifySignatureMatches(ValCtx, DXIL::SignatureKind::Input, GetDxilPartData(pPart), pPart->PartSize);
- break;
- case DFCC_OutputSignature:
- VerifySignatureMatches(ValCtx, DXIL::SignatureKind::Output, GetDxilPartData(pPart), pPart->PartSize);
- break;
- case DFCC_PatchConstantSignature:
- if (bTess) {
- VerifySignatureMatches(ValCtx, DXIL::SignatureKind::PatchConstant, GetDxilPartData(pPart), pPart->PartSize);
- } else {
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMatches, {"Program Patch Constant Signature"});
- }
- break;
- case DFCC_FeatureInfo:
- VerifyFeatureInfoMatches(ValCtx, GetDxilPartData(pPart), pPart->PartSize);
- break;
- case DFCC_RootSignature:
- pRootSignaturePart = pPart;
- break;
- case DFCC_PipelineStateValidation:
- pPSVPart = pPart;
- VerifyPSVMatches(ValCtx, GetDxilPartData(pPart), pPart->PartSize);
- break;
- // Skip these
- case DFCC_ResourceDef:
- case DFCC_ShaderStatistics:
- case DFCC_PrivateData:
- case DFCC_DXIL:
- case DFCC_ShaderDebugInfoDXIL:
- case DFCC_ShaderDebugName:
- continue;
- // Lib part
- case DFCC_RuntimeData:
- // TODO: Validate RuntimeData.
- break;
- case DFCC_Container:
- default:
- ValCtx.EmitFormatError(ValidationRule::ContainerPartInvalid, {szFourCC});
- break;
- }
- }
- // Verify required parts found
- if (FourCCFound.find(DFCC_InputSignature) == FourCCFound.end() && !ValCtx.isLibProfile) {
- VerifySignatureMatches(ValCtx, DXIL::SignatureKind::Input, nullptr, 0);
- }
- if (FourCCFound.find(DFCC_OutputSignature) == FourCCFound.end() && !ValCtx.isLibProfile) {
- VerifySignatureMatches(ValCtx, DXIL::SignatureKind::Output, nullptr, 0);
- }
- if (bTess && FourCCFound.find(DFCC_PatchConstantSignature) == FourCCFound.end() &&
- pDxilModule->GetPatchConstantSignature().GetElements().size())
- {
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMissing, {"Program Patch Constant Signature"});
- }
- if (FourCCFound.find(DFCC_FeatureInfo) == FourCCFound.end()) {
- // Could be optional, but RS1 runtime doesn't handle this case properly.
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMissing, {"Feature Info"});
- }
- // Validate Root Signature
- if (pPSVPart) {
- if (pRootSignaturePart) {
- try {
- RootSignatureHandle RS;
- RS.LoadSerialized((const uint8_t*)GetDxilPartData(pRootSignaturePart), pRootSignaturePart->PartSize);
- RS.Deserialize();
- IFTBOOL(VerifyRootSignatureWithShaderPSV(RS.GetDesc(),
- pDxilModule->GetShaderModel()->GetKind(),
- GetDxilPartData(pPSVPart), pPSVPart->PartSize,
- DiagStream), DXC_E_INCORRECT_ROOT_SIGNATURE);
- } catch (...) {
- ValCtx.EmitError(ValidationRule::ContainerRootSignatureIncompatible);
- }
- }
- } else {
- // Not for lib.
- if (!ValCtx.isLibProfile)
- ValCtx.EmitFormatError(ValidationRule::ContainerPartMissing, {"Pipeline State Validation"});
- }
- if (ValCtx.Failed) {
- emitDxilDiag(pModule->getContext(), DiagStream.str().c_str());
- return DXC_E_MALFORMED_CONTAINER;
- }
- return S_OK;
- }
- static HRESULT FindDxilPart(_In_reads_bytes_(ContainerSize) const void *pContainerBytes,
- _In_ uint32_t ContainerSize,
- _In_ DxilFourCC FourCC,
- _In_ const DxilPartHeader **ppPart) {
- const DxilContainerHeader *pContainer =
- IsDxilContainerLike(pContainerBytes, ContainerSize);
- if (!pContainer) {
- IFR(DXC_E_CONTAINER_INVALID);
- }
- if (!IsValidDxilContainer(pContainer, ContainerSize)) {
- IFR(DXC_E_CONTAINER_INVALID);
- }
- DxilPartIterator it = std::find_if(begin(pContainer), end(pContainer),
- DxilPartIsType(FourCC));
- if (it == end(pContainer)) {
- IFR(DXC_E_CONTAINER_MISSING_DXIL);
- }
- const DxilProgramHeader *pProgramHeader =
- reinterpret_cast<const DxilProgramHeader *>(GetDxilPartData(*it));
- if (!IsValidDxilProgramHeader(pProgramHeader, (*it)->PartSize)) {
- IFR(DXC_E_CONTAINER_INVALID);
- }
- *ppPart = *it;
- return S_OK;
- }
- _Use_decl_annotations_
- HRESULT ValidateLoadModule(const char *pIL,
- uint32_t ILLength,
- unique_ptr<llvm::Module> &pModule,
- LLVMContext &Ctx,
- llvm::raw_ostream &DiagStream,
- unsigned bLazyLoad) {
- llvm::DiagnosticPrinterRawOStream DiagPrinter(DiagStream);
- PrintDiagnosticContext DiagContext(DiagPrinter);
- DiagRestore DR(Ctx, &DiagContext);
- std::unique_ptr<llvm::MemoryBuffer> pBitcodeBuf;
- pBitcodeBuf.reset(llvm::MemoryBuffer::getMemBuffer(
- llvm::StringRef(pIL, ILLength), "", false).release());
- ErrorOr<std::unique_ptr<Module>> loadedModuleResult =
- bLazyLoad == 0?
- llvm::parseBitcodeFile(pBitcodeBuf->getMemBufferRef(), Ctx) :
- llvm::getLazyBitcodeModule(std::move(pBitcodeBuf), Ctx);
- // DXIL disallows some LLVM bitcode constructs, like unaccounted-for sub-blocks.
- // These appear as warnings, which the validator should reject.
- if (DiagContext.HasErrors() || DiagContext.HasWarnings() || loadedModuleResult.getError())
- return DXC_E_IR_VERIFICATION_FAILED;
- pModule = std::move(loadedModuleResult.get());
- return S_OK;
- }
- HRESULT ValidateDxilBitcode(
- _In_reads_bytes_(ILLength) const char *pIL,
- _In_ uint32_t ILLength,
- _In_ llvm::raw_ostream &DiagStream) {
- LLVMContext Ctx;
- std::unique_ptr<llvm::Module> pModule;
- llvm::DiagnosticPrinterRawOStream DiagPrinter(DiagStream);
- PrintDiagnosticContext DiagContext(DiagPrinter);
- Ctx.setDiagnosticHandler(PrintDiagnosticContext::PrintDiagnosticHandler,
- &DiagContext, true);
- HRESULT hr;
- if (FAILED(hr = ValidateLoadModule(pIL, ILLength, pModule, Ctx, DiagStream,
- /*bLazyLoad*/ false)))
- return hr;
- if (FAILED(hr = ValidateDxilModule(pModule.get(), nullptr)))
- return hr;
- DxilModule &dxilModule = pModule->GetDxilModule();
- if (!dxilModule.GetRootSignature().IsEmpty()) {
- unique_ptr<DxilPartWriter> pWriter(NewPSVWriter(dxilModule, 0));
- DXASSERT_NOMSG(pWriter->size());
- CComPtr<AbstractMemoryStream> pOutputStream;
- IFT(CreateMemoryStream(DxcGetThreadMallocNoRef(), &pOutputStream));
- pOutputStream->Reserve(pWriter->size());
- pWriter->write(pOutputStream);
- const DxilVersionedRootSignatureDesc* pDesc = dxilModule.GetRootSignature().GetDesc();
- RootSignatureHandle RS;
- try {
- if (!pDesc) {
- RS.Assign(nullptr, dxilModule.GetRootSignature().GetSerialized());
- RS.Deserialize();
- pDesc = RS.GetDesc();
- if (!pDesc)
- return DXC_E_INCORRECT_ROOT_SIGNATURE;
- }
- IFTBOOL(VerifyRootSignatureWithShaderPSV(pDesc,
- dxilModule.GetShaderModel()->GetKind(),
- pOutputStream->GetPtr(), pWriter->size(),
- DiagStream), DXC_E_INCORRECT_ROOT_SIGNATURE);
- } catch (...) {
- return DXC_E_INCORRECT_ROOT_SIGNATURE;
- }
- }
- if (DiagContext.HasErrors() || DiagContext.HasWarnings()) {
- return DXC_E_IR_VERIFICATION_FAILED;
- }
- return S_OK;
- }
- static HRESULT ValidateLoadModuleFromContainer(
- _In_reads_bytes_(ILLength) const void *pContainer,
- _In_ uint32_t ContainerSize, _In_ std::unique_ptr<llvm::Module> &pModule,
- _In_ std::unique_ptr<llvm::Module> &pDebugModule,
- _In_ llvm::LLVMContext &Ctx, LLVMContext &DbgCtx,
- _In_ llvm::raw_ostream &DiagStream, _In_ unsigned bLazyLoad) {
- llvm::DiagnosticPrinterRawOStream DiagPrinter(DiagStream);
- PrintDiagnosticContext DiagContext(DiagPrinter);
- DiagRestore DR(Ctx, &DiagContext);
- DiagRestore DR2(DbgCtx, &DiagContext);
- const DxilPartHeader *pPart = nullptr;
- IFR(FindDxilPart(pContainer, ContainerSize, DFCC_DXIL, &pPart));
- const char *pIL = nullptr;
- uint32_t ILLength = 0;
- GetDxilProgramBitcode(
- reinterpret_cast<const DxilProgramHeader *>(GetDxilPartData(pPart)), &pIL,
- &ILLength);
- IFR(ValidateLoadModule(pIL, ILLength, pModule, Ctx, DiagStream, bLazyLoad));
- HRESULT hr;
- const DxilPartHeader *pDbgPart = nullptr;
- if (FAILED(hr = FindDxilPart(pContainer, ContainerSize,
- DFCC_ShaderDebugInfoDXIL, &pDbgPart)) &&
- hr != DXC_E_CONTAINER_MISSING_DXIL) {
- return hr;
- }
- if (pDbgPart) {
- GetDxilProgramBitcode(
- reinterpret_cast<const DxilProgramHeader *>(GetDxilPartData(pDbgPart)),
- &pIL, &ILLength);
- if (FAILED(hr = ValidateLoadModule(pIL, ILLength, pDebugModule, DbgCtx,
- DiagStream, bLazyLoad))) {
- return hr;
- }
- }
- return S_OK;
- }
- _Use_decl_annotations_ HRESULT ValidateLoadModuleFromContainer(
- _In_reads_bytes_(ContainerSize) const void *pContainer,
- _In_ uint32_t ContainerSize, _In_ std::unique_ptr<llvm::Module> &pModule,
- _In_ std::unique_ptr<llvm::Module> &pDebugModule,
- _In_ llvm::LLVMContext &Ctx, llvm::LLVMContext &DbgCtx,
- _In_ llvm::raw_ostream &DiagStream) {
- return ValidateLoadModuleFromContainer(pContainer, ContainerSize, pModule,
- pDebugModule, Ctx, DbgCtx, DiagStream,
- /*bLazyLoad*/ false);
- }
- // Lazy loads module from container, validating load, but not module.
- _Use_decl_annotations_ HRESULT ValidateLoadModuleFromContainerLazy(
- _In_reads_bytes_(ContainerSize) const void *pContainer,
- _In_ uint32_t ContainerSize, _In_ std::unique_ptr<llvm::Module> &pModule,
- _In_ std::unique_ptr<llvm::Module> &pDebugModule,
- _In_ llvm::LLVMContext &Ctx, llvm::LLVMContext &DbgCtx,
- _In_ llvm::raw_ostream &DiagStream) {
- return ValidateLoadModuleFromContainer(pContainer, ContainerSize, pModule,
- pDebugModule, Ctx, DbgCtx, DiagStream,
- /*bLazyLoad*/ true);
- }
- _Use_decl_annotations_
- HRESULT ValidateDxilContainer(const void *pContainer,
- uint32_t ContainerSize,
- llvm::raw_ostream &DiagStream) {
- LLVMContext Ctx, DbgCtx;
- std::unique_ptr<llvm::Module> pModule, pDebugModule;
- llvm::DiagnosticPrinterRawOStream DiagPrinter(DiagStream);
- PrintDiagnosticContext DiagContext(DiagPrinter);
- Ctx.setDiagnosticHandler(PrintDiagnosticContext::PrintDiagnosticHandler,
- &DiagContext, true);
- DbgCtx.setDiagnosticHandler(PrintDiagnosticContext::PrintDiagnosticHandler,
- &DiagContext, true);
- IFR(ValidateLoadModuleFromContainer(pContainer, ContainerSize, pModule, pDebugModule,
- Ctx, DbgCtx, DiagStream));
- // Validate DXIL Module
- IFR(ValidateDxilModule(pModule.get(), pDebugModule.get()));
- if (DiagContext.HasErrors() || DiagContext.HasWarnings()) {
- return DXC_E_IR_VERIFICATION_FAILED;
- }
- return ValidateDxilContainerParts(pModule.get(), pDebugModule.get(),
- IsDxilContainerLike(pContainer, ContainerSize), ContainerSize);
- }
- } // namespace hlsl
|